sonleuid1 commited on
Commit
33ca4a6
·
verified ·
1 Parent(s): 716a5c8

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +37 -170
README.md CHANGED
@@ -1,199 +1,66 @@
1
  ---
2
- 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]
 
 
1
  ---
2
+ language:
3
+ - vi
4
+ pipeline_tag: text2text-generation
5
+ tags:
6
+ - teencode
7
+ - vietnamese
8
+ - seq2seq
9
+ - bartpho
10
+ - genz
11
  ---
12
 
13
+ # Model Card: TeenCode Translator BARTpho
 
 
 
14
 
15
+ Một mô hình Seq2Seq được tinh chỉnh (fine-tuned) chuyên sâu để dịch ngôn ngữ mạng, Teencode GenZ, và bình luận TikTok sang Tiếng Việt chuẩn mực.
16
 
17
  ## Model Details
18
 
19
  ### Model Description
20
 
21
+ Đây hình dịch thuật Teencode sang Tiếng Việt được huấn luyện theo phương pháp Active Learning. Thay vì chỉ chuẩn hóa chính tả thông thường, mô hình được thiết kế để bảo tồn tối đa ngữ cảnh và cảm xúc của câu gốc, tuân thủ nghiêm ngặt các quy tắc xử lý ngôn ngữ tự nhiên (NLP) đặc thù.
 
 
 
 
 
 
 
 
 
 
 
 
22
 
23
+ - **Developed by:** Đan Sơn (Hust)
24
+ - **Model type:** Text-to-Text Generation (Seq2Seq)
25
+ - **Language(s) (NLP):** Tiếng Việt (vi)
26
+ - **Finetuned from model:** BARTpho
 
27
 
28
  ## Uses
29
 
 
 
30
  ### Direct Use
31
 
32
+ hình được sử dụng trực tiếp để:
33
+ - Chuẩn hóa các văn bản chứa nhiều từ lóng, viết tắt (VD: `khum`, `đc`, `j`, `trc`).
34
+ - Làm sạch dữ liệu văn bản (Data Cleaning) cho các bài toán NLP khác tiếng Việt (Phân tích cảm xúc, Chatbot).
35
+ - Tích hợp vào các ứng dụng chat hoặc công cụ hỗ trợ đọc hiểu văn bản mạng.
 
 
 
 
 
36
 
37
  ### Out-of-Scope Use
38
 
39
+ - hình không được thiết kế để dịch thuật đa ngôn ngữ (VD: Anh - Việt).
40
+ - Không phải là mô hình đàm thoại (Chatbot/LLM) để trả lời câu hỏi.
 
41
 
42
  ## Bias, Risks, and Limitations
43
 
44
+ **Tính năng bảo lưu ngôn từ nhạy cảm:** Để đảm bảo tính nguyên bản của dữ liệu NLP, mô hình được huấn luyện để **TUYỆT ĐỐI KHÔNG KIỂM DUYỆT** từ chửi thề hay lóng thô tục (VD: `vcl`, `duma`). Người dùng tích hợp mô hình vào ứng dụng đại chúng cần tự xây dựng bộ lọc hậu xử lý (Post-processing) nếu cần thiết.
 
 
 
 
 
 
45
 
46
+ **Giới hạn độ dài:** Do được tinh chỉnh ở `max_length=64`, văn bản đầu vào quá dài (trên 50 từ) cần được băm nhỏ (chunking) theo dấu câu trước khi đưa vào hình để tránh hiện tượng ảo giác (hallucination).
47
 
48
  ## How to Get Started with the Model
49
 
50
+ Sử dụng thư viện `transformers` `pipeline` để gọi mô hình:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
51
 
52
+ ```python
53
+ from transformers import pipeline
54
 
55
+ # Nạp mô hình từ Hugging Face
56
+ translator = pipeline(
57
+ "text2text-generation",
58
+ model="Tên-Tài-Khoản-Của-Bạn/TeenCode-Translator-BARTpho"
59
+ )
60
 
61
+ # Test nghiệm thu
62
+ text = "mai ik cf k duma t thik m vcl =))"
63
+ result = translator(text, max_length=64, num_beams=5, early_stopping=True)
64
 
65
+ print(result[0]['generated_text'])
66
+ # Output kỳ vọng: "mai đi cà phê không duma tao thích mày vcl =))"