OmniSQL is a code-based tool that requires the user to have some programming knowledge. The following are the complete steps to install and use it.
- environmental preparation: Ensure that Python 3.8 or higher is installed, which can be done from the command line by typing
python --version
probe - Download Project:You can download the ZIP archive directly from GitHub or clone the project using the Git command
- Installation of dependencies:Go to the project directory and run
pip install -r requirements.txt
- plug-in (software):: For model inference, install vLLM or Transformers.
- Model Download:Need to download the model and SynSQL-2.5M dataset of the required size from HuggingFace
- Operational checks:: Go to the catalog and run
python omnisql.py
Checking the environment
Use preparations with the following in mind.
- Hardware Requirements:7B model requires approximately 14GB of video memory, 32B requires a higher configuration
- Currently only supports SQLite databases
- The project examples folder provides a variety of examples of prompt templates
This answer comes from the articleOmniSQL: A Model for Transforming Natural Language into High-Quality SQL QueriesThe