Datasets:
Update documentation for renamed scripts
Browse files- Update tools/README.md workflow to use new script names:
- 02_traverse_ud_repos.py → 02_generate_metadata.py
- 03_fill_universal_dependencies_tamplate.py → 03_generate_README.py
- Remove references to universal_dependencies-VERSION files (no longer generated)
- Update CONLLU_PARSING_ISSUES.md references to point to ud-hf-parquet-tools repo
- Update templates/README.tmpl with correct documentation link
- Regenerate README-2.17 from updated template
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- tools/BLOCKED_TREEBANKS.md +1 -1
- tools/README-2.17 +1 -1
- tools/README.md +10 -12
- tools/templates/README.tmpl +1 -1
tools/BLOCKED_TREEBANKS.md
CHANGED
|
@@ -126,5 +126,5 @@ uv run tools/04_generate_parquet.py
|
|
| 126 |
```
|
| 127 |
|
| 128 |
## See Also
|
| 129 |
-
- [
|
| 130 |
- [Universal Dependencies Licensing](https://lindat.mff.cuni.cz/repository/xmlui/page/license-ud-2.17)
|
|
|
|
| 126 |
```
|
| 127 |
|
| 128 |
## See Also
|
| 129 |
+
- [CONLLU_PARSING.md](https://github.com/bot-zen/ud-hf-parquet-tools/blob/main/CONLLU_PARSING.md) - CoNLL-U parsing edge cases (in ud-hf-parquet-tools)
|
| 130 |
- [Universal Dependencies Licensing](https://lindat.mff.cuni.cz/repository/xmlui/page/license-ud-2.17)
|
tools/README-2.17
CHANGED
|
@@ -2320,7 +2320,7 @@ Recent improvements include fixes for:
|
|
| 2320 |
- Empty metadata values and keys without values
|
| 2321 |
- Raw field parsing to bypass library bugs
|
| 2322 |
|
| 2323 |
-
For technical details, see [
|
| 2324 |
|
| 2325 |
### Usage
|
| 2326 |
|
|
|
|
| 2320 |
- Empty metadata values and keys without values
|
| 2321 |
- Raw field parsing to bypass library bugs
|
| 2322 |
|
| 2323 |
+
For technical details, see [CONLLU_PARSING.md](https://github.com/bot-zen/ud-hf-parquet-tools/blob/main/CONLLU_PARSING.md) in the ud-hf-parquet-tools repository.
|
| 2324 |
|
| 2325 |
### Usage
|
| 2326 |
|
tools/README.md
CHANGED
|
@@ -63,13 +63,13 @@ file already exists.
|
|
| 63 |
cd ..
|
| 64 |
```
|
| 65 |
|
| 66 |
-
5. **Regenerate metadata
|
| 67 |
```
|
| 68 |
-
./
|
| 69 |
-
./
|
| 70 |
```
|
| 71 |
-
Review the generated files (`README-${NEW_VER}`, `metadata-${NEW_VER}.json
|
| 72 |
-
|
| 73 |
|
| 74 |
6. **Generate and check parquet files**
|
| 75 |
(Update blocked_treebanks.yaml - if necessary. See BLOCKED_TREEBANKS.md)
|
|
@@ -83,14 +83,13 @@ file already exists.
|
|
| 83 |
|
| 84 |
7. **Commit and sync artefacts**
|
| 85 |
```
|
| 86 |
-
git add README-${NEW_VER} metadata-${NEW_VER}.json
|
| 87 |
-
git commit -m "Add README-${NEW_VER} metadata-${NEW_VER}.json
|
| 88 |
|
| 89 |
cp README-${NEW_VER} ../README.md
|
| 90 |
cp metadata-${NEW_VER}.json ../metadata.json
|
| 91 |
-
cp universal_dependencies-${NEW_VER} ../universal_dependencies.py
|
| 92 |
git add ../parquet
|
| 93 |
-
git commit -m "Bump to ${NEW_VER}: README.md metadata.json
|
| 94 |
|
| 95 |
git checkout main
|
| 96 |
git merge ${NEW_VER}
|
|
@@ -126,6 +125,5 @@ file already exists.
|
|
| 126 |
- collect {dev,train,test}.conllu files.
|
| 127 |
|
| 128 |
4. **03**
|
| 129 |
-
Use `./templates
|
| 130 |
-
- `
|
| 131 |
-
- `README.md`
|
|
|
|
| 63 |
cd ..
|
| 64 |
```
|
| 65 |
|
| 66 |
+
5. **Regenerate metadata and README**
|
| 67 |
```
|
| 68 |
+
./02_generate_metadata.py -o
|
| 69 |
+
./03_generate_README.py -o
|
| 70 |
```
|
| 71 |
+
Review the generated files (`README-${NEW_VER}`, `metadata-${NEW_VER}.json`)
|
| 72 |
+
before committing.
|
| 73 |
|
| 74 |
6. **Generate and check parquet files**
|
| 75 |
(Update blocked_treebanks.yaml - if necessary. See BLOCKED_TREEBANKS.md)
|
|
|
|
| 83 |
|
| 84 |
7. **Commit and sync artefacts**
|
| 85 |
```
|
| 86 |
+
git add README-${NEW_VER} metadata-${NEW_VER}.json
|
| 87 |
+
git commit -m "Add README-${NEW_VER} metadata-${NEW_VER}.json"
|
| 88 |
|
| 89 |
cp README-${NEW_VER} ../README.md
|
| 90 |
cp metadata-${NEW_VER}.json ../metadata.json
|
|
|
|
| 91 |
git add ../parquet
|
| 92 |
+
git commit -m "Bump to ${NEW_VER}: README.md metadata.json parquet/" ../README.md ../metadata.json
|
| 93 |
|
| 94 |
git checkout main
|
| 95 |
git merge ${NEW_VER}
|
|
|
|
| 125 |
- collect {dev,train,test}.conllu files.
|
| 126 |
|
| 127 |
4. **03**
|
| 128 |
+
Use `./templates/README.tmpl` to generate:
|
| 129 |
+
- `README-${UD_VER}` (dataset card for HuggingFace)
|
|
|
tools/templates/README.tmpl
CHANGED
|
@@ -137,7 +137,7 @@ Recent improvements include fixes for:
|
|
| 137 |
- Empty metadata values and keys without values
|
| 138 |
- Raw field parsing to bypass library bugs
|
| 139 |
|
| 140 |
-
For technical details, see [
|
| 141 |
|
| 142 |
### Usage
|
| 143 |
|
|
|
|
| 137 |
- Empty metadata values and keys without values
|
| 138 |
- Raw field parsing to bypass library bugs
|
| 139 |
|
| 140 |
+
For technical details, see [CONLLU_PARSING.md](https://github.com/bot-zen/ud-hf-parquet-tools/blob/main/CONLLU_PARSING.md) in the ud-hf-parquet-tools repository.
|
| 141 |
|
| 142 |
### Usage
|
| 143 |
|