huseinzol05 commited on
Commit
e0827fe
·
verified ·
1 Parent(s): 0202ce9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +76 -194
README.md CHANGED
@@ -3,197 +3,79 @@ library_name: transformers
3
  tags: []
4
  ---
5
 
6
- # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
-
11
-
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
3
  tags: []
4
  ---
5
 
6
+ # NanoT5 Base Malaysian Translation
7
+
8
+ Finetuned https://huggingface.co/mesolitica/nanot5-base-malaysian-cased using 2048 context length on 7B tokens of translation dataset.
9
+
10
+ - This model able to translate from localize text into standard text.
11
+ - This model able to reverse translate from standard to localize text, suitable for text augmentation.
12
+ - This model able to translate code.
13
+ - This model natively code switching.
14
+ - This model maintain `\n`, `\t`, `\r` as it is.
15
+
16
+ **Still in training session**, Wandb at https://wandb.ai/huseinzol05/nanot5-base-malaysian-cased-translation-v4?nw=nwuserhuseinzol05
17
+
18
+ ## Supported prefix
19
+
20
+ 1. `'terjemah ke Mandarin: '`
21
+ 3. `'terjemah ke Tamil: '`
22
+ 4. `'terjemah ke Jawa: '`
23
+ 5. `'terjemah ke Melayu: '`
24
+ 6. `'terjemah ke Inggeris: '`
25
+ 7. `'terjemah ke johor: '`
26
+ 8. `'terjemah ke kedah: '`
27
+ 9. `'terjemah ke kelantan: '`
28
+ 10. `'terjemah ke pasar Melayu: '`
29
+ 11. `'terjemah ke melaka: '`
30
+ 12. `'terjemah ke negeri sembilan: '`
31
+ 13. `'terjemah ke pahang: '`
32
+ 14. `'terjemah ke perak: '`
33
+ 15. `'terjemah ke sabah: '`
34
+ 16. `'terjemah ke sarawak: '`
35
+ 17. `'terjemah ke terengganu: '`
36
+ 18. `'terjemah ke Jawi: '`
37
+ 19. `'terjemah ke Manglish: '`
38
+ 20. `'terjemah ke Banjar: '`
39
+ 21. `'terjemah ke pasar Mandarin: '`
40
+
41
+ ## how to
42
+
43
+ ```python
44
+ from transformers import AutoTokenizer, T5ForConditionalGeneration
45
+
46
+ tokenizer = AutoTokenizer.from_pretrained('mesolitica/nanot5-base-malaysian-translation-v2')
47
+ model = T5ForConditionalGeneration.from_pretrained('mesolitica/nanot5-base-malaysian-translation-v2')
48
+
49
+ strings = [
50
+ 'ak tak paham la',
51
+ 'Hi guys! I noticed semalam & harini dah ramai yang dapat cookies ni kan. So harini i nak share some post mortem of our first batch:',
52
+ "Memanglah. Ini tak payah expert, aku pun tau. It's a gesture, bodoh.",
53
+ 'jam 8 di pasar KK memang org ramai 😂, pandai dia pilih tmpt.',
54
+ 'Jadi haram jadah😀😃🤭',
55
+ 'nak gi mana tuu',
56
+ 'Macam nak ambil half day',
57
+ "Bayangkan PH dan menang pru-14. Pastu macam-macam pintu belakang ada. Last-last Ismail Sabri naik. That's why I don't give a fk about politics anymore. Sumpah dah fk up dah.",
58
+ ]
59
+ all_special_ids = [0, 1, 2]
60
+ prefix = 'terjemah ke Melayu: '
61
+ input_ids = [{'input_ids': tokenizer.encode(f'{prefix}{s}{tokenizer.eos_token}', return_tensors='pt')[
62
+ 0]} for s in strings]
63
+ padded = tokenizer.pad(input_ids, padding='longest')
64
+ outputs = model.generate(**padded, max_length = 100)
65
+ tokenizer.batch_decode([[i for i in o if i not in all_special_ids] for o in outputs])
66
+ ```
67
+
68
+ Output,
69
+
70
+ ```
71
+ [' Saya tidak faham',
72
+ ' Hi guys! Saya perasan semalam dan hari ini ramai yang menerima cookies. Jadi hari ini saya ingin berkongsi beberapa post mortem batch pertama kami:',
73
+ ' Memanglah. Tak perlu pakar, saya juga tahu. Ini adalah satu isyarat, bodoh.',
74
+ ' Orang ramai di pasar KK pada jam 8 pagi, mereka sangat pandai memilih tempat.',
75
+ ' Jadi haram jadah 😀😃🤭',
76
+ ' Di mana kamu pergi?',
77
+ ' Saya ingin mengambil separuh hari',
78
+ ' Bayangkan PH dan menang PRU-14. Terdapat pelbagai pintu belakang. Akhirnya, Ismail Sabri naik. Itulah sebabnya saya tidak lagi bercakap tentang politik. Saya bersumpah sudah berputus asa.']
79
+ ```
80
+
81
+ Input text can be any languages that speak in Malaysia, as long you use proper prefix, it should be able to translate to target language.