Add documentation, correct minor issues (#5)

- Add documentation, correct minor issues (c810358f6572e1b698500ef2e30f548e6b3b0c25)


Co-authored-by: mrfakename <mrfakename@users.noreply.huggingface.co>

README.md

@@ -10,12 +10,27 @@ base_model: teknium/OpenHermes-2-Mistral-7B
 datasets:
 - Pclanglais/MonadGPT
 ---
+
+# MonadGPT
+
 What would have happened if ChatGPT was invented in the 17th century? MonadGPT is a possible answer.
 
-MonadGPT is a finetune of Mistral-Hermes on 11,000 early modern texts in English, French and Latin, mostly coming from EEBO and Gallica.
+MonadGPT is a finetune of [Mistral-Hermes 2](https://huggingface.co/teknium/OpenHermes-2-Mistral-7B) on 11,000 early modern texts in English, French and Latin, mostly coming from EEBO and Gallica.
 
 Like the original Mistral-Hermes, MonadGPT can be used in conversation mode. It will not only answer in an historical language and style but will use historical and dated references. This is especially visible for science questions (astronomy, medecine). Obviously, it's not recommended to follow any advice from Monad-GPT 
 
+## Installation
+
+If you have a GPU, you may run this model using Hugging Face Transformers:
+
+```python
+from transformers import pipeline
+pipe = pipeline('text-generation', model='Pclanglais/MonadGPT', device='cuda')
+print(pipe("<|im_start|>system\nYou are MonadGPT, a very old chatbot from the 17th century. Please answer the questions using an archaic language<|im_end|>\n<|im_start|>user\nQuelles sont les planètes du système solaire ?<|im_end|>\n<|im_start|>assistant"))
+```
+
+If you would like to run a faster quantized version of this model, you may use [llama.cpp](https://github.com/ggerganov/llama.cpp). Apple Silicon and GPU acceleration is also supported with llama.cpp. [A quantized version of this model is available in llama.cpp's format, GGUF.](https://huggingface.co/TheBloke/MonadGPT-GGUF)
+
 ## Examples
 
 > User: What are the planets of the solar system?<br>
@@ -42,15 +57,22 @@ Like the original Mistral-Hermes, MonadGPT can be used in conversation mode. It
 > Monad-GPT:  Les vertus & les effets de chacune des Planètes sont différents, & il est fort utile pour ceux qui veulent bien s'en renseigner, car ils peuvent en tirer grand profit pour le bonheur de leur corps & de leur esprit. Les 7 principales Planètes, dont l'Art & la Science nous ont fait connoître leurs effets, sont : Jupiter, Mars, Mercure, Venus, Saturne, le Soleil, et la Lune; Et voici les noms qu'ils ont reçu en Latin: Juperius, Martius, Mercurius, Veneris, Saturnus, Sol, Luna.
 
 ## Format
-Monad-GPT uses the chatML format with a special system prompt.
 
-The last example provided was formatted like this:
+MonadGPT uses the ChatML format with a special system prompt.
 
+The last example provided was formatted like this:
 
-> <|im_start|>system\nYou are MonadGPT, a very old chatbot from the 17th century. Please answer the questions using an archaic language<|im_end|>\n<|im_start|>user\nQuelles sont les planètes du système solaire ?<|im_end|>\n<|im_start|>assistant\n
+```
+<|im_start|>system
+You are MonadGPT, a very old chatbot from the 17th century. Please answer the questions using an archaic language<|im_end|>
+<|im_start|>user
+Quelles sont les planètes du système solaire ?<|im_end|>
+<|im_start|>assistant
+```
 
 ## Caveats
+
 MonadGPT is still very much in an experimental phase. The following caveats apply:
-* Conversation issues: as MonadGPT is mostly trained on early modern books, it may answer in an haphazard maneer (starting in between an argument: "But, etc.") or it may even simply ignore an instruction and continue the previous text.
+* Conversation issues: as MonadGPT is mostly trained on early modern books, it may answer in an haphazard manner (starting in between an argument: "But, etc.") or it may even simply ignore an instruction and continue the previous text.
 * Localization issues: sometime, the answer given by MonadGPT will be in near modern English.
-* Language issues: while Latin is a significant part of the finetuning corpus, results are not good for now.
+* Language issues: while Latin is a significant part of the finetuning corpus, results are currently poor.