Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,36 @@
+---
+library_name: transformers
+tags:
+- llama-cpp
+- gguf-my-repo
+---
+
+# AlirezaF138/Llama-3-Persian-8B-LoRA-Q6_K-GGUF
+This model was converted to GGUF format from [`safinal/Llama-3-Persian-8B-LoRA`](https://huggingface.co/safinal/Llama-3-Persian-8B-LoRA) 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/safinal/Llama-3-Persian-8B-LoRA) for more details on the model.
+## Use with llama.cpp
+
+Install llama.cpp through brew.
+
+```bash
+brew install ggerganov/ggerganov/llama.cpp
+```
+Invoke the llama.cpp server or the CLI.
+
+CLI:
+
+```bash
+llama-cli --hf-repo AlirezaF138/Llama-3-Persian-8B-LoRA-Q6_K-GGUF --model llama-3-persian-8b-lora.Q6_K.gguf -p "The meaning to life and the universe is"
+```
+
+Server:
+
+```bash
+llama-server --hf-repo AlirezaF138/Llama-3-Persian-8B-LoRA-Q6_K-GGUF --model llama-3-persian-8b-lora.Q6_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.
+
+```
+git clone https://github.com/ggerganov/llama.cpp &&             cd llama.cpp &&             make &&             ./main -m llama-3-persian-8b-lora.Q6_K.gguf -n 128
+```