Skip to content

Commit 48f58af

Browse files
committed
v1.0.2 Update Readme
1 parent 188659b commit 48f58af

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,36 @@
33
</div>
44

55
<div align="center" style="display: flex; gap: 5px; justify-content: center;">
6-
<a href="https://github.com/IDEA-FinAI/SQL-R1"><img src="https://img.shields.io/badge/🏠_Homepage-SQL--R1-4B4B77?style=flat-square"/></a>
6+
<a href="https://github.com/MPX0222/SQL-R1"><img src="https://img.shields.io/badge/🏠_Home-SQL--R1-4B4B77?style=flat-square"/></a>
77
<a href="https://arxiv.org/abs/2504.08600"><img src="https://img.shields.io/badge/📑_arXiv-2504.08600-00A98F?style=flat-square"/></a>
8-
<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>
9-
<!-- <a href="https://github.com/IDEA-FinAI/SQL-R1"><img src="https://img.shields.io/badge/🤗_HuggingFace-Models-FF9D00?style=flat-square"/></a> -->
10-
<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>
8+
<a href="https://github.com/MPX0222/SQL-R1"><img src="https://img.shields.io/badge/⭐_GitHub-SQL--R1-2F80ED?style=flat-square"/></a>
9+
<a href="https://github.com/MPX0222/SQL-R1"><img src="https://img.shields.io/badge/🤗_HuggingFace-Models-FF9D00?style=flat-square"/></a>
10+
<a href="https://github.com/MPX0222/SQL-R1/stargazers"><img src="https://img.shields.io/github/stars/MPX0222/SQL-R1?style=flat-square&color=946CE6"/></a>
1111
</div>
1212

13-
## Overview
13+
> 🚧 **Note:** This repository is under active development. We will be continuously updating with model weights, training code, and more resources in the coming weeks. Stay tuned! ✨
14+
15+
## 📖 Overview
1416

1517
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.
1618

1719
<div align="center">
1820
<img src="images/overview.png" alt="SQL-R1 Overview" width="800"/>
1921
</div>
2022

23+
2124
## 🚀 Coming Soon Checklist
2225

2326
- [ ] 📊 Release model weights on Hugging Face
2427
- [ ] 🔧 Open source training code
2528
- [ ] 📝 Detailed documentation
29+
- [ ] 🎯 Evaluation scripts and benchmarks
30+
- [ ] 🛠️ Environment setup guide
31+
- [ ] 📈 Training logs and results
32+
- [ ] 🎮 Interactive demo
33+
- [ ] 📚 Example usage and tutorials
2634

27-
28-
## Citations
35+
## 📚 Citations
2936
```
3037
@article{ma2025sql,
3138
title={SQL-R1: Training Natural Language to SQL Reasoning Model By Reinforcement Learning},

0 commit comments

Comments
 (0)