Update README.md

README.md

@@ -1,4 +1,11 @@
 ---
+language:
+- it
+- en
+- es
+- fr
+size_categories:
+- 10K<n<100K
 dataset_info:
 - config_name: en
   features:
@@ -8,8 +15,6 @@ dataset_info:
     dtype: int64
   - name: epigraph
     dtype: string
-  - name: body
-    dtype: string
   - name: decision
     dtype: string
   - name: maxims_text
@@ -27,105 +32,30 @@ dataset_info:
   - name: judgment_type
     dtype: int64
   - name: constitutional_parameters
-    dtype: string
+    sequence:
+      sequence: string
   - name: maxims
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 555145830
-    num_examples: 12600
-  - name: test
-    num_bytes: 30737608
-    num_examples: 700
-  - name: validation
-    num_bytes: 31671019
-    num_examples: 700
-  download_size: 278441383
-  dataset_size: 617554457
-- config_name: es
-  features:
-  - name: id
-    dtype: string
-  - name: ruling_type
-    dtype: int64
-  - name: epigraph
-    dtype: string
+    struct:
+    - name: numbers
+      sequence: float64
+    - name: texts
+      sequence: string
+    - name: titles
+      sequence: string
   - name: body
     dtype: string
-  - name: decision
-    dtype: string
-  - name: maxims_text
-    dtype: string
-  - name: maxims_title
-    dtype: string
-  - name: full_text
-    dtype: string
-  - name: num_maxims
-    dtype: int64
-  - name: maxims_len
-    dtype: int64
-  - name: full_text_len
-    dtype: int64
-  - name: judgment_type
-    dtype: int64
-  - name: constitutional_parameters
-    dtype: string
-  - name: maxims
-    dtype: string
   splits:
   - name: train
-    num_bytes: 575679719
-    num_examples: 12600
-  - name: test
-    num_bytes: 31896832
-    num_examples: 700
+    num_bytes: 2261057820
+    num_examples: 50400
   - name: validation
-    num_bytes: 32827830
-    num_examples: 700
-  download_size: 300803577
-  dataset_size: 640404381
-- config_name: fr
-  features:
-  - name: id
-    dtype: string
-  - name: ruling_type
-    dtype: int64
-  - name: epigraph
-    dtype: string
-  - name: body
-    dtype: string
-  - name: decision
-    dtype: string
-  - name: maxims_text
-    dtype: string
-  - name: maxims_title
-    dtype: string
-  - name: full_text
-    dtype: string
-  - name: num_maxims
-    dtype: int64
-  - name: maxims_len
-    dtype: int64
-  - name: full_text_len
-    dtype: int64
-  - name: judgment_type
-    dtype: int64
-  - name: constitutional_parameters
-    dtype: string
-  - name: maxims
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 580985816
-    num_examples: 12600
+    num_bytes: 128951061
+    num_examples: 2800
   - name: test
-    num_bytes: 32177379
-    num_examples: 700
-  - name: validation
-    num_bytes: 33152939
-    num_examples: 700
-  download_size: 306338176
-  dataset_size: 646316134
+    num_bytes: 125202513
+    num_examples: 2800
+  download_size: 1180085450
+  dataset_size: 2515211394
 - config_name: it
   features:
   - name: id
@@ -153,52 +83,201 @@ dataset_info:
   - name: judgment_type
     dtype: int64
   - name: constitutional_parameters
-    dtype: string
+    sequence:
+      sequence: string
   - name: maxims
-    dtype: string
+    struct:
+    - name: texts
+      sequence: string
+    - name: titles
+      sequence: string
+    - name: numbers
+      sequence: float64
   splits:
   - name: train
-    num_bytes: 557553146
+    num_bytes: 555460844
     num_examples: 12600
-  - name: test
-    num_bytes: 30850184
-    num_examples: 700
   - name: validation
-    num_bytes: 31775341
+    num_bytes: 31655527
+    num_examples: 700
+  - name: test
+    num_bytes: 30734422
     num_examples: 700
-  download_size: 293523614
-  dataset_size: 620178671
+  download_size: 293892604
+  dataset_size: 617850793
 configs:
 - config_name: en
   data_files:
   - split: train
     path: en/train-*
-  - split: test
-    path: en/test-*
   - split: validation
     path: en/validation-*
-- config_name: es
-  data_files:
-  - split: train
-    path: es/train-*
-  - split: test
-    path: es/test-*
-  - split: validation
-    path: es/validation-*
-- config_name: fr
-  data_files:
-  - split: train
-    path: fr/train-*
   - split: test
-    path: fr/test-*
-  - split: validation
-    path: fr/validation-*
+    path: en/test-*
 - config_name: it
   data_files:
   - split: train
     path: it/train-*
-  - split: test
-    path: it/test-*
   - split: validation
     path: it/validation-*
+  - split: test
+    path: it/test-*
 ---
+# Dataset Card for Dataset Name
+## Table of Contents
+- [Dataset Card for COMMA](#dataset-card-for-comma)
+  - [Table of Contents](#table-of-contents)
+  - [Dataset Description](#dataset-description)
+    - [Dataset Summary](#dataset-summary)
+    - [Languages](#languages)
+  - [Dataset](#dataset)
+    - [Data Fields](#data-fields)
+    - [Data Splits](#data-splits)
+  - [Dataset Sheet (Datasheet)](#dataset-sheet-datasheet)
+  - [Additional Information](#additional-information)
+    - [Dataset Curators](#dataset-curators)
+    - [Licensing Information](#licensing-information)
+    - [Citation Information](#citation-information)
+  - [Release History](#release-history)
+
+
+## Dataset Description
+
+- **Homepage:** 
+- **Repository:** 
+- **Paper:** 
+- **Leaderboard:** 
+- **Point of Contact:** 
+
+### Dataset Summary
+COMMA is a constitutional multi-task and multi-lingual archive consisting of 14K CCIR rulings with expert-authored annotations. It embodies distinctive features that render it a valuable object of study for broader NLP research.
+
+### Supported Tasks and Leaderboards
+
+[More Information Needed]
+
+### Languages
+Italian, English, Spanish, French
+
+
+## Dataset
+
+### Data Fields
+
+The dataset contains a list of instances (rulings); each instance contains the following data: 
+
+|                     Field |                                       Description |
+|-------------------------: | ------------------------------------------------: |
+|                        id |                             `(str)` The ruling ID |
+|               ruling_type |                           `(int)` The ruling type |
+|                  epigraph |                       `(str)` The ruling epigraph |
+|                      text |                           `(str)` The ruling text |
+|                  decision |                       `(str)` The ruling decision |
+|               maxims_text |                 `(str)` The text of ruling maxims |
+|              maxims_title |                `(str)` The title of ruling maxims |
+|                 full_text |                      `(str)` The ruling full_text |
+|                num_maxims |                      `(int)` The number of maxims |
+|                maxims_len |                      `(int)` The length of maxims |
+|             full_text_len |               `(int)` The length of the full text |
+|             judgment_type |                         `(int)` The judgment type |
+| constitutional_parameters | `(List[List[str]])` The constitutional parameters |
+|                    maxims |  `(dict)` The maxims' numbers, texts, and titles  |
+
+Please check the exemplar usage below for loading the data: 
+
+```python
+from datasets import load_dataset
+
+comma_en = load_dataset("disi-unibo-nlp/COMMA", "en")
+# Download comma_en locally and load it as a Dataset object.
+
+example = comma_en["validation"][0]  # The first instance of the dev set 
+example["full_text"]  # The full text (i.e., epigraph + text + decision) for the ruling
+
+print(example['maxims_title'])  # The corresponding maxims title for the ruling 
+```
+
+### Data Splits
+
+|          IT | Instances | 
+| ----------: | --------: | 
+| Train (90%) |    12,600 |               
+|   Test (5%) |       700 |               
+|    Dev (5%) |       700 |
+
+|          EN | Instances | 
+| ----------: | --------: | 
+| Train (90%) |    12,600 |               
+|   Test (5%) |       700 |               
+|    Dev (5%) |       700 |
+
+|          ES | Instances | 
+| ----------: | --------: | 
+| Train (90%) |    12,600 |               
+|   Test (5%) |       700 |               
+|    Dev (5%) |       700 |
+
+|          FR | Instances | 
+| ----------: | --------: | 
+| Train (90%) |    12,600 |               
+|   Test (5%) |       700 |               
+|    Dev (5%) |       700 |
+
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+
+[More Information Needed]