Improve model card: Add pipeline tag, library, comprehensive content, and correct GitHub links

README.md

@@ -1,5 +1,7 @@
 ---
 license: apache-2.0
+pipeline_tag: text-generation
+library_name: transformers
 ---
 
 <div align="center">
@@ -25,18 +27,35 @@ license: apache-2.0
 </div>
 
 <div align="center" style="display: flex; gap: 5px; justify-content: center;">
-<a href="https://idea-finai.github.io/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/MPX0222/SQL-R1"><img src="https://img.shields.io/badge/⭐_GitHub-SQL--R1-2F80ED?style=flat-square"/></a>
-<a href="https://huggingface.co/MPX0222forHF/SQL-R1-7B"><img src="https://img.shields.io/badge/🤗_HuggingFace-SQL--R1-FF9D00?style=flat-square"/></a>
-<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>
+<a href="https://dataarctech.github.io/SQL-R1/"><img src="https://img.shields.io/badge/🏠_Homepage-blue?style=for-the-badge"/></a>
+<a href="https://arxiv.org/abs/2504.08600"><img src="https://img.shields.io/badge/arXiv-red?style=for-the-badge&logo=arxiv"/></a>
+<a href="https://huggingface.co/papers/2504.08600"><img src="https://img.shields.io/badge/Paper-HuggingFace-ffbd45.svg?style=for-the-badge&logo=huggingface"/></a>
+<a href="https://github.com/IDEA-FinAI/SQL-R1"><img src="https://img.shields.io/badge/GitHub-black?style=for-the-badge&logo=github"/></a>
+<a href="https://huggingface.co/MPX0222forHF/SQL-R1-7B"><img src="https://img.shields.io/badge/HuggingFace-FF9D00?style=for-the-badge&logo=huggingface"/></a>
+<a href="https://www.modelscope.cn/models/MPX0222/SQL-R1-7B"><img src="https://img.shields.io/badge/🤖_ModelScope-946CE6?style=for-the-badge"/></a>
+<a href="https://github.com/IDEA-FinAI/SQL-R1/stargazers"><img src="https://img.shields.io/github/stars/IDEA-FinAI/SQL-R1?style=for-the-badge&color=white"/></a>
 </div>
+<br>
 
+<div align="center" style="display: flex; gap: 5px; justify-content: center;">
+  <p>
+  <b>🔥  Our work is accepted by NeurIPS 2025. Welcome to star and cite our work! ✨</b> 
+  </p>
+</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"/>
+<p align="center">
+Figure 1: Demonstration of our work.
+</p>
+
+</div>
+
+
 ## 📚 Citations
 
 ```bibtex
@@ -46,4 +65,137 @@ Natural Language to SQL (NL2SQL) enables intuitive interactions with databases b
   journal={arXiv preprint arXiv:2504.08600},
   year={2025}
 }
-```
+```
+
+## 📰 News
+
+- **[2025.09.18]** 🎉 SQL-R1 is accept by NeurIPS 2025! We will soon update the full version of the paper and poster. Welcome to star and cite our work!
+- **[2025.05.27]** 🎉 We have released the full version of SQL-R1.
+- **[2025.05.21]** 🎉 We have released our model weights on HuggingFace! Check out the [Model Weights](#-model-weights) section below.
+- **[2025.04.11]** 📑 Our paper is now available on [arXiv](https://arxiv.org/abs/2504.08600).
+
+
+## 🚀 Coming Soon Checklist
+
+- [x] 📝 Update the camera-ready version of the paper, homepage and poster. coming sooooon!
+- [x] 📊 Release model weights on HuggingFace and ModelScope
+- [x] 🔧 Open source training code and RL dataset
+- [x] 📝 Detailed documentation
+- [x] 🛠️ Environment setup guide
+
+
+## 🤖 Model Weights
+
+We are excited to release our SQL-R1 model weights! You can find them on HuggingFace:
+
+| Model  | Size | HuggingFace Link | ModelScope Link |
+|-------------|-------------|------|------|
+| SQL-R1 (3B) | 3B | [🤗 Download](https://huggingface.co/MPX0222forHF/SQL-R1-3B) | - |
+| SQL-R1 (7B) | 7B | [🤗 Download](https://huggingface.co/MPX0222forHF/SQL-R1-7B) | [��� Download](https://www.modelscope.cn/models/MPX0222/SQL-R1-7B) |
+| SQL-R1 (14B) | 14B | [🤗 Download](https://huggingface.co/MPX0222forHF/SQL-R1-14B) | - |
+
+
+## 📑 Documentation Structure
+
+This repository is organized as follows:
+
+```
+SQL-R1/
+├── data/                             # Datasets
+│   ├── Spider/      
+│   └── BIRD/        
+├── models/                           # Base models or checkpoints
+│   ├── Qwen2.5-Coder-3B-Instruct/   
+│   └── Qwen2.5-Coder-7B-Instruct/   
+......
+├── sh/                               # Scripts for data processing, training, inference and evaluation
+├── src/                              # Source code
+└── verl/                             # Verl framework
+```
+
+
+## 🛠️ Environment Setup
+
+> [!NOTE]
+> Before getting started, make sure your computing environment supports the following settings:
+> - Environment: Python 3.9+
+> - CUDA Version: 12.0+ (for verl and vllm integration)
+> - GPU Prerequisites: 8 x 80GB+ GPU (for training) / 2 x 40GB GPU (for inference)
+
+### Installation
+
+1. Clone the repository:
+```bash
+git clone https://github.com/IDEA-FinAI/SQL-R1.git
+cd SQL-R1
+```
+
+2. Create and activate a virtual environment (recommended):
+```bash
+conda create -n sqlr1 python=3.9
+```
+
+3. Install dependencies:
+```bash
+pip install torch==2.4.0 --index-url https://download.pytorch.org/whl/cu121
+pip install vllm==0.6.3 ray
+pip install flash-attn --no-build-isolation
+pip install -e .  # For verl integration
+pip install wandb IPython matplotlib sqlparse func_timeout nltk ijson
+```
+
+4. Download the model weights from HuggingFace and put them in the `models/` directory. 
+
+5. For training, copy the training dataset in the `example_data` directory to the `data` directory. For inference, copy the database information in the `db_info` directory (including files forSpider-dev, Spider-test and BIRD-dev) to the related dataset (`data/Spider`, `data/BIRD`) directory.
+
+## 🚀 Quick Start
+
+1. Run training:
+```bash
+sh sh/train.sh
+```
+
+2. Run inference:
+```bash
+sh sh/inference.sh
+```
+
+3. Run evaluation:
+```bash
+# evaluate spider
+sh sh/eval_spider.sh
+# evaluate bird
+sh sh/eval_bird.sh
+```
+
+## 🌟 Applications
+
+SQL-R1 can be effectively utilized in the following key areas:
+
+1.  **Foundation Model for Workflow Systems**
+    - Serves as a base model for complex database operations
+    - Enables seamless integration with existing workflow automation systems
+    - Supports customization and fine-tuning for specific business processes
+    - Provides robust API endpoints for system integration
+
+2.  **Enhanced NL2SQL Interpretability**
+    - Generates detailed explanations for SQL query construction
+    - Provides step-by-step reasoning for query transformation
+    - Helps users understand the relationship between natural language and SQL syntax
+    - Offers visualization of query execution plans
+
+3.  **Self-Evolving NL2SQL Agent Checkpoint**
+    - Acts as a foundation checkpoint for continuous learning
+    - Enables iterative improvement through feedback loops
+    - Supports transfer learning for domain-specific adaptations
+    - Facilitates model versioning and performance tracking
+
+This may be added in the future work. If you have any ideas, please feel free to contact us.
+
+## Thanks for
+
+We thank [OmniSQL](https://github.com/RUCKBReasoning/OmniSQL) and follow their evaluation code and database information retrieval code. We have adapted and modified their evaluation scripts for our project.
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=IDEA-FinAI/SQL-R1&type=Date)](https://www.star-history.com/#IDEA-FinAI/SQL-R1&Date)