Instructions to use MaziyarPanahi/calme-2.2-phi3-4b with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use MaziyarPanahi/calme-2.2-phi3-4b with Transformers:

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

pipe = pipeline("text-generation", model="MaziyarPanahi/calme-2.2-phi3-4b", trust_remote_code=True)
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("MaziyarPanahi/calme-2.2-phi3-4b", trust_remote_code=True)
model = AutoModelForCausalLM.from_pretrained("MaziyarPanahi/calme-2.2-phi3-4b", trust_remote_code=True, 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 MaziyarPanahi/calme-2.2-phi3-4b with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/MaziyarPanahi/calme-2.2-phi3-4b

SGLang

How to use MaziyarPanahi/calme-2.2-phi3-4b 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 "MaziyarPanahi/calme-2.2-phi3-4b" \
    --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": "MaziyarPanahi/calme-2.2-phi3-4b",
		"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 "MaziyarPanahi/calme-2.2-phi3-4b" \
        --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": "MaziyarPanahi/calme-2.2-phi3-4b",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Docker Model Runner
How to use MaziyarPanahi/calme-2.2-phi3-4b with Docker Model Runner:
```
docker model run hf.co/MaziyarPanahi/calme-2.2-phi3-4b
```

MaziyarPanahi commited on Jul 20, 2024

Commit

3aebcac

verified ·

1 Parent(s): b709d2b

Update README.md (#9)

Browse files

- Update README.md (ed3146df3261c0ce1f882140c9e19eea72778c29)

Files changed (1) hide show

README.md +18 -18

README.md CHANGED Viewed

@@ -20,7 +20,7 @@ inference: false
 model_creator: MaziyarPanahi
 quantized_by: MaziyarPanahi
 model-index:
-- name: Phi-3-mini-4k-instruct-v0.2
   results:
   - task:
       type: text-generation
@@ -37,7 +37,7 @@ model-index:
       value: 62.8
       name: normalized accuracy
     source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -53,7 +53,7 @@ model-index:
       value: 80.76
       name: normalized accuracy
     source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -70,7 +70,7 @@ model-index:
       value: 69.1
       name: accuracy
     source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -86,7 +86,7 @@ model-index:
     - type: mc2
       value: 59.97
     source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -103,7 +103,7 @@ model-index:
       value: 72.45
       name: accuracy
     source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -120,7 +120,7 @@ model-index:
       value: 73.62
       name: accuracy
     source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -135,7 +135,7 @@ model-index:
       value: 50.69
       name: strict accuracy
     source:
-      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -150,7 +150,7 @@ model-index:
       value: 37.73
       name: normalized accuracy
     source:
-      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -165,7 +165,7 @@ model-index:
       value: 2.34
       name: exact match
     source:
-      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -180,7 +180,7 @@ model-index:
       value: 9.51
       name: acc_norm
     source:
-      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -195,7 +195,7 @@ model-index:
       value: 7.7
       name: acc_norm
     source:
-      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
   - task:
       type: text-generation
@@ -212,23 +212,23 @@ model-index:
       value: 31.27
       name: accuracy
     source:
-      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
       name: Open LLM Leaderboard
 ---
 <img src="./phi-3-instruct.webp" alt="Phi-3 Logo" width="500" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
-# MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2
 This model is a fine-tune (DPO) of `microsoft/Phi-3-mini-4k-instruct` model.
 # ⚡ Quantized GGUF
-All GGUF models are available here: [MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2-GGUF](https://huggingface.co/MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2-GGUF)
 # 🏆 [Open LLM Leaderboard Evaluation Results](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard)
-Detailed results can be found [here](https://huggingface.co/datasets/open-llm-leaderboard/details_MaziyarPanahi__Phi-3-mini-4k-instruct-v0.2)
 |      Metric       |Value|
 |-------------------|----:|
@@ -271,7 +271,7 @@ This model uses `ChatML` prompt template:
 # How to use
-You can use this model by using `MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2` as the model name in Hugging Face's
 transformers library.
 ```python
@@ -279,7 +279,7 @@ from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
 from transformers import pipeline
 import torch
-model_id = "MaziyarPanahi/Phi-3-mini-4k-instruct-v0.2"
 model = AutoModelForCausalLM.from_pretrained(
     model_id,

 model_creator: MaziyarPanahi
 quantized_by: MaziyarPanahi
 model-index:
+- name: calme-2.2-phi3-4b
   results:
   - task:
       type: text-generation
       value: 62.8
       name: normalized accuracy
     source:
+      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 80.76
       name: normalized accuracy
     source:
+      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 69.1
       name: accuracy
     source:
+      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
     - type: mc2
       value: 59.97
     source:
+      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 72.45
       name: accuracy
     source:
+      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 73.62
       name: accuracy
     source:
+      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 50.69
       name: strict accuracy
     source:
+      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 37.73
       name: normalized accuracy
     source:
+      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 2.34
       name: exact match
     source:
+      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 9.51
       name: acc_norm
     source:
+      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 7.7
       name: acc_norm
     source:
+      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
   - task:
       type: text-generation
       value: 31.27
       name: accuracy
     source:
+      url: https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard?query=MaziyarPanahi/calme-2.2-phi3-4b
       name: Open LLM Leaderboard
 ---
 <img src="./phi-3-instruct.webp" alt="Phi-3 Logo" width="500" style="margin-left:'auto' margin-right:'auto' display:'block'"/>
+# MaziyarPanahi/calme-2.2-phi3-4b
 This model is a fine-tune (DPO) of `microsoft/Phi-3-mini-4k-instruct` model.
 # ⚡ Quantized GGUF
+All GGUF models are available here: [MaziyarPanahi/calme-2.2-phi3-4b-GGUF](https://huggingface.co/MaziyarPanahi/calme-2.2-phi3-4b-GGUF)
 # 🏆 [Open LLM Leaderboard Evaluation Results](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard)
+Detailed results can be found [here](https://huggingface.co/datasets/open-llm-leaderboard/details_MaziyarPanahi__calme-2.2-phi3-4b)
 |      Metric       |Value|
 |-------------------|----:|
 # How to use
+You can use this model by using `MaziyarPanahi/calme-2.2-phi3-4b` as the model name in Hugging Face's
 transformers library.
 ```python
 from transformers import pipeline
 import torch
+model_id = "MaziyarPanahi/calme-2.2-phi3-4b"
 model = AutoModelForCausalLM.from_pretrained(
     model_id,