wowsocool123 commited on
Commit
10a26a9
·
verified ·
1 Parent(s): 393fb74

Upload folder using huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +94 -177
README.md CHANGED
@@ -1,210 +1,127 @@
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
- - sft
9
- - transformers
10
- - trl
11
- - unsloth
 
 
12
  ---
13
 
14
- # Model Card for Model ID
15
-
16
- <!-- Provide a quick summary of what the model is/does. -->
17
-
18
-
19
-
20
- ## Model Details
21
-
22
- ### Model Description
23
-
24
- <!-- Provide a longer summary of what this model is. -->
25
-
26
-
27
-
28
- - **Developed by:** [More Information Needed]
29
- - **Funded by [optional]:** [More Information Needed]
30
- - **Shared by [optional]:** [More Information Needed]
31
- - **Model type:** [More Information Needed]
32
- - **Language(s) (NLP):** [More Information Needed]
33
- - **License:** [More Information Needed]
34
- - **Finetuned from model [optional]:** [More Information Needed]
35
-
36
- ### Model Sources [optional]
37
-
38
- <!-- Provide the basic links for the model. -->
39
-
40
- - **Repository:** [More Information Needed]
41
- - **Paper [optional]:** [More Information Needed]
42
- - **Demo [optional]:** [More Information Needed]
43
-
44
- ## Uses
45
-
46
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
47
-
48
- ### Direct Use
49
-
50
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
51
-
52
- [More Information Needed]
53
-
54
- ### Downstream Use [optional]
55
-
56
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
57
-
58
- [More Information Needed]
59
-
60
- ### Out-of-Scope Use
61
-
62
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
63
-
64
- [More Information Needed]
65
-
66
- ## Bias, Risks, and Limitations
67
-
68
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
69
-
70
- [More Information Needed]
71
-
72
- ### Recommendations
73
-
74
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
75
-
76
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
77
-
78
- ## How to Get Started with the Model
79
-
80
- Use the code below to get started with the model.
81
-
82
- [More Information Needed]
83
-
84
- ## Training Details
85
-
86
- ### Training Data
87
-
88
- <!-- 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. -->
89
-
90
- [More Information Needed]
91
-
92
- ### Training Procedure
93
-
94
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
95
-
96
- #### Preprocessing [optional]
97
-
98
- [More Information Needed]
99
-
100
-
101
- #### Training Hyperparameters
102
-
103
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
104
-
105
- #### Speeds, Sizes, Times [optional]
106
-
107
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
108
-
109
- [More Information Needed]
110
-
111
- ## Evaluation
112
-
113
- <!-- This section describes the evaluation protocols and provides the results. -->
114
-
115
- ### Testing Data, Factors & Metrics
116
-
117
- #### Testing Data
118
-
119
- <!-- This should link to a Dataset Card if possible. -->
120
-
121
- [More Information Needed]
122
-
123
- #### Factors
124
-
125
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
126
-
127
- [More Information Needed]
128
-
129
- #### Metrics
130
-
131
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
132
-
133
- [More Information Needed]
134
-
135
- ### Results
136
-
137
- [More Information Needed]
138
-
139
- #### Summary
140
-
141
-
142
-
143
- ## Model Examination [optional]
144
-
145
- <!-- Relevant interpretability work for the model goes here -->
146
-
147
- [More Information Needed]
148
-
149
- ## Environmental Impact
150
 
151
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
 
 
152
 
153
- 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).
 
154
 
155
- - **Hardware Type:** [More Information Needed]
156
- - **Hours used:** [More Information Needed]
157
- - **Cloud Provider:** [More Information Needed]
158
- - **Compute Region:** [More Information Needed]
159
- - **Carbon Emitted:** [More Information Needed]
160
 
161
- ## Technical Specifications [optional]
 
 
162
 
163
- ### Model Architecture and Objective
 
 
 
164
 
165
- [More Information Needed]
 
 
 
 
166
 
167
- ### Compute Infrastructure
168
 
169
- [More Information Needed]
170
 
171
- #### Hardware
 
 
172
 
173
- [More Information Needed]
 
 
 
174
 
175
- #### Software
176
 
177
- [More Information Needed]
 
178
 
179
- ## Citation [optional]
180
 
181
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
182
 
183
- **BibTeX:**
 
 
 
 
 
184
 
185
- [More Information Needed]
 
 
 
186
 
187
- **APA:**
188
 
189
- [More Information Needed]
 
 
 
190
 
191
- ## Glossary [optional]
 
 
 
192
 
193
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
 
 
194
 
195
- [More Information Needed]
196
 
197
- ## More Information [optional]
 
 
 
 
 
 
 
 
 
198
 
199
- [More Information Needed]
 
 
 
200
 
201
- ## Model Card Authors [optional]
202
 
203
- [More Information Needed]
 
 
 
204
 
205
- ## Model Card Contact
 
 
 
206
 
207
- [More Information Needed]
208
- ### Framework versions
209
 
210
- - PEFT 0.19.1
 
 
1
  ---
2
+ base_model: Qwen/Qwen3-4B-Instruct-2507
3
  library_name: peft
4
+ license: apache-2.0
5
  tags:
6
+ - lora
7
+ - qlora
8
+ - peft
9
+ - regex
10
+ - code
11
+ language:
12
+ - en
13
+ pipeline_tag: text-generation
14
  ---
15
 
16
+ # Qwen3-4B Regex LoRA
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
17
 
18
+ A LoRA adapter that teaches `Qwen/Qwen3-4B-Instruct-2507` to **compose**
19
+ regular expressions — stacked lookaheads, backreferences, quantified groups,
20
+ exclusion classes — rather than recall canonical ones.
21
 
22
+ Trained on 360 programmatically generated examples, each verified by executing
23
+ the pattern against its own test cases. ~5 minutes on a free Colab T4.
24
 
25
+ ## Results
 
 
 
 
26
 
27
+ Evaluated on 24 hand-written held-out tasks in two tiers. A task passes only if
28
+ its pattern satisfies *every* held-out test case; some test cases are shown in
29
+ the prompt and the rest are withheld, so literal-matching scores zero.
30
 
31
+ | tier | what it tests | before | after |
32
+ |---|---|---|---|
33
+ | **hard** | composition (lookaheads, backrefs, counting) | 0.250 | **0.417** |
34
+ | seed | canonical patterns (postcode, IPv4, email) | 0.333 | 0.167 |
35
 
36
+ **Fine-tuning traded memorised canonical patterns for compositional skill.**
37
+ The hard tier improved 67% relative. The seed tier regressed — those are
38
+ patterns the base model already half-knew from pretraining, and training on
39
+ composition tasks partially overwrote them. Both numbers are reported because
40
+ the trade is the actual finding.
41
 
42
+ For reference, Gemini Flash-Lite scores 1.000 / 0.750 on the same tiers.
43
 
44
+ ## Usage
45
 
46
+ ```python
47
+ from peft import PeftModel
48
+ from transformers import AutoModelForCausalLM, AutoTokenizer
49
 
50
+ base = "Qwen/Qwen3-4B-Instruct-2507"
51
+ tok = AutoTokenizer.from_pretrained(base)
52
+ model = AutoModelForCausalLM.from_pretrained(base, device_map="auto")
53
+ model = PeftModel.from_pretrained(model, "wowsocool123/qwen3-4b-regex-lora")
54
 
55
+ prompt = """Write a Python regular expression for this task.
56
 
57
+ Task: Match a string of 8 to 16 characters with no whitespace, containing at \
58
+ least one lowercase letter, at least one uppercase letter, and at least one digit.
59
 
60
+ The pattern is applied with re.fullmatch (it must match the ENTIRE string).
61
 
62
+ Reply with ONLY the regular expression pattern. No explanation, no code fences,
63
+ no quotes, no re.compile() call. Just the raw pattern."""
64
 
65
+ text = tok.apply_chat_template([{"role": "user", "content": prompt}],
66
+ tokenize=False, add_generation_prompt=True)
67
+ out = model.generate(**tok(text, return_tensors="pt").to(model.device),
68
+ max_new_tokens=256, do_sample=False)
69
+ print(tok.decode(out[0], skip_special_tokens=True))
70
+ ```
71
 
72
+ Prompt format matters. The adapter was trained on the exact template above —
73
+ task description, `re.fullmatch` or `re.search` note, a few example strings,
74
+ then the "reply with ONLY the pattern" instruction. Straying far from it will
75
+ degrade output.
76
 
77
+ ## Known issues
78
 
79
+ **The model prefixes every answer with an empty `<think>\n\n</think>` block.**
80
+ Qwen3's chat template injects a reasoning block into the final assistant turn,
81
+ so all training targets carried one and the model learned to reproduce it.
82
+ Strip it before using the output:
83
 
84
+ ```python
85
+ import re
86
+ pattern = re.sub(r"<think>.*?</think>", "", raw, flags=re.DOTALL).strip()
87
+ ```
88
 
89
+ Other limitations: 24 held-out tasks is a small evaluation, so a one-task swing
90
+ moves the score by 0.083; results come from a single training run with no
91
+ seed-variance estimate; and training instructions were templated rather than
92
+ natural English, so unusual phrasing may degrade output.
93
 
94
+ ## Training
95
 
96
+ | | |
97
+ |---|---|
98
+ | Method | QLoRA (4-bit NF4 base, LoRA adapter) |
99
+ | Rank / alpha | 16 / 32 |
100
+ | Target modules | q, k, v, o, gate, up, down |
101
+ | Learning rate | 2e-4, linear schedule |
102
+ | Epochs | 3 |
103
+ | Effective batch | 8 (2 × 4 grad accum) |
104
+ | Loss | responses only (prompt masked) |
105
+ | Hardware | Colab T4, ~5 min |
106
 
107
+ `adapter_config.json` records the base as
108
+ `unsloth/qwen3-4b-instruct-2507-unsloth-bnb-4bit` — Unsloth's pre-quantised
109
+ mirror of `Qwen/Qwen3-4B-Instruct-2507`, which is what was actually trained
110
+ against. It loads fine on either.
111
 
112
+ ## Data
113
 
114
+ Training data was generated **programmatically**, not by an LLM. Nine templates
115
+ (one per regex technique) emit the instruction, the reference pattern, and the
116
+ test cases together, then every candidate is rejected unless the pattern passes
117
+ its own tests.
118
 
119
+ An earlier LLM-based generator produced 9 verified tasks in ~20 minutes with
120
+ six of nine techniques stuck at zero — asking a model to "use a backreference"
121
+ does not make it use one. Templates produced 400 verified tasks in 0.4 seconds
122
+ with every technique evenly represented.
123
 
124
+ ## Links
 
125
 
126
+ Code, evaluation harness, and full write-up:
127
+ [github.com/asadusman123/regex-finetune](https://github.com/asadusman123/regex-finetune)