Update README.md

README.md

@@ -1,28 +1,204 @@
 ---
-base_model:
-- Casual-Autopsy/L3-Umbral-Mind-RP-v1.0-8B
-- aifeifei798/llama3-8B-DarkIdol-2.1-Uncensored-32K
-- Nitral-AI/Hathor_Stable-v0.2-L3-8B
-- Sao10K/L3-8B-Stheno-v3.1
 tags:
 - merge
 - mergekit
 - lazymergekit
+- not-for-all-audiences
+- nsfw
+- rp
+- roleplay
+- role-play
+license: llama3
+language:
+- en
+library_name: transformers
+pipeline_tag: text-generation
+base_model:
 - Casual-Autopsy/L3-Umbral-Mind-RP-v1.0-8B
+- bluuwhale/L3-SthenoMaidBlackroot-8B-V1
+- Cas-Warehouse/Llama-3-SOVL-MopeyMule-Blackroot-8B
+- Cas-Warehouse/Llama-3-Mopeyfied-Psychology-v2
+- tannedbum/L3-Nymeria-8B
+- migtissera/Llama-3-8B-Synthia-v3.5
+- Casual-Autopsy/L3-Umbral-Mind-RP-v0.3-8B
+- tannedbum/L3-Nymeria-Maid-8B
+- Casual-Autopsy/L3-Uncen-Merger-Omelette-RP-v0.2-8B
 - aifeifei798/llama3-8B-DarkIdol-2.1-Uncensored-32K
 - Nitral-AI/Hathor_Stable-v0.2-L3-8B
 - Sao10K/L3-8B-Stheno-v3.1
 ---
 
-# L3-Umbral-Mind-RP-v2.0-8B
+<img src="https://huggingface.co/Casual-Autopsy/L3-Umbral-Mind-RP-v3-8B/resolve/main/63073798_p0_master1200.jpg" style="display: block; margin: auto;">
+Image by ろ47
+
+# Merge
+
+This is a merge of pre-trained language models created using [mergekit](https://github.com/cg123/mergekit).
+
+## Merge Details
+
+The goal of this merge was to make an RP model better suited for role-plays with heavy themes such as but not limited to:
+- Mental illness
+- Self-harm
+- Trauma
+- Suicide
+
+I hated how RP models tended to be overly positive and hopeful with role-plays involving such themes,
+but thanks to [failspy/Llama-3-8B-Instruct-MopeyMule](https://huggingface.co/failspy/Llama-3-8B-Instruct-MopeyMule) this problem has been lessened considerably.
+
+If you're an enjoyer of savior/reverse savior type role-plays like myself, then this model is for you.
+
+### Usage Info
+
+This model is meant to be used with asterisks/quotes RPing formats, any other format that isn't asterisks/quotes is likely to cause issues
+
+### Quants
+
+
+
+### Merge Method
+
+This model was merged using several Task Arithmetic merges and then tied together with a Model Stock merge, followed by another Task Arithmetic merge with a model containing psychology data.
+
+### Models Merged
 
-L3-Umbral-Mind-RP-v2.0-8B is a merge of the following models using [LazyMergekit](https://colab.research.google.com/drive/1obulZ1ROXHjYLn6PPZJwRR6GzgQogxxb?usp=sharing):
+The following models were included in the merge:
 * [Casual-Autopsy/L3-Umbral-Mind-RP-v1.0-8B](https://huggingface.co/Casual-Autopsy/L3-Umbral-Mind-RP-v1.0-8B)
+* [bluuwhale/L3-SthenoMaidBlackroot-8B-V1](https://huggingface.co/bluuwhale/L3-SthenoMaidBlackroot-8B-V1)
+* [Cas-Warehouse/Llama-3-SOVL-MopeyMule-Blackroot-8B](https://huggingface.co/Cas-Warehouse/Llama-3-SOVL-MopeyMule-Blackroot-8B)
+* [Cas-Warehouse/Llama-3-Mopeyfied-Psychology-v2](https://huggingface.co/Cas-Warehouse/Llama-3-Mopeyfied-Psychology-v2)
+* [tannedbum/L3-Nymeria-8B](https://huggingface.co/tannedbum/L3-Nymeria-8B)
+* [migtissera/Llama-3-8B-Synthia-v3.5](https://huggingface.co/migtissera/Llama-3-8B-Synthia-v3.5)
+* [Casual-Autopsy/L3-Umbral-Mind-RP-v0.3-8B](https://huggingface.co/Casual-Autopsy/L3-Umbral-Mind-RP-v0.3-8B)
+* [tannedbum/L3-Nymeria-Maid-8B](https://huggingface.co/tannedbum/L3-Nymeria-Maid-8B)
+* [Casual-Autopsy/L3-Uncen-Merger-Omelette-RP-v0.2-8B](https://huggingface.co/Casual-Autopsy/L3-Uncen-Merger-Omelette-RP-v0.2-8B)
 * [aifeifei798/llama3-8B-DarkIdol-2.1-Uncensored-32K](https://huggingface.co/aifeifei798/llama3-8B-DarkIdol-2.1-Uncensored-32K)
 * [Nitral-AI/Hathor_Stable-v0.2-L3-8B](https://huggingface.co/Nitral-AI/Hathor_Stable-v0.2-L3-8B)
 * [Sao10K/L3-8B-Stheno-v3.1](https://huggingface.co/Sao10K/L3-8B-Stheno-v3.1)
 
-## 🧩 Configuration
+## Secret Sauce
+
+The following YAML configurations were used to produce this model:
+
+### Umbral-1
+
+```yaml
+models:
+  - model: Casual-Autopsy/L3-Umbral-Mind-RP-v1.0-8B
+  - model: bluuwhale/L3-SthenoMaidBlackroot-8B-V1
+    parameters:
+      density: 0.45
+      weight: 0.4
+  - model: Cas-Warehouse/Llama-3-SOVL-MopeyMule-Blackroot-8B
+    parameters:
+      density: 0.65
+      weight: 0.1
+merge_method: dare_ties
+base_model: Casual-Autopsy/L3-Umbral-Mind-RP-v1.0-8B
+parameters:
+  int8_mask: true
+dtype: bfloat16
+```
+
+### Umbral-2
+
+```yaml
+models:
+  - model: Cas-Warehouse/Llama-3-Mopeyfied-Psychology-v2
+  - model: tannedbum/L3-Nymeria-8B
+    parameters:
+      density: 0.45
+      weight: 0.25
+  - model: migtissera/Llama-3-8B-Synthia-v3.5
+    parameters:
+      density: 0.65
+      weight: 0.25
+merge_method: dare_ties
+base_model: Cas-Warehouse/Llama-3-Mopeyfied-Psychology-v2
+parameters:
+  int8_mask: true
+dtype: bfloat16
+```
+
+### Umbral-3
+
+```yaml
+models:
+  - model: Casual-Autopsy/L3-Umbral-Mind-RP-v0.3-8B
+  - model: tannedbum/L3-Nymeria-Maid-8B
+    parameters:
+      density: 0.4
+      weight: 0.3
+  - model: Cas-Warehouse/Llama-3-SOVL-MopeyMule-Blackroot-8B
+    parameters:
+      density: 0.6
+      weight: 0.2
+merge_method: dare_ties
+base_model: Casual-Autopsy/L3-Umbral-Mind-RP-v0.3-8B
+parameters:
+  int8_mask: true
+dtype: bfloat16
+```
+
+### Mopey-Omelette
+
+```yaml
+models:
+  - model: Casual-Autopsy/L3-Uncen-Merger-Omelette-RP-v0.2-8B
+  - model: Cas-Warehouse/Llama-3-SOVL-MopeyMule-Blackroot-8B
+    parameters:
+      weight: 0.15
+merge_method: task_arithmetic
+base_model: Casual-Autopsy/L3-Uncen-Merger-Omelette-RP-v0.2-8B
+dtype: bfloat16
+```
+
+### Umbral-Mind-1
+
+```yaml
+models:
+  - model: Casual-Autopsy/Umbral-1
+  - model: Casual-Autopsy/Umbral-3
+merge_method: slerp
+base_model: Casual-Autopsy/Umbral-1
+parameters:
+  t:
+    - value: [0.7, 0.5, 0.3, 0.25, 0.2, 0.25, 0.3, 0.5, 0.7]
+  embed_slerp: true
+dtype: bfloat16
+```
+
+### Umbral-Mind-2
+
+```yaml
+models:
+  - model: Casual-Autopsy/Umbral-Mind-1
+  - model: Casual-Autopsy/Umbral-2
+merge_method: slerp
+base_model: Casual-Autopsy/Umbral-Mind-1
+parameters:
+  t:
+    - value: [0.1, 0.15, 0.2, 0.4, 0.6, 0.4, 0.2, 0.15, 0.1]
+  embed_slerp: true
+dtype: bfloat16
+```
+
+### Umbral-Mind-3
+
+```yaml
+models:
+  - model: Casual-Autopsy/Umbral-Mind-2
+  - model: Casual-Autopsy/Mopey-Omelette
+merge_method: slerp
+base_model: Casual-Autopsy/Umbral-Mind-2
+parameters:
+  t:
+    - value: [0.2, 0.25, 0.3, 0.4, 0.3, 0.25, 0.2, 0.25, 0.3, 0.4, 0.3, 0.25, 0.2]
+  embed_slerp: true
+dtype: bfloat16
+```
+
+### L3-Umbral-Mind-RP-v2.0-8B
 
 ```yaml
 models:
@@ -42,29 +218,4 @@ models:
 merge_method: task_arithmetic
 base_model: Casual-Autopsy/Umbral-Mind-3
 dtype: bfloat16
-```
-
-## 💻 Usage
-
-```python
-!pip install -qU transformers accelerate
-
-from transformers import AutoTokenizer
-import transformers
-import torch
-
-model = "Casual-Autopsy/L3-Umbral-Mind-RP-v2.0-8B"
-messages = [{"role": "user", "content": "What is a large language model?"}]
-
-tokenizer = AutoTokenizer.from_pretrained(model)
-prompt = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
-pipeline = transformers.pipeline(
-    "text-generation",
-    model=model,
-    torch_dtype=torch.float16,
-    device_map="auto",
-)
-
-outputs = pipeline(prompt, max_new_tokens=256, do_sample=True, temperature=0.7, top_k=50, top_p=0.95)
-print(outputs[0]["generated_text"])
 ```