Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,86 @@
+---
+library_name: transformers
+license: apache-2.0
+language:
+- en
+- fr
+- zh
+- de
+tags:
+- creative
+- creative writing
+- fiction writing
+- plot generation
+- sub-plot generation
+- story generation
+- scene continue
+- storytelling
+- fiction story
+- science fiction
+- romance
+- all genres
+- story
+- writing
+- vivid prose
+- vivid writing
+- fiction
+- roleplaying
+- bfloat16
+- swearing
+- rp
+- qwen3
+- horror
+- finetune
+- merge
+- not-for-all-audiences
+- uncensored
+- abliterated
+- llama-cpp
+- gguf-my-repo
+base_model: DavidAU/Qwen3-The-Xiaolong-Josiefied-Omega-Directive-22B-uncensored-abliterated
+pipeline_tag: text-generation
+---
+
+# Recouper/Qwen3-The-Xiaolong-Josiefied-Omega-Directive-22B-uncensored-abliterated-Q4_K_M-GGUF
+This model was converted to GGUF format from [`DavidAU/Qwen3-The-Xiaolong-Josiefied-Omega-Directive-22B-uncensored-abliterated`](https://huggingface.co/DavidAU/Qwen3-The-Xiaolong-Josiefied-Omega-Directive-22B-uncensored-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/DavidAU/Qwen3-The-Xiaolong-Josiefied-Omega-Directive-22B-uncensored-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 Recouper/Qwen3-The-Xiaolong-Josiefied-Omega-Directive-22B-uncensored-abliterated-Q4_K_M-GGUF --hf-file qwen3-the-xiaolong-josiefied-omega-directive-22b-uncensored-abliterated-q4_k_m.gguf -p "The meaning to life and the universe is"
+```
+
+### Server:
+```bash
+llama-server --hf-repo Recouper/Qwen3-The-Xiaolong-Josiefied-Omega-Directive-22B-uncensored-abliterated-Q4_K_M-GGUF --hf-file qwen3-the-xiaolong-josiefied-omega-directive-22b-uncensored-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 Recouper/Qwen3-The-Xiaolong-Josiefied-Omega-Directive-22B-uncensored-abliterated-Q4_K_M-GGUF --hf-file qwen3-the-xiaolong-josiefied-omega-directive-22b-uncensored-abliterated-q4_k_m.gguf -p "The meaning to life and the universe is"
+```
+or 
+```
+./llama-server --hf-repo Recouper/Qwen3-The-Xiaolong-Josiefied-Omega-Directive-22B-uncensored-abliterated-Q4_K_M-GGUF --hf-file qwen3-the-xiaolong-josiefied-omega-directive-22b-uncensored-abliterated-q4_k_m.gguf -c 2048
+```