Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,89 @@
+---
+inference: false
+library_name: transformers
+language:
+- en
+- fr
+- de
+- es
+- it
+- pt
+- ja
+- ko
+- zh
+- ar
+- el
+- fa
+- pl
+- id
+- cs
+- he
+- hi
+- nl
+- ro
+- ru
+- tr
+- uk
+- vi
+license: cc-by-nc-4.0
+extra_gated_prompt: By submitting this form, you agree to the [License Agreement](https://cohere.com/c4ai-cc-by-nc-license)  and
+  acknowledge that the information you provide will be collected, used, and shared
+  in accordance with Cohere’s [Privacy Policy]( https://cohere.com/privacy). You’ll
+  receive email updates about C4AI and Cohere research, events, products and services.
+  You can unsubscribe at any time.
+extra_gated_fields:
+  Name: text
+  Affiliation: text
+  Country: country
+  I agree to use this model for non-commercial use ONLY: checkbox
+tags:
+- abliterated
+- uncensored
+- llama-cpp
+- gguf-my-repo
+base_model: huihui-ai/aya-expanse-8b-abliterated
+---
+
+# AIronMind/aya-expanse-8b-abliterated-Q4_K_M-GGUF
+This model was converted to GGUF format from [`huihui-ai/aya-expanse-8b-abliterated`](https://huggingface.co/huihui-ai/aya-expanse-8b-abliterated) 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/huihui-ai/aya-expanse-8b-abliterated) 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 AIronMind/aya-expanse-8b-abliterated-Q4_K_M-GGUF --hf-file aya-expanse-8b-abliterated-q4_k_m.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo AIronMind/aya-expanse-8b-abliterated-Q4_K_M-GGUF --hf-file aya-expanse-8b-abliterated-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/aya-expanse-8b-abliterated-Q4_K_M-GGUF --hf-file aya-expanse-8b-abliterated-q4_k_m.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo AIronMind/aya-expanse-8b-abliterated-Q4_K_M-GGUF --hf-file aya-expanse-8b-abliterated-q4_k_m.gguf -c 2048
+```