pplboy commited on
Commit
3183010
·
verified ·
1 Parent(s): a13db05

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +163 -188
README.md CHANGED
@@ -2,205 +2,180 @@
2
  base_model: Qwen/Qwen2.5-0.5B-Instruct
3
  library_name: peft
4
  tags:
5
- - base_model:adapter:Qwen/Qwen2.5-0.5B-Instruct
6
  - lora
7
- - transformers
 
 
 
 
 
 
8
  ---
9
 
10
- # Model Card for Model ID
11
 
12
- <!-- Provide a quick summary of what the model is/does. -->
13
 
 
14
 
 
 
 
 
 
15
 
16
- ## Model Details
17
 
18
- ### Model Description
19
 
20
- <!-- Provide a longer summary of what this model is. -->
 
 
21
 
 
22
 
 
 
 
23
 
24
- - **Developed by:** [More Information Needed]
25
- - **Funded by [optional]:** [More Information Needed]
26
- - **Shared by [optional]:** [More Information Needed]
27
- - **Model type:** [More Information Needed]
28
- - **Language(s) (NLP):** [More Information Needed]
29
- - **License:** [More Information Needed]
30
- - **Finetuned from model [optional]:** [More Information Needed]
31
 
32
- ### Model Sources [optional]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
33
 
34
- <!-- Provide the basic links for the model. -->
35
-
36
- - **Repository:** [More Information Needed]
37
- - **Paper [optional]:** [More Information Needed]
38
- - **Demo [optional]:** [More Information Needed]
39
-
40
- ## Uses
41
-
42
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
43
-
44
- ### Direct Use
45
-
46
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
47
-
48
- [More Information Needed]
49
-
50
- ### Downstream Use [optional]
51
-
52
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
53
-
54
- [More Information Needed]
55
-
56
- ### Out-of-Scope Use
57
-
58
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
59
-
60
- [More Information Needed]
61
-
62
- ## Bias, Risks, and Limitations
63
-
64
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
65
-
66
- [More Information Needed]
67
-
68
- ### Recommendations
69
-
70
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
71
-
72
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
73
-
74
- ## How to Get Started with the Model
75
-
76
- Use the code below to get started with the model.
77
-
78
- [More Information Needed]
79
-
80
- ## Training Details
81
-
82
- ### Training Data
83
-
84
- <!-- 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. -->
85
-
86
- [More Information Needed]
87
-
88
- ### Training Procedure
89
-
90
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
91
-
92
- #### Preprocessing [optional]
93
-
94
- [More Information Needed]
95
-
96
-
97
- #### Training Hyperparameters
98
-
99
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
100
-
101
- #### Speeds, Sizes, Times [optional]
102
-
103
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
104
-
105
- [More Information Needed]
106
-
107
- ## Evaluation
108
-
109
- <!-- This section describes the evaluation protocols and provides the results. -->
110
-
111
- ### Testing Data, Factors & Metrics
112
-
113
- #### Testing Data
114
-
115
- <!-- This should link to a Dataset Card if possible. -->
116
-
117
- [More Information Needed]
118
-
119
- #### Factors
120
-
121
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
122
-
123
- [More Information Needed]
124
-
125
- #### Metrics
126
-
127
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
128
-
129
- [More Information Needed]
130
-
131
- ### Results
132
-
133
- [More Information Needed]
134
-
135
- #### Summary
136
-
137
-
138
-
139
- ## Model Examination [optional]
140
-
141
- <!-- Relevant interpretability work for the model goes here -->
142
-
143
- [More Information Needed]
144
-
145
- ## Environmental Impact
146
-
147
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
148
-
149
- 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).
150
-
151
- - **Hardware Type:** [More Information Needed]
152
- - **Hours used:** [More Information Needed]
153
- - **Cloud Provider:** [More Information Needed]
154
- - **Compute Region:** [More Information Needed]
155
- - **Carbon Emitted:** [More Information Needed]
156
-
157
- ## Technical Specifications [optional]
158
-
159
- ### Model Architecture and Objective
160
-
161
- [More Information Needed]
162
-
163
- ### Compute Infrastructure
164
-
165
- [More Information Needed]
166
-
167
- #### Hardware
168
-
169
- [More Information Needed]
170
-
171
- #### Software
172
-
173
- [More Information Needed]
174
-
175
- ## Citation [optional]
176
-
177
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
178
-
179
- **BibTeX:**
180
-
181
- [More Information Needed]
182
-
183
- **APA:**
184
-
185
- [More Information Needed]
186
-
187
- ## Glossary [optional]
188
-
189
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
190
-
191
- [More Information Needed]
192
-
193
- ## More Information [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Authors [optional]
198
-
199
- [More Information Needed]
200
-
201
- ## Model Card Contact
202
-
203
- [More Information Needed]
204
- ### Framework versions
205
-
206
- - PEFT 0.16.0
 
2
  base_model: Qwen/Qwen2.5-0.5B-Instruct
3
  library_name: peft
4
  tags:
 
5
  - lora
6
+ - qwen
7
+ - customer-service
8
+ - chinese
9
+ - conversational
10
+ license: mit
11
+ language:
12
+ - zh
13
  ---
14
 
15
+ # Qwen2.5-0.5B-Instruct 客服微调模型
16
 
17
+ 这是一个基于 Qwen2.5-0.5B-Instruct 使用 LoRA 方法微调的客服对话模型。
18
 
19
+ ## 模型详情
20
 
21
+ - **基础模型**: [Qwen/Qwen2.5-0.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct)
22
+ - **微调方法**: LoRA (Low-Rank Adaptation)
23
+ - **参数量**: 基础模型 0.5B + LoRA 适配器 ~2MB
24
+ - **语言**: 中文
25
+ - **用途**: 客服对话、智能问答
26
 
27
+ ## 使用方法
28
 
29
+ ### 安装依赖
30
 
31
+ ```bash
32
+ pip install transformers peft torch
33
+ ```
34
 
35
+ ### 加载和使用模型
36
 
37
+ ```python
38
+ from transformers import AutoModelForCausalLM, AutoTokenizer
39
+ from peft import PeftModel
40
 
41
+ # 加载基础模型
42
+ base_model = AutoModelForCausalLM.from_pretrained(
43
+ "Qwen/Qwen2.5-0.5B-Instruct",
44
+ torch_dtype="auto",
45
+ device_map="auto"
46
+ )
 
47
 
48
+ # 加载 LoRA 适配器
49
+ model = PeftModel.from_pretrained(
50
+ base_model,
51
+ "pplboy/test"
52
+ )
53
+
54
+ # 加载分词器
55
+ tokenizer = AutoTokenizer.from_pretrained("pplboy/test")
56
+
57
+ # 使用模型
58
+ prompt = "你好,我想咨询一下产品"
59
+ inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
60
+
61
+ outputs = model.generate(
62
+ **inputs,
63
+ max_new_tokens=100,
64
+ temperature=0.7,
65
+ top_p=0.9,
66
+ do_sample=True
67
+ )
68
+
69
+ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
70
+ print(response)
71
+ ```
72
+
73
+ ### 使用 Transformers Pipeline
74
+
75
+ ```python
76
+ from transformers import pipeline
77
+ from peft import PeftModel, PeftConfig
78
+ from transformers import AutoModelForCausalLM, AutoTokenizer
79
 
80
+ # 加载模型
81
+ config = PeftConfig.from_pretrained("pplboy/test")
82
+ base_model = AutoModelForCausalLM.from_pretrained(
83
+ config.base_model_name_or_path,
84
+ torch_dtype="auto",
85
+ device_map="auto"
86
+ )
87
+ model = PeftModel.from_pretrained(base_model, "pplboy/test")
88
+ tokenizer = AutoTokenizer.from_pretrained("pplboy/test")
89
+
90
+ # 创建 pipeline
91
+ pipe = pipeline(
92
+ "text-generation",
93
+ model=model,
94
+ tokenizer=tokenizer,
95
+ device_map="auto"
96
+ )
97
+
98
+ # 生成回复
99
+ result = pipe("你好,我想咨询一下产品", max_new_tokens=100)
100
+ print(result[0]['generated_text'])
101
+ ```
102
+
103
+ ## 模型信息
104
+
105
+ ### LoRA 配置
106
+
107
+ - **LoRA rank (r)**: 8
108
+ - **LoRA alpha**: 16
109
+ - **LoRA dropout**: 0.1
110
+ - **Target modules**: q_proj, v_proj
111
+
112
+ ### 训练信息
113
+
114
+ - **训练框架**: PEFT 0.16.0
115
+ - **训练方法**: LoRA 微调
116
+ - **基础模型**: Qwen2.5-0.5B-Instruct
117
+
118
+ ## 使用场景
119
+
120
+ - 智能客服系统
121
+ - 自动问答
122
+ - 对话机器人
123
+ - 客户支持
124
+
125
+ ## 限制和注意事项
126
+
127
+ 1. **需要基础模型**: 这是一个 LoRA 适配器,使用前需要先加载基础模型 `Qwen/Qwen2.5-0.5B-Instruct`
128
+ 2. **模型大小**: 基础模型约 1GB,LoRA 适配器约 2MB
129
+ 3. **内存要求**: 建议至少 4GB 内存(使用 GPU 可减少内存占用)
130
+ 4. **语言支持**: 主要支持中文,英文能力有限
131
+
132
+ ## 示例
133
+
134
+ ```python
135
+ # 完整示例
136
+ from transformers import AutoModelForCausalLM, AutoTokenizer
137
+ from peft import PeftModel
138
+
139
+ # 加载
140
+ base_model = AutoModelForCausalLM.from_pretrained("Qwen/Qwen2.5-0.5B-Instruct")
141
+ model = PeftModel.from_pretrained(base_model, "pplboy/test")
142
+ tokenizer = AutoTokenizer.from_pretrained("pplboy/test")
143
+
144
+ # 测试对话
145
+ conversations = [
146
+ "你好,我想咨询一下产品",
147
+ "这个产品有什么特点?",
148
+ "如何退货?",
149
+ "客服工作时间是什么时候?"
150
+ ]
151
+
152
+ for prompt in conversations:
153
+ inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
154
+ outputs = model.generate(**inputs, max_new_tokens=100, temperature=0.7)
155
+ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
156
+ print(f"Q: {prompt}")
157
+ print(f"A: {response}\n")
158
+ ```
159
+
160
+ ## 引用
161
+
162
+ 如果使用本模型,请引用:
163
+
164
+ ```bibtex
165
+ @misc{pplboy-test-2024,
166
+ title={Qwen2.5-0.5B-Instruct 客服微调模型},
167
+ author={pplboy},
168
+ year={2024},
169
+ howpublished={\url{https://huggingface.co/pplboy/test}}
170
+ }
171
+ ```
172
+
173
+ ## 许可证
174
+
175
+ 本模型基于 Qwen2.5-0.5B-Instruct,遵循 MIT 许可证。
176
+
177
+ ## 相关链接
178
+
179
+ - [基础模型](https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct)
180
+ - [PEFT 文档](https://huggingface.co/docs/peft)
181
+ - [Transformers 文档](https://huggingface.co/docs/transformers)