ZomiLanguage commited on
Commit
e48c3fc
ยท
verified ยท
1 Parent(s): efeff42

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +48 -123
README.md CHANGED
@@ -1,141 +1,66 @@
1
  ---
 
 
 
2
  license: apache-2.0
 
 
 
 
 
 
 
 
 
 
 
 
3
  ---
4
 
5
- # Dataset Card for Dataset Name
6
 
7
- <!-- Provide a quick summary of the dataset. -->
8
 
9
- This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
 
10
 
11
- ## Dataset Details
12
-
13
- ### Dataset Description
14
-
15
- <!-- Provide a longer summary of what this dataset is. -->
16
-
17
-
18
-
19
- - **Curated by:** [More Information Needed]
20
- - **Funded by [optional]:** [More Information Needed]
21
- - **Shared by [optional]:** [More Information Needed]
22
- - **Language(s) (NLP):** [More Information Needed]
23
- - **License:** [More Information Needed]
24
-
25
- ### Dataset Sources [optional]
26
-
27
- <!-- Provide the basic links for the dataset. -->
28
-
29
- - **Repository:** [More Information Needed]
30
- - **Paper [optional]:** [More Information Needed]
31
- - **Demo [optional]:** [More Information Needed]
32
-
33
- ## Uses
34
-
35
- <!-- Address questions around how the dataset is intended to be used. -->
36
-
37
- ### Direct Use
38
-
39
- <!-- This section describes suitable use cases for the dataset. -->
40
-
41
- [More Information Needed]
42
-
43
- ### Out-of-Scope Use
44
-
45
- <!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
46
-
47
- [More Information Needed]
48
-
49
- ## Dataset Structure
50
-
51
- <!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
52
-
53
- [More Information Needed]
54
-
55
- ## Dataset Creation
56
-
57
- ### Curation Rationale
58
-
59
- <!-- Motivation for the creation of this dataset. -->
60
-
61
- [More Information Needed]
62
-
63
- ### Source Data
64
-
65
- <!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
66
-
67
- #### Data Collection and Processing
68
-
69
- <!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
70
-
71
- [More Information Needed]
72
-
73
- #### Who are the source data producers?
74
-
75
- <!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
76
-
77
- [More Information Needed]
78
-
79
- ### Annotations [optional]
80
-
81
- <!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
82
-
83
- #### Annotation process
84
-
85
- <!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
86
-
87
- [More Information Needed]
88
-
89
- #### Who are the annotators?
90
-
91
- <!-- This section describes the people or systems who created the annotations. -->
92
-
93
- [More Information Needed]
94
-
95
- #### Personal and Sensitive Information
96
-
97
- <!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
98
-
99
- [More Information Needed]
100
-
101
- ## Bias, Risks, and Limitations
102
-
103
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
104
-
105
- [More Information Needed]
106
-
107
- ### Recommendations
108
-
109
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
110
-
111
- Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
112
-
113
- ## Citation [optional]
114
-
115
- <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
116
-
117
- **BibTeX:**
118
-
119
- [More Information Needed]
120
 
121
- **APA:**
122
 
123
- [More Information Needed]
 
124
 
125
- ## Glossary [optional]
 
 
 
126
 
127
- <!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
128
 
129
- [More Information Needed]
 
 
 
130
 
131
- ## More Information [optional]
 
 
132
 
133
- [More Information Needed]
134
 
135
- ## Dataset Card Authors [optional]
136
 
137
- [More Information Needed]
138
 
139
- ## Dataset Card Contact
 
 
 
140
 
141
- [More Information Needed]
 
 
 
 
 
 
1
  ---
2
+ language:
3
+ - ctd
4
+ - en
5
  license: apache-2.0
6
+ task_categories:
7
+ - translation
8
+ - text-generation
9
+ - fill-mask
10
+ tags:
11
+ - zomi
12
+ - low-resource
13
+ - neural-machine-translation
14
+ - culture-preservation
15
+ pretty_name: Zomi-English Parallel Corpus
16
+ size_categories:
17
+ - 1K<n<10K
18
  ---
19
 
20
+ # ๐ŸŒ Zomi-English Parallel Corpus (ZomiLanguage)
21
 
22
+ ![License](https://img.shields.io/badge/License-Apache_2.0-green.svg) ![Language](https://img.shields.io/badge/Language-Zomi_(Tedim)-blue) ![Task](https://img.shields.io/badge/Task-Machine_Translation-orange) ![Status](https://img.shields.io/badge/Status-Active_Development-brightgreen)
23
 
24
+ > **"Preserving Identity Through Technology."**
25
+ > This dataset is the foundational block for the **Zomi AI Initiative**, aiming to bridge the digital divide for the Zomi people by providing high-quality, open-source training data for Neural Machine Translation (NMT).
26
 
27
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
 
29
+ ## ๐Ÿ“Š Dataset Details
30
 
31
+ ### Dataset Description
32
+ This dataset contains parallel sentences aligned between **English** and the **Zomi language** (specifically the *Tedim* dialect, the lingua franca of the Zomi people). It allows researchers and developers to train AI models to translate, understand, and generate Zomi text, moving the language from "low-resource" to "digitally vital."
33
 
34
+ - **Curated by:** Zomi Language & AI Initiative (Disciple Sian)
35
+ - **Language(s):** English (`en`), Zomi (`ctd`/`zom`)
36
+ - **License:** Apache License 2.0
37
+ - **Task:** Machine Translation (En โ†” Zomi)
38
 
39
+ ### ๐Ÿš€ Uses
40
 
41
+ #### Direct Use
42
+ - **Neural Machine Translation (NMT):** Fine-tuning models like Meta's NLLB-200, MarianMT, or mBART.
43
+ - **Linguistic Analysis:** Comparative studies between Chin-Kuki-Mizo languages and English.
44
+ - **Educational Tools:** Building dictionary apps or flashcards for language learners.
45
 
46
+ #### Out-of-Scope Use
47
+ - **Medical/Legal Advice:** The dataset contains general domain text and should not be relied upon for critical medical or legal translation without human verification.
48
+ - **Profanity Generation:** The dataset is filtered for cultural appropriateness.
49
 
50
+ ---
51
 
52
+ ## ๐Ÿ“‚ Dataset Structure
53
 
54
+ The dataset is formatted in **CSV (Comma Separated Values)**, optimized for simplicity and compatibility with the Hugging Face `datasets` library.
55
 
56
+ | Column Name | Type | Description |
57
+ |:------------|:-------|:-------------------------------------------------|
58
+ | `english` | String | The source sentence in English. |
59
+ | `zomi` | String | The translation in Zomi (Standard Tedim spelling)|
60
 
61
+ **Example Data:**
62
+ ```json
63
+ {
64
+ "english": "How are you doing today?",
65
+ "zomi": "Tuni in na dam maw?"
66
+ }