Rename README.md to readme

README.md

@@ -1,25 +0,0 @@
----
-license: apache-2.0
-datasets:
-- Kundyzka/informatics_kaz
-language:
-- kk
-metrics:
-  - name: exact_match
-    type: Exact Match
-    value: 13.116
-  - name: f1
-    type: F1 Score
-    value: 26.950
-  - name: exact_match_test
-    type: Exact Match (Test)
-    value: 49.740
-  - name: f1_test
-    type: F1 Score (Test)
-    value: 70.127
-base_model:
-- FacebookAI/xlm-roberta-large
-pipeline_tag: question-answering
-tags:
-- computerscience
----

readme

@@ -0,0 +1,53 @@
+---
+license: apache-2.0
+datasets:
+- Kundyzka/informatics_kaz
+language:
+- kk
+metrics:
+  - name: exact_match
+    type: Exact Match
+    value: 13.116
+  - name: f1
+    type: F1 Score
+    value: 26.950
+  - name: exact_match_test
+    type: Exact Match (Test)
+    value: 49.740
+  - name: f1_test
+    type: F1 Score (Test)
+    value: 70.127
+base_model:
+- FacebookAI/xlm-roberta-large
+pipeline_tag: question-answering
+tags:
+- computerscience
+# Description
+This model was developed by **Kundyz Maksutova**, PhD Candidate, as part of research on question-answering systems in the Kazakh language. It is a fine-tuned version of `FacebookAI/xlm-roberta-large` on the `Kundyzka/informatics_kaz` dataset, tailored for the domain of computer science.
+
+### Key Features:
+- **Base Model**: `FacebookAI/xlm-roberta-large`
+- **Dataset**: `Kundyzka/informatics_kaz`
+- **Language**: Kazakh (`kk`)
+- **Task**: Question Answering (`pipeline_tag: question-answering`)
+- **Performance**:
+  - Validation:
+    - F1 Score: 26.950
+    - Exact Match: 13.116
+  - Test:
+    - F1 Score: 70.127
+    - Exact Match: 49.740
+
+### Intended Use:
+This model is intended for use in question-answering systems, particularly in the domain of computer science and related fields. It can handle questions and provide accurate answers in the Kazakh language, making it an ideal tool for educational, research, and application development purposes.
+
+### Limitations and Ethical Considerations:
+- The model may reflect biases present in the training dataset.
+- It is optimized for the Kazakh language and may not perform well with other languages.
+- It is recommended to validate the model's performance on domain-specific tasks before deployment.
+
+### Tags:
+This model is tagged with `computerscience` for better discoverability and categorization.
+
+For more details, fine-tuning instructions, or adaptation to other tasks, feel free to explore the model's repository.
+---