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

Libraries

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

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="MaziyarPanahi/ByteCraft-GGUF",
	filename="ByteCraft.Q5_K_M.gguf",
)

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

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use MaziyarPanahi/ByteCraft-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/ByteCraft-GGUF:Q5_K_M
# Run inference directly in the terminal:
llama-cli -hf MaziyarPanahi/ByteCraft-GGUF:Q5_K_M

Install from WinGet (Windows)

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

Use Docker

docker model run hf.co/MaziyarPanahi/ByteCraft-GGUF:Q5_K_M

LM Studio
Jan

vLLM

How to use MaziyarPanahi/ByteCraft-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/MaziyarPanahi/ByteCraft-GGUF:Q5_K_M

Ollama
How to use MaziyarPanahi/ByteCraft-GGUF with Ollama:
```
ollama run hf.co/MaziyarPanahi/ByteCraft-GGUF:Q5_K_M
```

Unsloth Studio

How to use MaziyarPanahi/ByteCraft-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/ByteCraft-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/ByteCraft-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/ByteCraft-GGUF to start chatting

How to use MaziyarPanahi/ByteCraft-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/ByteCraft-GGUF:Q5_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/ByteCraft-GGUF:Q5_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use MaziyarPanahi/ByteCraft-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/ByteCraft-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/ByteCraft-GGUF:Q5_K_M

Run Hermes

hermes

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

Lemonade

How to use MaziyarPanahi/ByteCraft-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull MaziyarPanahi/ByteCraft-GGUF:Q5_K_M

Run and chat with the model

lemonade run user.ByteCraft-GGUF-Q5_K_M

List all available models

lemonade list

MaziyarPanahi commited on Mar 20, 2025

Commit

2bd7bbd

verified ·

1 Parent(s): 176b59d

Upload folder using huggingface_hub (#1)

Browse files

- 04357a66b5e46c94134f710446b61b63bef823d6a4c2f85153d9640c875b8595 (689b676651458d3228aeab45f933bfc671174df0)
- a610f78902909b5e8d18e001edf69618ffe7e5b699cb05ea530fca9f574ad17a (40211efc6a4a5b909baacb56fd91328baa0939e7)
- e90e62195cd47486bad6b4a19ebf930d53d4d5607e082781810f5a673dd6c0ac (9df6abbd3ffa825f90561df186070e16fd2dc299)
- e844f3b04c67d4c4bdce584038f83300709fb1628753521a71d6ca11c7a634fa (654dbe039b19d907a9e41ed98e30e6afc5bf3995)
- a6d35eb0bda41d2025de6a02920bc663243953609596a5719ea2ee0f60c5599f (c3bc6e06852a1e6e9a6b9b594c91113068032fbd)
- cedfbb8e1ac0f000f3ebf33d2261eac66d5aae6743a609c9a70e7a9742d0ef6a (486323d79534dcb39df8bae9c0f7bd0a5fe8ea99)

Files changed (7) hide show

.gitattributes +5 -0
ByteCraft.Q5_K_M.gguf +3 -0
ByteCraft.Q5_K_S.gguf +3 -0
ByteCraft.Q6_K.gguf +3 -0
ByteCraft.Q8_0.gguf +3 -0
ByteCraft.fp16.gguf +3 -0
README.md +45 -0

.gitattributes CHANGED Viewed

@@ -33,3 +33,8 @@ 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
+ByteCraft.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+ByteCraft.Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+ByteCraft.Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
+ByteCraft.Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+ByteCraft.fp16.gguf filter=lfs diff=lfs merge=lfs -text

ByteCraft.Q5_K_M.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:94942e851d3d792ece2f5d025079c76a5d932022bdf7662ecdad421e6a7a7a18
+size 6030814464

ByteCraft.Q5_K_S.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:9dd7f717eed1cda8c8cd9188dabb2082928c82e0f1d38766df7f16bcbe28c6c8
+size 5901159680

ByteCraft.Q6_K.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:4034b8f9fbd7490d5df95a7f7569b86f7478f5b711f3095cdf14f4d65a0db21e
+size 6891597632

ByteCraft.Q8_0.gguf ADDED Viewed

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

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

ByteCraft.fp16.gguf ADDED Viewed

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

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

README.md ADDED Viewed

	@@ -0,0 +1,45 @@

+---
+base_model: SamsungSAILMontreal/ByteCraft
+inference: false
+model_creator: SamsungSAILMontreal
+model_name: ByteCraft-GGUF
+pipeline_tag: text-generation
+quantized_by: MaziyarPanahi
+tags:
+- quantized
+- 2-bit
+- 3-bit
+- 4-bit
+- 5-bit
+- 6-bit
+- 8-bit
+- GGUF
+- text-generation
+---
+# [MaziyarPanahi/ByteCraft-GGUF](https://huggingface.co/MaziyarPanahi/ByteCraft-GGUF)
+- Model creator: [SamsungSAILMontreal](https://huggingface.co/SamsungSAILMontreal)
+- Original model: [SamsungSAILMontreal/ByteCraft](https://huggingface.co/SamsungSAILMontreal/ByteCraft)
+## Description
+[MaziyarPanahi/ByteCraft-GGUF](https://huggingface.co/MaziyarPanahi/ByteCraft-GGUF) contains GGUF format model files for [SamsungSAILMontreal/ByteCraft](https://huggingface.co/SamsungSAILMontreal/ByteCraft).
+### 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.