Instructions to use cloudsurf-software/CloudSurf-1B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use cloudsurf-software/CloudSurf-1B with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="cloudsurf-software/CloudSurf-1B")

# pip install -U transformers accelerate
# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("cloudsurf-software/CloudSurf-1B")
model = AutoModelForCausalLM.from_pretrained("cloudsurf-software/CloudSurf-1B", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use cloudsurf-software/CloudSurf-1B with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "cloudsurf-software/CloudSurf-1B"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "cloudsurf-software/CloudSurf-1B",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker

docker model run hf.co/cloudsurf-software/CloudSurf-1B

SGLang

How to use cloudsurf-software/CloudSurf-1B with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "cloudsurf-software/CloudSurf-1B" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "cloudsurf-software/CloudSurf-1B",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "cloudsurf-software/CloudSurf-1B" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "cloudsurf-software/CloudSurf-1B",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use cloudsurf-software/CloudSurf-1B with Docker Model Runner:
```
docker model run hf.co/cloudsurf-software/CloudSurf-1B
```

brady777 commited on 12 days ago

Commit

bb2b8a9

verified ·

1 Parent(s): 501a824

Add special_tokens_map.json

Browse files

Files changed (1) hide show

special_tokens_map.json +5 -0

special_tokens_map.json ADDED Viewed

	@@ -0,0 +1,5 @@

+{
+  "bos_token": "<|bos|>",
+  "eos_token": "<|eos|>",
+  "pad_token": "<|pad|>"
+}