Hirojie5310 commited on
Commit
97599be
·
verified ·
1 Parent(s): 3166c7d

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +74 -179
README.md CHANGED
@@ -1,208 +1,103 @@
1
  ---
2
- base_model: unsloth/qwen3-4b-instruct-2507-unsloth-bnb-4bit
 
 
 
 
 
3
  library_name: peft
4
  pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:unsloth/qwen3-4b-instruct-2507-unsloth-bnb-4bit
7
  - lora
8
- - transformers
9
- - unsloth
 
 
 
 
 
10
  ---
11
 
12
- # Model Card for Model ID
13
 
14
- <!-- Provide a quick summary of what the model is/does. -->
 
15
 
 
 
16
 
 
 
17
 
18
- ## Model Details
19
 
20
- ### Model Description
 
21
 
22
- <!-- Provide a longer summary of what this model is. -->
 
 
 
23
 
 
 
 
24
 
 
 
 
 
25
 
26
- - **Developed by:** [More Information Needed]
27
- - **Funded by [optional]:** [More Information Needed]
28
- - **Shared by [optional]:** [More Information Needed]
29
- - **Model type:** [More Information Needed]
30
- - **Language(s) (NLP):** [More Information Needed]
31
- - **License:** [More Information Needed]
32
- - **Finetuned from model [optional]:** [More Information Needed]
33
 
34
- ### Model Sources [optional]
 
35
 
36
- <!-- Provide the basic links for the model. -->
 
 
 
 
 
 
 
 
 
 
37
 
38
- - **Repository:** [More Information Needed]
39
- - **Paper [optional]:** [More Information Needed]
40
- - **Demo [optional]:** [More Information Needed]
41
 
42
- ## Uses
 
 
 
43
 
44
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
45
 
46
- ### Direct Use
47
 
48
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 
 
 
49
 
50
- [More Information Needed]
 
51
 
52
- ### Downstream Use [optional]
53
 
54
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
55
 
56
- [More Information Needed]
 
 
57
 
58
- ### Out-of-Scope Use
 
59
 
60
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
61
-
62
- [More Information Needed]
63
-
64
- ## Bias, Risks, and Limitations
65
-
66
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
67
-
68
- [More Information Needed]
69
-
70
- ### Recommendations
71
-
72
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
73
-
74
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
75
-
76
- ## How to Get Started with the Model
77
-
78
- Use the code below to get started with the model.
79
-
80
- [More Information Needed]
81
-
82
- ## Training Details
83
-
84
- ### Training Data
85
-
86
- <!-- 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. -->
87
-
88
- [More Information Needed]
89
-
90
- ### Training Procedure
91
-
92
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
93
-
94
- #### Preprocessing [optional]
95
-
96
- [More Information Needed]
97
-
98
-
99
- #### Training Hyperparameters
100
-
101
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
102
-
103
- #### Speeds, Sizes, Times [optional]
104
-
105
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
106
-
107
- [More Information Needed]
108
-
109
- ## Evaluation
110
-
111
- <!-- This section describes the evaluation protocols and provides the results. -->
112
-
113
- ### Testing Data, Factors & Metrics
114
-
115
- #### Testing Data
116
-
117
- <!-- This should link to a Dataset Card if possible. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Factors
122
-
123
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
124
-
125
- [More Information Needed]
126
-
127
- #### Metrics
128
-
129
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
130
-
131
- [More Information Needed]
132
-
133
- ### Results
134
-
135
- [More Information Needed]
136
-
137
- #### Summary
138
-
139
-
140
-
141
- ## Model Examination [optional]
142
-
143
- <!-- Relevant interpretability work for the model goes here -->
144
-
145
- [More Information Needed]
146
-
147
- ## Environmental Impact
148
-
149
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
150
-
151
- 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).
152
-
153
- - **Hardware Type:** [More Information Needed]
154
- - **Hours used:** [More Information Needed]
155
- - **Cloud Provider:** [More Information Needed]
156
- - **Compute Region:** [More Information Needed]
157
- - **Carbon Emitted:** [More Information Needed]
158
-
159
- ## Technical Specifications [optional]
160
-
161
- ### Model Architecture and Objective
162
-
163
- [More Information Needed]
164
-
165
- ### Compute Infrastructure
166
-
167
- [More Information Needed]
168
-
169
- #### Hardware
170
-
171
- [More Information Needed]
172
-
173
- #### Software
174
-
175
- [More Information Needed]
176
-
177
- ## Citation [optional]
178
-
179
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
180
-
181
- **BibTeX:**
182
-
183
- [More Information Needed]
184
-
185
- **APA:**
186
-
187
- [More Information Needed]
188
-
189
- ## Glossary [optional]
190
-
191
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
192
-
193
- [More Information Needed]
194
-
195
- ## More Information [optional]
196
-
197
- [More Information Needed]
198
-
199
- ## Model Card Authors [optional]
200
-
201
- [More Information Needed]
202
-
203
- ## Model Card Contact
204
-
205
- [More Information Needed]
206
- ### Framework versions
207
-
208
- - PEFT 0.18.1
 
1
  ---
2
+ base_model: Qwen/Qwen3-4B-Instruct-2507
3
+ datasets:
4
+ - Hirojie5310/structured-mix-sft-qwen3
5
+ language:
6
+ - en
7
+ license: apache-2.0
8
  library_name: peft
9
  pipeline_tag: text-generation
10
  tags:
 
11
  - lora
12
+ - qlora
13
+ - structured-output
14
+ - json
15
+ - yaml
16
+ - xml
17
+ - cot-mask
18
+ - after-marker
19
  ---
20
 
21
+ # Qwen3-4B Structured Transformation LoRA v1.1 by Hirojie5310 (v1)
22
 
23
+ This repository provides a **LoRA adapter** fine-tuned from
24
+ **Qwen3-4B-Instruct-2507** using **QLoRA (4-bit) with Unsloth**.
25
 
26
+ This adapter is specialized for **structured data transformation tasks**
27
+ (JSON / YAML / XML / CSV), with strict output formatting.
28
 
29
+ This repository contains **LoRA adapter weights only**.
30
+ The base model must be loaded separately.
31
 
32
+ ## Training Objective
33
 
34
+ This LoRA adapter is trained to improve **structured output accuracy**
35
+ for deterministic format conversion tasks such as:
36
 
37
+ - JSON YAML
38
+ - JSON ↔ XML
39
+ - CSV → XML / YAML
40
+ - Schema-constrained structured transformations
41
 
42
+ Training is performed with **assistant-only loss**:
43
+ - Loss is applied **only after explicit output markers** (e.g. `Final:` or `Output:`).
44
+ - Intermediate reasoning (Chain-of-Thought) is **fully masked** and not learned.
45
 
46
+ This design ensures:
47
+ - No leakage of reasoning text
48
+ - Clean, strictly formatted final outputs
49
+ - Robust generalization to unseen structured schemas
50
 
51
+ ## Training Configuration
 
 
 
 
 
 
52
 
53
+ This version uses the same training data and objective as the previous release,
54
+ with adjusted hyperparameters for improved stability under limited GPU resources.
55
 
56
+ - Base model: Qwen3-4B-Instruct-2507
57
+ - Fine-tuning method: QLoRA (4-bit) with Unsloth
58
+ - Max sequence length: 512
59
+ - Epochs: 1
60
+ - Learning rate: 2e-5
61
+ - Weight decay: 0.01
62
+ - Batch size (effective): 16
63
+ - LoRA configuration:
64
+ - Rank (r): 64
65
+ - Alpha: 128
66
+ - Dropout: 0
67
 
68
+ ## Usage
 
 
69
 
70
+ ```python
71
+ from transformers import AutoModelForCausalLM, AutoTokenizer
72
+ from peft import PeftModel
73
+ import torch
74
 
75
+ base_model = "Qwen/Qwen3-4B-Instruct-2507"
76
+ adapter = "Hirojie5310/your-lora-repo-name"
77
 
78
+ tokenizer = AutoTokenizer.from_pretrained(base_model)
79
 
80
+ model = AutoModelForCausalLM.from_pretrained(
81
+ base_model,
82
+ torch_dtype=torch.float16,
83
+ device_map="auto",
84
+ )
85
 
86
+ model = PeftModel.from_pretrained(model, adapter)
87
+ ```
88
 
89
+ ## Sources & Terms (IMPORTANT)
90
 
91
+ Training data is a mixed dataset constructed from the following sources:
92
 
93
+ - u-10bei/structured_data_with_cot_dataset_512_v5 (MIT License)
94
+ - daichira/structured-5k-mix-sft
95
+ - daichira/structured-hard-sft-4k
96
 
97
+ These datasets are used in compliance with their respective licenses
98
+ and terms of use.
99
 
100
+ This repository distributes **LoRA adapter weights only**.
101
+ Users must comply with:
102
+ - Each dataset's original license
103
+ - The base model's original terms of use (Qwen/Qwen3-4B-Instruct-2507)