haricharanhl22 commited on
Commit
8ed3943
·
verified ·
1 Parent(s): 8e80c1b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +91 -167
README.md CHANGED
@@ -1,199 +1,123 @@
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
+ language:
3
+ - en
4
+ license: llama3.2
5
+ base_model: unsloth/Llama-3.2-3B
6
+ tags:
7
+ - text-generation
8
+ - sql
9
+ - distributed-databases
10
+ - qlora
11
+ - peft
12
+ - fine-tuned
13
+ - e-commerce
14
+ pipeline_tag: text-generation
15
  ---
16
 
17
+ # Llama 3.2 3B E-commerce Distributed SQL
18
 
19
+ Fine-tuned version of Llama 3.2 3B that converts natural language questions
20
+ into SQL queries for distributed e-commerce databases.
21
 
22
+ ## Example
23
 
24
+ **Input:**
25
+ ```
26
+ ### Instruction:
27
+ Convert to distributed SQL
28
 
29
+ ### Input:
30
+ Find all customers who spent more than 1000 euros in Germany
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
 
32
+ ### Response:
33
+ ```
34
 
35
+ **Output:**
36
+ ```sql
37
+ SELECT * FROM customers
38
+ WHERE country = 'Germany' AND amount > 1000;
39
+ ```
40
 
41
+ ## Model Details
 
 
 
 
 
 
 
 
 
 
 
 
 
 
42
 
43
+ | Property | Value |
44
+ |----------|-------|
45
+ | Base model | Llama 3.2 3B |
46
+ | Fine-tuning method | QLoRA (4-bit quantization + LoRA) |
47
+ | LoRA rank | 16 |
48
+ | Trainable parameters | 0.14% |
49
+ | Training GPU | Google Colab T4 (free tier) |
50
+ | Training time | ~20 minutes |
51
+ | Dataset size | 25 examples |
52
+ | Training epochs | 3 |
53
 
54
  ## Training Details
55
 
56
+ Fine-tuned using QLoRA — 4-bit NF4 quantization with LoRA adapters on the
57
+ attention layers (`q_proj`, `v_proj`). This reduced memory requirements enough
58
+ to train on a free Colab T4 GPU (15GB VRAM) in under 20 minutes, while only
59
+ updating 0.14% of parameters.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
60
 
61
+ **Libraries used:** HuggingFace Transformers, PEFT, TRL (SFTTrainer),
62
+ bitsandbytes, datasets
63
 
64
+ ## Dataset
65
 
66
+ 25 natural language → SQL pairs covering distributed e-commerce scenarios:
67
+ - Orders across regions and shards
68
+ - Inventory across warehouses
69
+ - Customer analytics and segmentation
70
+ - Revenue aggregations
71
+ - JOIN queries across fragmented tables
72
 
73
+ **Prompt format used during training:**
74
+ ```
75
+ ### Instruction:
76
+ Convert to distributed SQL
77
 
78
+ ### Input:
79
+ {natural language question}
80
 
81
+ ### Response:
82
+ {SQL query}
83
+ ```
84
 
85
+ ## How to Use
86
+ ```python
87
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
88
+ from peft import PeftModel
89
 
90
+ # Load base model + adapter
91
+ base = AutoModelForCausalLM.from_pretrained("unsloth/Llama-3.2-3B")
92
+ model = PeftModel.from_pretrained(base, "haricharanhl22/ecommerce-distributed-sql")
93
+ tokenizer = AutoTokenizer.from_pretrained("haricharanhl22/ecommerce-distributed-sql")
94
 
95
+ pipe = pipeline("text-generation", model=model, tokenizer=tokenizer)
96
 
97
+ query = """### Instruction:
98
+ Convert to distributed SQL
99
 
100
+ ### Input:
101
+ Find top 5 customers by total order value
102
 
103
+ ### Response:"""
104
 
105
+ result = pipe(query, max_new_tokens=100, do_sample=False)
106
+ print(result[0]["generated_text"])
107
+ ```
108
 
109
+ ## Limitations
110
 
111
+ - Trained on a small dataset (25 examples) — works best for common query patterns
112
+ - Optimized for e-commerce schemas (orders, customers, products, inventory)
113
+ - May not generalize well to very complex multi-level nested subqueries
114
+ - SQL dialect closest to standard SQL / SQLite
115
 
116
+ ## Author
117
 
118
+ **Hari Charan Hosakote Lokesh**
119
+ M.Sc. Digital Engineering — Otto-von-Guericke-Universität Magdeburg
120
 
121
+ - GitHub: [haricharanhl22](https://github.com/haricharanhl22)
122
+ - LinkedIn: [haricharanhl22](https://linkedin.com/in/haricharanhl22)
123
+ - Live project: [ai-bewerbung-assistant.vercel.app](https://ai-bewerbung-assistant.vercel.app)