StrangeSX commited on
Commit
7dc86f0
·
verified ·
1 Parent(s): 26a0e4e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +111 -194
README.md CHANGED
@@ -3,197 +3,114 @@ 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
+ # NN-NER-FT: โมเดล Named Entity Recognition (NER) ที่ Fine-tune แล้ว
7
+
8
+ ## ภาพรวม
9
+ **NN-NER-FT** เป็นโมเดลสำหรับงาน Named Entity Recognition (NER) ในภาษาไทย ที่ผ่านการ fine-tune จากโมเดลพื้นฐาน โดยใช้ชุดข้อมูล NN-NER จาก Hugging Face ในการฝึก
10
+ โมเดลนี้สามารถระบุ entity ต่าง ๆ เช่น BRAND, PRODUCT_NAME, PRODUCT_SIZE, SPEC, SPEC_PER_UNIT, PACKAGE, และอื่น ๆ ในข้อความภาษาไทย
11
+
12
+ ## การใช้งานที่ตั้งใจไว้
13
+ - **งานหลัก:** การระบุ Named Entities ในข้อความภาษาไทย
14
+ - **กลุ่มเป้าหมาย:** นักวิจัย, นักพัฒนา และองค์กรที่ต้องการระบบ NER สำหรับภาษาไทย
15
+ - **ข้อควรระวัง:** โมเดลนี้เหมาะสำหรับการทดลองและพัฒนาเบื้องต้น สำหรับงาน production อาจต้องปรับปรุงและเทรนเพิ่มเติม
16
+
17
+ ## รายละเอียดการเทรน
18
+
19
+ ### ข้อมูลชุดฝึก
20
+ - **ชุดข้อมูล:** NN-NER (จาก Hugging Face)
21
+ - **การแบ่งชุดข้อมูล:**
22
+ - Train: 80%
23
+ - Validation: 10%
24
+ - Test: 10%
25
+
26
+ ### Hyperparameters (สำหรับการสาธิต)
27
+ - **Batch Size:** 16 (สำหรับทั้งการเทรนและการประเมินต่ออุปกรณ์)
28
+ - **Learning Rate:** 3e-5
29
+ - **Warmup Ratio:** 0.1
30
+ - **Weight Decay:** 0.01
31
+ - **Adam Optimizer:**
32
+ - Beta1: 0.9
33
+ - Beta2: 0.999
34
+ - Epsilon: 1e-8
35
+ - **Epochs:** 3 (สำหรับการสาธิต – ในงานจริงอาจเทรนมากขึ้น)
36
+ - **Mixed Precision:** ใช้ fp16
37
+ - **Checkpoint & Evaluation Strategy:**
38
+ - ประเมินผลทุก 100 steps
39
+ - บันทึก checkpoint ทุก 100 steps (จำกัดที่ 5 checkpoint ล่าสุด)
40
+ - โหลดโมเดลที่ดีที่สุดตาม metric `eval_loss`
41
+
42
+ ### ตัวอย่างคำสั่งการตั้งค่า TrainingArguments
43
+ ```python
44
+ thainer_training_args = TrainingArguments(
45
+ output_dir=path.join("finetuned_models", "NN-NER-FT"),
46
+ overwrite_output_dir=True,
47
+ evaluation_strategy="steps",
48
+ eval_steps=100,
49
+ save_strategy="steps",
50
+ save_steps=100,
51
+ save_total_limit=5,
52
+ per_device_train_batch_size=16,
53
+ per_device_eval_batch_size=16,
54
+ learning_rate=3e-5,
55
+ warmup_ratio=0.1,
56
+ weight_decay=0.01,
57
+ adam_beta1=0.9,
58
+ adam_beta2=0.999,
59
+ adam_epsilon=1e-8,
60
+ num_train_epochs=3,
61
+ fp16=True,
62
+ load_best_model_at_end=True,
63
+ metric_for_best_model="eval_loss"
64
+ )
65
+ ```
66
+
67
+ ### ผลการประเมินบนชุดทดสอบ
68
+ - **Test Loss**: 0.2114
69
+ - **Test Micro Average F1**: 0.8580
70
+ - **Test Macro Average F1**: 0.8034
71
+
72
+ ### F1 Score แยกตาม Class
73
+ - **BRAND**: 0.8358
74
+ - **GRADE**: 0.6835
75
+ - **PACKAGE**: 0.8788
76
+ - **PRODUCT_NAME**: 0.8638
77
+ - **PRODUCT_SIZE**: 0.9624
78
+ - **SPEC**: 0.6606
79
+ - **SPEC_PER_UNIT**: 0.7481
80
+ - **SPEC_SIZE**: 0.6471
81
+ - **STORAGE_CONDITION**: 0.9504
82
+
83
+ ### โค้ดการประเมินผล (Evaluation Pipeline)
84
+ ```python
85
+ def thainer_f1_metric(eval_pred):
86
+ predictions = eval_pred.predictions.argmax(axis=2)
87
+ labels = eval_pred.label_ids
88
+ predictions = [
89
+ [thainer_id2label[p] for p, l in zip(p_row, l_row) if l != -100]
90
+ for p_row, l_row in zip(predictions, labels)
91
+ ]
92
+ labels = [
93
+ [thainer_id2label[l] for l in l_row if l != -100]
94
+ for l_row in labels
95
+ ]
96
+ result = seqeval_metric(y_pred=predictions, y_true=labels, output_dict=True)
97
+ tag_set = {tag[2:] for tag in thainer_id2label.values() if tag != "O"}
98
+ return {
99
+ "micro_average_f1": result["micro avg"]["f1-score"],
100
+ "macro_average_f1": result["macro avg"]["f1-score"],
101
+ "class_f1": {
102
+ tag: result[tag]["f1-score"]
103
+ for tag in result if tag in tag_set
104
+ }
105
+ }
106
+
107
+ thainer_trainer = Trainer(
108
+ model=thainer_model,
109
+ args=thainer_training_args,
110
+ train_dataset=thainer["train"],
111
+ eval_dataset=thainer["validation"],
112
+ tokenizer=tokenizer,
113
+ data_collator=thainer_data_collator,
114
+ compute_metrics=thainer_f1_metric
115
+ )
116
+ ```