Update README.md

README.md

@@ -16,9 +16,9 @@ model-index:
 <!-- 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. -->
 
-# bert-finetuned-ner-ontonotes5
+# Model Description
 
-This model is a fine-tuned version of [dslim/bert-base-NER](https://huggingface.co/dslim/bert-base-NER) on an unknown dataset.
+This model is a fine-tuned version of [dslim/bert-base-NER](https://huggingface.co/dslim/bert-base-NER) on OntoNotes 5 dataset and is designed to identify and classify various types of entities in text, including persons, organizations, locations, dates, and more.
 It achieves the following results on the evaluation set:
 - Loss: 0.1634
 - Precision: 0.8620
@@ -26,19 +26,56 @@ It achieves the following results on the evaluation set:
 - F1: 0.8733
 - Accuracy: 0.9758
 
-## Model description
-
-More information needed
-
 ## Intended uses & limitations
 
-More information needed
+The model is intended for use in applications requiring NER, such as information extraction, text classification, and enhancing search capabilities by identifying key entities within the text. It can be used to identify entities in any English text, including news articles, social media posts, and legal documents.
+
 
 ## Training and evaluation data
 
-More information needed
+Training Data
+The model was fine-tuned on the OntoNotes 5 dataset. This dataset includes multiple types of named entities and is widely used for NER tasks. The dataset is annotated with the following entity tags:
+
+CARDINAL: Numerical values
+
+DATE: References to dates and periods
+
+PERSON: Names of people
+
+NORP: Nationalities, religious groups, political groups
+
+GPE: Countries, cities, states
+
+LAW: Named documents and legal entities
+
+ORG: Organizations
+
+PERCENT: Percentage values
+
+ORDINAL: Ordinal numbers
+
+MONEY: Monetary values
+
+WORK_OF_ART: Titles of creative works
 
-## Training procedure
+FAC: Facilities
+
+TIME: Times smaller than a day
+
+LOC: Non-GPE locations, mountain ranges, bodies of water
+
+QUANTITY: Measurements, as of weight or distance
+
+PRODUCT: Objects, vehicles, foods, etc. (not services)
+
+EVENT: Named events
+
+LANGUAGE: Named languages
+
+## Model Configuration
+Base Model: dslim/bert-base-NER
+
+Number of Labels: 37 (including the "O" tag for outside any named entity)
 
 ### Training hyperparameters
 
@@ -68,3 +105,15 @@ The following hyperparameters were used during training:
 - Pytorch 2.3.0+cu121
 - Datasets 2.20.0
 - Tokenizers 0.19.1
+
+## Contact Information
+
+For questions, comments, or issues with the model, please contact:
+
+Name: [Irechukwu Nkweke]
+Email: [[email protected]]
+GitHub: [https://github.com/mnkweke]
+
+## Acknowledgments
+
+This model was trained using the Hugging Face transformers library and the OntoNotes 5 dataset.