update model card README.md

README.md

@@ -0,0 +1,62 @@
+---
+license: apache-2.0
+tags:
+- generated_from_trainer
+metrics:
+- accuracy
+- f1
+model-index:
+- name: turkic-cyrillic-classifier
+  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. -->
+
+# turkic-cyrillic-classifier
+
+This model is a fine-tuned version of [bert-base-multilingual-uncased](https://huggingface.co/bert-base-multilingual-uncased) on an unknown dataset.
+It achieves the following results on the evaluation set:
+- Loss: 0.0078
+- Accuracy: 0.9981
+- F1: 0.9981
+
+## 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: 64
+- eval_batch_size: 64
+- seed: 42
+- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
+- lr_scheduler_type: linear
+- num_epochs: 2
+
+### Training results
+
+| Training Loss | Epoch | Step | Validation Loss | Accuracy | F1     |
+|:-------------:|:-----:|:----:|:---------------:|:--------:|:------:|
+| 0.0503        | 1.0   | 2229 | 0.0087          | 0.9975   | 0.9975 |
+| 0.0055        | 2.0   | 4458 | 0.0078          | 0.9981   | 0.9981 |
+
+
+### Framework versions
+
+- Transformers 4.24.0.dev0
+- Pytorch 1.12.1
+- Datasets 2.10.1
+- Tokenizers 0.13.1