Skip to main content

Text2SQL Assistant Backend

Project description

Project Curie - Text2SQL

Project description

  • Idea: Use natural language prompts to generate SQL queries

  • Front-end: VS Code Plugin

    • Integration of trained LLM into useful plugin with quick insights
    • Establish connection with existing database
    • Use natural language to describe queries to this database, which are generated by fine-tuned LLM
    • Ability to run generated SQL code directly via plugin to see results immediately with no bothersome copying
  • ...

Simple example:

simple_example.png

Project structure

evaluation/   Benchmark setups for Text-to-SQL evaluation
data/         Local datasets and sample data
docs/         Project documentation, presentations, and research notes
experiments/  Ongoing fine-tuning experiments and run notes
extension/    VS Code extension and demo database
ml/           Training, fine-tuning, and inference code
ml/models/    Model metadata, configs, and model cards

Project team and responsibilities

Name E-Mail Identifier Responsibilities / tasks
Tamer Lewis tamer.lewis@tum.de go68maj TBD
Antonia Gilles antonia.gilles@tum.de go34cih TBD
Leon Pfänder leon.pfaender@tum.de ge27fob TBD
Christoph Klein christoph.m.klein@tum.de ge42low TBD

Project setup

The project uses Python 3.12 and a pinned ML stack from requirements.txt.

python3.12 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -r requirements.txt

Verify that the installed dependencies are consistent:

python -m pip check

Git LFS for model weights

Git LFS stores large model binaries on the GitLab LFS server while Git tracks small pointer files. This repository uses LFS for *.safetensors files.

Minimal setup:

brew install git-lfs
git lfs install
git lfs pull

Add and push model weights through the normal Git workflow:

git add .gitattributes ml/models/<model>/adapter_model.safetensors
git commit -m "Add model adapter"
git push

After cloning, Git LFS normally downloads tracked files automatically. If a model file is only an LFS pointer or is missing, run git lfs pull. Verify the available model files with git lfs ls-files.

LFS does not change how the benchmark is invoked:

python3 evaluation/spider/run.py \
  --split dev \
  --model-dir ml/models/<model>

Spider

Download the Spider dataset and place it in the data/ folder:

https://drive.google.com/file/d/1403EGqzIDoHMdQF4c9Bkyl7dZLZ5Wt6J/view

Sources

TBD

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

curie_backend-0.1.0.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

curie_backend-0.1.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

Details for the file curie_backend-0.1.0.tar.gz.

File metadata

  • Download URL: curie_backend-0.1.0.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for curie_backend-0.1.0.tar.gz
Algorithm Hash digest
SHA256 709f0ed2521a1e969a71683b0037ded8d73aea3bdabe4d2ab26e9884b3a5f4cf
MD5 e4b4a476dade7aff87257a52d3cc2304
BLAKE2b-256 2c757815ac344c58f0f73963831c6827fcf263610d7cf731a381bd2bfeb0491c

See more details on using hashes here.

File details

Details for the file curie_backend-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: curie_backend-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for curie_backend-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3c2f3d357693ebdffa0b63c6267b3d1ad87d3afdccbcafa6d9de45b873b19c7e
MD5 c38f5b27500a6573080bfd5d66a10231
BLAKE2b-256 c85c71497fb592b2d001c54cd869806dc1221d2268989369473490409b6fc9f5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page