update model card README.md

README.md

@@ -0,0 +1,70 @@
+---
+license: mit
+tags:
+- generated_from_trainer
+datasets:
+- harem
+metrics:
+- precision
+- recall
+- f1
+- accuracy
+model-index:
+- name: bert-base-portuguese-cased_harem-selective-CRF-first-ner
+  results: []
+---
+
+<!-- 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-base-portuguese-cased_harem-selective-CRF-first-ner
+
+This model is a fine-tuned version of [neuralmind/bert-base-portuguese-cased](https://huggingface.co/neuralmind/bert-base-portuguese-cased) on the harem dataset.
+It achieves the following results on the evaluation set:
+- Loss: 0.2045
+- Precision: 0.5352
+- Recall: 0.4351
+- F1: 0.48
+- Accuracy: 0.9484
+
+## Model description
+
+More information needed
+
+## Intended uses & limitations
+
+More information needed
+
+## Training and evaluation data
+
+More information needed
+
+## Training procedure
+
+### Training hyperparameters
+
+The following hyperparameters were used during training:
+- learning_rate: 2e-05
+- train_batch_size: 2
+- eval_batch_size: 2
+- seed: 42
+- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- lr_scheduler_type: linear
+- lr_scheduler_warmup_ratio: 0.1
+- num_epochs: 3
+
+### Training results
+
+| Training Loss | Epoch | Step | Validation Loss | Precision | Recall | F1     | Accuracy |
+|:-------------:|:-----:|:----:|:---------------:|:---------:|:------:|:------:|:--------:|
+| 0.102         | 1.0   | 2517 | 0.2498          | 0.4367    | 0.3817 | 0.4073 | 0.9332   |
+| 0.0614        | 2.0   | 5034 | 0.1842          | 0.4756    | 0.4084 | 0.4394 | 0.9408   |
+| 0.0455        | 3.0   | 7551 | 0.2045          | 0.5352    | 0.4351 | 0.48   | 0.9484   |
+
+
+### Framework versions
+
+- Transformers 4.18.0
+- Pytorch 1.10.2+cu102
+- Datasets 2.2.2
+- Tokenizers 0.12.1