Instructions to use MaziyarPanahi/Arch-Function-3B-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Notebooks
Google Colab
Kaggle
Local Apps Settings

How to use MaziyarPanahi/Arch-Function-3B-GGUF with llama.cpp:

Install (macOS, Linux)

curl -LsSf https://llama.app/install.sh | sh
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M
# Run inference directly in the terminal:
llama cli -hf MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M
# Run inference directly in the terminal:
llama cli -hf MaziyarPanahi/Arch-Function-3B-GGUF:Q5_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/Arch-Function-3B-GGUF:Q5_K_M
# Run inference directly in the terminal:
./llama-cli -hf MaziyarPanahi/Arch-Function-3B-GGUF:Q5_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/Arch-Function-3B-GGUF:Q5_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M

Use Docker

docker model run hf.co/MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M

LM Studio
Jan

vLLM

How to use MaziyarPanahi/Arch-Function-3B-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M

Ollama
How to use MaziyarPanahi/Arch-Function-3B-GGUF with Ollama:
```
ollama run hf.co/MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M
```
Unsloth Desktop

How to use MaziyarPanahi/Arch-Function-3B-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M

Configure the model in Pi

# Install Pi:
npm install -g @earendil-works/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/Arch-Function-3B-GGUF:Q5_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use MaziyarPanahi/Arch-Function-3B-GGUF with Docker Model Runner:
```
docker model run hf.co/MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M
```

Lemonade

How to use MaziyarPanahi/Arch-Function-3B-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M

Run and chat with the model

lemonade run user.Arch-Function-3B-GGUF-Q5_K_M

List all available models

lemonade list

Hermes Agent

How to use MaziyarPanahi/Arch-Function-3B-GGUF with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf MaziyarPanahi/Arch-Function-3B-GGUF:Q5_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/Arch-Function-3B-GGUF:Q5_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use MaziyarPanahi/Arch-Function-3B-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M

Configure OpenClaw

# Install OpenClaw:
npm install -g openclaw@latest
# Register the local server and set it as the default model:
openclaw onboard --non-interactive --mode local \
  --auth-choice custom-api-key \
  --custom-base-url http://127.0.0.1:8080/v1 \
  --custom-model-id "MaziyarPanahi/Arch-Function-3B-GGUF:Q5_K_M" \
  --custom-provider-id llama-cpp \
  --custom-compatibility openai \
  --custom-text-input \
  --accept-risk \
  --skip-health

Run OpenClaw

openclaw agent --local --agent main --message "Hello from Hugging Face"

Upload folder using huggingface_hub

by MaziyarPanahi - opened Oct 30, 2024

base: refs/heads/main

←

from: refs/pr/1

Discussion Files changed

+70

-0

Files changed (8) hide show

.gitattributes +6 -0
Arch-Function-3B-GGUF_imatrix.dat +3 -0
Arch-Function-3B.Q5_K_M.gguf +3 -0
Arch-Function-3B.Q5_K_S.gguf +3 -0
Arch-Function-3B.Q6_K.gguf +3 -0
Arch-Function-3B.Q8_0.gguf +3 -0
Arch-Function-3B.fp16.gguf +3 -0
README.md +46 -0

.gitattributes CHANGED Viewed

@@ -33,3 +33,9 @@ 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
+Arch-Function-3B.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+Arch-Function-3B.Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+Arch-Function-3B.Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
+Arch-Function-3B.Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+Arch-Function-3B.fp16.gguf filter=lfs diff=lfs merge=lfs -text
+Arch-Function-3B-GGUF_imatrix.dat filter=lfs diff=lfs merge=lfs -text

Arch-Function-3B-GGUF_imatrix.dat ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:5a9511e3202ee13ab4a20251c4ab5e3d4005b9877ed3ffa5eb101e27a21407dc
+size 3362966

Arch-Function-3B.Q5_K_M.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:5909db03ac758e815ece7c3387f56383d131ada674914abdc0bd42a72423191b
+size 2224815264

Arch-Function-3B.Q5_K_S.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:586b1d45af7ce8b2573d68c8201dd2f2e0d92b3c528e857564ceb767d505c00e
+size 2169666720

Arch-Function-3B.Q6_K.gguf ADDED Viewed

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

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

Arch-Function-3B.Q8_0.gguf ADDED Viewed

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

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

Arch-Function-3B.fp16.gguf ADDED Viewed

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

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

README.md ADDED Viewed

	@@ -0,0 +1,46 @@

+---
+tags:
+- quantized
+- 2-bit
+- 3-bit
+- 4-bit
+- 5-bit
+- 6-bit
+- 8-bit
+- GGUF
+- text-generation
+- text-generation
+model_name: Arch-Function-3B-GGUF
+base_model: katanemo/Arch-Function-3B
+inference: false
+model_creator: katanemo
+pipeline_tag: text-generation
+quantized_by: MaziyarPanahi
+---
+# [MaziyarPanahi/Arch-Function-3B-GGUF](https://huggingface.co/MaziyarPanahi/Arch-Function-3B-GGUF)
+- Model creator: [katanemo](https://huggingface.co/katanemo)
+- Original model: [katanemo/Arch-Function-3B](https://huggingface.co/katanemo/Arch-Function-3B)
+## Description
+[MaziyarPanahi/Arch-Function-3B-GGUF](https://huggingface.co/MaziyarPanahi/Arch-Function-3B-GGUF) contains GGUF format model files for [katanemo/Arch-Function-3B](https://huggingface.co/katanemo/Arch-Function-3B).
+### About GGUF
+GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
+Here is an incomplete list of clients and libraries that are known to support GGUF:
+* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
+* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
+* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
+* [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
+* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
+* [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
+* [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
+* [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
+* [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
+* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
+## Special thanks
+🙏 Special thanks to [Georgi Gerganov](https://github.com/ggerganov) and the whole team working on [llama.cpp](https://github.com/ggerganov/llama.cpp/) for making all of this possible.