Update README.md

README.md

@@ -1,12 +1,28 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- sentiment-analysis
+- text-classification
+- multilingual
+- nollywood
+datasets:
+- Davlan/nollysenti
+language:
+- yo
+- en
+- ig
+- ha
+metrics:
+- accuracy
+base_model:
+- google-bert/bert-base-multilingual-cased
+pipeline_tag: text-classification
 ---
 
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
-
+This is a sentiment classification model fine-tuned on the NollySenti dataset provided by David Adelani for test. It is designed to classify the sentiment of movie reviews in multiple Nigerian languages and English
 
 
 ## Model Details
@@ -14,22 +30,25 @@ tags: []
 ### Model Description
 
 <!-- Provide a longer summary of what this model is. -->
+This model is a fine-tuned version of the bert-base-multilingual-cased model for sentiment classification. It was trained on the NollySenti dataset, which contains movie reviews in English, Hausa, Igbo, Nigerian Pidgin, and Yoruba, labeled as either positive or negative sentiment.
+
+
 
 This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
-- **Developed by:** [More Information Needed]
+- **Developed by:** [Samuel Oyerinde]
 - **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
+- **Shared by [optional]:** [Sam4rano]
+- **Model type:** [BertForSequenceClassification]
+- **Language(s) (NLP):** [English, Hausa, Igbo, Nigerian Pidgin (pcm), Yoruba (yo)]
 - **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Finetuned from model [optional]:** [bert-base-multilingual-cased]
 
 ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
+- **Repository:** [https://huggingface.co/Sam4rano/nollysenti_classifier]
 - **Paper [optional]:** [More Information Needed]
 - **Demo [optional]:** [More Information Needed]
 
@@ -53,7 +72,7 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+[This model is specifically trained for movie review sentiment analysis. It may not perform well on text from other domains or in languages it was not trained on. Using it for sensitive applications without further evaluation and fine-tuning is not recommended.]
 
 ## Bias, Risks, and Limitations