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

Libraries

How to use transformers-community/contrastive-search with Transformers:

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

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

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("transformers-community/contrastive-search")
model = AutoModelForCausalLM.from_pretrained("transformers-community/contrastive-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]:]))

Inference
Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use transformers-community/contrastive-search with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "transformers-community/contrastive-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/contrastive-search",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/transformers-community/contrastive-search

SGLang

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

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

allow Output subclasses in contrastive search

by jood-canva - opened Oct 22, 2025

base: refs/heads/main

←

from: refs/pr/4

Discussion Files changed

-3

jood-canva

Oct 22, 2025

•

edited Oct 22, 2025

Hi,

I am trying to use contrastive search on a custom multimodal model and I found out that it was overriding the model outputs to have the default type (like CausalLMOutputWithPast for instance). This can be an issue for models that rely on extra attributes in the output class. I think we could simply replace the attributes we want in Outputs rather than recreating the object from the default class. We achieve the same thing but it's a bit cleaner in my opinion. Happy to discuss if I'm missing something!

Also happy to add assertions to check that outputs inherit from the correct class if you want.

allow Output subclasses in contrastive searchca11c727

RaushanTurganbay

Transformers Community org Nov 10, 2025

Hi @jood-canva !

It is a known problem and there was another GH issue reporting it. Contrastive search is currently not maintained actively and we only fix outstanding bugs, if any. The diff looks reasonable to me, did you verify that it works with a few major VLM families?

It should be fine looking at code though I think I ma not sure it covers all possible cases for VLMs 🤔

Upload images, audio, and videos by dragging in the text input, pasting, or clicking here.

Tap or paste here to upload images

Ready to merge

This branch is ready to get merged automatically.

· Sign up or log in to comment