Instructions to use MaziyarPanahi/Kyro-n1-3B-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use MaziyarPanahi/Kyro-n1-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/Kyro-n1-3B-GGUF:Q5_K_M # Run inference directly in the terminal: llama cli -hf MaziyarPanahi/Kyro-n1-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/Kyro-n1-3B-GGUF:Q5_K_M # Run inference directly in the terminal: llama cli -hf MaziyarPanahi/Kyro-n1-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/Kyro-n1-3B-GGUF:Q5_K_M # Run inference directly in the terminal: ./llama-cli -hf MaziyarPanahi/Kyro-n1-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/Kyro-n1-3B-GGUF:Q5_K_M # Run inference directly in the terminal: ./build/bin/llama-cli -hf MaziyarPanahi/Kyro-n1-3B-GGUF:Q5_K_M
Use Docker
docker model run hf.co/MaziyarPanahi/Kyro-n1-3B-GGUF:Q5_K_M
- LM Studio
- Jan
- vLLM
How to use MaziyarPanahi/Kyro-n1-3B-GGUF with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "MaziyarPanahi/Kyro-n1-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/Kyro-n1-3B-GGUF", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/MaziyarPanahi/Kyro-n1-3B-GGUF:Q5_K_M
- Ollama
How to use MaziyarPanahi/Kyro-n1-3B-GGUF with Ollama:
ollama run hf.co/MaziyarPanahi/Kyro-n1-3B-GGUF:Q5_K_M
- Unsloth Desktop
- Docker Model Runner
How to use MaziyarPanahi/Kyro-n1-3B-GGUF with Docker Model Runner:
docker model run hf.co/MaziyarPanahi/Kyro-n1-3B-GGUF:Q5_K_M
- Lemonade
How to use MaziyarPanahi/Kyro-n1-3B-GGUF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull MaziyarPanahi/Kyro-n1-3B-GGUF:Q5_K_M
Run and chat with the model
lemonade run user.Kyro-n1-3B-GGUF-Q5_K_M
List all available models
lemonade list
- Atomic Chat
Upload folder using huggingface_hub (#1)
Browse files- b2a62292aae8e14c45c390eebb7596b2082e5db96b2b3793c44b479afa86fd98 (4d9782fe3f68672bfa0fecff75dc7cb74f535352)
- 9797ea9a5b79335b295982400824488f1e894af4e57bc1c7206fcbd8818cba21 (44b5447c80207ad7f6502f6a195d54305e86fd2a)
- 07e4fea1aefeec71f09941f2484d31741230bd2482b937fa7dfc972b2e72ef3a (902357f40262b29312f34c61450d9fc041777067)
- 80a032f1df601df9220f969193913fc8b839a9d3d56ff512cbb3087b24b8354c (3ba9395ae0bd60bcf0fa6e31421c23d02408314b)
- 2f9e528c97771b64ba692e0d3176fbab5ae68d211e48104b83aa821f86eecf5b (44ed2980b339a03a365c95a439bf28e062f28966)
- 20e09869493e4786d054c18727a4a2a9b1ed14eacce540c46eb406807e46714b (82c8b0809137139e21f9ea30330d04ff68ddc77d)
- .gitattributes +6 -0
- Kyro-n1-3B-GGUF_imatrix.dat +3 -0
- Kyro-n1-3B.Q5_K_M.gguf +3 -0
- Kyro-n1-3B.Q5_K_S.gguf +3 -0
- Kyro-n1-3B.Q6_K.gguf +3 -0
- Kyro-n1-3B.Q8_0.gguf +3 -0
- Kyro-n1-3B.fp16.gguf +3 -0
- README.md +45 -0
|
@@ -33,3 +33,9 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
|
| 33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
| 36 |
+
Kyro-n1-3B.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
|
| 37 |
+
Kyro-n1-3B.Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
|
| 38 |
+
Kyro-n1-3B.Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
|
| 39 |
+
Kyro-n1-3B.Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
|
| 40 |
+
Kyro-n1-3B.fp16.gguf filter=lfs diff=lfs merge=lfs -text
|
| 41 |
+
Kyro-n1-3B-GGUF_imatrix.dat filter=lfs diff=lfs merge=lfs -text
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:20850a84ada6933056b58f5e04b4f32438d2be51c4669a9546e2d588d794384d
|
| 3 |
+
size 3362966
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:084f9e59082e0e2589437c85f2d76537cdbe8ba43ed6f67ec83db7b18ea25104
|
| 3 |
+
size 2224813824
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:e5653db87db5720dbd97f601457cb4f0010360808ce87091e0c2415927daa281
|
| 3 |
+
size 2169665280
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:2933fc13b02e0a9fb90594ae54f7de3b811a9cc7109ba15d2e20966c109c3238
|
| 3 |
+
size 2538157824
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:086b728f07feca79c33251b790b0d6353c76c4b611b2327f37147e71878c7d92
|
| 3 |
+
size 3285475072
|
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:8b0a3c51fff58ac8afd0176a16c8763dd2be2657529426328386a5b53bd41c93
|
| 3 |
+
size 6178315840
|
|
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
base_model: open-neo/Kyro-n1-3B
|
| 3 |
+
inference: false
|
| 4 |
+
model_creator: open-neo
|
| 5 |
+
model_name: Kyro-n1-3B-GGUF
|
| 6 |
+
pipeline_tag: text-generation
|
| 7 |
+
quantized_by: MaziyarPanahi
|
| 8 |
+
tags:
|
| 9 |
+
- quantized
|
| 10 |
+
- 2-bit
|
| 11 |
+
- 3-bit
|
| 12 |
+
- 4-bit
|
| 13 |
+
- 5-bit
|
| 14 |
+
- 6-bit
|
| 15 |
+
- 8-bit
|
| 16 |
+
- GGUF
|
| 17 |
+
- text-generation
|
| 18 |
+
---
|
| 19 |
+
# [MaziyarPanahi/Kyro-n1-3B-GGUF](https://huggingface.co/MaziyarPanahi/Kyro-n1-3B-GGUF)
|
| 20 |
+
- Model creator: [open-neo](https://huggingface.co/open-neo)
|
| 21 |
+
- Original model: [open-neo/Kyro-n1-3B](https://huggingface.co/open-neo/Kyro-n1-3B)
|
| 22 |
+
|
| 23 |
+
## Description
|
| 24 |
+
[MaziyarPanahi/Kyro-n1-3B-GGUF](https://huggingface.co/MaziyarPanahi/Kyro-n1-3B-GGUF) contains GGUF format model files for [open-neo/Kyro-n1-3B](https://huggingface.co/open-neo/Kyro-n1-3B).
|
| 25 |
+
|
| 26 |
+
### About GGUF
|
| 27 |
+
|
| 28 |
+
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.
|
| 29 |
+
|
| 30 |
+
Here is an incomplete list of clients and libraries that are known to support GGUF:
|
| 31 |
+
|
| 32 |
+
* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
|
| 33 |
+
* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
|
| 34 |
+
* [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.
|
| 35 |
+
* [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.
|
| 36 |
+
* [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.
|
| 37 |
+
* [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
|
| 38 |
+
* [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.
|
| 39 |
+
* [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.
|
| 40 |
+
* [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
|
| 41 |
+
* [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.
|
| 42 |
+
|
| 43 |
+
## Special thanks
|
| 44 |
+
|
| 45 |
+
🙏 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.
|