Instructions to use Skywork/Skywork-R1V-38B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use Skywork/Skywork-R1V-38B with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("image-text-to-text", model="Skywork/Skywork-R1V-38B", trust_remote_code=True) messages = [ { "role": "user", "content": [ {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"}, {"type": "text", "text": "What animal is on the candy?"} ] }, ] pipe(text=messages)# Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("Skywork/Skywork-R1V-38B", trust_remote_code=True, dtype="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps
- vLLM
How to use Skywork/Skywork-R1V-38B with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "Skywork/Skywork-R1V-38B" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "Skywork/Skywork-R1V-38B", "messages": [ { "role": "user", "content": [ { "type": "text", "text": "Describe this image in one sentence." }, { "type": "image_url", "image_url": { "url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg" } } ] } ] }'Use Docker
docker model run hf.co/Skywork/Skywork-R1V-38B
- SGLang
How to use Skywork/Skywork-R1V-38B 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 "Skywork/Skywork-R1V-38B" \ --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": "Skywork/Skywork-R1V-38B", "messages": [ { "role": "user", "content": [ { "type": "text", "text": "Describe this image in one sentence." }, { "type": "image_url", "image_url": { "url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg" } } ] } ] }'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 "Skywork/Skywork-R1V-38B" \ --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": "Skywork/Skywork-R1V-38B", "messages": [ { "role": "user", "content": [ { "type": "text", "text": "Describe this image in one sentence." }, { "type": "image_url", "image_url": { "url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg" } } ] } ] }' - Docker Model Runner
How to use Skywork/Skywork-R1V-38B with Docker Model Runner:
docker model run hf.co/Skywork/Skywork-R1V-38B
Update README.md
Browse files
README.md
CHANGED
|
@@ -239,23 +239,21 @@ pipeline_tag: image-text-to-text
|
|
| 239 |
|
| 240 |
## 4. Usage
|
| 241 |
|
| 242 |
-
###
|
| 243 |
-
First, clone the repository to your local machine:
|
| 244 |
|
| 245 |
```shell
|
| 246 |
git clone https://github.com/SkyworkAI/Skywork-R1V.git
|
| 247 |
cd skywork-r1v/inference
|
| 248 |
```
|
| 249 |
-
###
|
| 250 |
|
| 251 |
```shell
|
| 252 |
-
|
| 253 |
-
|
|
|
|
| 254 |
```
|
| 255 |
|
| 256 |
-
###
|
| 257 |
-
|
| 258 |
-
Prepare your images and questions, and update them to inference_with_transformers.py
|
| 259 |
|
| 260 |
```shell
|
| 261 |
CUDA_VISIBLE_DEVICES="0,1" python inference_with_transformers.py \
|
|
|
|
| 239 |
|
| 240 |
## 4. Usage
|
| 241 |
|
| 242 |
+
### 1. Clone the Repository
|
|
|
|
| 243 |
|
| 244 |
```shell
|
| 245 |
git clone https://github.com/SkyworkAI/Skywork-R1V.git
|
| 246 |
cd skywork-r1v/inference
|
| 247 |
```
|
| 248 |
+
### 2. Set Up the Environment
|
| 249 |
|
| 250 |
```shell
|
| 251 |
+
conda create -n r1-v python=3.10
|
| 252 |
+
conda activate r1-v
|
| 253 |
+
bash setup.sh
|
| 254 |
```
|
| 255 |
|
| 256 |
+
### 3. Run the Inference Script
|
|
|
|
|
|
|
| 257 |
|
| 258 |
```shell
|
| 259 |
CUDA_VISIBLE_DEVICES="0,1" python inference_with_transformers.py \
|