Update README.md
Browse files
README.md
CHANGED
|
@@ -21,40 +21,51 @@ A 1.5B parameter model fine-tuned from Qwen2.5-Coder-1.5B for Text-to-SQL genera
|
|
| 21 |
This model is a 1.5B parameter transformer model fine-tuned for Text-to-SQL generation tasks, built upon Qwen/Qwen2.5-Coder-1.5B. It is designed to translate natural language questions into accurate SQL queries across various database schemas. The fine-tuning process enhances its ability to handle complex SQL structures, improve schema grounding, and generate executable queries for downstream applications such as data querying, analytics automation, and natural language interfaces to databases.
|
| 22 |
|
| 23 |
- **Developed by:** https://www.linkedin.com/in/kuldeep-rathoree/
|
| 24 |
-
- **
|
| 25 |
-
- **
|
| 26 |
-
- **
|
| 27 |
-
- **
|
| 28 |
-
- **License:** [More Information Needed]
|
| 29 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 30 |
|
| 31 |
### Model Sources [optional]
|
| 32 |
|
| 33 |
<!-- Provide the basic links for the model. -->
|
| 34 |
|
| 35 |
-
- **Repository:**
|
| 36 |
-
- **Paper
|
| 37 |
-
- **Demo
|
|
|
|
| 38 |
|
| 39 |
## Uses
|
| 40 |
|
| 41 |
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
|
|
|
| 42 |
|
| 43 |
### Direct Use
|
| 44 |
|
| 45 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
|
|
|
| 46 |
|
| 47 |
[More Information Needed]
|
| 48 |
|
| 49 |
### Downstream Use [optional]
|
| 50 |
|
| 51 |
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 52 |
|
| 53 |
[More Information Needed]
|
| 54 |
|
| 55 |
### Out-of-Scope Use
|
| 56 |
|
| 57 |
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 58 |
|
| 59 |
[More Information Needed]
|
| 60 |
|
|
|
|
| 21 |
This model is a 1.5B parameter transformer model fine-tuned for Text-to-SQL generation tasks, built upon Qwen/Qwen2.5-Coder-1.5B. It is designed to translate natural language questions into accurate SQL queries across various database schemas. The fine-tuning process enhances its ability to handle complex SQL structures, improve schema grounding, and generate executable queries for downstream applications such as data querying, analytics automation, and natural language interfaces to databases.
|
| 22 |
|
| 23 |
- **Developed by:** https://www.linkedin.com/in/kuldeep-rathoree/
|
| 24 |
+
- **Model type:** Causal language model
|
| 25 |
+
- **Language(s) (NLP):** English (en)
|
| 26 |
+
- **License:** Apache 2.0
|
| 27 |
+
- **Finetuned from model:** Qwen/Qwen2.5-Coder-1.5B
|
|
|
|
|
|
|
| 28 |
|
| 29 |
### Model Sources [optional]
|
| 30 |
|
| 31 |
<!-- Provide the basic links for the model. -->
|
| 32 |
|
| 33 |
+
- **Repository:** ikuldeep1/Qwen2.5-Coder-1.5B-FullBase677-SQL-PEFT
|
| 34 |
+
- **Paper:** N/A
|
| 35 |
+
- **Demo:** Coming soon (Colab demo notebook in progress)
|
| 36 |
+
|
| 37 |
|
| 38 |
## Uses
|
| 39 |
|
| 40 |
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 41 |
+
This model is intended for converting natural language questions into SQL queries. It can be used to power natural language interfaces for databases, automate data querying, and support research on Text-to-SQL generation.
|
| 42 |
|
| 43 |
### Direct Use
|
| 44 |
|
| 45 |
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 46 |
+
The model can be directly used to generate SQL queries from English text prompts using the 🤗 Transformers pipeline or via the Hugging Face Inference API.
|
| 47 |
|
| 48 |
[More Information Needed]
|
| 49 |
|
| 50 |
### Downstream Use [optional]
|
| 51 |
|
| 52 |
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 53 |
+
It can be integrated into applications such as:
|
| 54 |
+
|
| 55 |
+
Data analytics dashboards with natural language interfaces
|
| 56 |
+
Chatbots that answer database-related questions
|
| 57 |
+
Tools for automating report generation or data retrieval
|
| 58 |
|
| 59 |
[More Information Needed]
|
| 60 |
|
| 61 |
### Out-of-Scope Use
|
| 62 |
|
| 63 |
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 64 |
+
The model is not suitable for:
|
| 65 |
+
|
| 66 |
+
Executing SQL queries directly on databases without validation
|
| 67 |
+
Handling non-English inputs (it’s trained primarily on English)
|
| 68 |
+
Use in production systems without proper testing or query sanitization
|
| 69 |
|
| 70 |
[More Information Needed]
|
| 71 |
|