Instructions to use transformers-community/constrained-beam-search with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use transformers-community/constrained-beam-search with Transformers:

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

pipe = pipeline("text-generation", model="transformers-community/constrained-beam-search")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("transformers-community/constrained-beam-search")
model = AutoModelForCausalLM.from_pretrained("transformers-community/constrained-beam-search")
messages = [
    {"role": "user", "content": "Who are you?"},
]
inputs = tokenizer.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(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use transformers-community/constrained-beam-search with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "transformers-community/constrained-beam-search"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "transformers-community/constrained-beam-search",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/transformers-community/constrained-beam-search

SGLang

How to use transformers-community/constrained-beam-search 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 "transformers-community/constrained-beam-search" \
    --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": "transformers-community/constrained-beam-search",
		"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 "transformers-community/constrained-beam-search" \
        --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": "transformers-community/constrained-beam-search",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Docker Model Runner
How to use transformers-community/constrained-beam-search with Docker Model Runner:
```
docker model run hf.co/transformers-community/constrained-beam-search
```

constrained-beam-search

Commit History

fix(generation): support v5 cached constrained beam decoding

b9878b0

lavrenko commited on 11 days ago

Fix typo

be8f33a
verified

cyrilvallez HF Staff commited on Mar 18

Update for new version!

e9235ab
verified

cyrilvallez HF Staff commited on Mar 18

Fix to avoid error with synced_gpus (#1)

57fb327
verified

RaushanTurganbay HF Staff