Instructions to use MaziyarPanahi/firefunction-v2-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use MaziyarPanahi/firefunction-v2-GGUF with Transformers:

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

pipe = pipeline("text-generation", model="MaziyarPanahi/firefunction-v2-GGUF")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("MaziyarPanahi/firefunction-v2-GGUF", dtype="auto")

llama-cpp-python

How to use MaziyarPanahi/firefunction-v2-GGUF with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="MaziyarPanahi/firefunction-v2-GGUF",
	filename="firefunction-v2.IQ1_M.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": "What is the capital of France?"
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps

llama.cpp

How to use MaziyarPanahi/firefunction-v2-GGUF with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

Use pre-built binary

# Download pre-built binary from:
# https://github.com/ggerganov/llama.cpp/releases
# Start a local OpenAI-compatible server with a web UI:
./llama-server -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

Build from source code

git clone https://github.com/ggerganov/llama.cpp.git
cd llama.cpp
cmake -B build
cmake --build build -j --target llama-server llama-cli
# Start a local OpenAI-compatible server with a web UI:
./build/bin/llama-server -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

Use Docker

docker model run hf.co/MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use MaziyarPanahi/firefunction-v2-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

SGLang

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

Ollama
How to use MaziyarPanahi/firefunction-v2-GGUF with Ollama:
```
ollama run hf.co/MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M
```

Unsloth Studio new

How to use MaziyarPanahi/firefunction-v2-GGUF with Unsloth Studio:

Install Unsloth Studio (macOS, Linux, WSL)

curl -fsSL https://unsloth.ai/install.sh | sh
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for MaziyarPanahi/firefunction-v2-GGUF to start chatting

Install Unsloth Studio (Windows)

irm https://unsloth.ai/install.ps1 | iex
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for MaziyarPanahi/firefunction-v2-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for MaziyarPanahi/firefunction-v2-GGUF to start chatting

Pi new

How to use MaziyarPanahi/firefunction-v2-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @mariozechner/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use MaziyarPanahi/firefunction-v2-GGUF with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

Configure Hermes

# Install Hermes:
curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash
hermes setup
# Point Hermes at the local server:
hermes config set model.provider custom
hermes config set model.base_url http://127.0.0.1:8080/v1
hermes config set model.default MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

Run Hermes

hermes

Docker Model Runner
How to use MaziyarPanahi/firefunction-v2-GGUF with Docker Model Runner:
```
docker model run hf.co/MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M
```

Lemonade

How to use MaziyarPanahi/firefunction-v2-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull MaziyarPanahi/firefunction-v2-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.firefunction-v2-GGUF-Q4_K_M

List all available models

lemonade list

Upload folder using huggingface_hub

by MaziyarPanahi - opened Jun 19, 2024

base: refs/heads/main

←

from: refs/pr/2

Discussion Files changed

+52

-0

@@ -33,3 +33,16 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text

 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.IQ1_M.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.IQ1_S.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.IQ2_XS.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.IQ3_XS.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.IQ4_XS.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.Q2_K.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.Q3_K_L.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.Q3_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.Q3_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.Q4_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text

+version https://git-lfs.github.com/spec/v1
+oid sha256:435f8864e2de1fbd3bbe3e7926745269ab9c9d3b52890944c415b8ea4cb51117
+size 16751198848

+version https://git-lfs.github.com/spec/v1
+oid sha256:c1cf5ff16909bdf80a812cbc17366b7950ec3ab262365f1cc057f2d1c0e51e93
+size 15343485568

+version https://git-lfs.github.com/spec/v1
+oid sha256:8e0f9e6031bd22e19a76ff95d88b4a1439879c57921cdf49451c20318d021c16
+size 21142110848

+version https://git-lfs.github.com/spec/v1
+oid sha256:11d88aab174d05ca99ce3912af3720a5c1dbbcf43ac1ebd15e5c9f2a551eab59
+size 29307732608

+version https://git-lfs.github.com/spec/v1
+oid sha256:8d1a3ebdb96da78dd01491ffba2fe75dd678b2435aca00e86ca98fb1a3261198
+size 37902664320

+version https://git-lfs.github.com/spec/v1
+oid sha256:156db2307fd2ded1ab9c34640871341532439a959854817fddff4e7028472145
+size 26375111296

+version https://git-lfs.github.com/spec/v1
+oid sha256:b8583f717b1cde54d3f31378ca870e6f807d8e6ee9adef4d803c32a7b3967099
+size 37140595328

+version https://git-lfs.github.com/spec/v1
+oid sha256:3fe264908b2475c5c3d40a9b47c0201caa6bf765e651a3ad86e9f94b57207ff4
+size 34267497088

+version https://git-lfs.github.com/spec/v1
+oid sha256:6afc27c7c3734593d89131df15cf09709d1623b84b646274f01237803f556706
+size 30912053888

+version https://git-lfs.github.com/spec/v1
+oid sha256:53c0d58fbb2d036d690c8d2df873a1a64117404fc57d877add38963f12a7d04c
+size 42520396416

	@@ -0,0 +1,3 @@

	@@ -0,0 +1,3 @@

	@@ -0,0 +1,3 @@

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:4b1dfb060a3fc81d2fe6149feb57dee2f46caea9e2b917c405dd4074ee5a4842
+size 40347222656

+version https://git-lfs.github.com/spec/v1
+oid sha256:ca0e9933fbdab3de7c1cf828c088e0140831d58bea84d6042e2ad2dd368a9b73
+size 49949819520

+version https://git-lfs.github.com/spec/v1
+oid sha256:d175cc848bb64fc2d6a0190f9d05092e7cb7c52b7c414d6508cd413b55317b21
+size 48657449600