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

MaziyarPanahi commited on Jun 20, 2024

Commit

e48d670

verified ·

1 Parent(s): 043a879

Upload folder using huggingface_hub (#4)

Browse files

- 0a3f8bb7206a61d5d7cbb0a7f70d8294dc8089860f77305e666afe6c8979d927 (367193b8751cc04613d0afd75b545ace3f88370b)
- 841c911b01ff5710b3fa4fcb5fa1bf278c6d1ddfc4f4a24350939ca6be69624d (7da2b498ba2a96c28648c6e9f63adb28846aa712)
- 860ea77808ac3586c119f7370613042c537cbe9bc23f0aee473d252d18d449ac (caa6d203b4129dc114af49edf3fcee7b7a4667c4)
- d93c9fdab9f72ef8130b34f20c2fb322790934f05a3ce831ac477ccad680afc8 (456d9e465e122024d7c91f00e88ad655a72a2497)
- f1d42c83950167ee5de72ba0414241b607a29b9442dcb0cbf30a08d467ab41b9 (c45c773e7b3bee5865de6a3d4b87191895828878)
- e1b44532b9b10b8b1da65970ada50555b333c28e0d8dd4a084fec536418c0f7c (f398d1b21f5cf1d37eccb271636e71e0a854e0b6)
- ca2d6e7a0265c18be980a54fe455f526fdc158c4754989c6cca66e42ebff7b9f (c855bdeb7815f57c0cbf7a6da525d4ffe4cb1718)
- dba4af19eeb2e0f2f5f589b77f70c1a9d8095d39b1ff3215c6c4dba53df2cb07 (e5ea1fdcd68e858a4e5c57a65c30614abe06ce08)
- d382aea5e132bc091499f29ec3d7edd63b125376596392a999d0581e7bc36cc6 (46c51936bd34c2f6a5030f69b61c383a253dd471)
- 1d480e2cb0b5a8483abf490c25019e070ff166bd7c831c9fd119772d207b1e72 (4d8fa9cda0b5c90e02951e3428806230318e0a41)
- f2f3ea04780216370f3d8772c795957de72d633fc75faad1cc39610f06d0a70e (6f3ef3ef2e41094ca3f56bba8d045b7f269f085f)
- 10c575f81b16bacc2f69864cb90f1044ccabe3698b41f61f7fcfbb67dd9953df (9e424774956c4c5a76e7e57de5bc2594619f593c)
- 7bcd3992c681bfd323fc82e3d780516d045f18593404b0a91aa6d34f3acbc267 (655db1bf75ce8557df01f05b29b74d845dd9fefc)
- e4da1f187a62799def57cc6ea2dccc1487128cfcf9cc5c6e5e07f6c2a9856ad1 (52c312a639965aee7d278c8eee554a96b5b1c7af)
- d27d0f41aa5897f83d687073b49aed02787e733cb403387b8de2062ef5cd0173 (cda54177113978e2b10039e4d53a90a9a1bc0485)
- 76d0e0a8a96da1d4c9a17b1c4752e85f677c89cc47a17c457b418d31785edf36 (d60305fbd322d7d102ffe7de446b591d7e055ff7)
- 4d79218cbda3abfd2556b35c513e6d4eca2bc665308785d6460ca0ef80793dc7 (e59822d7cef98da50939b8ca50af75fff56d7897)
- 65ad5606c738b352810dc4fa73a724c7d2bf47482ce2bb896e8ae18bf86595ee (1f2a614ccea7f51410d8cf07828ccd63127c81c6)

Files changed (4) hide show

.gitattributes +3 -0
firefunction-v2.fp16-00004-of-00006.gguf +3 -0
firefunction-v2.fp16-00005-of-00006.gguf +3 -0
firefunction-v2.fp16-00006-of-00006.gguf +3 -0

.gitattributes CHANGED Viewed

@@ -61,3 +61,6 @@ firefunction-v2.Q8_0-00006-of-00006.gguf filter=lfs diff=lfs merge=lfs -text
 firefunction-v2.fp16-00001-of-00006.gguf filter=lfs diff=lfs merge=lfs -text
 firefunction-v2.fp16-00002-of-00006.gguf filter=lfs diff=lfs merge=lfs -text
 firefunction-v2.fp16-00003-of-00006.gguf filter=lfs diff=lfs merge=lfs -text

 firefunction-v2.fp16-00001-of-00006.gguf filter=lfs diff=lfs merge=lfs -text
 firefunction-v2.fp16-00002-of-00006.gguf filter=lfs diff=lfs merge=lfs -text
 firefunction-v2.fp16-00003-of-00006.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.fp16-00004-of-00006.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.fp16-00005-of-00006.gguf filter=lfs diff=lfs merge=lfs -text
+firefunction-v2.fp16-00006-of-00006.gguf filter=lfs diff=lfs merge=lfs -text

firefunction-v2.fp16-00004-of-00006.gguf ADDED Viewed

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

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

firefunction-v2.fp16-00005-of-00006.gguf ADDED Viewed

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

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

firefunction-v2.fp16-00006-of-00006.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:27ab822ff03be38c054021277cf96d342440c2a4cca4e404f946bc8fb6ce2ae5
+size 17503458240