premai-io
/

prem-1B-SQL

@@ -3,197 +3,104 @@ 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: []
 ---
+# Prem-1B-SQL
+Prem-1B-SQL is the one of the very first series of fully local Text-to-SQL models developed by Prem AI. Being a 1B parameter model
+it easily fits on low GPU devices (and CPU devices when quantized). We believe that AI assisted data analysis should be a Local first
+approach. Because exposing Databases to third party closed source models can lead to data security breaches. We will be publishing some
+of the public benchmarks results of this model very soon. We will also be iterating on this model for more better results.
+- **Developed by:** [Prem AI](https://www.premai.io/)
+- **License:** [MIT]
+## How to use Prem-1B-SQL
+Since it is a model built upon transformers, so it can be directly used with transformers. However running Text-to-SQL is not as simple
+as running normal LLMs. The reason lies in model input prompt formations which is tightly coupled with databases. So we have developed PremSQL,
+a fully open source library which is:
+- **Local-First**: Avoid third-party closed-source providers and keep your data secure.
+- **Customizable Datasets**: Create, fine-tune, and evaluate models with built-in or custom datasets.
+- **Robust Executors and Evaluators**: Easily connect to databases and assess model performance.
+- **Advanced Generators**: Convert natural language prompts into executable SQL queries.
+- **Error Handling and Self-Correction**: Automatically correct SQL queries during inference.
+- **Fine-Tuning Support**: Fine-tune models with LoRA, QLoRA, or full fine-tuning strategies.
+- **End-to-End Pipelines**: Seamlessly integrate all components for autonomous data analysis.
+To install PremSQL just create a new environment and type:
+```bash
+pip install -U premsql
+```
+Please [check out our documentation](https://docs.premai.io/premsql) to know about more details of the library usage.
+### Running Prem-1B-SQL using PremSQL Pipelines
+The easiest way to use this model is through PremSQL pipelines. All you need to do is provide the database path (in case of SQLite databases)
+or provide the DB connection URI. After this, all you need to do is, connect it with the model. Here is how you do that:
+```python
+from premsql.pipelines import SimpleText2SQLAgent
+from premsql.generators import Text2SQLGeneratorHF
+from premsql.executors import SQLiteExecutor
+# Provide a SQLite file here or see documentation for more customization
+dsn_or_db_path = "./data/db/california_schools.sqlite"
+agent = SimpleText2SQLAgent(
+    dsn_or_db_path=dsn_or_db_path,
+    generator=Text2SQLGeneratorHF(
+        model_or_name_or_path="premai-io/prem-1B-SQL",
+        experiment_name="simple_pipeline",
+        device="cuda:0",
+        type="test"
+    ),
+)
+question = "please list the phone numbers of the direct charter-funded schools that are opened after 2000/1/1"
+response = agent.query(question)
+response["table"]
+```
+Under the hood, it automatically connects with your Database and do all the heavy lifting like prompt creation, execution etc for you.
+### Running Prem-1B-SQL using PremSQL Generators
+You can also run the model using PremSQL Generators. This is helpful when you want to do generations in
+bulk on some dataset. Here is an example:
+```python
+from premsql.generators import Text2SQLGeneratorHF
+from premsql.datasets import Text2SQLDataset
+# Define a dataset
+dataset = bird_dataset = Text2SQLDataset(
+    dataset_name='bird', split="validation", force_download=False,
+    dataset_folder="/path/to/dataset"
+).setup_dataset(num_rows=10, num_fewshot=3)
+# Define a generator
+generator = Text2SQLGeneratorHF(
+    model_or_name_or_path="premai-io/prem-1B-SQL",
+    experiment_name="test_generators",
+    device="cuda:0",
+    type="test"
+)
+# Generate on the full dataset
+responses = generator.generate_and_save_results(
+    dataset=bird_dataset,
+    temperature=0.1,
+    max_new_tokens=256
+)
+print(responses)
+```
+You can also fine-tune Prem-1B-SQL using HuggingFace Transformers and with [PremSQL Tuners](https://docs.premai.io/premsql/tuners)  as well.
+Please [check out our documentation](https://docs.premai.io/premsql) to know about more about PremSQL and all the features
+we provide.