Upload README.md with huggingface_hub

README.md

@@ -1,22 +1,58 @@
 ---
-base_model: unsloth/qwen2.5-3b-bnb-4bit
+base_model: qingy2024/GRMR-3B-Instruct-v2
 tags:
 - text-generation-inference
 - transformers
 - unsloth
 - qwen2
-- gguf
+- trl
+- llama-cpp
+- gguf-my-repo
 license: apache-2.0
 language:
 - en
 ---
 
-# Uploaded  model
+# qingy2024/GRMR-3B-Instruct-v2-Q8_0-GGUF
+This model was converted to GGUF format from [`qingy2024/GRMR-3B-Instruct-v2`](https://huggingface.co/qingy2024/GRMR-3B-Instruct-v2) 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/qingy2024/GRMR-3B-Instruct-v2) for more details on the model.
 
-- **Developed by:** qingy2024
-- **License:** apache-2.0
-- **Finetuned from model :** unsloth/qwen2.5-3b-bnb-4bit
+## Use with llama.cpp
+Install llama.cpp through brew (works on Mac and Linux)
 
-This qwen2 model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+```bash
+brew install llama.cpp
 
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+```
+Invoke the llama.cpp server or the CLI.
+
+### CLI:
+```bash
+llama-cli --hf-repo qingy2024/GRMR-3B-Instruct-v2-Q8_0-GGUF --hf-file grmr-3b-instruct-v2-q8_0.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo qingy2024/GRMR-3B-Instruct-v2-Q8_0-GGUF --hf-file grmr-3b-instruct-v2-q8_0.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 qingy2024/GRMR-3B-Instruct-v2-Q8_0-GGUF --hf-file grmr-3b-instruct-v2-q8_0.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo qingy2024/GRMR-3B-Instruct-v2-Q8_0-GGUF --hf-file grmr-3b-instruct-v2-q8_0.gguf -c 2048
+```