Update README.md

README.md

@@ -1,23 +1,28 @@
 ---
-tags:
-- autotrain
-- text-generation
-widget:
-- text: "I love AutoTrain because "
-license: other
----
+license: afl-3.0
+
+language: 
+- yo
 
-# Model Trained Using AutoTrain
+datasets:
+- afriqa
+- xlsum
+- menyo20k_mt
+- alpaca-gpt4
+---
 
-This model was trained using AutoTrain. For more information, please visit [AutoTrain](https://hf.co/docs/autotrain).
+# Model Description
+**mistral_7b_yo_instruct** is a **text generation** model in Yorùbá. 
 
-# Usage
+## Intended uses & limitations
+#### How to use
+You can use this model with Transformers.
 
 ```python
 
 from transformers import AutoModelForCausalLM, AutoTokenizer
 
-model_path = "PATH_TO_THIS_REPO"
+model_path = "seyabde/mistral_7b_yo_instruct"
 
 tokenizer = AutoTokenizer.from_pretrained(model_path)
 model = AutoModelForCausalLM.from_pretrained(
@@ -37,4 +42,24 @@ response = tokenizer.decode(output_ids[0][input_ids.shape[1]:], skip_special_tok
 
 # Model response: "Hello! How can I assist you today?"
 print(response)
-```
+```
+
+## Eval results
+Coming soon
+
+#### Limitations and bias
+This model is limited by its training dataset of entity-annotated news articles from a specific span of time. This may not generalize well for all use cases in different domains.  
+
+## Training data
+This model is fine-tuned on 60k+ instruction-following demonstrations built from an aggregation of datasets ([AfriQA](https://huggingface.co/datasets/masakhane/afriqa), [XLSum](https://huggingface.co/datasets/csebuetnlp/xlsum), [MENYO-20k](https://huggingface.co/datasets/menyo20k_mt)), and translations of [Alpaca-gpt4](https://huggingface.co/datasets/vicgalle/alpaca-gpt4)).
+
+### BibTeX entry and citation info
+```
+@article{
+  title={},
+  author={},
+  journal={},
+  year={},
+  volume={}
+}
+```