MoMonir commited on
Commit
014808e
·
verified ·
1 Parent(s): b0504ff

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +24 -3
README.md CHANGED
@@ -10,9 +10,30 @@ datasets:
10
  pipeline_tag: text-generation
11
  ---
12
 
13
- # MoMonir/Coxcomb-Q5_K_M-GGUF
14
  This model was converted to GGUF format from [`N8Programs/Coxcomb`](https://huggingface.co/N8Programs/Coxcomb) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
15
  Refer to the [original model card](https://huggingface.co/N8Programs/Coxcomb) for more details on the model.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
  ## Use with llama.cpp
17
 
18
  Install llama.cpp through brew.
@@ -25,13 +46,13 @@ Invoke the llama.cpp server or the CLI.
25
  CLI:
26
 
27
  ```bash
28
- llama-cli --hf-repo MoMonir/Coxcomb-Q5_K_M-GGUF --model coxcomb.Q5_K_M.gguf -p "The meaning to life and the universe is"
29
  ```
30
 
31
  Server:
32
 
33
  ```bash
34
- llama-server --hf-repo MoMonir/Coxcomb-Q5_K_M-GGUF --model coxcomb.Q5_K_M.gguf -c 2048
35
  ```
36
 
37
  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.
 
10
  pipeline_tag: text-generation
11
  ---
12
 
13
+ # MoMonir/Coxcomb-GGUF
14
  This model was converted to GGUF format from [`N8Programs/Coxcomb`](https://huggingface.co/N8Programs/Coxcomb) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
15
  Refer to the [original model card](https://huggingface.co/N8Programs/Coxcomb) for more details on the model.
16
+
17
+ <!-- README_GGUF.md-about-gguf start -->
18
+ ### About GGUF ([TheBloke](https://huggingface.co/TheBloke) Description)
19
+
20
+ 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.
21
+
22
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
23
+
24
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
25
+ * [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.
26
+ * [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.
27
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
28
+ * [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.
29
+ * [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.
30
+ * [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.
31
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
32
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
33
+ * [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.
34
+
35
+ <!-- README_GGUF.md-about-gguf end -->
36
+
37
  ## Use with llama.cpp
38
 
39
  Install llama.cpp through brew.
 
46
  CLI:
47
 
48
  ```bash
49
+ llama-cli --hf-repo MoMonir/Coxcomb-GGUF --model coxcomb.Q5_K_M.gguf -p "The meaning to life and the universe is"
50
  ```
51
 
52
  Server:
53
 
54
  ```bash
55
+ llama-server --hf-repo MoMonir/Coxcomb-GGUF --model coxcomb.Q5_K_M.gguf -c 2048
56
  ```
57
 
58
  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.