darija-translation / README.md
imomayiz's picture
Update README.md
5e07588 verified
metadata
license: cc
task_categories:
  - translation
language:
  - ar
  - fr
  - en

Welcome to the AtlasIA Darija Translation repo!

This repository is part of an open-source initiative aimed at collecting a dataset for Darija-English translation. Our project involves using the interface https://atlasia.ma for collecting and storing the data. Here's an overview of how our project works:

Project Overview:

  • Translation Interface: Using the user-friendly interface of AtlasIA, we present Darija sentences for translation, then contributors provide translations in English or French for the given Darija sentences.
  • Additional Features: Optionally, contributors can also provide audio recordings of the Darija sentences, along with a confidence level associated with the translation.
  • Data Storage: The collected data, including Darija sentences, translations, audio recordings, and confidence levels, are stored initially in a Firestore DB. After processing, the data is moved to this repository to be open-sourced.

How to Contribute:

  • Visit AtlasIA.
  • Translate Sentences: Read the provided sentence, select the translation language (EN/FR), and translate the sentence into the chosen language.
  • Optional Features: Contributors can record an audio reading of the original sentence (optional) and submit.
  • Reporting Incorrect Sentences: If you encounter an incorrect sentence, you can use the "Report" button to send an alert about it.
  • Pre-Processing: Before adding data to this repo, our team will pre-process it to ensure data quality and consistency.
  • Contributions Welcome: We invite contributions from individuals interested in Darija-English translation. Feel free to join our efforts by contributing translations or improving the dataset.

Dataset Structure:

The dataset is organized in a structured format, with each entry containing:

  • Darija Sentence
  • English or French Translation
  • Optional Audio Recording
  • Confidence Level

License:

This dataset is released under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0). It is open to everyone for research and open-source work.

Contact Us:

If you have any questions, suggestions, or feedback regarding the dataset or project, please don't hesitate to contact one of the project collaborators or join our Discord community.

Thank you for your interest and contribution to the Darija-English Translation Dataset!