Rj18 commited on
Commit
a3f482d
·
verified ·
1 Parent(s): b55ed9a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -182
README.md CHANGED
@@ -2,208 +2,66 @@
2
  base_model: TinyLlama/TinyLlama-1.1B-Chat-v1.0
3
  library_name: peft
4
  pipeline_tag: text-generation
 
 
 
 
 
5
  tags:
6
  - base_model:adapter:TinyLlama/TinyLlama-1.1B-Chat-v1.0
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.18.1
 
 
 
 
 
 
2
  base_model: TinyLlama/TinyLlama-1.1B-Chat-v1.0
3
  library_name: peft
4
  pipeline_tag: text-generation
5
+ license: mit
6
+ language:
7
+ - en
8
+ datasets:
9
+ - spider
10
  tags:
11
  - base_model:adapter:TinyLlama/TinyLlama-1.1B-Chat-v1.0
12
  - lora
13
  - sft
14
  - transformers
15
  - trl
16
+ - text-to-sql
17
+ - sql
18
+ - natural-language-processing
19
+ metrics:
20
+ - loss
21
  ---
22
 
23
+ # Text-to-SQL TinyLlama LoRA Adapter
 
 
 
24
 
25
+ A fine-tuned LoRA adapter that converts **natural language questions into SQL queries**. Built on top of [TinyLlama-1.1B-Chat-v1.0](https://huggingface.co/TinyLlama/TinyLlama-1.1B-Chat-v1.0) using Supervised Fine-Tuning (SFT) on the Spider benchmark dataset.
26
 
27
  ## Model Details
28
 
29
  ### Model Description
30
 
31
+ This is a **LoRA (Low-Rank Adaptation) adapter** fine-tuned to generate SQL queries from natural language questions. Only 0.10% of the base model's parameters were trained, making it extremely lightweight (4.5 MB) while still achieving strong results.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
32
 
33
+ - **Developed by:** [Rj18](https://huggingface.co/Rj18)
34
+ - **Model type:** Causal Language Model (LoRA Adapter)
35
+ - **Language(s):** English
36
+ - **License:** MIT
37
+ - **Fine-tuned from:** [TinyLlama/TinyLlama-1.1B-Chat-v1.0](https://huggingface.co/TinyLlama/TinyLlama-1.1B-Chat-v1.0)
38
 
39
+ ### Model Sources
40
 
41
+ - **Repository:** [https://github.com/18-RAJAT/Interactive-Production-text2sql-Pipeline](https://github.com/18-RAJAT/Interactive-Production-text2sql-Pipeline)
42
 
43
+ ## How to Use
44
 
45
+ import torch
46
+ from transformers import AutoModelForCausalLM, AutoTokenizer
47
+ from peft import PeftModel
48
 
49
+ # Load base model and tokenizer
50
+ base_model = "TinyLlama/TinyLlama-1.1B-Chat-v1.0"
51
+ adapter = "Rj18/text-to-sql-tinyllama-lora"
52
 
53
+ tokenizer = AutoTokenizer.from_pretrained(adapter)
54
+ model = AutoModelForCausalLM.from_pretrained(base_model, torch_dtype=torch.float16)
55
+ model = PeftModel.from_pretrained(model, adapter)
56
+ model.eval()
57
 
58
+ # Generate SQL
59
+ question = "How many employees are in each department?"
60
+ prompt = f"[INST] Generate SQL for the following question.\nQuestion: {question} [/INST]\n"
61
 
62
+ inputs = tokenizer(prompt, return_tensors="pt")
63
+ with torch.no_grad():
64
+ outputs = model.generate(**inputs, max_new_tokens=128, temperature=0.1)
65
+
66
+ sql = tokenizer.decode(outputs[0], skip_special_tokens=True)
67
+ print(sql)