cwolff commited on
Commit
d319c21
·
verified ·
1 Parent(s): 206f180

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +49 -0
README.md CHANGED
@@ -35,3 +35,52 @@ configs:
35
  - split: train
36
  path: data/train-*
37
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
  - split: train
36
  path: data/train-*
37
  ---
38
+
39
+ # SQaLe 2 - Work in Progress
40
+
41
+ ## Using the SQaLe Library
42
+
43
+ The [SQaLe library](https://pypi.org/project/SQaLe/) turns this dataset into ready-to-query SQLite databases — one `.db` file per unique schema, pre-populated with the synthetic row data.
44
+
45
+ **Install:**
46
+ ```bash
47
+ pip install SQaLe
48
+ ```
49
+
50
+ **CLI — download and materialize schemas directly from HuggingFace:**
51
+ ```bash
52
+ # All unique schemas
53
+ sqale-extract --output ./dbs
54
+
55
+ # First 100 unique schemas only
56
+ sqale-extract --output ./dbs --limit 100
57
+ ```
58
+
59
+ **Python API:**
60
+ ```python
61
+ from sqale import deserialize_sqale
62
+
63
+ results = deserialize_sqale(
64
+ file_path="trl-lab/SQaLe_2",
65
+ output_dir="./dbs",
66
+ limit=100, # optional
67
+ )
68
+
69
+ for r in results:
70
+ print(r["db_path"], r["rows_per_table"])
71
+ ```
72
+
73
+ Each entry in the returned list contains the path to the `.db` file, the table names, row counts per table, and any error encountered during materialization.
74
+
75
+ ## Citation
76
+
77
+ ```
78
+ @inproceedings{
79
+ wolff2025sqale,
80
+ title={{SQ}aLe: A large text-to-{SQL} corpus grounded in real schemas},
81
+ author={Cornelius Wolff and Daniel Gomm and Madelon Hulsebos},
82
+ booktitle={EurIPS 2025 Workshop: AI for Tabular Data},
83
+ year={2025},
84
+ url={https://openreview.net/forum?id=6PsKDjgoEy}
85
+ }
86
+ ```