feat: add pipeline tag, library name, and sample usage (#1)

- Add pipeline tag, library name, and sample usage (f8c0df49f8d80adf4eadd7b15e824b98dfbeef91)


Co-authored-by: Niels Rogge <[email protected]>

README.md

@@ -1,7 +1,9 @@
 ---
-license: apache-2.0
 base_model:
 - deepseek-ai/DeepSeek-R1-Distill-Qwen-7B
+license: apache-2.0
+pipeline_tag: text-generation
+library_name: transformers
 ---
 
 # Spiral-DeepSeek-R1-Distill-Qwen-7B
@@ -18,6 +20,47 @@ This model is trained with self-play on multi-games (TicTacToe, Kuhn Poker, Simp
 
 <img src="https://raw.githubusercontent.com/spiral-rl/spiral/refs/heads/main/assets/framework.png" width=100%/>
 
+## Usage
+
+This model can be easily loaded and used with the `transformers` library.
+
+```python
+from transformers import pipeline, AutoTokenizer, AutoModelForCausalLM
+import torch
+
+model_id = "spiral-rl/Spiral-DeepSeek-R1-Distill-Qwen-7B"
+
+# Load model and tokenizer
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    torch_dtype=torch.bfloat16, # or torch.float16 for GPUs that don't support bfloat16
+    device_map="auto"
+)
+
+# Create a text generation pipeline
+pipe = pipeline(
+    "text-generation",
+    model=model,
+    tokenizer=tokenizer,
+    max_new_tokens=50,
+    do_sample=True,
+    temperature=0.7,
+    top_k=50,
+    top_p=0.95
+)
+
+# Define a chat message
+messages = [
+    {"role": "user", "content": "What is the capital of France?"}
+]
+
+# Generate text
+output = pipe(messages)
+print(output[0]['generated_text'])
+```
+
+For more advanced usage, including training and evaluation with the SPIRAL framework, please refer to the [GitHub repository](https://github.com/spiral-rl/spiral).
 
 ## Citation