antony-bryan-3D2Y commited on
Commit
afbfa47
·
verified ·
1 Parent(s): 8da6994

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +83 -188
README.md CHANGED
@@ -1,199 +1,94 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
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
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
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]
 
1
  ---
2
+ base_model: microsoft/phi-2
3
+ tags:
4
+ - sql
5
+ - text-to-sql
6
+ - lora
7
+ - qlora
8
+ - pytorch
9
+ license: mit
10
+ language:
11
+ - en
12
  ---
13
 
14
+ # Phi-2 SQL LoRA (lr=5e-4)
15
 
16
+ Fine-tuned [microsoft/phi-2](https://huggingface.co/microsoft/phi-2) on
17
+ [b-mc2/sql-create-context](https://huggingface.co/datasets/b-mc2/sql-create-context)
18
+ using QLoRA — achieving **70% exact match** on SQL generation, up from a 2% baseline.
19
 
20
+ This is **Run 2** (lr=5e-4).
21
+ See also: [phi2-sql-lora-lr2e4](https://huggingface.co/antony-bryan-3D2Y/phi2-sql-lora-lr2e4) (lr=2e-4, 76% EM — best run)
22
 
23
+ ## Results
24
 
25
+ | Model | Exact Match | ROUGE-L | Δ vs Base |
26
+ |---|---|---|---|
27
+ | Phi-2 Base | 2.0% | 0.886 | — |
28
+ | **This model (lr=5e-4)** | **70.0%** | **0.9825** | **+68pp** |
29
 
30
+ Evaluated on 50 held-out samples from sql-create-context (seed=42).
31
+ The lower learning rate (lr=2e-4) outperformed this run by 6 percentage points,
32
+ consistent with the general finding that conservative learning rates are more
33
+ stable for LoRA fine-tuning.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
34
 
35
  ## Training Details
36
 
37
+ | Parameter | Value |
38
+ |---|---|
39
+ | Method | QLoRA (4-bit NF4 + LoRA) |
40
+ | LoRA rank | 16 |
41
+ | LoRA alpha | 32 |
42
+ | Target modules | q_proj, v_proj |
43
+ | Dataset | 20,000 samples from sql-create-context |
44
+ | Epochs | 2 |
45
+ | Learning rate | 5e-4 |
46
+ | Effective batch size | 16 |
47
+ | Hardware | Kaggle T4 x2 |
48
+ | Training time | ~7 hours |
49
+
50
+ ## Usage
51
+
52
+ ```python
53
+ from peft import PeftModel
54
+ from transformers import AutoModelForCausalLM, AutoTokenizer, AutoConfig
55
+ import torch
56
+
57
+ model_name = "microsoft/phi-2"
58
+ tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
59
+ tokenizer.pad_token = tokenizer.eos_token
60
+
61
+ config = AutoConfig.from_pretrained(model_name, trust_remote_code=True)
62
+ config.__dict__['pad_token_id'] = tokenizer.pad_token_id
63
+
64
+ base = AutoModelForCausalLM.from_pretrained(
65
+ model_name, config=config,
66
+ dtype=torch.float16, device_map="auto", trust_remote_code=True
67
+ )
68
+ model = PeftModel.from_pretrained(base, "antony-bryan-3D2Y/phi2-sql-lora-lr5e4")
69
+ model.eval()
70
+
71
+ prompt = """### SQL Schema:
72
+ CREATE TABLE employees (id INT, name VARCHAR, department VARCHAR, salary INT)
73
+
74
+ ### Question:
75
+ What are the names of employees in the engineering department?
76
+
77
+ ### SQL Query:
78
+ """
79
+
80
+ inputs = tokenizer(prompt, return_tensors="pt").to(model.device)
81
+ with torch.no_grad():
82
+ output = model.generate(**inputs, max_new_tokens=100, do_sample=False,
83
+ eos_token_id=tokenizer.eos_token_id)
84
+ n = inputs['input_ids'].shape[1]
85
+ result = tokenizer.decode(output[0][n:], skip_special_tokens=True)
86
+ result = result.replace("</s>", "").replace("<|endoftext|>", "").split('\n')[0].strip()
87
+ print(result)
88
+ # SELECT name FROM employees WHERE department = "engineering"
89
+ ```
90
+
91
+ ## Links
92
+ - 📓 Training notebook: [llm-finetune-eval](https://github.com/antony-bryan/llm-finetune-eval)
93
+ - 📊 W&B training runs: [phi2-sql-finetune](https://wandb.ai/antonybryan2-00-anthropic/phi2-sql-finetune)
94
+ - 🔗 Run 1 (lr=2e-4): [phi2-sql-lora-lr2e4](https://huggingface.co/antony-bryan-3D2Y/phi2-sql-lora-lr2e4)