Update README.md

README.md

@@ -5,49 +5,72 @@ tags:
 - mergekit
 - merge
 - llama-cpp
-- gguf-my-repo
+- llama
 ---
 
-# v000000/SwallowMaid-8B-L3-SPPO-abliterated-Q8_0-GGUF
-This model was converted to GGUF format from [`v000000/SwallowMaid-8B-L3-SPPO-abliterated`](https://huggingface.co/v000000/SwallowMaid-8B-L3-SPPO-abliterated) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
+This model was converted to GGUF format from [`v000000/SwallowMaid-8B-L3-SPPO-abliterated`](https://huggingface.co/v000000/SwallowMaid-8B-L3-SPPO-abliterated) using llama.cpp
 Refer to the [original model card](https://huggingface.co/v000000/SwallowMaid-8B-L3-SPPO-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 v000000/SwallowMaid-8B-L3-SPPO-abliterated-Q8_0-GGUF --hf-file swallowmaid-8b-l3-sppo-abliterated-q8_0.gguf -p "The meaning to life and the universe is"
-```
-
-### Server:
-```bash
-llama-server --hf-repo v000000/SwallowMaid-8B-L3-SPPO-abliterated-Q8_0-GGUF --hf-file swallowmaid-8b-l3-sppo-abliterated-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 v000000/SwallowMaid-8B-L3-SPPO-abliterated-Q8_0-GGUF --hf-file swallowmaid-8b-l3-sppo-abliterated-q8_0.gguf -p "The meaning to life and the universe is"
-```
-or 
-```
-./llama-server --hf-repo v000000/SwallowMaid-8B-L3-SPPO-abliterated-Q8_0-GGUF --hf-file swallowmaid-8b-l3-sppo-abliterated-q8_0.gguf -c 2048
-```
+# merge
+
+This is a merge of pre-trained language models created using [mergekit](https://github.com/cg123/mergekit).
+
+## Merge Details
+### Merge Method
+
+This model was merged using the [linear](https://arxiv.org/abs/2203.05482) merge method.
+
+### Models Merged
+
+The following models were included in the merge:
+* [grimjim/Llama-3-Instruct-abliteration-LoRA-8B](https://huggingface.co/grimjim/Llama-3-Instruct-abliteration-LoRA-8B)
+* [UCLA-AGI/Llama-3-Instruct-8B-SPPO-Iter3](https://huggingface.co/UCLA-AGI/Llama-3-Instruct-8B-SPPO-Iter3)
+* [NeverSleep/Llama-3-Lumimaid-8B-v0.1-OAS](https://huggingface.co/NeverSleep/Llama-3-Lumimaid-8B-v0.1-OAS)
+* [maldv/llama-3-fantasy-writer-8b](https://huggingface.co/maldv/llama-3-fantasy-writer-8b)
+* [tokyotech-llm/Llama-3-Swallow-8B-v0.1](https://huggingface.co/tokyotech-llm/Llama-3-Swallow-8B-v0.1)
+* [Nitral-AI/Hathor_Respawn-L3-8B-v0.8](https://huggingface.co/Nitral-AI/Hathor_Respawn-L3-8B-v0.8)
+
+### Configuration
+
+The following YAML configuration was used to produce this model:
+
+```yaml
+# Part 3, Apply abliteration (SwallowMaid-8B)
+models:
+  - model: sppo-rpmix-part2+grimjim/Llama-3-Instruct-abliteration-LoRA-8B
+    parameters:
+      weight: 1.0
+merge_method: linear
+dtype: float32
+
+# Part 2, infuse 35% swallow+rpmix to SPPO-Iter3 (sppo-rpmix-part2)
+models:
+  - model: UCLA-AGI/Llama-3-Instruct-8B-SPPO-Iter3
+    parameters:
+      weight: 1.0
+  - model: rpmix-part1
+    parameters:
+      weight: 0.35
+merge_method: task_arithmetic
+base_model: UCLA-AGI/Llama-3-Instruct-8B-SPPO-Iter3
+parameters:
+    normalize: false
+dtype: float32
+
+# Part 1, linear merge rpmix (rpmix-part1)
+models:
+  - model: Nitral-AI/Hathor_Respawn-L3-8B-v0.8
+    parameters:
+      weight: 0.6
+  - model: maldv/llama-3-fantasy-writer-8b
+    parameters:
+      weight: 0.1
+  - model: NeverSleep/Llama-3-Lumimaid-8B-v0.1-OAS
+    parameters:
+      weight: 0.4
+  - model: tokyotech-llm/Llama-3-Swallow-8B-v0.1
+    parameters:
+      weight: 0.15
+merge_method: linear
+dtype: float32
+```