MertML
/

Llama2-7b-text2sql

Transformers

Safetensors

text-to-sql

Model card Files Files and versions

xet

Community

MertML commited on Feb 11

Commit

ebf5114

verified ·

1 Parent(s): 1d06ce2

Update README.md

Browse files

Files changed (1) hide show

README.md +25 -179

README.md CHANGED Viewed

@@ -3,197 +3,43 @@ library_name: transformers
 tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
 ## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- 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. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-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).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 tags: []
 ---
+# Llama 2-7B Fine-Tuned for Text-to-SQL
+This model is a fine-tuned version of the **Llama 2-7B** model, specifically adapted for **Text-to-SQL** tasks. The model was trained to generate SQL queries from natural language questions, providing a robust solution for systems that need to translate user queries into executable SQL code.
 ## Model Details
+- **Model Name**: Llama 2-7B Fine-Tuned for Text-to-SQL
+- **Base Model**: Llama 2-7B
+- **Model Developers**: Fine-tuned by MertML
+- **License**: Custom commercial license. Please refer to the repository for terms.
+- **Intended Use**: Designed for generating SQL queries from natural language input. Ideal for applications in databases, conversational agents, and data analysis tools.
+## Model Architecture
+Llama 2-7B is an autoregressive language model based on the transformer architecture. The fine-tuned version has been specifically adapted for the Text-to-SQL task, trained to convert user-written questions into valid and executable SQL queries using supervised fine-tuning.
+## Intended Use Cases
+Translating natural language queries into SQL queries, suitable for database query generation, business intelligence applications, and conversational agents that interact with databases.
+### Out-of-Scope Uses
+While this model is capable of text generation, it is fine-tuned specifically for Text-to-SQL tasks and may not perform well for general-purpose language generation tasks.
+## Training Data
+The model was fine-tuned using the [**refined-sql-create-context**](https://huggingface.co/datasets/MertML/refined-sql-create-context) dataset, which contains natural language queries, corresponding table schemas, and the correct SQL queries. This dataset was preprocessed to ensure that all queries were valid and executable on a MySQL database.
+- **Training Data Size**: 11,632 samples, split into training, validation, and test sets (80%, 10%, 10%).
+- **Data Source**: SQL-create-context dataset (refined for this task).
+- **Data Preprocessing**: Ambiguities in table schemas were resolved, invalid SQL queries were removed, and normalization was performed on SQL formatting for consistent evaluation.
+## Model Performance
+The fine-tuned Llama 2-7B on Text-to-SQL demonstrated significant improvements over the base model in generating syntactically correct and contextually relevant SQL queries. Performance was evaluated on a set of queries with varying levels of difficulty, and the model was benchmarked against the [**refined-sql-create-context**](https://huggingface.co/datasets/MertML/refined-sql-create-context) datasets.
+### Evaluation Metrics
+- **Accuracy**: Measures the percentage of generated SQL queries that are syntactically and semantically correct.
+- **Execution Success Rate**: Measures the percentage of SQL queries that execute successfully against a database.
+- **Response Quality**: Assesses the relevance and correctness of the generated SQL queries in context.