H-Z-Ning commited on
Commit
d88b3b4
·
verified ·
1 Parent(s): e2d0a47

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +71 -179
README.md CHANGED
@@ -1,199 +1,91 @@
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
+ **Chinese Movie Review Sentiment Classification Model (5-Star Rating)**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
 
3
+ ---
4
 
5
+ ## 1. Model Overview
6
+ `H-Z-Ning/Senti-RoBERTa-Mini` is a lightweight Chinese RoBERTa model fine-tuned specifically for assigning 1-to-5-star sentiment ratings to Chinese movie short reviews. Built on the HFL-Tencent `hfl/chinese-roberta-wwm-ext` checkpoint, it retains a small footprint and fast inference, making it ideal for resource-constrained deployments.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
 
8
+ ---
9
 
10
+ ## 2. Model Facts
11
 
12
+ | Item | Details |
13
+ |---|---|
14
+ | Task | Chinese text classification (sentiment / star rating) |
15
+ | Labels | 5 classes (1 star – 5 stars) |
16
+ | Base model | [hfl/chinese-roberta-wwm-ext](https://huggingface.co/hfl/chinese-roberta-wwm-ext) |
17
+ | Dataset | [Kaggle: Douban Movie Short Comments (140 K)](https://www.kaggle.com/datasets/utmhikari/doubanmovieshortcomments) |
18
+ | Training framework | 🤗 transformers + Trainer |
19
+ | Language | Simplified Chinese |
20
+ | Parameters | ≈ 102 M (same as base model) |
21
 
22
+ ---
23
 
24
+ ## 3. Quick Start
25
 
26
+ ### 3.1 Install Dependencies
27
+ ```bash
28
+ pip install transformers torch
29
+ ```
30
 
31
+ ### 3.2 One-Line Inference
32
+ ```python
33
+ from transformers import AutoTokenizer, AutoModelForSequenceClassification
34
+ import torch
35
 
36
+ repo = "H-Z-Ning/Senti-RoBERTa-Mini"
37
+ tok = AutoTokenizer.from_pretrained(repo)
38
+ model = AutoModelForSequenceClassification.from_pretrained(repo)
39
 
40
+ text = "这个导演真厉害。"
41
+ inputs = tok(text, return_tensors="pt", truncation=True, max_length=256)
42
+ with torch.no_grad():
43
+ logits = model(**inputs).logits
44
+ pred = int(torch.argmax(logits, dim=-1).item()) + 1 # 1..5
45
+ print("predicted rating:", pred)
46
+ ```
47
 
48
+ ---
49
 
50
+ ## 4. Training Details
51
+
52
+ | Hyper-parameter | Value |
53
+ |---|---|
54
+ | Base model | hfl/chinese-roberta-wwm-ext |
55
+ | Training framework | 🤗 transformers `Trainer` |
56
+ | Training set | 50 000 samples (randomly drawn from 140 K) |
57
+ | Validation set | 5 000 samples (same random draw) |
58
+ | Test set | full original test set |
59
+ | Max sequence length | 256 |
60
+ | Training epochs | 3 |
61
+ | Batch size | 32 (train) / 64 (eval) |
62
+ | Learning rate | 2e-5 |
63
+ | Optimizer | AdamW |
64
+ | Weight decay | 0.01 |
65
+ | Scheduler | linear warmup (warmup_ratio=0.1) |
66
+ | Precision | FP16 |
67
+ | Best-model criterion | **QWK (↑)** |
68
+ | Training time | ≈ 32 min on single P100 (FP16) |
69
+ | Logging interval | every 10 steps |
70
 
71
+ ---
72
 
73
+ ## 5. Citation
74
 
75
+ ```bibtex
76
+ @misc{senti-roberta-mini-2025,
77
+ title={Senti-RoBERTa-Mini: A Mini Chinese RoBERTa for Movie Review Rating},
78
+ author={H-Z-Ning},
79
+ year={2025},
80
+ howpublished={\url{https://huggingface.co/H-Z-Ning/Senti-RoBERTa-Mini}}
81
+ }
82
+ ```
83
 
84
+ ---
85
 
86
+ ## 6. License
87
+ This model is released under [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). The base model `hfl/chinese-roberta-wwm-ext` is also Apache-2.0.
88
 
89
+ ---
90
 
91
+ Community contributions and feedback are welcome! If you encounter any issues, please open an [Issue](https://huggingface.co/H-Z-Ning/Senti-RoBERTa-Mini/discussions) or email the author.