Update README.md

README.md

@@ -10,16 +10,19 @@ metrics:
 - f1
 - accuracy
 model-index:
-- name: test-ner
+- name: whataboutyou-ai/financial_bert
   results: []
+language:
+- en
+datasets:
+- expertai/BUSTER
 ---
 
-<!-- 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. -->
-
 # financial_bert
 
-This model is a fine-tuned version of [bert-base-uncased](https://huggingface.co/bert-base-uncased) on an unknown dataset.
+This model is a fine-tuned version of [bert-base-uncased](https://huggingface.co/bert-base-uncased) on the [BUSTER](https://huggingface.co/datasets/expertai/BUSTER) dataset.
+This model is ready to use for **Named Entity Recognition** (NER).
+
 It achieves the following results on the evaluation set:
 - Loss: 0.0201
 - Precision: 0.7977
@@ -37,7 +40,25 @@ More information needed
 
 ## Training and evaluation data
 
-More information needed
+This model was fine-tuned on the [BUSTER](https://huggingface.co/datasets/expertai/BUSTER) dataset. 
+
+The training dataset distinguishes between the beginning and continuation of an entity so that if there are back-to-back entities of the same type, the model can output where the second entity begins. As in the dataset, each token will be classified as one of the following classes:
+
+Entity|Description
+-|-
+O|Outside of a named entity
+B-Generic_Info.ANNUAL_REVENUES|Beginning of annual revenues entity
+I-Generic_Info.ANNUAL_REVENUES|Continuation of annual revenues entity
+B-Parties.ACQUIRED_COMPANY|Beginning of acquired company entity
+I-Parties.ACQUIRED_COMPANY|Continuation of acquired company entity
+B-Parties.BUYING_COMPANY|Beginning of buying company entity
+I-Parties.BUYING_COMPANY|Continuation of buying company entity
+B-Parties.SELLING_COMPANY|Beginning of selling company entity
+I-Parties.SELLING_COMPANY|Continuation of selling company entity
+B-Advisors.GENERIC_CONSULTING_COMPANY|Beginning of generic consulting company entity
+I-Advisors.GENERIC_CONSULTING_COMPANY|Continuation of generic consulting company entity
+B-Advisors.LEGAL_CONSULTING_COMPANY|Beginning of legal consulting company entity
+I-Advisors.LEGAL_CONSULTING_COMPANY|Continuation of legal consulting company entity
 
 ## Training procedure
 
@@ -61,4 +82,4 @@ The following hyperparameters were used during training:
 - Transformers 4.48.0.dev0
 - Pytorch 2.5.1
 - Datasets 3.1.0
-- Tokenizers 0.21.0
+- Tokenizers 0.21.0