Update README.md

README.md

@@ -1,22 +1,85 @@
----
-license: cc-by-4.0
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-dataset_info:
-  features:
-  - name: sentence1
-    dtype: string
-  - name: sentence2
-    dtype: string
-  - name: lable
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 9761971
-    num_examples: 74862
-  download_size: 2998202
-  dataset_size: 9761971
----
+---
+license: cc-by-4.0
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-*
+dataset_info:
+  features:
+  - name: sentence1
+    dtype: string
+  - name: sentence2
+    dtype: string
+  - name: lable
+    dtype: int64
+  splits:
+  - name: train
+    num_bytes: 9761971
+    num_examples: 74862
+  download_size: 2998202
+  dataset_size: 9761971
+task_categories:
+- token-classification
+language:
+- az
+tags:
+- nli
+pretty_name: AzNLI Benchmark
+size_categories:
+- 10K<n<100K
+---
+
+# AzNLI-Benchmark: Azerbaijani Natural Language Inference
+
+This repository contains the AzNLI benchmark dataset for Natural Language Inference (NLI) in the Azerbaijani language. NLI is a fundamental task in natural language understanding where the goal is to determine the logical relationship between two sentences.
+
+## Dataset Overview
+
+The AzNLI benchmark consists of sentence pairs in Azerbaijani, where each pair is labeled according to the logical relationship between the first sentence (premise) and the second sentence (hypothesis).
+
+## Format
+
+The dataset is provided in CSV format with the following columns:
+- `sentence1`: The premise sentence in Azerbaijani
+- `sentence2`: The hypothesis sentence in Azerbaijani
+- `label`: The relationship label (0, 1, or 2)
+
+## Label Definitions
+
+The labels indicate the following relationships:
+
+- **0**: Entailment - The hypothesis is definitely true given the premise
+- **1**: Neutral - The hypothesis may or may not be true given the premise  
+- **2**: Contradiction - The hypothesis is definitely false given the premise
+
+## Example
+
+```csv
+sentence1,sentence2,label
+Məktəb digər mədəniyyətlərlə məclislərdə necə davranıldığını nümayiş etdirmək üçün Amerika mədəniyyətini göstərən xüsusi bir tədbir keçirir.,Bir məktəb basketbol oyunu təşkil edir.,2
+Məktəb digər mədəniyyətlərlə məclislərdə necə davranıldığını nümayiş etdirmək üçün Amerika mədəniyyətini göstərən xüsusi bir tədbir keçirir.,Bir orta məktəb bir tədbir keçirir.,1
+Məktəb digər mədəniyyətlərlə məclislərdə necə davranıldığını nümayiş etdirmək üçün Amerika mədəniyyətini göstərən xüsusi bir tədbir keçirir.,Bir məktəb bir tədbir keçirir.,0
+```
+
+In the example above:
+- The first pair shows contradiction: a cultural event about American culture contradicts a basketball game
+- The second pair shows neutral relationship: a middle school event is neither confirmed nor denied by the premise
+- The third pair shows entailment: a school holding an event is directly implied by the premise
+
+## Usage
+
+This dataset can be used for:
+- Training and evaluating NLI models for Azerbaijani
+- Cross-lingual transfer learning experiments
+- Studying natural language understanding in low-resource languages
+- Benchmarking multilingual models on Azerbaijani NLI
+
+## License
+
+[CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/)
+
+
+## Contact
+
+For more information, questions, or issues, please contact LocalDoc at [v.resad.89@gmail.com].