update model card README.md

README.md

@@ -0,0 +1,91 @@
+---
+license: apache-2.0
+tags:
+- generated_from_trainer
+datasets:
+- conll2003
+metrics:
+- precision
+- recall
+- f1
+- accuracy
+model-index:
+- name: ner-from-bert
+  results:
+  - task:
+      name: Token Classification
+      type: token-classification
+    dataset:
+      name: conll2003
+      type: conll2003
+      config: conll2003
+      split: train
+      args: conll2003
+    metrics:
+    - name: Precision
+      type: precision
+      value: 0.9350885908262957
+    - name: Recall
+      type: recall
+      value: 0.9503534163581285
+    - name: F1
+      type: f1
+      value: 0.9426592104164928
+    - name: Accuracy
+      type: accuracy
+      value: 0.9859451345146288
+---
+
+<!-- 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. -->
+
+# ner-from-bert
+
+This model is a fine-tuned version of [bert-base-cased](https://huggingface.co/bert-base-cased) on the conll2003 dataset.
+It achieves the following results on the evaluation set:
+- Loss: 0.0615
+- Precision: 0.9351
+- Recall: 0.9504
+- F1: 0.9427
+- Accuracy: 0.9859
+
+## 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: 8
+- eval_batch_size: 8
+- 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.0879        | 1.0   | 1756 | 0.0685          | 0.9170    | 0.9320 | 0.9245 | 0.9815   |
+| 0.0328        | 2.0   | 3512 | 0.0625          | 0.9267    | 0.9495 | 0.9380 | 0.9853   |
+| 0.0189        | 3.0   | 5268 | 0.0615          | 0.9351    | 0.9504 | 0.9427 | 0.9859   |
+
+
+### Framework versions
+
+- Transformers 4.25.1
+- Pytorch 1.13.0+cu116
+- Datasets 2.8.0
+- Tokenizers 0.13.2