Datasets:
docs: add parquet stale-artifact guard workflow
Browse files- ADDING_NEW_UD_VERSION.md +10 -4
- tools/README.md +6 -5
ADDING_NEW_UD_VERSION.md
CHANGED
|
@@ -225,13 +225,13 @@ cat blocked_treebanks.yaml
|
|
| 225 |
|
| 226 |
```bash
|
| 227 |
# Test with 3 treebanks first
|
| 228 |
-
uv run ./04_generate_parquet.py --ud-ver ${NEW_VER} --test
|
| 229 |
|
| 230 |
# If successful, generate all treebanks (takes 2-4 hours)
|
| 231 |
-
uv run ./04_generate_parquet.py --ud-ver ${NEW_VER}
|
| 232 |
|
| 233 |
# Re-runs on an existing branch should overwrite in-place
|
| 234 |
-
# uv run ./04_generate_parquet.py --ud-ver ${NEW_VER} --overwrite
|
| 235 |
|
| 236 |
# This creates:
|
| 237 |
# - ../parquet/{treebank_name}/{split}.parquet for all treebanks
|
|
@@ -247,6 +247,11 @@ du -sh ../parquet/
|
|
| 247 |
- `--test`: Generate only 3 treebanks (quick test)
|
| 248 |
- `--overwrite`: Regenerate existing files
|
| 249 |
- `--blocked-treebanks`: Path to YAML file with blocked treebanks
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 250 |
|
| 251 |
**Expected time:** 2-4 hours for all treebanks
|
| 252 |
|
|
@@ -449,7 +454,7 @@ for UD_VER in 2.7 2.8 2.9 2.10 2.11 2.12 2.13 2.14 2.15 2.16 2.17; do
|
|
| 449 |
uv run ./03_generate_README.py -o --ud-ver "${UD_VER}"
|
| 450 |
cp "README-${UD_VER}" ../README.md
|
| 451 |
cp "metadata-${UD_VER}.json" ../metadata.json
|
| 452 |
-
uv run ./04_generate_parquet.py --ud-ver "${UD_VER}" --overwrite
|
| 453 |
uv run ./05_validate_parquet.py --ud-ver "${UD_VER}" --local
|
| 454 |
cd ..
|
| 455 |
|
|
@@ -560,6 +565,7 @@ Before marking the release as complete:
|
|
| 560 |
- [ ] `metadata-{VER}.json` generated with blocked treebank info
|
| 561 |
- [ ] `README-{VER}` generated
|
| 562 |
- [ ] Parquet files generated for all non-blocked treebanks
|
|
|
|
| 563 |
- [ ] Full local validation run (`--local` without `--test`)
|
| 564 |
- [ ] Root files synced from tools outputs before parquet generation and before commit
|
| 565 |
- [ ] Files copied to repository root (`README.md`, `metadata.json`, `parquet/`)
|
|
|
|
| 225 |
|
| 226 |
```bash
|
| 227 |
# Test with 3 treebanks first
|
| 228 |
+
uv run ./04_generate_parquet.py --ud-ver ${NEW_VER} --test --prune-extra --check-extra
|
| 229 |
|
| 230 |
# If successful, generate all treebanks (takes 2-4 hours)
|
| 231 |
+
uv run ./04_generate_parquet.py --ud-ver ${NEW_VER} --prune-extra --check-extra
|
| 232 |
|
| 233 |
# Re-runs on an existing branch should overwrite in-place
|
| 234 |
+
# uv run ./04_generate_parquet.py --ud-ver ${NEW_VER} --overwrite --prune-extra --check-extra
|
| 235 |
|
| 236 |
# This creates:
|
| 237 |
# - ../parquet/{treebank_name}/{split}.parquet for all treebanks
|
|
|
|
| 247 |
- `--test`: Generate only 3 treebanks (quick test)
|
| 248 |
- `--overwrite`: Regenerate existing files
|
| 249 |
- `--blocked-treebanks`: Path to YAML file with blocked treebanks
|
| 250 |
+
- `--check-extra`: Fail fast if extra parquet files/directories are present
|
| 251 |
+
- `--prune-extra`: Delete extra parquet files/directories before generation
|
| 252 |
+
|
| 253 |
+
**Recommended release flags:** `--prune-extra --check-extra` to guard against
|
| 254 |
+
stale parquet artifacts when treebanks are renamed/removed between UD versions.
|
| 255 |
|
| 256 |
**Expected time:** 2-4 hours for all treebanks
|
| 257 |
|
|
|
|
| 454 |
uv run ./03_generate_README.py -o --ud-ver "${UD_VER}"
|
| 455 |
cp "README-${UD_VER}" ../README.md
|
| 456 |
cp "metadata-${UD_VER}.json" ../metadata.json
|
| 457 |
+
uv run ./04_generate_parquet.py --ud-ver "${UD_VER}" --overwrite --prune-extra --check-extra
|
| 458 |
uv run ./05_validate_parquet.py --ud-ver "${UD_VER}" --local
|
| 459 |
cd ..
|
| 460 |
|
|
|
|
| 565 |
- [ ] `metadata-{VER}.json` generated with blocked treebank info
|
| 566 |
- [ ] `README-{VER}` generated
|
| 567 |
- [ ] Parquet files generated for all non-blocked treebanks
|
| 568 |
+
- [ ] Parquet run used stale-artifact guard (`--prune-extra --check-extra`)
|
| 569 |
- [ ] Full local validation run (`--local` without `--test`)
|
| 570 |
- [ ] Root files synced from tools outputs before parquet generation and before commit
|
| 571 |
- [ ] Files copied to repository root (`README.md`, `metadata.json`, `parquet/`)
|
tools/README.md
CHANGED
|
@@ -25,7 +25,7 @@ cp README-${NEW_VER} ../README.md
|
|
| 25 |
cp metadata-${NEW_VER}.json ../metadata.json
|
| 26 |
|
| 27 |
# Generate and fully validate parquet
|
| 28 |
-
uv run 04_generate_parquet.py --ud-ver "${NEW_VER}"
|
| 29 |
uv run 05_validate_parquet.py --ud-ver "${NEW_VER}" --local
|
| 30 |
|
| 31 |
# Stage generated outputs
|
|
@@ -59,7 +59,7 @@ for UD_VER in 2.7 2.8 2.9 2.10 2.11 2.12 2.13 2.14 2.15 2.16 2.17; do
|
|
| 59 |
uv run 03_generate_README.py -o --ud-ver "${UD_VER}"
|
| 60 |
cp README-${UD_VER} ../README.md
|
| 61 |
cp metadata-${UD_VER}.json ../metadata.json
|
| 62 |
-
uv run 04_generate_parquet.py --ud-ver "${UD_VER}" --overwrite
|
| 63 |
uv run 05_validate_parquet.py --ud-ver "${UD_VER}" --local
|
| 64 |
cd ..
|
| 65 |
|
|
@@ -119,7 +119,8 @@ done
|
|
| 119 |
- Converts CoNLL-U files to Parquet format
|
| 120 |
- Creates: `../parquet/{treebank}/{split}.parquet`
|
| 121 |
- Uses `tools/metadata-{UD_VER}.json` when present; otherwise falls back to `../metadata.json`
|
| 122 |
-
- Options: `--ud-ver`, `--test`, `--overwrite`, `--blocked-treebanks`
|
|
|
|
| 123 |
|
| 124 |
### 05 - Validate Parquet
|
| 125 |
|
|
@@ -185,7 +186,7 @@ pip install ud-hf-parquet-tools pyyaml python-dotenv jinja2
|
|
| 185 |
|
| 186 |
**Test on subset:**
|
| 187 |
```bash
|
| 188 |
-
uv run ./04_generate_parquet.py --ud-ver 2.17 --test
|
| 189 |
uv run ./05_validate_parquet.py --ud-ver 2.17 --test --local
|
| 190 |
```
|
| 191 |
|
|
@@ -198,7 +199,7 @@ uv run ./05_validate_parquet.py --ud-ver 2.17 --local
|
|
| 198 |
```bash
|
| 199 |
./02_generate_metadata.py --ud-ver 2.17 -o
|
| 200 |
./03_generate_README.py --ud-ver 2.17 -o
|
| 201 |
-
uv run ./04_generate_parquet.py --ud-ver 2.17 --overwrite
|
| 202 |
```
|
| 203 |
|
| 204 |
**Skip blocked treebanks:**
|
|
|
|
| 25 |
cp metadata-${NEW_VER}.json ../metadata.json
|
| 26 |
|
| 27 |
# Generate and fully validate parquet
|
| 28 |
+
uv run 04_generate_parquet.py --ud-ver "${NEW_VER}" --prune-extra --check-extra
|
| 29 |
uv run 05_validate_parquet.py --ud-ver "${NEW_VER}" --local
|
| 30 |
|
| 31 |
# Stage generated outputs
|
|
|
|
| 59 |
uv run 03_generate_README.py -o --ud-ver "${UD_VER}"
|
| 60 |
cp README-${UD_VER} ../README.md
|
| 61 |
cp metadata-${UD_VER}.json ../metadata.json
|
| 62 |
+
uv run 04_generate_parquet.py --ud-ver "${UD_VER}" --overwrite --prune-extra --check-extra
|
| 63 |
uv run 05_validate_parquet.py --ud-ver "${UD_VER}" --local
|
| 64 |
cd ..
|
| 65 |
|
|
|
|
| 119 |
- Converts CoNLL-U files to Parquet format
|
| 120 |
- Creates: `../parquet/{treebank}/{split}.parquet`
|
| 121 |
- Uses `tools/metadata-{UD_VER}.json` when present; otherwise falls back to `../metadata.json`
|
| 122 |
+
- Options: `--ud-ver`, `--test`, `--overwrite`, `--blocked-treebanks`, `--check-extra`, `--prune-extra`
|
| 123 |
+
- Recommended for release runs: `--prune-extra --check-extra` to prevent stale parquet files when treebanks are renamed/removed across UD versions
|
| 124 |
|
| 125 |
### 05 - Validate Parquet
|
| 126 |
|
|
|
|
| 186 |
|
| 187 |
**Test on subset:**
|
| 188 |
```bash
|
| 189 |
+
uv run ./04_generate_parquet.py --ud-ver 2.17 --test --prune-extra --check-extra
|
| 190 |
uv run ./05_validate_parquet.py --ud-ver 2.17 --test --local
|
| 191 |
```
|
| 192 |
|
|
|
|
| 199 |
```bash
|
| 200 |
./02_generate_metadata.py --ud-ver 2.17 -o
|
| 201 |
./03_generate_README.py --ud-ver 2.17 -o
|
| 202 |
+
uv run ./04_generate_parquet.py --ud-ver 2.17 --overwrite --prune-extra --check-extra
|
| 203 |
```
|
| 204 |
|
| 205 |
**Skip blocked treebanks:**
|