Update README.md

README.md

@@ -1,3 +1,55 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+tags:
+- mistral
+- conversational
+- text-generation-inference
+base_model: BeaverAI/mistral-dory-12b
+library_name: transformers
+---
+
+> [!WARNING]
+> **Sampling:**<br>
+> Mistral-Nemo-12B-Instruct-2407 is very sensitive to the temperature sampler, try values near **0.3** or else you will get some weird results. This is mentioned by MistralAI at their [Transformers](https://huggingface.co/mistralai/Mistral-Nemo-Instruct-2407#transformers) section
+
+**How to Use:**  
+As of July 20, 2024, llama.cpp does not support Mistral-Nemo-Instruct-2407. However, you can still use it by building from iamlemec's branch **mistral-nemo** at [llama.cpp GitHub repository](https://github.com/iamlemec/llama.cpp/tree/mistral-nemo).
+
+```
+git clone -b mistral-nemo https://github.com/iamlemec/llama.cpp.git
+cd llama.cpp
+cmake -B build
+cmake --build build --config Release
+```
+
+Recommended to use `cmake -B build -DGGML_CUDA=ON` if you're using a CUDA compatible GPU.
+
+If the build takes too long use `cmake -B build --config Release -j 4`, which uses 4 threads to build. Adjust the number to the amount of physical cores on your CPU.
+
+Use:
+```
+llama-server.exe -m .\models\Mistral-Nemo-12B-Instruct-2407-Q8_0.gguf -b 512 -ub 512 -c 4096 -ngl 100
+```
+
+Set `-b` to batch size<br>
+Set `-ub` to physical batch size<br>
+Set `-c` to context size<br>
+Set `-ngl` to amount of layers to load onto GPU<br>
+Change the path to where the model is actually stored. <br>
+If you need more clarification on parameters check out the [llama.cpp Server Docs](https://github.com/ggerganov/llama.cpp/blob/master/examples/server/README.md)
+
+**License:**  
+Apache 2.0
+
+**Original Model:**  
+[BeaverAI/mistral-dory-12b](https://huggingface.co/BeaverAI/mistral-dory-12b)
+
+# Quants
+Quantizing currently
+
+> [!NOTE]
+> **Note: Q8_0_L**<br>
+> Leaves output.weight unquantized. Increases model size but may also increase quality.
+
+**The MistralAI Team:**  
+Albert Jiang, Alexandre Sablayrolles, Alexis Tacnet, Alok Kothari, Antoine Roux, Arthur Mensch, Audrey Herblin-Stoop, Augustin Garreau, Austin Birky, Bam4d, Baptiste Bout, Baudouin de Monicault, Blanche Savary, Carole Rambaud, Caroline Feldman, Devendra Singh Chaplot, Diego de las Casas, Eleonore Arcelin, Emma Bou Hanna, Etienne Metzger, Gaspard Blanchet, Gianna Lengyel, Guillaume Bour, Guillaume Lample, Harizo Rajaona, Henri Roussez, Hichem Sattouf, Ian Mack, Jean-Malo Delignon, Jessica Chudnovsky, Justus Murke, Kartik Khandelwal, Lawrence Stewart, Louis Martin, Louis Ternon, Lucile Saulnier, Lélio Renard Lavaud, Margaret Jennings, Marie Pellat, Marie Torelli, Marie-Anne Lachaux, Marjorie Janiewicz, Mickaël Seznec, Nicolas Schuhl, Niklas Muhs, Olivier de Garrigues, Patrick von Platen, Paul Jacob, Pauline Buche, Pavan Kumar Reddy, Perry Savas, Pierre Stock, Romain Sauvestre, Sagar Vaze, Sandeep Subramanian, Saurabh Garg, Sophia Yang, Szymon Antoniak, Teven Le Scao, Thibault Schueller, Thibaut Lavril, Thomas Wang, Théophile Gervet, Timothée Lacroix, Valera Nemychnikova, Wendy Shang, William El Sayed, William Marshall