Instructions to use xlangai/OpenCUA-7B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use xlangai/OpenCUA-7B with Transformers:

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

pipe = pipeline("image-text-to-text", model="xlangai/OpenCUA-7B", 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("xlangai/OpenCUA-7B", trust_remote_code=True, dtype="auto")

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use xlangai/OpenCUA-7B with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "xlangai/OpenCUA-7B"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "xlangai/OpenCUA-7B",
		"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/xlangai/OpenCUA-7B

SGLang

How to use xlangai/OpenCUA-7B 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 "xlangai/OpenCUA-7B" \
    --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": "xlangai/OpenCUA-7B",
		"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 "xlangai/OpenCUA-7B" \
        --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": "xlangai/OpenCUA-7B",
		"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 xlangai/OpenCUA-7B with Docker Model Runner:
```
docker model run hf.co/xlangai/OpenCUA-7B
```

replace the config.json with a correct version

by LutherXD - opened Jan 15

base: refs/heads/main

←

from: refs/pr/6

Discussion Files changed

+11

-8

Files changed (1) hide show

config.json +11 -8

config.json CHANGED Viewed

@@ -12,25 +12,28 @@
   "media_placeholder_token_id": 151664,
   "model_type": "opencua",
   "pad_token_id": 0,
   "text_config": {
     "bos_token_id": 151643,
     "eos_token_id": 151644,
     "head_dim": 128,
     "hidden_act": "silu",
-    "hidden_size": 5120,
     "initializer_range": 0.02,
-    "intermediate_size": 27648,
     "k_proj_bias": true,
     "max_length": 20,
     "min_length": 0,
     "model_type": "qwen2",
-    "num_attention_heads": 40,
     "num_beam_groups": 1,
     "num_beams": 1,
-    "num_hidden_layers": 64,
-    "num_key_value_heads": 8,
     "pad_token_id": 152063,
-    "pretraining_sequence_length": 131072,
     "q_proj_bias": true,
     "rms_norm_eps": 1e-05,
     "rope_theta": 1000000.0,
@@ -56,13 +59,13 @@
     "hidden_size": 1280,
     "num_heads": 16,
     "in_chans": 3,
-    "intermediate_size": 3456,
     "patch_size": 14,
     "spatial_merge_size": 2,
     "spatial_patch_size": 14,
     "temporal_patch_size": 2,
-    "out_hidden_size": 5120,
     "tokens_per_second": 2,
     "window_size": 112
   },

   "media_placeholder_token_id": 151664,
   "model_type": "opencua",
   "pad_token_id": 0,
+  "num_attention_heads": 28,
+  "max_position_embeddings": 128000,
   "text_config": {
     "bos_token_id": 151643,
     "eos_token_id": 151644,
     "head_dim": 128,
     "hidden_act": "silu",
+    "hidden_size": 3584,
     "initializer_range": 0.02,
+    "intermediate_size": 18944,
     "k_proj_bias": true,
     "max_length": 20,
     "min_length": 0,
     "model_type": "qwen2",
+    "num_attention_heads": 28,
     "num_beam_groups": 1,
     "num_beams": 1,
+    "num_hidden_layers": 28,
+    "num_key_value_heads": 4,
     "pad_token_id": 152063,
+    "max_position_embeddings": 128000,
+    "pretraining_sequence_length": 128000,
     "q_proj_bias": true,
     "rms_norm_eps": 1e-05,
     "rope_theta": 1000000.0,
     "hidden_size": 1280,
     "num_heads": 16,
     "in_chans": 3,
+    "intermediate_size": 3420,
     "patch_size": 14,
     "spatial_merge_size": 2,
     "spatial_patch_size": 14,
     "temporal_patch_size": 2,
+    "out_hidden_size": 3584,
     "tokens_per_second": 2,
     "window_size": 112
   },