Kazupal commited on
Commit
4da0555
·
verified ·
1 Parent(s): 9620338

Upload LoRA adapter (README written by author)

Browse files
Files changed (1) hide show
  1. README.md +82 -202
README.md CHANGED
@@ -1,202 +1,82 @@
1
- ---
2
- base_model: unsloth/qwen3-4b-instruct-2507-unsloth-bnb-4bit
3
- library_name: peft
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
-
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]
200
- ### Framework versions
201
-
202
- - PEFT 0.13.2
 
1
+ ---
2
+ license: apache-2.0
3
+ base_model: Qwen/Qwen3-4B-Instruct-2507
4
+ library_name: peft
5
+ tags:
6
+ - lora
7
+ - qlora
8
+ - structeval
9
+ - structured-output
10
+ - matsuolab
11
+ ---
12
+
13
+
14
+ # StructEval-Oriented Qwen3-4B LoRA (KazumaInoue)
15
+
16
+
17
+ ## 1. Model Overview
18
+ This repository provides a LoRA adapter trained for structured output generation tasks
19
+ based on Qwen/Qwen3-4B-Instruct-2507.
20
+
21
+
22
+ The model was developed as part of the Matsuo Lab LLM Application Course (Final Assignment).
23
+ Its primary focus is improving output stability when generating structured formats such as
24
+ JSON, YAML, and XML under explicit formatting constraints.
25
+
26
+
27
+ ## 2. Training Objective and Design Rationale
28
+ The objective of this model is to generate outputs that follow explicit structural constraints
29
+ specified in the prompt.
30
+
31
+
32
+ To achieve this, the following design choices were adopted:
33
+ - Loss is applied only to assistant responses (assistant-only loss).
34
+ - Output-marker-based masking is used to avoid learning intermediate reasoning tokens.
35
+ - Priority is given to format correctness rather than creative or verbose responses.
36
+
37
+
38
+ ## 3. Training Configuration
39
+ - Base model: Qwen/Qwen3-4B-Instruct-2507
40
+ - Training method: QLoRA (4-bit quantized base model with LoRA adapters)
41
+ - Maximum sequence length: 512
42
+ - LoRA rank (r): 64
43
+ - LoRA alpha: 128
44
+ - LoRA dropout: 0.05
45
+ - Number of epochs: 1
46
+ - Optimizer and scheduler: AdamW with cosine learning rate schedule
47
+ - Training framework: Unsloth, PEFT, Hugging Face Transformers
48
+
49
+
50
+ ## 4. Training Data
51
+ The model was trained using a synthetic supervised fine-tuning dataset provided by the course organizers.
52
+
53
+
54
+ - Dataset: u-10bei/structured_data_with_cot_dataset_512_v2
55
+ - Dataset type: Structured output SFT dataset
56
+ - Content: Instruction-following samples with explicit output markers
57
+
58
+
59
+ ### Dataset License and Compliance
60
+ The dataset was used strictly in accordance with the course guidelines and is intended
61
+ for research and educational purposes only.
62
+
63
+
64
+ ## 5. Usage
65
+ This repository contains LoRA adapter weights only.
66
+ The base model must be obtained separately.
67
+
68
+
69
+ Example usage with Unsloth:
70
+
71
+
72
+ ```python
73
+ from unsloth import FastLanguageModel
74
+
75
+
76
+ model, tokenizer = FastLanguageModel.from_pretrained(
77
+ model_name="Qwen/Qwen3-4B-Instruct-2507",
78
+ load_in_4bit=True,
79
+ )
80
+
81
+
82
+ model.load_adapter("YOUR_HF_REPO_ID")