Upload README.md with huggingface_hub

README.md

@@ -1,43 +1,58 @@
 ---
-license: gemma
 library_name: transformers
-tags:
-- llama-cpp
-- gguf-my-repo
+license: gemma
 license_link: https://ai.google.dev/gemma/terms
 extra_gated_heading: Access CodeGemma on Hugging Face
 extra_gated_prompt: To access CodeGemma on Hugging Face, you’re required to review
   and agree to Google’s usage license. To do this, please ensure you’re logged-in
   to Hugging Face and click below. Requests are processed immediately.
 extra_gated_button_content: Acknowledge license
+base_model: google/codegemma-2b
+tags:
+- llama-cpp
+- gguf-my-repo
 ---
 
 # AIronMind/codegemma-2b-Q4_K_M-GGUF
 This model was converted to GGUF format from [`google/codegemma-2b`](https://huggingface.co/google/codegemma-2b) 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/google/codegemma-2b) 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 AIronMind/codegemma-2b-Q4_K_M-GGUF --model codegemma-2b.Q4_K_M.gguf -p "The meaning to life and the universe is"
+llama-cli --hf-repo AIronMind/codegemma-2b-Q4_K_M-GGUF --hf-file codegemma-2b-q4_k_m.gguf -p "The meaning to life and the universe is"
 ```
 
-Server:
-
+### Server:
 ```bash
-llama-server --hf-repo AIronMind/codegemma-2b-Q4_K_M-GGUF --model codegemma-2b.Q4_K_M.gguf -c 2048
+llama-server --hf-repo AIronMind/codegemma-2b-Q4_K_M-GGUF --hf-file codegemma-2b-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 AIronMind/codegemma-2b-Q4_K_M-GGUF --hf-file codegemma-2b-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 codegemma-2b.Q4_K_M.gguf -n 128
+./llama-server --hf-repo AIronMind/codegemma-2b-Q4_K_M-GGUF --hf-file codegemma-2b-q4_k_m.gguf -c 2048
 ```