Update README.md

README.md

@@ -9,8 +9,52 @@ model-index:
   results: []
 ---
 
-<!-- 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. -->
+# mistral-7b-english-welsh-translate
+
+
+
+This model is a fine-tuned version of [mistralai/Mistral-7B-Instruct-v0.3](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.3) on the [Welsh Government Alpaca Welsh-English Instructions](https://huggingface.co/datasets/AndreasThinks/welsh-translation-instruction/blob/main/README.md) dataset.
+
+This model is trained for English-Welsh translation (in any direction), with a focus on government documents, using Markdown formatting.
+
+To ensure the highest quality translations, use the Alpaca instruction prompt format with the below structure.
+
+```
+    ### Instruction: {instruction}
+
+    ### Input: {input}
+
+    ### Response:
+
+```
+
+Your instruction should be "Translate the text from English to Welsh." (or vice versa).
+
+The model is also available [quantized as GGUF](https://huggingface.co/AndreasThinks/mistral-7b-english-welsh-translate-GGUF).
+
+## Running the model
+
+The model is intended to be run locally, ideally using [Text generation web UI](https://github.com/oobabooga/text-generation-webui) to ensure correct prompt structure.
+
+Start the UI as instructed for your system.
+
+- In the "Model" tab, download either this model or [the quantized version](https://huggingface.co/AndreasThinks/mistral-7b-english-welsh-translate-GGUF). Once the download is complete, load the model.
+- In the "Parameters" tab, under "Generation", set "auto_max_new_tokens" to maximum, and "Ban the eos_token" to True. In "Custom stopping strings", add "### Input"
+- In the "Notebook" tab, make sure you are using the "Alpaca-with-input" prompt.  Set the instruction as "Translate the text from Welsh to English." (or vice versa).#
+- Add the text you would like to translate (replacing "Input"), and hit "generate"
+
+Performance may start to degrade past a certain context window (especially if using the quantized models).  Convert in chunks of under 1000 words to avoid these issues.
+
+## LLM Evals
+
+Thanks to [YALL - Yet Another LLM Leaderboard](https://huggingface.co/spaces/mlabonne/Yet_Another_LLM_Leaderboard)
+
+|                                                    Model                                                    |AGIEval|TruthfulQA|Bigbench|
+|-------------------------------------------------------------------------------------------------------------|------:|---------:|-------:|
+|[mistral-7b-english-welsh-translate](https://huggingface.co/AndreasThinks/mistral-7b-english-welsh-translate)|  35.31|      54.5|    38.4|
+
+
+## Training procedure
 
 [<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>
@@ -84,50 +128,6 @@ special_tokens:
 </details><br>
 
 [<img src="https://raw.githubusercontent.com/wandb/assets/main/wandb-github-badge-28.svg" alt="Visualize in Weights & Biases" width="200" height="32"/>](https://wandb.ai/andreasthinks/mistral-nemo-welsh/runs/syq2m3vr)
-# mistral-7b-english-welsh-translate
-
-This model is a fine-tuned version of [mistralai/Mistral-7B-Instruct-v0.3](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.3) on the [Welsh Government Alpaca Welsh-English Instructions](https://huggingface.co/datasets/AndreasThinks/welsh-translation-instruction/blob/main/README.md) dataset.
-
-This model is trained for English-Welsh translation (in any direction), with a focus on government documents, using Markdown formatting.
-
-To ensure the highest quality translations, use the Alpaca instruction prompt format with the below structure.
-
-```
-    ### Instruction: {instruction}
-
-    ### Input: {input}
-
-    ### Response:
-
-```
-
-Your instruction should be "Translate the text from English to Welsh." (or vice versa).
-
-The model is also available [quantized as GGUF](https://huggingface.co/AndreasThinks/mistral-7b-english-welsh-translate-GGUF).
-
-## Running the model
-
-The model is intended to be run locally, ideally using [Text generation web UI](https://github.com/oobabooga/text-generation-webui) to ensure correct prompt structure.
-
-Start the UI as instructed for your system.
-
-- In the "Model" tab, download either this model or [the quantized version](https://huggingface.co/AndreasThinks/mistral-7b-english-welsh-translate-GGUF). Once the download is complete, load the model.
-- In the "Parameters" tab, under "Generation", set "auto_max_new_tokens" to maximum, and "Ban the eos_token" to True. In "Custom stopping strings", add "### Input"
-- In the "Notebook" tab, make sure you are using the "Alpaca-with-input" prompt.  Set the instruction as "Translate the text from Welsh to English." (or vice versa).#
-- Add the text you would like to translate (replacing "Input"), and hit "generate"
-
-Performance may start to degrade past a certain context window (especially if using the quantized models).  Convert in chunks of under 1000 words to avoid these issues.
-
-## LLM Evals
-
-Thanks to [YALL - Yet Another LLM Leaderboard](https://huggingface.co/spaces/mlabonne/Yet_Another_LLM_Leaderboard)
-
-|                                                    Model                                                    |AGIEval|TruthfulQA|Bigbench|
-|-------------------------------------------------------------------------------------------------------------|------:|---------:|-------:|
-|[mistral-7b-english-welsh-translate](https://huggingface.co/AndreasThinks/mistral-7b-english-welsh-translate)|  35.31|      54.5|    38.4|
-
-
-## Training procedure
 
 ### Training hyperparameters