Update README.md

README.md

@@ -1,3 +1,151 @@
----
-license: cc-by-4.0
----
+---
+language:
+- ca
+- arn
+multilinguality:
+- multilingual
+pretty_name: Catalan-Aranese Parallel Corpus
+size_categories:
+- 100M<n<1B
+task_categories:
+- translation
+license: cc-by-4.0
+---
+# Dataset Card for Catalan-Aranese Parallel Corpus
+
+## Dataset Description
+
+- **Point of Contact:** langtech@bsc.es
+
+
+### Dataset Summary
+
+Parallel corpus covering the low-resource language pair Catalan-Aranese. Built by aggregating and filtering multiple public sources, it provides sentence-level alignments for training Machine Translation systems. The dataset includes synthetic Catalan translations generated from Aranese using [SalamandraTA 7B Instruct](https://huggingface.co/BSC-LT/salamandra-7b-instruct).
+
+### Supported Tasks and Leaderboards
+
+The dataset is primarily designed for Machine Translation between Catalan and Aranese. Typical uses include supervised MT training, fine-tuning multilingual models, and data augmentation.
+
+### Languages
+
+The dataset includes parallel sentences across the following language pairs:
+
+| Language pair     | Codes | Size (sentences)
+|-------------------|-------|------------------
+| Catalan-Aranese    | ca-arn |                 539,110
+
+## Dataset Structure
+
+### Data Instances
+
+The dataset is provided in tsv format. Each row contains a parallel sentence pair with the following structure:
+
+```json
+{
+  "l1_sentence": "Example sentence in first language",
+  "l2_sentence": "Example sentence in second language",
+  "l1": "en",
+  "l2": "es"
+}
+```
+
+### Data Fields
+
+- `l1_sentence`: The sentence in the first language (string)
+- `l2_sentence`: The parallel sentence in the second language (string)
+- `l1`: ISO 639-1 code of the first language (string)
+- `l2`: ISO 639-1 code of the second language (string)
+
+### Data Splits
+
+The dataset contains a single split: `train`.
+
+## Dataset Creation
+
+### Curation Rationale
+
+This dataset is aimed at promoting the development of Machine Translation between Catalan and Aranese, supporting research in bilingual and multilingual NLP, and facilitating the development of translation systems for low-resource language pairs.
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+The corpus is a combination of the following original datasets collected via direct datasharing agreements between the BSC and other parties, as well as public web-based sources:
+
+- **DOGC**: Parallel sentences extracted from Diari Oficial de la Generalitat de Catalunya
+- **Jordi Suils Translations**: Add description
+- **Pilar**: Pan-Iberian Language Archival Resource corpus
+- **IEA**: Sentences from Institut d'Estudis Aranesi
+- **Conselh News Articles**: Parallel sentences extracted from Conselh Generau d'Aran
+- **Edictes**: Add description
+- **Escaletas TV3**: Add description
+
+**Synthetic Data Generation:**
+
+For monolingual Aranese data, synthetic Catalan parallel data was created by translating using [SalamandraTA 7B Instruct](https://huggingface.co/BSC-LT/salamandra-7b-instruct).
+
+**Data Filtering and Normalization:**
+
+The data underwent minimal filtering due to data scarcity:
+- **Alignment filtering**: Sentence-level alignments were calculated using [LaBSE](https://huggingface.co/sentence-transformers/LaBSE), and sentence pairs with a similarity score below 0.75 were discarded.
+- **Language identification**: The probability of being the target language was calculated using [Lingua.py](https://github.com/pemistahl/lingua-py), and sentences with a language probability score below 0.5 were discarded.
+- **Normalization**: Text was minimally normalized using [Bifixer](https://github.com/bitextor/bifixer) to ensure consistency and quality.
+- **Deduplication**: The filtered datasets were deduplicated to remove redundant sentence pairs.
+
+The filtered and normalized datasets were then concatenated to form the final corpus.
+
+#### Who are the source language producers?
+
+- Various open-source and institutional contributors
+
+### Annotations
+
+#### Annotation process
+
+The dataset does not contain any manual annotations beyond the parallel alignments, which were either preserved from source datasets or validated through automated alignment scoring.
+
+#### Who are the annotators?
+
+[N/A]
+
+### Personal and Sensitive Information
+
+Given that this dataset is derived from pre-existing datasets that may contain crawled data, and that no specific anonymisation process has been applied, personal and sensitive information may be present in the data. This needs to be considered when using the data for training models.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+By providing this large-scale multilingual resource, we intend to promote multilingual NLP research and improve the accessibility of machine translation for the included languages, particularly for language pairs that may be underrepresented in existing resources. This contributes to reducing language barriers and supporting linguistic diversity in NLP applications.
+
+### Discussion of Biases
+
+No specific bias mitigation strategies were applied to this dataset beyond quality filtering. Inherent biases may exist within the data, reflecting the biases present in the source datasets, which include web-crawled content, subtitles, news articles, and other user-generated or institutionally produced text. Users should be aware that the es-hi and es-zh datasets contain synthetically generated Spanish text, which may reflect biases present in the translation model used.
+
+### Other Known Limitations
+
+The dataset contains data of a general domain. Application of this dataset in more specific domains such as biomedical, legal, technical, or other specialized fields would be of limited use. Additionally, the synthetic Spanish data in es-hi and es-zh pairs may not achieve the same quality or naturalness as naturally parallel data.
+
+## Additional Information
+
+### Dataset Curators
+
+Language Technologies Unit at the Barcelona Supercomputing Center (langtech@bsc.es).
+
+### Funding
+
+This work is funded by the Ministerio para la Transformación Digital y de la Función Pública - Funded by EU – NextGenerationEU within the framework of the project Desarrollo de Modelos ALIA.
+
+
+### Licensing Information
+
+This work is licensed under a [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) licence.
+
+
+### Citation Information
+
+[N/A]
+
+### Contributions
+
+[N/A]