Update README.md

README.md

@@ -1,3 +1,84 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-4.0
+task_categories:
+- text-classification
+language:
+- ka
+tags:
+- linguistics
+- morphology
+- case-alignment
+size_categories:
+- n<1K
+configs:
+- config_name: intransitive
+  data_files:
+  - split: train
+    path: "intransitive/train.csv"
+- config_name: transitive-s1-subj
+  data_files:
+  - split: train
+    path: "transitive-s1-subj/train.csv"
+- config_name: transitive-s1-obj
+  data_files:
+  - split: train
+    path: "transitive-s1-obj/train.csv"
+- config_name: transitive-s2-subj
+  data_files:
+  - split: train
+    path: "transitive-s2-subj/train.csv"
+- config_name: transitive-s2-obj
+  data_files:
+  - split: train
+    path: "transitive-s2-obj/train.csv"
+- config_name: transitive-s3-subj
+  data_files:
+  - split: train
+    path: "transitive-s3-subj/train.csv"
+- config_name: transitive-s3-obj
+  data_files:
+  - split: train
+    path: "transitive-s3-obj/train.parquet"
+---
+
+# Georgian Case-Alignment Dataset
+
+This dataset contains examples for testing Georgian case alignment patterns across different verb series and argument structures.
+
+## Dataset Structure
+
+### Configurations
+
+The dataset has 7 configurations corresponding to different grammatical contexts:
+
+- `intransitive`: Intransitive verb constructions
+- `transitive-s1-subj`: Series 1 transitive verbs, subject position
+- `transitive-s1-obj`: Series 1 transitive verbs, object position
+- `transitive-s2-subj`: Series 2 transitive verbs, subject position
+- `transitive-s2-obj`: Series 2 transitive verbs, object position
+- `transitive-s3-subj`: Series 3 transitive verbs, subject position
+- `transitive-s3-obj`: Series 3 transitive verbs, object position
+
+### Features
+
+Each configuration contains the following fields:
+
+- `sentence_id` (string): Unique identifier for the sentence
+- `match_id` (int32): Match identifier
+- `masked_text` (string): Sentence with masked argument
+- `form_grammatical` (string): Grammatically correct case form
+- `form_ungrammatical_*` (string): Ungrammatical case alternatives
+
+**Note:** The specific ungrammatical forms vary by configuration (nom/dat/erg combinations).
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+# Load a specific configuration
+dataset = load_dataset("your-username/georgian-case-alignment", "intransitive")
+
+# Load all configurations
+dataset = load_dataset("your-username/georgian-case-alignment")
+```