Instructions to use azugarini/clue-instruct-llama-7b with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use azugarini/clue-instruct-llama-7b with Transformers:

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

pipe = pipeline("text-generation", model="azugarini/clue-instruct-llama-7b")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("azugarini/clue-instruct-llama-7b")
model = AutoModelForCausalLM.from_pretrained("azugarini/clue-instruct-llama-7b")
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

vLLM

How to use azugarini/clue-instruct-llama-7b with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/azugarini/clue-instruct-llama-7b

SGLang

How to use azugarini/clue-instruct-llama-7b 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 "azugarini/clue-instruct-llama-7b" \
    --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": "azugarini/clue-instruct-llama-7b",
		"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 "azugarini/clue-instruct-llama-7b" \
        --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": "azugarini/clue-instruct-llama-7b",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Docker Model Runner
How to use azugarini/clue-instruct-llama-7b with Docker Model Runner:
```
docker model run hf.co/azugarini/clue-instruct-llama-7b
```

Pre-print

More details about the model are available here

Citation

If you find it useful, please cite us:

@inproceedings{zugarini2024clue,
  title={Clue-Instruct: Text-Based Clue Generation for Educational Crossword Puzzles},
  author={Zugarini, Andrea and Zeinalipour, Kamyar and Kadali, Surya Sai and Maggini, Marco and Gori, Marco and Rigutini, Leonardo},
  booktitle={Proceedings of the 2024 Joint International Conference on Computational Linguistics, Language Resources and Evaluation (LREC-COLING 2024)},
  pages={3347--3356},
  year={2024}
}

Downloads last month: 6

Safetensors

Model size

7B params

Tensor type

BF16

Dataset used to train azugarini/clue-instruct-llama-7b

Collection including azugarini/clue-instruct-llama-7b

Clue-instruct

Collection

Clue-instruct dataset and different models fine-tuned on it. • 8 items • Updated Nov 8, 2024

Paper for azugarini/clue-instruct-llama-7b

Clue-Instruct: Text-Based Clue Generation for Educational Crossword Puzzles

Paper • 2404.06186 • Published Apr 9, 2024 • 3