MoMonir commited on
Commit
d1ebb43
1 Parent(s): bb80dd3

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +24 -3
README.md CHANGED
@@ -179,9 +179,30 @@ extra_gated_description: The information you provide will be collected, stored,
179
  extra_gated_button_content: Submit
180
  ---
181
 
182
- # MoMonir/Meta-Llama-Guard-2-8B-Q5_K_M-GGUF
183
  This model was converted to GGUF format from [`meta-llama/Meta-Llama-Guard-2-8B`](https://huggingface.co/meta-llama/Meta-Llama-Guard-2-8B) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
184
  Refer to the [original model card](https://huggingface.co/meta-llama/Meta-Llama-Guard-2-8B) for more details on the model.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
185
  ## Use with llama.cpp
186
 
187
  Install llama.cpp through brew.
@@ -194,13 +215,13 @@ Invoke the llama.cpp server or the CLI.
194
  CLI:
195
 
196
  ```bash
197
- llama-cli --hf-repo MoMonir/Meta-Llama-Guard-2-8B-Q5_K_M-GGUF --model meta-llama-guard-2-8b.Q5_K_M.gguf -p "The meaning to life and the universe is"
198
  ```
199
 
200
  Server:
201
 
202
  ```bash
203
- llama-server --hf-repo MoMonir/Meta-Llama-Guard-2-8B-Q5_K_M-GGUF --model meta-llama-guard-2-8b.Q5_K_M.gguf -c 2048
204
  ```
205
 
206
  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.
 
179
  extra_gated_button_content: Submit
180
  ---
181
 
182
+ # MoMonir/Meta-Llama-Guard-2-8B-GGUF
183
  This model was converted to GGUF format from [`meta-llama/Meta-Llama-Guard-2-8B`](https://huggingface.co/meta-llama/Meta-Llama-Guard-2-8B) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
184
  Refer to the [original model card](https://huggingface.co/meta-llama/Meta-Llama-Guard-2-8B) for more details on the model.
185
+
186
+ <!-- README_GGUF.md-about-gguf start -->
187
+ ### About GGUF ([TheBloke](https://huggingface.co/TheBloke) Description)
188
+
189
+ 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.
190
+
191
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
192
+
193
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
194
+ * [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.
195
+ * [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.
196
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
197
+ * [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.
198
+ * [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.
199
+ * [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.
200
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
201
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
202
+ * [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.
203
+
204
+ <!-- README_GGUF.md-about-gguf end -->
205
+
206
  ## Use with llama.cpp
207
 
208
  Install llama.cpp through brew.
 
215
  CLI:
216
 
217
  ```bash
218
+ llama-cli --hf-repo MoMonir/Meta-Llama-Guard-2-8B-GGUF --model meta-llama-guard-2-8b.Q5_K_M.gguf -p "The meaning to life and the universe is"
219
  ```
220
 
221
  Server:
222
 
223
  ```bash
224
+ llama-server --hf-repo MoMonir/Meta-Llama-Guard-2-8B-GGUF --model meta-llama-guard-2-8b.Q5_K_M.gguf -c 2048
225
  ```
226
 
227
  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.