nelsondiasandre commited on
Commit
4d38d14
·
verified ·
1 Parent(s): 3b3d0af

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +105 -183
README.md CHANGED
@@ -1,209 +1,131 @@
1
  ---
2
- base_model: Qwen/Qwen2.5-1.5B-Instruct
 
 
3
  library_name: peft
 
4
  pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:Qwen/Qwen2.5-1.5B-Instruct
7
- - lora
8
- - sft
9
- - transformers
10
- - trl
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  ---
12
 
13
- # Model Card for Model ID
14
-
15
- <!-- Provide a quick summary of what the model is/does. -->
16
-
17
-
18
-
19
- ## Model Details
20
-
21
- ### Model Description
22
-
23
- <!-- Provide a longer summary of what this model is. -->
24
-
25
-
26
-
27
- - **Developed by:** [More Information Needed]
28
- - **Funded by [optional]:** [More Information Needed]
29
- - **Shared by [optional]:** [More Information Needed]
30
- - **Model type:** [More Information Needed]
31
- - **Language(s) (NLP):** [More Information Needed]
32
- - **License:** [More Information Needed]
33
- - **Finetuned from model [optional]:** [More Information Needed]
34
-
35
- ### Model Sources [optional]
36
-
37
- <!-- Provide the basic links for the model. -->
38
-
39
- - **Repository:** [More Information Needed]
40
- - **Paper [optional]:** [More Information Needed]
41
- - **Demo [optional]:** [More Information Needed]
42
-
43
- ## Uses
44
-
45
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
46
-
47
- ### Direct Use
48
-
49
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
50
-
51
- [More Information Needed]
52
-
53
- ### Downstream Use [optional]
54
 
55
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
56
 
57
- [More Information Needed]
58
 
59
- ### Out-of-Scope Use
 
 
60
 
61
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
62
 
63
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
64
 
65
- ## Bias, Risks, and Limitations
 
66
 
67
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
68
 
69
- [More Information Needed]
70
 
71
- ### Recommendations
 
 
 
 
 
72
 
73
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
74
-
75
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
76
-
77
- ## How to Get Started with the Model
78
-
79
- Use the code below to get started with the model.
80
-
81
- [More Information Needed]
82
 
83
  ## Training Details
84
 
85
- ### Training Data
86
-
87
- <!-- 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. -->
88
-
89
- [More Information Needed]
90
-
91
- ### Training Procedure
92
-
93
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
94
-
95
- #### Preprocessing [optional]
96
-
97
- [More Information Needed]
98
-
99
-
100
- #### Training Hyperparameters
101
-
102
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
103
-
104
- #### Speeds, Sizes, Times [optional]
105
-
106
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
107
-
108
- [More Information Needed]
 
 
 
 
 
109
 
110
  ## Evaluation
111
 
112
- <!-- This section describes the evaluation protocols and provides the results. -->
113
-
114
- ### Testing Data, Factors & Metrics
115
-
116
- #### Testing Data
117
-
118
- <!-- This should link to a Dataset Card if possible. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Factors
123
-
124
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
125
-
126
- [More Information Needed]
127
-
128
- #### Metrics
129
-
130
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
131
-
132
- [More Information Needed]
133
-
134
- ### Results
135
-
136
- [More Information Needed]
137
-
138
- #### Summary
139
-
140
-
141
-
142
- ## Model Examination [optional]
143
-
144
- <!-- Relevant interpretability work for the model goes here -->
145
-
146
- [More Information Needed]
147
-
148
- ## Environmental Impact
149
-
150
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
151
-
152
- 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).
153
-
154
- - **Hardware Type:** [More Information Needed]
155
- - **Hours used:** [More Information Needed]
156
- - **Cloud Provider:** [More Information Needed]
157
- - **Compute Region:** [More Information Needed]
158
- - **Carbon Emitted:** [More Information Needed]
159
-
160
- ## Technical Specifications [optional]
161
-
162
- ### Model Architecture and Objective
163
-
164
- [More Information Needed]
165
-
166
- ### Compute Infrastructure
167
-
168
- [More Information Needed]
169
-
170
- #### Hardware
171
-
172
- [More Information Needed]
173
-
174
- #### Software
175
-
176
- [More Information Needed]
177
-
178
- ## Citation [optional]
179
-
180
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
181
-
182
- **BibTeX:**
183
-
184
- [More Information Needed]
185
-
186
- **APA:**
187
-
188
- [More Information Needed]
189
-
190
- ## Glossary [optional]
191
-
192
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
193
-
194
- [More Information Needed]
195
-
196
- ## More Information [optional]
197
-
198
- [More Information Needed]
199
-
200
- ## Model Card Authors [optional]
201
 
202
- [More Information Needed]
203
 
204
- ## Model Card Contact
 
 
 
205
 
206
- [More Information Needed]
207
- ### Framework versions
208
 
209
- - PEFT 0.19.1
 
1
  ---
2
+ license: apache-2.0
3
+ language:
4
+ - pt
5
  library_name: peft
6
+ base_model: Qwen/Qwen2.5-1.5B-Instruct
7
  pipeline_tag: text-generation
8
  tags:
9
+ - peft
10
+ - lora
11
+ - portuguese
12
+ - question-answering
13
+ - instruction-tuning
14
+ - qwen2.5
15
+ - pt-pt
16
+ datasets:
17
+ - nelsondiasandre/portuguese-qa-instruct-500
18
+ model-index:
19
+ - name: qwen25-1.5b-pt-qa-lora
20
+ results:
21
+ - task:
22
+ type: text-generation
23
+ dataset:
24
+ name: portuguese-qa-instruct-500
25
+ type: nelsondiasandre/portuguese-qa-instruct-500
26
+ metrics:
27
+ - type: perplexity
28
+ name: Perplexity (eval set, 100 examples)
29
+ value: 1.86
30
+ widget:
31
+ - text: "<|im_start|>user\nQual e a capital de Portugal?<|im_end|>\n<|im_start|>assistant\n"
32
+ example_title: "Capital de Portugal"
33
+ - text: "<|im_start|>user\nO que e a fotossintese?<|im_end|>\n<|im_start|>assistant\n"
34
+ example_title: "Ciencias"
35
+ - text: "<|im_start|>user\nQuem escreveu Os Lusiadas?<|im_end|>\n<|im_start|>assistant\n"
36
+ example_title: "Literatura Portuguesa"
37
  ---
38
 
39
+ # Qwen2.5-1.5B PT-PT Q&A LoRA
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
40
 
41
+ LoRA adapter fine-tuned on [Qwen/Qwen2.5-1.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-1.5B-Instruct) for Portuguese question answering.
42
 
43
+ ## Usage
44
 
45
+ ```python
46
+ from peft import AutoPeftModelForCausalLM
47
+ from transformers import AutoTokenizer
48
 
49
+ model = AutoPeftModelForCausalLM.from_pretrained("nelsondiasandre/qwen25-1.5b-pt-qa-lora")
50
+ tokenizer = AutoTokenizer.from_pretrained("Qwen/Qwen2.5-1.5B-Instruct")
51
 
52
+ def perguntar(pergunta: str) -> str:
53
+ prompt = f"<|im_start|>user\n{pergunta}<|im_end|>\n<|im_start|>assistant\n"
54
+ inputs = tokenizer(prompt, return_tensors="pt")
55
+ outputs = model.generate(
56
+ **inputs,
57
+ max_new_tokens=100,
58
+ do_sample=True,
59
+ temperature=0.7,
60
+ repetition_penalty=1.3,
61
+ pad_token_id=tokenizer.eos_token_id,
62
+ )
63
+ resposta = tokenizer.decode(outputs[0], skip_special_tokens=False)
64
+ resposta = resposta.split("<|im_start|>assistant\n")[-1].split("<|im_end|>")[0].strip()
65
+ return resposta
66
 
67
+ print(perguntar("Qual e a capital de Portugal?"))
68
+ ```
69
 
70
+ ## Chat Template
71
 
72
+ This model uses the **Qwen ChatML format**:
73
 
74
+ ```
75
+ <|im_start|>user
76
+ {pergunta}<|im_end|>
77
+ <|im_start|>assistant
78
+ {resposta}<|im_end|>
79
+ ```
80
 
81
+ Do **not** use Qwen's native `apply_chat_template()` — it produces a slightly different format than what this adapter was trained on. Use the prompt string directly as shown above.
 
 
 
 
 
 
 
 
82
 
83
  ## Training Details
84
 
85
+ | Parameter | Value |
86
+ |---|---|
87
+ | Base model | Qwen/Qwen2.5-1.5B-Instruct |
88
+ | LoRA rank (r) | 8 |
89
+ | LoRA alpha | 16 |
90
+ | LoRA dropout | 0.05 |
91
+ | Target modules | q_proj, k_proj, v_proj, o_proj |
92
+ | Epochs | 20 |
93
+ | Learning rate | 2e-4 |
94
+ | LR scheduler | cosine |
95
+ | Warmup ratio | 0.1 |
96
+ | Batch size | 2 (effective 8 with grad accum 4) |
97
+ | Max sequence length | 512 tokens |
98
+ | Training hardware | CPU |
99
+ | Training dataset | 500 PT-PT instruction pairs (400 train / 100 eval) |
100
+
101
+ ## Training Data
102
+
103
+ 500 Portuguese (PT-PT) question-answer pairs across 20+ categories:
104
+ - Geography and capitals
105
+ - History (Portuguese and world)
106
+ - Science and biology
107
+ - Mathematics
108
+ - Literature (including Portuguese classics)
109
+ - Culture, gastronomy, and traditions
110
+ - Technology and computing
111
+ - Sports (including football)
112
+
113
+ See the [dataset card](https://huggingface.co/datasets/nelsondiasandre/portuguese-qa-instruct-500) for details.
114
 
115
  ## Evaluation
116
 
117
+ | Metric | Value |
118
+ |---|---|
119
+ | Eval loss (final epoch) | 0.6199 |
120
+ | Perplexity (eval set) | 1.86 |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
121
 
122
+ ## Limitations
123
 
124
+ - Small training set (500 examples) — may not generalise well to topics outside training data
125
+ - Trained on CPU only — no GPU-optimised quantisation applied
126
+ - Portuguese (PT-PT) only — not validated for Brazilian Portuguese
127
+ - Short answers expected — trained on concise Q&A format, not long-form generation
128
 
129
+ ## License
 
130
 
131
+ Apache 2.0 (inherited from Qwen2.5-1.5B-Instruct base model).