Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,110 @@
+---
+language:
+- fr
+- gcf
+license: cc-by-4.0
+task_categories:
+- translation
+size_categories:
+- 1K<n<10K
+tags:
+- guadeloupean-creole
+- french
+- low-resource-language
+- caribbean
+pretty_name: Guadeloupean Creole-French Translation Dataset
+---
+
+# Guadeloupean Creole-French Translation Dataset
+
+## Dataset Description
+
+This dataset contains 2113 translation pairs between French and Guadeloupean Creole (Kreyòl Gwadloup) as part of the POTOMITAN project.
+in this v2, we have added the gcf audio file when available other thedefault value is paniaudio.mp3
+
+### Languages
+- French (fr)
+- Guadeloupean Creole (gcf)
+
+### Dataset Structure
+
+The dataset is in JSON format with the following structure:
+
+```json
+[
+  {
+    "id": "med1",
+    "fr": "Où avez-vous mal ?",
+    "gcf": "Ki koté ou ni mal ?",
+    "audio": "ou_mal.mp3",
+    "urgency": "critical",
+    "category": "medical",
+    "source": "static_data"
+  },
+]
+```
+
+### Fields
+- `id`: Unique identifier
+- `fr`: French text
+- `gcf`: Guadeloupean Creole translation
+- `audio`: Guadeloupean Creole audio
+- `urgency`: level of criticalité
+- `category`: (medical, secours, evacuation, information, etc.)
+- `source`: source du couple fr/gcf
+
+### Statistics
+- Total pairs: 2,058
+- Emergency contexts: 9
+- Categories: multiple (guadeloupean lesson, medical_emergency, natural_disaster, basic_needs)
+
+### Dataset Sources
+- Assimil guide language lessons
+- Emergency phrase translations
+- Common conversational expressions
+
+### Potential Applications
+- Machine translation systems
+- Language learning applications
+- Emergency response systems
+- Cultural preservation initiatives
+- Linguistic research
+
+## Usage
+
+```python
+import json
+
+with open('gcf_fr_translation_dataset.json', 'r', encoding='utf-8') as f:
+    data = json.load(f)
+
+for pair in data['pairs']:
+    print(f"French: {pair['fr']}")
+    print(f"Creole: {pair['gcf']}")
+```
+
+## Citation
+
+If you use this dataset, please cite:
+
+```
+@dataset{potomitan_gcf_fr_2025,
+  title={Guadeloupean Creole-French Translation Dataset},
+  author={POTOMITAN Project},
+  year={2025},
+  publisher={POTOMITAN PROJECT TEAM}
+}
+```
+
+## License
+
+This dataset is licensed under CC BY 4.0.
+
+## Contact
+
+For questions or collaboration, please contact the POTOMITAN project team:
+- GitHub: https://github.com/Brdcie/creoles-translation
+
+## Acknowledgments
+
+Special thanks to all contributors who helped collect and verify these translations.