Update README.md

README.md

@@ -1,5 +1,60 @@
 ---
-base_model: Felladrin/gguf-Q5_K_M-OLMo-1B-SFT-hf
+base_model: kykim0/OLMo-1B-SFT-hf
+datasets:
+- allenai/tulu-v2-sft-mixture
+license: apache-2.0
+tags:
+- alignment-handbook
+- trl
+- sft
+- generated_from_trainer
+- llama-cpp
+- gguf-my-repo
+model-index:
+- name: OLMo-1B-SFT-hf
+  results: []
 ---
 
-Sharded GGUF version of [Felladrin/gguf-Q5_K_M-OLMo-1B-SFT-hf](https://huggingface.co/Felladrin/gguf-Q5_K_M-OLMo-1B-SFT-hf).
+# Felladrin/OLMo-1B-SFT-hf-Q5_K_M-GGUF
+This model was converted to GGUF format from [`kykim0/OLMo-1B-SFT-hf`](https://huggingface.co/kykim0/OLMo-1B-SFT-hf) 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/kykim0/OLMo-1B-SFT-hf) for more details on the model.
+
+## Use with llama.cpp
+Install llama.cpp through brew (works on Mac and Linux)
+
+```bash
+brew install llama.cpp
+
+```
+Invoke the llama.cpp server or the CLI.
+
+### CLI:
+```bash
+llama-cli --hf-repo Felladrin/OLMo-1B-SFT-hf-Q5_K_M-GGUF --hf-file olmo-1b-sft-hf-q5_k_m-imat.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo Felladrin/OLMo-1B-SFT-hf-Q5_K_M-GGUF --hf-file olmo-1b-sft-hf-q5_k_m-imat.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 Felladrin/OLMo-1B-SFT-hf-Q5_K_M-GGUF --hf-file olmo-1b-sft-hf-q5_k_m-imat.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo Felladrin/OLMo-1B-SFT-hf-Q5_K_M-GGUF --hf-file olmo-1b-sft-hf-q5_k_m-imat.gguf -c 2048
+```