Upload README.md with huggingface_hub

README.md

@@ -1,42 +1,56 @@
 ---
-license: apache-2.0
+base_model: openchat/openchat-3.5-0106
 library_name: transformers
+license: apache-2.0
+pipeline_tag: text-generation
 tags:
 - openchat
 - mistral
 - C-RLFT
 - llama-cpp
 - gguf-my-repo
-base_model: mistralai/Mistral-7B-v0.1
-pipeline_tag: text-generation
 ---
 
 # newsletter/openchat-3.5-0106-Q6_K-GGUF
 This model was converted to GGUF format from [`openchat/openchat-3.5-0106`](https://huggingface.co/openchat/openchat-3.5-0106) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
 Refer to the [original model card](https://huggingface.co/openchat/openchat-3.5-0106) for more details on the model.
-## Use with llama.cpp
 
-Install llama.cpp through brew.
+## Use with llama.cpp
+Install llama.cpp through brew (works on Mac and Linux)
 
 ```bash
-brew install ggerganov/ggerganov/llama.cpp
+brew install llama.cpp
+
 ```
 Invoke the llama.cpp server or the CLI.
 
-CLI:
-
+### CLI:
 ```bash
-llama-cli --hf-repo newsletter/openchat-3.5-0106-Q6_K-GGUF --model openchat-3.5-0106.Q6_K.gguf -p "The meaning to life and the universe is"
+llama-cli --hf-repo newsletter/openchat-3.5-0106-Q6_K-GGUF --hf-file openchat-3.5-0106-q6_k.gguf -p "The meaning to life and the universe is"
 ```
 
-Server:
-
+### Server:
 ```bash
-llama-server --hf-repo newsletter/openchat-3.5-0106-Q6_K-GGUF --model openchat-3.5-0106.Q6_K.gguf -c 2048
+llama-server --hf-repo newsletter/openchat-3.5-0106-Q6_K-GGUF --hf-file openchat-3.5-0106-q6_k.gguf -c 2048
 ```
 
 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.
 
+Step 1: Clone llama.cpp from GitHub.
+```
+git clone https://github.com/ggerganov/llama.cpp
+```
+
+Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
+```
+cd llama.cpp && LLAMA_CURL=1 make
+```
+
+Step 3: Run inference through the main binary.
+```
+./llama-cli --hf-repo newsletter/openchat-3.5-0106-Q6_K-GGUF --hf-file openchat-3.5-0106-q6_k.gguf -p "The meaning to life and the universe is"
+```
+or 
 ```
-git clone https://github.com/ggerganov/llama.cpp &&             cd llama.cpp &&             make &&             ./main -m openchat-3.5-0106.Q6_K.gguf -n 128
+./llama-server --hf-repo newsletter/openchat-3.5-0106-Q6_K-GGUF --hf-file openchat-3.5-0106-q6_k.gguf -c 2048
 ```