simonl0909 commited on
Commit
81658ff
1 Parent(s): 02055f9

Moved license to CC BY-NC-SA 4.0

Browse files

since the dataset is produced via Microsoft's API.

Files changed (1) hide show
  1. README.md +27 -17
README.md CHANGED
@@ -6,7 +6,7 @@ language_creators:
6
  language:
7
  - zh
8
  license:
9
- - mit
10
  multilinguality:
11
  - translation
12
  size_categories:
@@ -62,11 +62,7 @@ tags:
62
 
63
  ### Dataset Summary
64
 
65
- The dataset is produced by doing the following:
66
-
67
- - Download [HKCancor Cantonese Corpus](https://github.com/fcbond/hkcancor) and [CommonVoice Cantonese (Hong Kong Chinese `yue`) text corpus](https://commonvoice.mozilla.org/en/datasets)
68
- - Extract text corpus and merge datasets
69
- - Run text against [Microsoft's Translator API](https://learn.microsoft.com/en-us/azure/ai-services/translator/language-support) from `yue` to `zh-Hans`
70
 
71
 
72
  ### Supported Tasks and Leaderboards
@@ -80,47 +76,60 @@ N/A
80
 
81
  ## Dataset Structure
82
 
 
 
83
  ### Data Instances
84
 
85
  [More Information Needed]
86
 
87
  ### Data Fields
88
 
89
- [More Information Needed]
 
90
 
91
  ### Data Splits
92
 
93
- [More Information Needed]
94
 
95
  ## Dataset Creation
96
 
 
 
 
 
 
 
97
  ### Curation Rationale
98
 
99
- [More Information Needed]
100
 
101
  ### Source Data
102
 
 
 
 
103
  #### Initial Data Collection and Normalization
104
 
105
- [More Information Needed]
106
 
107
  #### Who are the source language producers?
108
 
109
- [More Information Needed]
 
110
 
111
  ### Annotations
112
 
113
  #### Annotation process
114
 
115
- [More Information Needed]
116
 
117
  #### Who are the annotators?
118
 
119
- [More Information Needed]
120
 
121
  ### Personal and Sensitive Information
122
 
123
- [More Information Needed]
124
 
125
  ## Considerations for Using the Data
126
 
@@ -134,17 +143,18 @@ N/A
134
 
135
  ### Other Known Limitations
136
 
137
- [More Information Needed]
138
 
139
  ## Additional Information
140
 
141
  ### Dataset Curators
142
 
143
- [More Information Needed]
 
144
 
145
  ### Licensing Information
146
 
147
- MIT
148
 
149
  ### Citation Information
150
 
 
6
  language:
7
  - zh
8
  license:
9
+ - cc-by-nc-sa-4.0
10
  multilinguality:
11
  - translation
12
  size_categories:
 
62
 
63
  ### Dataset Summary
64
 
65
+ This is a machine-translated parallel corpus between Cantonese (a Chinese dialect that is mainly spoken by Guangdong, Hong Kong and part of Malaysia) and Chinese (written form, in Simplified Chinese).
 
 
 
 
66
 
67
 
68
  ### Supported Tasks and Leaderboards
 
76
 
77
  ## Dataset Structure
78
 
79
+ JSON lines with `yue` field and `zh` field for the parallel corpus.
80
+
81
  ### Data Instances
82
 
83
  [More Information Needed]
84
 
85
  ### Data Fields
86
 
87
+ - `yue`: Cantonese corpus
88
+ - `zh`: translated Chinese corpus
89
 
90
  ### Data Splits
91
 
92
+ No data splitting is done as of yet.
93
 
94
  ## Dataset Creation
95
 
96
+ The dataset is produced by doing the following:
97
+
98
+ - Download [HKCancor Cantonese Corpus](https://github.com/fcbond/hkcancor) and [CommonVoice Cantonese (Hong Kong Chinese `yue`) text corpus](https://commonvoice.mozilla.org/en/datasets)
99
+ - Extract text corpus and merge datasets
100
+ - Run text against [Microsoft's Translator API](https://learn.microsoft.com/en-us/azure/ai-services/translator/language-support) from `yue` to `zh-Hans`
101
+
102
  ### Curation Rationale
103
 
104
+ Currently no such corpus exists, and it is hard to find such a corpus, so we tried to generate a reasonable batch of samples using machine translation for research purposes.
105
 
106
  ### Source Data
107
 
108
+ - [HKCancor](https://github.com/fcbond/hkcancor)
109
+ - [CommonVoice 7.0 Chinese (Hong Kong)](https://commonvoice.mozilla.org/en/datasets)
110
+
111
  #### Initial Data Collection and Normalization
112
 
113
+ Normalization scripts will be included soon.
114
 
115
  #### Who are the source language producers?
116
 
117
+ - [HKCancor](https://github.com/fcbond/hkcancor)
118
+ - [CommonVoice 7.0 Chinese (Hong Kong)](https://commonvoice.mozilla.org/en/datasets)
119
 
120
  ### Annotations
121
 
122
  #### Annotation process
123
 
124
+ We run the Cantonese text corpus against Microsoft's Translator API.
125
 
126
  #### Who are the annotators?
127
 
128
+ - [Microsoft's Translator API](https://learn.microsoft.com/en-us/azure/ai-services/translator/language-support)
129
 
130
  ### Personal and Sensitive Information
131
 
132
+ N/A
133
 
134
  ## Considerations for Using the Data
135
 
 
143
 
144
  ### Other Known Limitations
145
 
146
+ This parallel corpus is machine-translated, it is not 100% accurate.
147
 
148
  ## Additional Information
149
 
150
  ### Dataset Curators
151
 
152
+ - [Botisan AI](https://botisan.ai)
153
+ - [Simon Liang](https://github.com/lhr0909)
154
 
155
  ### Licensing Information
156
 
157
+ [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
158
 
159
  ### Citation Information
160