MoMonir commited on
Commit
739f1dc
1 Parent(s): 468a935

Update README.md

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