patrickNLP commited on
Commit
0639b44
Β·
verified Β·
1 Parent(s): c80f04b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +77 -14
README.md CHANGED
@@ -1,43 +1,106 @@
1
  ---
2
  license: cc-by-sa-4.0
 
 
 
 
 
 
3
  ---
4
 
5
- # BIRD-CRITIC-1.0-PostgreSQL
6
 
7
- <!-- Quick summary of the dataset. -->
8
- BIRD-Critic is the first SQL debugging benchmark designed to answer a critical question: **Can large language models (LLMs) resolve real-world user bugs in database applications?** To build this benchmark, we curated realistic bug cases from Stack Overflow.
 
 
 
 
 
 
 
 
 
9
 
10
- We are releasing a lite version of BIRD-Critic, which includes 200 PostgreSQL data instances. These instances focus on Stack Overflow issues where we:
11
- - Collect SQL debugging scenarios.
12
- - Distill problem definitions.
13
- - Reproduce bugs and solutions in the BIRD environment.
14
- - Design test cases for evaluation.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
 
16
  ## Dataset Details
17
 
18
  ### Dataset Description
19
 
20
- - **Curated by:** BIRD Team
21
  - **License:** [cc-by-sa-4.0](https://creativecommons.org/licenses/by-sa/4.0/)
22
 
23
  ## Uses
24
 
25
- To avoid data leakage, if you are interested in accessing the full dataset, please email [bird.[email protected]](mailto:[email protected]).
 
26
 
27
  ### Code Sources
28
 
29
- - **Repository:** [More Information Needed]
30
 
31
  ## Dataset Structure
32
 
33
  Below is a description of the dataset fields and additional information about the structure:
34
 
35
  - **db_id**: The name of the database.
36
- - **query**: The user query rewritten in the BIRD environment.
37
  - **error_sql**: The buggy SQL query written by the user.
38
  - **sol_sql**: The ground truth SQL solution.
39
  - **preprocess_sql**: SQL queries to run before executing the solution or prediction.
40
  - **clean_up_sql**: SQL queries to run after the test cases to revert any changes made to the database.
41
  - **test_cases**: A set of test cases to validate the predicted corrected SQL.
42
- - **efficiency**: True if this question need optimization, measure the cost by Query Execution Plan (QEP)
43
- - **external_data**: For the external JSON data if present
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: cc-by-sa-4.0
3
+ language:
4
+ - en
5
+ tags:
6
+ - text-to-sql
7
+ - database
8
+ - code
9
  ---
10
 
11
+ # BIRD-CRITIC-1.0-Flash
12
 
13
+ BIRD-Critic is the first SQL debugging benchmark designed to answer a critical question:
14
+ **Can large language models (LLMs) resolve user issues in real-world database applications?** \
15
+ Each task in BIRD-CRITIC has been verified by human experts on the following dimensions:
16
+ 1) Reproduction of errors on BIRD env
17
+ 2) Carefully curate test case functions for each task specifically.
18
+ - **Soft EX**: This metric can evaluate SELECT-ONLY tasks.
19
+ - **Soft EX + Parsing**: This metric can evaluate tasks with user specific requirements or refinements.
20
+ - **Test Case**: For CRUD (CREAT, READ, UPDATE, DELETE) and other tasks with DBA use, test cases should be promised to evaluate the correct logic. This is also effective for user issues requiring multiple sequential SQLs to resolve.
21
+ - **Query Execution Plan**: For user tasks involving efficiency improvement or runtime errors, QEP can be introduced to evaluate solution SQLs on algorithm level.
22
+ 4) Fast Eval Sandbox via PostgreSQL template & docker.
23
+ 5) Created new RDBs in different scale and professional domains.
24
 
25
+ We are releasing a lite version of BIRD-Critic, `bird-critic-1.0-flash-exp`, which includes 200 high-quality user issues on PostgreSQL when developing real-world applications. We curate tasks by:
26
+ - Collecting and understanding realistic user issues.
27
+ - Distilling problem definitions and SQL knowledge.
28
+ - Reproducing bugs and solutions in the BIRD environment.
29
+ - Designing test cases for evaluation.
30
+
31
+ # Model Performance Results
32
+
33
+ | Rank | Model Name | Score | Level |
34
+ |------|------------|-------|-----------|
35
+ | 1 | bird-critic-1.0-flash | 38.50 | πŸ† Leading |
36
+ | 2 | deepseek-reasoner | 34.0 | 🌟 Elite |
37
+ | 3 | gpt-4o-2024-11-20 | 29.0 | 🌟 Elite |
38
+ | 4 | o1-mini | 28.0 | πŸ’Ž Superior |
39
+ | 5 | deepseek-V3 | 27.5 | πŸ’Ž Superior |
40
+ | 6 | phi-4 | 24.5 | πŸ’Ž Superior |
41
+ | 7 | claude-3-5-sonnet | 24.0 | πŸ”Έ Advanced |
42
+ | 8 | gemini-2.0-flash-exp | 24.0 | πŸ”Έ Advanced |
43
+ | 9 | Qwen2.5-Coder-32B-Instruct | 23.5 | πŸ”Έ Advanced |
44
+ | 10 | gemini-2.0-flash-thinking-exp | 19.5 | πŸ”Έ Advanced |
45
+ | 11 | Meta-Llama-3.3-70B-Instruct | 18.5 | πŸ’« Standard |
46
+ | 12 | Codestral-22B-v0.1 | 18.0 | πŸ’« Standard |
47
+ | 13 | gemma-2-27b-it | 18.0 | πŸ’« Standard |
48
+ | 14 | QwQ-32B-Preview | 17.5 | πŸ’« Standard |
49
+ | 15 | starcoder2-15b-instruct-v0.1 | 15.5 | πŸ’« Standard |
50
+ | 16 | DeepSeek-Coder-V2-Lite-Instruct | 12.5 | βšͺ Basic |
51
+ | 17 | Mixtral-8x7B-Instruct-v0.1 | 11.5 | βšͺ Basic |
52
+ | 18 | gemma-2-9b-it | 10.5 | βšͺ Basic |
53
+ | 19 | Yi-1.5-34B-Chat-16K | 10.5 | βšͺ Basic |
54
+ | 20 | CodeLlama-34b-Instruct-hf | 10.0 | βšͺ Basic |
55
+ | 21 | CodeLlama-13b-Instruct-hf | 8.5 | βšͺ Basic |
56
+ | 22 | Mistral-7B-Instruct-v0.2 | 3.5 | βšͺ Basic |
57
+
58
+ **Tier Classification (By Ranking):**
59
+ - πŸ† Leading: Top 5%
60
+ - 🌟 Elite: Top 15%
61
+ - πŸ’Ž Superior: Top 30%
62
+ - πŸ”Έ Advanced: Top 45%
63
+ - πŸ’« Standard: Top 70%
64
+ - βšͺ Basic: Bottom 30%
65
 
66
  ## Dataset Details
67
 
68
  ### Dataset Description
69
 
70
+ - **Curated by:** BIRD Team & Google Cloud
71
  - **License:** [cc-by-sa-4.0](https://creativecommons.org/licenses/by-sa/4.0/)
72
 
73
  ## Uses
74
 
75
+ To avoid data leakage by auto-crawling, we do not include GT solution sqls and test cases along with data.
76
+ please email [[email protected]](mailto:[email protected]) or [[email protected]](mailto:[email protected]) for full set, which will be sent automatically.
77
 
78
  ### Code Sources
79
 
80
+ - **Repository:** Comming soon.
81
 
82
  ## Dataset Structure
83
 
84
  Below is a description of the dataset fields and additional information about the structure:
85
 
86
  - **db_id**: The name of the database.
87
+ - **query**: The user query is rewritten in the BIRD environment.
88
  - **error_sql**: The buggy SQL query written by the user.
89
  - **sol_sql**: The ground truth SQL solution.
90
  - **preprocess_sql**: SQL queries to run before executing the solution or prediction.
91
  - **clean_up_sql**: SQL queries to run after the test cases to revert any changes made to the database.
92
  - **test_cases**: A set of test cases to validate the predicted corrected SQL.
93
+ - **efficiency**: True if this question needs optimization, measure the cost by Query Execution Plan (QEP)
94
+ - **external_data**: For the external JSON data if present
95
+
96
+ # Todo Lists
97
+
98
+ - [x] Release lite version, bird-critic-1.0-flash (200).
99
+ - [ ] Open source code, leaderboard page.
100
+ - [ ] Release Full bird-critic-1.0-open (600 w/ 5 dialects).
101
+ - [ ] Release Full bird-critic-1.0-postgresql (600 pg tasks).
102
+ - [ ] Update agent baselines.
103
+ - [ ] BIRD-CRITIC 1.5 / 2.0 on track!
104
+
105
+ ### Post By:
106
+ BIRD Team & Google Cloud