Instructions to use PKU-Alignment/Beaver-Vision-11B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use PKU-Alignment/Beaver-Vision-11B with Transformers:

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

pipe = pipeline("image-text-to-text", model="PKU-Alignment/Beaver-Vision-11B", device_map="auto")
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 AutoProcessor, AutoModelForMultimodalLM

processor = AutoProcessor.from_pretrained("PKU-Alignment/Beaver-Vision-11B")
model = AutoModelForMultimodalLM.from_pretrained("PKU-Alignment/Beaver-Vision-11B", device_map="auto")
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?"}
        ]
    },
]
inputs = processor.apply_chat_template(
	messages,
	add_generation_prompt=True,
	tokenize=True,
	return_dict=True,
	return_tensors="pt",
).to(model.device)

outputs = model.generate(**inputs, max_new_tokens=40)
print(processor.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use PKU-Alignment/Beaver-Vision-11B with vLLM:

Install from pip and serve model

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

SGLang

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

Gaie commited on Nov 8, 2024

Commit

41edc44

verified ·

1 Parent(s): 72671d8

Update README.md

Browse files

Files changed (1) hide show

README.md +1 -1

README.md CHANGED Viewed

@@ -124,7 +124,7 @@ widget:
 Beaver-Vision-11B is an <u>Image-Text-to-Text</u> chat assistant trained based on the [LLaMA-3.2-11B-Vision](https://huggingface.co/meta-llama/Llama-3.2-11B-Vision) (**pretrained version**)  using the [Align-Anything-Instruct](https://huggingface.co/datasets/PKU-Alignment/Align-Anything) dataset and [Align-Anything](https://github.com/PKU-Alignment/align-anything) framework.
 Beaver-Vision-11B aims to enhance the instruction-following abilities of MLLMs (Multi-modal Large Language Models).
-Compared with [LLaMA-3.2-11B-Vision-Instruct](https://huggingface.co/meta-llama/Llama-3.2-11B-Vision-Instruct), Beaver-Vision-11B uses [Align-Anything-Instruct](https://huggingface.co/datasets/PKU-Alignment/Align-Anything) dataset and post-training alignment method, achieving better performance. More importantly, Beaver-Vision-7B has open-sourced all of its training data, code, and evaluation scripts, providing greater convenience for the community and researchers.
 - **Developed by:** the [PKU-Alignment](https://github.com/PKU-Alignment) Team.
 - **Model Type:** An auto-regressive multi-modal (Image-Text-to-Text) language model based on the transformer architecture.

 Beaver-Vision-11B is an <u>Image-Text-to-Text</u> chat assistant trained based on the [LLaMA-3.2-11B-Vision](https://huggingface.co/meta-llama/Llama-3.2-11B-Vision) (**pretrained version**)  using the [Align-Anything-Instruct](https://huggingface.co/datasets/PKU-Alignment/Align-Anything) dataset and [Align-Anything](https://github.com/PKU-Alignment/align-anything) framework.
 Beaver-Vision-11B aims to enhance the instruction-following abilities of MLLMs (Multi-modal Large Language Models).
+Compared with [LLaMA-3.2-11B-Vision-Instruct](https://huggingface.co/meta-llama/Llama-3.2-11B-Vision-Instruct), Beaver-Vision-11B uses [Align-Anything-Instruct](https://huggingface.co/datasets/PKU-Alignment/Align-Anything) dataset and post-training alignment method, achieving better performance. More importantly, Beaver-Vision-11B has open-sourced all of its training data, code, and evaluation scripts, providing greater convenience for the community and researchers.
 - **Developed by:** the [PKU-Alignment](https://github.com/PKU-Alignment) Team.
 - **Model Type:** An auto-regressive multi-modal (Image-Text-to-Text) language model based on the transformer architecture.