Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,58 @@
+---
+base_model: Andrefty/bitnet-3B_lora_noshuf_PCL_alpaca_prs_pe_csec
+language:
+- en
+license: apache-2.0
+tags:
+- text-generation-inference
+- transformers
+- unsloth
+- llama
+- trl
+- llama-cpp
+- gguf-my-repo
+---
+
+# Andrefty/bitnet-3B_lora_noshuf_PCL_alpaca_prs_pe_csec-Q2_K-GGUF
+This model was converted to GGUF format from [`Andrefty/bitnet-3B_lora_noshuf_PCL_alpaca_prs_pe_csec`](https://huggingface.co/Andrefty/bitnet-3B_lora_noshuf_PCL_alpaca_prs_pe_csec) 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/Andrefty/bitnet-3B_lora_noshuf_PCL_alpaca_prs_pe_csec) 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 Andrefty/bitnet-3B_lora_noshuf_PCL_alpaca_prs_pe_csec-Q2_K-GGUF --hf-file bitnet-3b_lora_noshuf_pcl_alpaca_prs_pe_csec-q2_k.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo Andrefty/bitnet-3B_lora_noshuf_PCL_alpaca_prs_pe_csec-Q2_K-GGUF --hf-file bitnet-3b_lora_noshuf_pcl_alpaca_prs_pe_csec-q2_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 Andrefty/bitnet-3B_lora_noshuf_PCL_alpaca_prs_pe_csec-Q2_K-GGUF --hf-file bitnet-3b_lora_noshuf_pcl_alpaca_prs_pe_csec-q2_k.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo Andrefty/bitnet-3B_lora_noshuf_PCL_alpaca_prs_pe_csec-Q2_K-GGUF --hf-file bitnet-3b_lora_noshuf_pcl_alpaca_prs_pe_csec-q2_k.gguf -c 2048
+```