update model card README.md

README.md

@@ -0,0 +1,89 @@
+---
+license: apache-2.0
+tags:
+- generated_from_trainer
+datasets:
+- conll2003
+metrics:
+- precision
+- recall
+- f1
+- accuracy
+model-index:
+- name: distilbert-base-uncased-finetuned-ner
+  results:
+  - task:
+      name: Token Classification
+      type: token-classification
+    dataset:
+      name: conll2003
+      type: conll2003
+      args: conll2003
+    metrics:
+    - name: Precision
+      type: precision
+      value: 0.9255213505461768
+    - name: Recall
+      type: recall
+      value: 0.9383599955252265
+    - name: F1
+      type: f1
+      value: 0.931896455949339
+    - name: Accuracy
+      type: accuracy
+      value: 0.9840977330134876
+---
+
+<!-- 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-ner
+
+This model is a fine-tuned version of [distilbert-base-uncased](https://huggingface.co/distilbert-base-uncased) on the conll2003 dataset.
+It achieves the following results on the evaluation set:
+- Loss: 0.0582
+- Precision: 0.9255
+- Recall: 0.9384
+- F1: 0.9319
+- Accuracy: 0.9841
+
+## 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: 16
+- eval_batch_size: 16
+- seed: 42
+- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- lr_scheduler_type: linear
+- num_epochs: 3
+
+### Training results
+
+| Training Loss | Epoch | Step | Validation Loss | Precision | Recall | F1     | Accuracy |
+|:-------------:|:-----:|:----:|:---------------:|:---------:|:------:|:------:|:--------:|
+| 0.2429        | 1.0   | 878  | 0.0697          | 0.9094    | 0.9182 | 0.9138 | 0.9805   |
+| 0.0555        | 2.0   | 1756 | 0.0581          | 0.9206    | 0.9351 | 0.9278 | 0.9833   |
+| 0.0296        | 3.0   | 2634 | 0.0582          | 0.9255    | 0.9384 | 0.9319 | 0.9841   |
+
+
+### Framework versions
+
+- Transformers 4.18.0
+- Pytorch 1.10.0+cu111
+- Datasets 2.0.0
+- Tokenizers 0.11.6