Update README.md
Browse files
README.md
CHANGED
@@ -85,9 +85,31 @@ model-index:
|
|
85 |
name: pass@1
|
86 |
---
|
87 |
|
88 |
-
# MoMonir/granite-8b-code-instruct-
|
89 |
This model was converted to GGUF format from [`ibm-granite/granite-8b-code-instruct`](https://huggingface.co/ibm-granite/granite-8b-code-instruct) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
|
90 |
Refer to the [original model card](https://huggingface.co/ibm-granite/granite-8b-code-instruct) for more details on the model.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
91 |
## Use with llama.cpp
|
92 |
|
93 |
Install llama.cpp through brew.
|
@@ -100,13 +122,13 @@ Invoke the llama.cpp server or the CLI.
|
|
100 |
CLI:
|
101 |
|
102 |
```bash
|
103 |
-
llama-cli --hf-repo MoMonir/granite-8b-code-instruct-
|
104 |
```
|
105 |
|
106 |
Server:
|
107 |
|
108 |
```bash
|
109 |
-
llama-server --hf-repo MoMonir/granite-8b-code-instruct-
|
110 |
```
|
111 |
|
112 |
Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.
|
|
|
85 |
name: pass@1
|
86 |
---
|
87 |
|
88 |
+
# MoMonir/granite-8b-code-instruct-GGUF
|
89 |
This model was converted to GGUF format from [`ibm-granite/granite-8b-code-instruct`](https://huggingface.co/ibm-granite/granite-8b-code-instruct) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
|
90 |
Refer to the [original model card](https://huggingface.co/ibm-granite/granite-8b-code-instruct) for more details on the model.
|
91 |
+
|
92 |
+
|
93 |
+
<!-- README_GGUF.md-about-gguf start -->
|
94 |
+
### About GGUF ([TheBloke](https://huggingface.co/TheBloke) Description)
|
95 |
+
|
96 |
+
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.
|
97 |
+
|
98 |
+
Here is an incomplete list of clients and libraries that are known to support GGUF:
|
99 |
+
|
100 |
+
* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
|
101 |
+
* [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.
|
102 |
+
* [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.
|
103 |
+
* [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
|
104 |
+
* [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.
|
105 |
+
* [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.
|
106 |
+
* [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.
|
107 |
+
* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
|
108 |
+
* [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
|
109 |
+
* [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.
|
110 |
+
|
111 |
+
<!-- README_GGUF.md-about-gguf end -->
|
112 |
+
|
113 |
## Use with llama.cpp
|
114 |
|
115 |
Install llama.cpp through brew.
|
|
|
122 |
CLI:
|
123 |
|
124 |
```bash
|
125 |
+
llama-cli --hf-repo MoMonir/granite-8b-code-instruct-GGUF --model granite-8b-code-instruct.Q4_K_M.gguf -p "The meaning to life and the universe is"
|
126 |
```
|
127 |
|
128 |
Server:
|
129 |
|
130 |
```bash
|
131 |
+
llama-server --hf-repo MoMonir/granite-8b-code-instruct-GGUF --model granite-8b-code-instruct.Q4_K_M.gguf -c 2048
|
132 |
```
|
133 |
|
134 |
Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.
|