Instructions to use inclusionAI/Ring-1T with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use inclusionAI/Ring-1T with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="inclusionAI/Ring-1T", trust_remote_code=True) messages = [ {"role": "user", "content": "Who are you?"}, ] pipe(messages)# Load model directly from transformers import AutoModelForCausalLM model = AutoModelForCausalLM.from_pretrained("inclusionAI/Ring-1T", trust_remote_code=True, device_map="auto") - Inference
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- vLLM
How to use inclusionAI/Ring-1T with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "inclusionAI/Ring-1T" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "inclusionAI/Ring-1T", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/inclusionAI/Ring-1T
- SGLang
How to use inclusionAI/Ring-1T 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 "inclusionAI/Ring-1T" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "inclusionAI/Ring-1T", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'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 "inclusionAI/Ring-1T" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "inclusionAI/Ring-1T", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }' - Docker Model Runner
How to use inclusionAI/Ring-1T with Docker Model Runner:
docker model run hf.co/inclusionAI/Ring-1T
Update README.md
Browse files
README.md
CHANGED
|
@@ -171,6 +171,44 @@ curl -s http://${MASTER_IP}:${PORT}/v1/chat/completions \
|
|
| 171 |
|
| 172 |
More usage can be found [here](https://docs.sglang.ai/basic_usage/send_request.html)
|
| 173 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 174 |
## Finetuning
|
| 175 |
|
| 176 |
We recommend you use [Llama-Factory](https://github.com/hiyouga/LLaMA-Factory) to [finetune Ring](https://github.com/inclusionAI/Ring-V2/blob/main/docs/llamafactory_finetuning.md).
|
|
|
|
| 171 |
|
| 172 |
More usage can be found [here](https://docs.sglang.ai/basic_usage/send_request.html)
|
| 173 |
|
| 174 |
+
### vLLM
|
| 175 |
+
|
| 176 |
+
#### Environment Preparation
|
| 177 |
+
|
| 178 |
+
```bash
|
| 179 |
+
pip install vllm==0.11.0
|
| 180 |
+
```
|
| 181 |
+
|
| 182 |
+
#### Run Inference:
|
| 183 |
+
|
| 184 |
+
Here is the example to deploy the model with multiple GPU nodes, where the master node IP is ${MASTER_IP}, server port is ${PORT} and the path of model is ${MODEL_PATH}:
|
| 185 |
+
|
| 186 |
+
```bash
|
| 187 |
+
# step 1. start ray on all nodes
|
| 188 |
+
|
| 189 |
+
# step 2. start vllm server only on node 0:
|
| 190 |
+
vllm serve $MODEL_PATH --port $PORT --served-model-name my_model --trust-remote-code --tensor-parallel-size 8 --pipeline-parallel-size 4 --gpu-memory-utilization 0.85
|
| 191 |
+
|
| 192 |
+
|
| 193 |
+
# This is only an example, please adjust arguments according to your actual environment.
|
| 194 |
+
```
|
| 195 |
+
|
| 196 |
+
To handle long context in vLLM using YaRN, we need to follow these two steps:
|
| 197 |
+
1. Add a `rope_scaling` field to the model's `config.json` file, for example:
|
| 198 |
+
```json
|
| 199 |
+
{
|
| 200 |
+
...,
|
| 201 |
+
"rope_scaling": {
|
| 202 |
+
"factor": 4.0,
|
| 203 |
+
"original_max_position_embeddings": 32768,
|
| 204 |
+
"type": "yarn"
|
| 205 |
+
}
|
| 206 |
+
}
|
| 207 |
+
```
|
| 208 |
+
2. Use an additional parameter `--max-model-len` to specify the desired maximum context length when starting the vLLM service.
|
| 209 |
+
|
| 210 |
+
For detailed guidance, please refer to the vLLM [`instructions`](https://docs.vllm.ai/en/latest/).
|
| 211 |
+
|
| 212 |
## Finetuning
|
| 213 |
|
| 214 |
We recommend you use [Llama-Factory](https://github.com/hiyouga/LLaMA-Factory) to [finetune Ring](https://github.com/inclusionAI/Ring-V2/blob/main/docs/llamafactory_finetuning.md).
|