MertML
/

TinyLlama_v1.1-text2sql

Transformers

Safetensors

text-to-sql

Model card Files Files and versions

xet

Community

MertML commited on Feb 11

Commit

1c639f1

verified ·

1 Parent(s): 4d1deba

Update README.md

Browse files

Files changed (1) hide show

README.md +25 -181

README.md CHANGED Viewed

@@ -1,199 +1,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]

 ---
 library_name: transformers
+tags: [text-to-sql]
 ---
+# TinyLlama-7B (Fine-tuned for Text-to-SQL)
+TinyLlama-7B is a fine-tuned version of the Llama-2 7B model, specifically trained to handle Text-to-SQL tasks. It is designed to efficiently translate natural language queries into structured SQL queries, making it ideal for use in applications requiring database interactions from natural language instructions. With a smaller model size compared to larger variants, TinyLlama-7B offers a balance between performance and efficiency for environments with limited computational resources.
 ## Model Details
+- **Model Name**: TinyLlama-7B (Fine-tuned for Text-to-SQL)
+- **Base Model**: Llama-2 7B
+- **Model Type**: Fine-tuned Transformer-based language model
+- **Parameter Size**: 7 billion parameters
+- **Fine-tuning Tasks**: Text-to-SQL, Natural Language to Structured Query Translation
+- **License**: Custom commercial license (please refer to original Llama-2 model license)
+## Intended Use
+### Use Cases:
+- **Text-to-SQL**: Translating natural language questions into executable SQL queries for database retrieval tasks.
+- **Database Management**: Assisting with creating, modifying, and querying databases using natural language.
+- **General NLP**: Handling basic language tasks like question answering, summarization, and text classification when combined with SQL-related tasks.
+### Out-of-scope Uses:
+- **Harmful Content Generation**: Generating biased or harmful content, or violating local laws.
+- **Languages Other Than English**: Primary focus is on English for database queries and SQL generation.
+- **Non-SQL Tasks**: Not intended for use in tasks outside of text-to-SQL or related language generation.
+## Model Performance
+TinyLlama-7B has been fine-tuned specifically for the task of converting natural language queries into SQL queries. The fine-tuning data included a diverse set of SQL query generation tasks, making the model capable of handling complex queries, joins, aggregations, and filtering operations.
+**Evaluation on Text-to-SQL Tasks**:
+- **High accuracy in translating natural language into SQL**: TinyLlama-7B performs well in generating accurate SQL queries from user inputs, even for complex requests involving multiple tables and conditions.
+- **Efficient and Fast**: The smaller size ensures lower latency and faster inference time compared to larger models, making it more suitable for environments with limited resources.
+## Training Data
+TinyLlama-7B was fine-tuned using a variety of publicly available datasets focused on SQL generation, including text-to-SQL datasets and query-generation tasks. The model was trained on data that includes diverse table schemas, SQL queries, and natural language questions to improve its performance on Text-to-SQL tasks.