Upload README.md with huggingface_hub

README.md

@@ -1,4 +1,5 @@
 ---
+base_model: OpenBuddy/openbuddy-openllama-3b-v10-bf16
 language:
 - zh
 - en
@@ -8,41 +9,55 @@ language:
 - ko
 - it
 - ru
-license: apache-2.0
 library_name: transformers
+license: apache-2.0
+pipeline_tag: text-generation
 tags:
 - llama-cpp
 - gguf-my-repo
-pipeline_tag: text-generation
 inference: false
 ---
 
 # Fadikkop/openbuddy-openllama-3b-v10-bf16-Q4_K_M-GGUF
 This model was converted to GGUF format from [`OpenBuddy/openbuddy-openllama-3b-v10-bf16`](https://huggingface.co/OpenBuddy/openbuddy-openllama-3b-v10-bf16) 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/OpenBuddy/openbuddy-openllama-3b-v10-bf16) 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 Fadikkop/openbuddy-openllama-3b-v10-bf16-Q4_K_M-GGUF --model openbuddy-openllama-3b-v10-bf16.Q4_K_M.gguf -p "The meaning to life and the universe is"
+llama-cli --hf-repo Fadikkop/openbuddy-openllama-3b-v10-bf16-Q4_K_M-GGUF --hf-file openbuddy-openllama-3b-v10-bf16-q4_k_m.gguf -p "The meaning to life and the universe is"
 ```
 
-Server:
-
+### Server:
 ```bash
-llama-server --hf-repo Fadikkop/openbuddy-openllama-3b-v10-bf16-Q4_K_M-GGUF --model openbuddy-openllama-3b-v10-bf16.Q4_K_M.gguf -c 2048
+llama-server --hf-repo Fadikkop/openbuddy-openllama-3b-v10-bf16-Q4_K_M-GGUF --hf-file openbuddy-openllama-3b-v10-bf16-q4_k_m.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 Fadikkop/openbuddy-openllama-3b-v10-bf16-Q4_K_M-GGUF --hf-file openbuddy-openllama-3b-v10-bf16-q4_k_m.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 openbuddy-openllama-3b-v10-bf16.Q4_K_M.gguf -n 128
+./llama-server --hf-repo Fadikkop/openbuddy-openllama-3b-v10-bf16-Q4_K_M-GGUF --hf-file openbuddy-openllama-3b-v10-bf16-q4_k_m.gguf -c 2048
 ```