Skip to content

Commit c0cf75e

Browse files
committed
v1.1.2 modify some desc
1 parent 0b130e2 commit c0cf75e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Figure 1: Demonstration of our work.
5858
## 📰 News
5959

6060
- **[2024.05.27]** 🎉 We have released the full version of SQL-R1.
61-
- **[2024.05.21]** 🎉 We have released our model weights on Hugging Face! Check out the [Model Weights](#-model-weights) section below.
61+
- **[2024.05.21]** 🎉 We have released our model weights on HuggingFace! Check out the [Model Weights](#-model-weights) section below.
6262
- **[2024.04.11]** 📑 Our paper is now available on [arXiv](https://arxiv.org/abs/2504.08600).
6363

6464

@@ -72,7 +72,7 @@ Figure 1: Demonstration of our work.
7272

7373
## 🤖 Model Weights
7474

75-
We are excited to release our SQL-R1 model weights! You can find them on Hugging Face:
75+
We are excited to release our SQL-R1 model weights! You can find them on HuggingFace:
7676

7777
| Model | Size | Link |
7878
|-------------|-------------|------|
@@ -87,14 +87,14 @@ This repository is organized as follows:
8787

8888
```
8989
SQL-R1/
90-
├── data/ # Data processing scripts and datasets
90+
├── data/ # Datasets
9191
│ ├── Spider/
9292
│ └── BIRD/
93-
├── models/ # Base models
93+
├── models/ # Base models or checkpoints
9494
│ ├── Qwen2.5-Coder-3B-Instruct/
9595
│ └── Qwen2.5-Coder-7B-Instruct/
9696
......
97-
├── sh/ # Scripts for training, inference and evaluation
97+
├── sh/ # Scripts for data processing, training, inference and evaluation
9898
├── src/ # Source code
9999
└── verl/ # Verl framework
100100
```
@@ -129,9 +129,9 @@ pip install -e . # For verl integration
129129
pip install wandb IPython matplotlib sqlparse func_timeout
130130
```
131131

132-
4. Download the model weights from Hugging Face and put them in the `models/` directory
132+
4. Download the model weights from HuggingFace and put them in the `models/` directory.
133133

134-
5. Copy the database information in the `db_info` directory to the related dataset (`data/Spider/`, `data/BIRD/`) directory.
134+
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 to the related dataset (`data/Spider`, `data/BIRD`) directory.
135135

136136
## 🚀 Quick Start
137137
> Note: Please set the related data paths and params before running the scripts.

0 commit comments

Comments
 (0)