Instructions to use jadechoghari/Ferret-UI-Llama8b with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use jadechoghari/Ferret-UI-Llama8b with Transformers:

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

pipe = pipeline("image-text-to-text", model="jadechoghari/Ferret-UI-Llama8b", 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 AutoModelForCausalLM
model = AutoModelForCausalLM.from_pretrained("jadechoghari/Ferret-UI-Llama8b", trust_remote_code=True, device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use jadechoghari/Ferret-UI-Llama8b with vLLM:

Install from pip and serve model

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

SGLang

How to use jadechoghari/Ferret-UI-Llama8b 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 "jadechoghari/Ferret-UI-Llama8b" \
    --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": "jadechoghari/Ferret-UI-Llama8b",
		"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 "jadechoghari/Ferret-UI-Llama8b" \
        --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": "jadechoghari/Ferret-UI-Llama8b",
		"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 jadechoghari/Ferret-UI-Llama8b with Docker Model Runner:
```
docker model run hf.co/jadechoghari/Ferret-UI-Llama8b
```

jadechoghari commited on Oct 9, 2024

Commit

89f21fc

verified ·

1 Parent(s): 4e05b75

Create constants.py

Browse files

Files changed (1) hide show

constants.py +32 -0

constants.py ADDED Viewed

	@@ -0,0 +1,32 @@

+CONTROLLER_HEART_BEAT_EXPIRATION = 30
+WORKER_HEART_BEAT_INTERVAL = 15
+LOGDIR = "."
+# Model Constants
+IGNORE_INDEX = -100
+IMAGE_TOKEN_INDEX = -200
+DEFAULT_IMAGE_TOKEN = "<image>"
+DEFAULT_IMAGE_PATCH_TOKEN = "<im_patch>"
+DEFAULT_IM_START_TOKEN = "<im_start>"
+DEFAULT_IM_END_TOKEN = "<im_end>"
+IMAGE_PLACEHOLDER = "<image-placeholder>"
+# Added by Ferret
+DEFAULT_REGION_FEA_TOKEN = "<region_fea>"
+VOCAB_IMAGE_W = 1000
+VOCAB_IMAGE_H = 1000
+# GROUNDING PROMPTS
+GROUNDING_TEMPLATES = [
+	'\nProvide the bounding boxes of the mentioned objects.',
+ 	'\nInclude the coordinates for each mentioned object.',
+	'\nLocate the objects with their coordinates.',
+	'\nAnswer in [x1, y1, x2, y2] format.',
+	'\nMention the objects and their locations using the format [x1, y1, x2, y2].',
+	'\nDraw boxes around the mentioned objects.',
+	'\nUse boxes to show where each thing is.',
+	'\nTell me where the objects are with coordinates.',
+	'\nList where each object is with boxes.',
+	'\nShow me the regions with boxes.'
+]