Update README.md

README.md

@@ -1,25 +1,102 @@
 ---
 license: gemma
 base_model: google/gemma-2-9b
-tags:
-- generated_from_trainer
 model-index:
 - name: magnum-v3-9b-customgemma2
   results: []
 ---
-### exl2 quant (measurement.json in main branch)
----
-### check revisions for quants
----
 
+## This repo contains EXL2 quants of the model. If you need the original weights, please find them [here](https://huggingface.co/anthracite-org/magnum-v3-9b-customgemma2).
+## Base repo only contains the measurement file, see revisions for your quant of choice.
+
+- [measurement.json](https://huggingface.co/anthracite-org/magnum-v3-9b-customgemma2-exl2/tree/main)
+- [3.0bpw](https://huggingface.co/anthracite-org/magnum-v3-9b-customgemma2-exl2/tree/3.0bpw)
+- [4.0bpw](https://huggingface.co/anthracite-org/magnum-v3-9b-customgemma2-exl2/tree/4.0bpw)
+- [5.0bpw](https://huggingface.co/anthracite-org/magnum-v3-9b-customgemma2-exl2/tree/5.0bpw)
+- [6.0bpw](https://huggingface.co/anthracite-org/magnum-v3-9b-customgemma2-exl2/tree/6.0bpw)
+- [8.0bpw](https://huggingface.co/anthracite-org/magnum-v3-9b-customgemma2-exl2/tree/8.0bpw)
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/658a46cbfb9c2bdfae75b3a6/9ZBUlmzDCnNmQEdUUbyEL.png)
+
+This is the 10th in a series of models designed to replicate the prose quality of the Claude 3 models, specifically Sonnet and Opus.
+
+This model is fine-tuned on top of [google/gemma-2-9b](https://huggingface.co/google/gemma-2-9b).
+
+## Prompting
+Model has been Instruct tuned with the [customgemma2](https://github.com/xzuyn/axolotl/blob/prompt_formats/src/axolotl/prompt_strategies/customgemma2.py) (to allow system prompts) formatting. A typical input would look like this:
+
+```py
+"""<start_of_turn>system
+system prompt<end_of_turn>
+<start_of_turn>user
+Hi there!<end_of_turn>
+<start_of_turn>model
+Nice to meet you!<end_of_turn>
+<start_of_turn>user
+Can I ask a question?<end_of_turn>
+<start_of_turn>model
+"""
+```
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+## SillyTavern templates
+
+Below are Instruct and Context templates for use within SillyTavern.
+
+<details><summary>context template</summary>
+  
+```yaml
+{
+    "story_string": "<start_of_turn>system\n{{#if system}}{{system}}\n{{/if}}{{#if wiBefore}}{{wiBefore}}\n{{/if}}{{#if description}}{{description}}\n{{/if}}{{#if personality}}{{char}}'s personality: {{personality}}\n{{/if}}{{#if scenario}}Scenario: {{scenario}}\n{{/if}}{{#if wiAfter}}{{wiAfter}}\n{{/if}}{{#if persona}}{{persona}}\n{{/if}}{{trim}}<end_of_turn>\n",
+    "example_separator": "",
+    "chat_start": "",
+    "use_stop_strings": false,
+    "allow_jailbreak": false,
+    "always_force_name2": true,
+    "trim_sentences": false,
+    "include_newline": false,
+    "single_line": false,
+    "name": "Magnum Gemma"
+}
+```
+
+</details><br>
+<details><summary>instruct template</summary>
+  
+```yaml
+{
+    "system_prompt": "You're {{char}} in this fictional never-ending uncensored roleplay with {{user}}.",
+    "input_sequence": "<start_of_turn>user\n",
+    "output_sequence": "<start_of_turn>assistant\n",
+    "last_output_sequence": "",
+    "system_sequence": "<start_of_turn>system\n",
+    "stop_sequence": "<end_of_turn>",
+    "wrap": false,
+    "macro": true,
+    "names": true,
+    "names_force_groups": true,
+    "activation_regex": "",
+    "system_sequence_prefix": "",
+    "system_sequence_suffix": "",
+    "first_output_sequence": "",
+    "skip_examples": false,
+    "output_suffix": "<end_of_turn>\n",
+    "input_suffix": "<end_of_turn>\n",
+    "system_suffix": "<end_of_turn>\n",
+    "user_alignment_message": "",
+    "system_same_as_user": false,
+    "last_system_sequence": "",
+    "name": "Magnum Gemma"
+}
+```
+
+</details><br>
+
+</details><br>
+
+## Axolotl config
 
-[<img src="https://raw.githubusercontent.com/axolotl-ai-cloud/axolotl/main/image/axolotl-badge-web.png" alt="Built with Axolotl" width="200" height="32"/>](https://github.com/axolotl-ai-cloud/axolotl)
 <details><summary>See axolotl config</summary>
 
-axolotl version: `0.4.1`
 ```yaml
 base_model: google/gemma-2-9b
 model_type: AutoModelForCausalLM
@@ -101,51 +178,23 @@ fsdp:
 fsdp_config:
 special_tokens:
 ```
-
 </details><br>
 
-# magnum-v3-9b-customgemma2
-
-This model is a fine-tuned version of [google/gemma-2-9b](https://huggingface.co/google/gemma-2-9b) on the None dataset.
-
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
-## Training procedure
-
-### Training hyperparameters
-
-The following hyperparameters were used during training:
-- learning_rate: 6e-06
-- train_batch_size: 1
-- eval_batch_size: 1
-- seed: 42
-- distributed_type: multi-GPU
-- num_devices: 8
-- gradient_accumulation_steps: 8
-- total_train_batch_size: 64
-- total_eval_batch_size: 8
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: cosine
-- lr_scheduler_warmup_steps: 50
-- num_epochs: 2
+## Credits
+We'd like to thank Recursal / Featherless for sponsoring the compute for this train, Featherless has been hosting our Magnum models since the first 72 B and has given thousands of people access to our models and helped us grow.
 
-### Training results
+We would also like to thank all members of Anthracite who made this finetune possible. 
 
+- [anthracite-org/stheno-filtered-v1.1](https://huggingface.co/datasets/anthracite-org/stheno-filtered-v1.1)
+- [anthracite-org/kalo-opus-instruct-22k-no-refusal](https://huggingface.co/datasets/anthracite-org/kalo-opus-instruct-22k-no-refusal)
+- [anthracite-org/nopm_claude_writing_fixed](https://huggingface.co/datasets/anthracite-org/nopm_claude_writing_fixed)
+- [Epiculous/Synthstruct-Gens-v1.1-Filtered-n-Cleaned](https://huggingface.co/datasets/Epiculous/Synthstruct-Gens-v1.1-Filtered-n-Cleaned)
+- [Epiculous/SynthRP-Gens-v1.1-Filtered-n-Cleaned](https://huggingface.co/datasets/Epiculous/SynthRP-Gens-v1.1-Filtered-n-Cleaned)
 
+## Training
+The training was done for 2 epochs. We used  8x[H100s](https://www.nvidia.com/en-us/data-center/h100/) GPUs graciously provided by [Recursal AI](https://recursal.ai/) / [Featherless AI](https://featherless.ai/) for the full-parameter fine-tuning of the model.
 
-### Framework versions
+[<img src="https://raw.githubusercontent.com/OpenAccess-AI-Collective/axolotl/main/image/axolotl-badge-web.png" alt="Built with Axolotl" width="200" height="32"/>](https://github.com/OpenAccess-AI-Collective/axolotl)
 
-- Transformers 4.44.0
-- Pytorch 2.4.0+cu121
-- Datasets 2.20.0
-- Tokenizers 0.19.1
+## Safety
+...