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)

# pip install -U transformers accelerate
# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("transformers-community/contrastive-search")
model = AutoModelForCausalLM.from_pretrained("transformers-community/contrastive-search", device_map="auto")
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=256)
print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

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
```

Fix mask None-ness

by cyrilvallez HF Staff - opened Sep 15

base: refs/heads/main

←

from: refs/pr/5

Discussion Files changed

-1

Files changed (1) hide show

custom_generate/generate.py +2 -1

custom_generate/generate.py CHANGED Viewed

@@ -193,7 +193,8 @@ def _contrastive_search(
         if "decoder_attention_mask" in model_kwargs and model_kwargs["decoder_attention_mask"] is not None:
             cosine_matrix_mask = model_kwargs["decoder_attention_mask"]
     else:
-        cosine_matrix_mask = model_kwargs["attention_mask"]
     cosine_matrix_mask = cosine_matrix_mask.repeat_interleave(top_k, dim=0)
     this_peer_finished = False

         if "decoder_attention_mask" in model_kwargs and model_kwargs["decoder_attention_mask"] is not None:
             cosine_matrix_mask = model_kwargs["decoder_attention_mask"]
     else:
+        if model_kwargs["attention_mask"] is not None:
+            cosine_matrix_mask = model_kwargs["attention_mask"]
     cosine_matrix_mask = cosine_matrix_mask.repeat_interleave(top_k, dim=0)
     this_peer_finished = False