Update README.md
Browse files
README.md
CHANGED
|
@@ -16,52 +16,6 @@ tags:
|
|
| 16 |
|
| 17 |
LLM instruction finetuned for Text-to-SQL task.
|
| 18 |
|
| 19 |
-
## Model Details
|
| 20 |
-
|
| 21 |
-
### Model Description
|
| 22 |
-
|
| 23 |
-
<!-- Provide a longer summary of what this model is. -->
|
| 24 |
-
|
| 25 |
-
- **Developed by:** [dataeaze systems pvt ltd](https://www.dataeaze.io/)
|
| 26 |
-
- **Funded by :** [dataeaze systems pvt ltd](https://www.dataeaze.io/)
|
| 27 |
-
- **Shared by :** [dataeaze systems pvt ltd](https://www.dataeaze.io/)
|
| 28 |
-
- **Model type:** LlamaForCausalLM
|
| 29 |
-
- **Language(s) (NLP):** English
|
| 30 |
-
- **License:** [cc-by-nc-sa-4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en) Model is made available under non-commercial use for research purposes only. For commercial usage please connect at contactus@dataeaze.io
|
| 31 |
-
- **Finetuned from model :** [CodeLlama-7b-Instruct-hf](https://huggingface.co/codellama/CodeLlama-7b-Instruct-hf)
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
## Uses
|
| 35 |
-
|
| 36 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 37 |
-
|
| 38 |
-
### Direct Use
|
| 39 |
-
|
| 40 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 41 |
-
Model can be used a tool to convert queries in expressed in natural language (English) to SQL statements
|
| 42 |
-
|
| 43 |
-
|
| 44 |
-
### Downstream Use
|
| 45 |
-
|
| 46 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 47 |
-
The model could be used as the initial stage in a data analytics / business intelligence application pipeline.
|
| 48 |
-
|
| 49 |
-
|
| 50 |
-
### Out-of-Scope Use
|
| 51 |
-
|
| 52 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 53 |
-
|
| 54 |
-
Model has been fine tuned on a specific task of converting English language statements to SQL queries.
|
| 55 |
-
Any use beyond this is not guaranteed to be accurate.
|
| 56 |
-
|
| 57 |
-
## Bias, Risks, and Limitations
|
| 58 |
-
|
| 59 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 60 |
-
|
| 61 |
-
- **Bias:** Trained for English language only.
|
| 62 |
-
- **Risk:** Guardrails are reliant on the base models CodeLlama (Llama2). Finetuning could impact this behaviour.
|
| 63 |
-
- **Limitations:** Intended to be a small model optimised for inference. Does not provide SoTA results on accuracy.
|
| 64 |
-
|
| 65 |
|
| 66 |
## How to Get Started with the Model
|
| 67 |
|
|
@@ -160,26 +114,6 @@ print(generated_query)
|
|
| 160 |
```
|
| 161 |
|
| 162 |
|
| 163 |
-
## Evaluation
|
| 164 |
-
|
| 165 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 166 |
-
|
| 167 |
-
### Testing Data & Metrics
|
| 168 |
-
|
| 169 |
-
#### Testing Data
|
| 170 |
-
|
| 171 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 172 |
-
|
| 173 |
-
[SPIDER dataset Test Set](https://yale-lily.github.io/spider)
|
| 174 |
-
|
| 175 |
-
|
| 176 |
-
#### Metrics
|
| 177 |
-
|
| 178 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 179 |
-
|
| 180 |
-
SQL queries are matched against the correct answer, with two types of evaluation
|
| 181 |
-
* Execution with Values
|
| 182 |
-
* Exact Set Match without Values
|
| 183 |
|
| 184 |
### Results
|
| 185 |
|
|
@@ -203,14 +137,3 @@ model-index:
|
|
| 203 |
name: Spider 1.0 - Leaderboard
|
| 204 |
url: https://yale-lily.github.io/spider
|
| 205 |
```
|
| 206 |
-
|
| 207 |
-
|
| 208 |
-
## Model Card Authors
|
| 209 |
-
|
| 210 |
-
* Suyash Chougule
|
| 211 |
-
* Chittaranjan Rathod
|
| 212 |
-
* Sourabh Daptardar
|
| 213 |
-
|
| 214 |
-
## Model Card Contact
|
| 215 |
-
|
| 216 |
-
"dataeaze systems" <contactus@dataeaze.io>
|
|
|
|
| 16 |
|
| 17 |
LLM instruction finetuned for Text-to-SQL task.
|
| 18 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
|
| 20 |
## How to Get Started with the Model
|
| 21 |
|
|
|
|
| 114 |
```
|
| 115 |
|
| 116 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 117 |
|
| 118 |
### Results
|
| 119 |
|
|
|
|
| 137 |
name: Spider 1.0 - Leaderboard
|
| 138 |
url: https://yale-lily.github.io/spider
|
| 139 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|