Update README.md

README.md

@@ -11,14 +11,25 @@ metrics:
 model-index:
 - name: distilbert-base-uncased-finetuned-FiNER
   results: []
+datasets:
+- nlpaueb/finer-139
+language:
+- en
+pipeline_tag: token-classification
 ---
 
-<!-- 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. -->
-
 # distilbert-base-uncased-finetuned-FiNER
 
-This model is a fine-tuned version of [distilbert/distilbert-base-uncased](https://huggingface.co/distilbert/distilbert-base-uncased) on an unknown dataset.
+This model is a fine-tuned version of [distilbert/distilbert-base-uncased](https://huggingface.co/distilbert/distilbert-base-uncased) trained on a subset of the [nlpaueb/finer-139](https://huggingface.co/datasets/nlpaueb/finer-139) dataset.
+The subset is generated by filtering the dataset to contain only samples with at least one of the following NER tags:
+* 'O',
+* 'B-DebtInstrumentBasisSpreadOnVariableRate1',
+* 'B-DebtInstrumentFaceAmount',
+* 'B-LineOfCreditFacilityMaximumBorrowingCapacity',
+* 'B-DebtInstrumentInterestRateStatedPercentage'
+
+Then, it was fine-tuned to detect only the afforementioned 4 tags (plus other "O")
+
 It achieves the following results on the evaluation set:
 - Loss: 0.0336
 - Precision: 0.9154
@@ -26,20 +37,28 @@ It achieves the following results on the evaluation set:
 - F1: 0.9240
 - Accuracy: 0.9917
 
+
 ## Model description
 
-More information needed
+Model based on [distilbert/distilbert-base-uncased](https://huggingface.co/distilbert/distilbert-base-uncased) with all default parameters.
 
 ## Intended uses & limitations
 
-More information needed
+The model published here was trained for demo purposes only.
 
 ## Training and evaluation data
 
-More information needed
+Original train/validation/test splits from [nlpaueb/finer-139](https://huggingface.co/datasets/nlpaueb/finer-139), after filtering for samples containing at least one of the following NER tags:
+* 'O',
+* 'B-DebtInstrumentBasisSpreadOnVariableRate1',
+* 'B-DebtInstrumentFaceAmount',
+* 'B-LineOfCreditFacilityMaximumBorrowingCapacity',
+* 'B-DebtInstrumentInterestRateStatedPercentage'
 
 ## Training procedure
 
+
+
 ### Training hyperparameters
 
 The following hyperparameters were used during training:
@@ -68,4 +87,4 @@ The following hyperparameters were used during training:
 - Transformers 4.38.2
 - Pytorch 2.2.1+cu121
 - Datasets 2.18.0
-- Tokenizers 0.15.2
+- Tokenizers 0.15.2