v1.0.1 First commit

Author: peixian ma

.gitignore

@@ -0,0 +1,88 @@
+# Folders
+data/
+models/
+logs/
+outputs/
+results/
+wandb/
+sh/
+openr1_ckpts/
+*.wandb
+*.out
+
+core
+test_all.ipynb
+
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# 环境和依赖
+venv/
+env/
+.env
+.venv
+ENV/
+env.bak/
+venv.bak/
+.python-version
+
+# 日志和缓存
+*.log
+logs/
+.cache
+.pytest_cache/
+.coverage
+htmlcov/
+
+# 数据和模型文件
+data/
+*.pkl
+*.h5
+*.pt
+*.pth
+*.bin
+*.ckpt
+*.model
+results/
+
+# 系统文件
+.DS_Store
+Thumbs.db
+
+# 配置文件
+config.ini
+secrets.json
+credentials.json
+*.config
+
+# 临时文件
+tmp/
+temp/
+.temp/
+*.tmp

README.md

@@ -0,0 +1,42 @@
+<div align="center">
+<h1>SQL-R1: Training Natural Language to SQL Reasoning Model By Reinforcement Learning</h1>
+</div>
+
+<div align="center" style="display: flex; gap: 5px; justify-content: center;">
+<a href="https://github.com/IDEA-FinAI/SQL-R1"><img src="https://img.shields.io/badge/🏠_Homepage-SQL--R1-4B4B77?style=flat-square"/></a>
+<a href="https://arxiv.org/abs/2504.08600"><img src="https://img.shields.io/badge/📑_arXiv-2504.08600-00A98F?style=flat-square"/></a>
+<a href="https://github.com/IDEA-FinAI/SQL-R1"><img src="https://img.shields.io/badge/⭐_GitHub-IDEA--FinAI/SQL--R1-2F80ED?style=flat-square"/></a>
+<!-- <a href="https://github.com/IDEA-FinAI/SQL-R1"><img src="https://img.shields.io/badge/🤗_HuggingFace-Models-FF9D00?style=flat-square"/></a> -->
+<a href="https://github.com/IDEA-FinAI/SQL-R1/stargazers"><img src="https://img.shields.io/github/stars/IDEA-FinAI/SQL-R1?style=flat-square&color=946CE6"/></a>
+</div>
+
+## Overview
+
+Natural Language to SQL (NL2SQL) enables intuitive interactions with databases by transforming natural language queries into structured SQL statements.  Despite recent advancements in enhancing human-computer interaction within database applications, significant challenges persist, particularly regarding the inference performance in complex scenarios involving multi-table joins and nested queries. Current methodologies primarily utilize supervised fine-tuning (SFT) to train the NL2SQL model, which may limit adaptability and interpretability in new environments (e.g., finance and healthcare). In order to enhance the reasoning performance of the NL2SQL model in the above complex situations, we introduce SQL-R1, a novel NL2SQL reasoning model trained by the reinforcement learning (RL) algorithms. We design a specialized RL-based reward function tailored for NL2SQL tasks and discussed the impact of cold start on the effectiveness of intensive training. In addition, we achieve competitive accuracy using only a tiny amount of synthetic NL2SQL data for augmented training and further explore data engineering for RL. In existing experiments, SQL-R1 achieves execution accuracy of 88.6\% and 67.1\% on the benchmark Spider and BIRD, respectively.
+
+<div align="center">
+<img src="images/overview.png" alt="SQL-R1 Overview" width="800"/>
+</div>
+
+## 🚀 Coming Soon Checklist
+
+- [ ] 📊 Release model weights on Hugging Face
+- [ ] 🔧 Open source training code
+- [ ] 📝 Detailed documentation
+
+
+## Citations
+```
+@article{ma2025sql,
+  title={SQL-R1: Training Natural Language to SQL Reasoning Model By Reinforcement Learning},
+  author={Ma, Peixian and Zhuang, Xialie and Xu, Chengjin and Jiang, Xuhui and Chen, Ran and Guo, Jian},
+  journal={arXiv preprint arXiv:2504.08600},
+  year={2025}
+}
+```
+
+
+
+
+
+