Update MIGRATION information

#4
by iiegn - opened
ADDING_NEW_UD_VERSION.md CHANGED
@@ -600,6 +600,7 @@ Before marking the release as complete:
600
  - **No Python script loader:** v2.0 architecture uses Parquet files only (no `universal_dependencies.py`)
601
  - **Helper functions external:** CoNLL-U utilities available in `ud-hf-parquet-tools` library
602
  - **Blocked treebanks:** Some treebanks excluded due to license restrictions (see `blocked_treebanks.yaml`)
 
603
  - **Branch independence:** Each UD version branch is self-contained
604
  - **Version pinning:** Users can load specific versions via `revision="2.18"`
605
 
@@ -607,7 +608,6 @@ Before marking the release as complete:
607
 
608
  - **Quick reference:** [tools/README.md](tools/README.md) - Script documentation and common operations
609
  - **Blocked treebanks:** [tools/BLOCKED_TREEBANKS.md](tools/BLOCKED_TREEBANKS.md) - License restrictions
610
- - **Migration guide:** [MIGRATION.md](MIGRATION.md) - v1.x to v2.0 migration
611
  - **Parquet tools:** https://github.com/bot-zen/ud-hf-parquet-tools - External library for CoNLL-U processing
612
  - **CoNLL-U parsing:** https://github.com/bot-zen/ud-hf-parquet-tools/blob/main/CONLLU_PARSING.md - Parsing edge cases
613
 
 
600
  - **No Python script loader:** v2.0 architecture uses Parquet files only (no `universal_dependencies.py`)
601
  - **Helper functions external:** CoNLL-U utilities available in `ud-hf-parquet-tools` library
602
  - **Blocked treebanks:** Some treebanks excluded due to license restrictions (see `blocked_treebanks.yaml`)
603
+ - **Migration guide:** [MIGRATION.md](MIGRATION.md) - v2.x to v2.y migration
604
  - **Branch independence:** Each UD version branch is self-contained
605
  - **Version pinning:** Users can load specific versions via `revision="2.18"`
606
 
 
608
 
609
  - **Quick reference:** [tools/README.md](tools/README.md) - Script documentation and common operations
610
  - **Blocked treebanks:** [tools/BLOCKED_TREEBANKS.md](tools/BLOCKED_TREEBANKS.md) - License restrictions
 
611
  - **Parquet tools:** https://github.com/bot-zen/ud-hf-parquet-tools - External library for CoNLL-U processing
612
  - **CoNLL-U parsing:** https://github.com/bot-zen/ud-hf-parquet-tools/blob/main/CONLLU_PARSING.md - Parsing edge cases
613
 
CHANGELOG.md CHANGED
@@ -5,6 +5,12 @@ All notable changes to the Universal Dependencies HuggingFace dataset loader wil
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
 
 
 
 
 
 
 
8
  ## [2.2.1] - 2026-05-29
9
 
10
  ### Added
 
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
 
8
+ ## [WIP] - 2026-05
9
+
10
+ ### Changed
11
+
12
+ - Updated [MIGRATION.md](MIGRATION.md) - Update migration path to `v2.x → v2.y`.
13
+
14
  ## [2.2.1] - 2026-05-29
15
 
16
  ### Added
MIGRATION.md CHANGED
@@ -1,483 +1,25 @@
1
- # Migration Guide: v1.x → v2.0
2
 
3
- This guide helps you migrate from Universal Dependencies dataset loader v1.x to v2.0.
4
 
5
- ## What's New in v2.0
6
-
7
- **Architecture Changes:**
8
- - **Parquet format**: Native support with datasets >=4.0.0 (5-10x faster loading)
9
- - **No Python script**: Dataset no longer requires `trust_remote_code=True`
10
- - **External helper library**: CoNLL-U processing utilities moved to [`ud-hf-parquet-tools`](https://github.com/bot-zen/ud-hf-parquet-tools)
11
 
12
  **Data Changes:**
13
- - **MWT bug fix**: Token sequences now correctly exclude Multi-Word Token surface forms
14
- - **MWT field added**: New structured `mwt` field with Multi-Word Token information
15
- - **Enhanced metadata**: Includes `num_fused` (MWT counts) in statistics
16
-
17
- ## Quick Start
18
-
19
- ### For Users with datasets >=4.0.0
20
-
21
- No code changes needed! Parquet files load automatically:
22
-
23
- ```python
24
- from datasets import load_dataset
25
-
26
- # v2.0: Works seamlessly with datasets >=4.0.0
27
- dataset = load_dataset("commul/universal_dependencies", "fr_gsd")
28
- # Automatically uses Parquet format (fast, secure)
29
- ```
30
-
31
- ### For Users with datasets <4.0.0
32
-
33
- **Option 1: Upgrade datasets (Recommended)**
34
-
35
- ```bash
36
- pip install --upgrade "datasets>=4.0.0"
37
- ```
38
-
39
- **Option 2: Continue using v1.x**
40
-
41
- ```python
42
- # v1.x: Requires trust_remote_code
43
- dataset = load_dataset("commul/universal_dependencies", "fr_gsd", trust_remote_code=True, revision="v1.0")
44
- ```
45
-
46
- ## Breaking Changes
47
-
48
- ### 1. Token Sequences Now Exclude MWT Forms
49
-
50
- **Impact:** Token counts and sequences have changed for treebanks with Multi-Word Tokens (MWTs).
51
-
52
- **What Changed:**
53
- - v1.x incorrectly included MWT surface forms in token sequences
54
- - v2.0 correctly excludes them, matching UD guidelines
55
-
56
- **Example (French "des" → "de" + "les"):**
57
-
58
- ```python
59
- # v1.x (BUGGY):
60
- {
61
- "tokens": ["Elle", "des", "de", "les", "pommes", "."], # WRONG: "des" included
62
- "lemmas": ["elle", "_", "de", "le", "pomme", "."],
63
- "upos": ["PRON", "_", "ADP", "DET", "NOUN", "PUNCT"],
64
- }
65
-
66
- # v2.0 (CORRECT):
67
- {
68
- "tokens": ["Elle", "de", "les", "pommes", "."], # CORRECT: only syntactic words
69
- "lemmas": ["elle", "de", "le", "pomme", "."],
70
- "upos": ["PRON", "ADP", "DET", "NOUN", "PUNCT"],
71
- "mwt": [{"id": "2-3", "form": "des", "misc": ""}], # MWT info preserved
72
- }
73
- ```
74
-
75
- **Affected Treebanks (50+):**
76
-
77
- Languages with common MWTs include:
78
- - **French** (fr_*): du, au, des, aux (~2-5% of tokens)
79
- - **Italian** (it_*): del, della, nel, alla (~1-3%)
80
- - **Portuguese** (pt_*): do, da, no, pelo (~2-4%)
81
- - **Spanish** (es_*): del, al (~0.5-1%)
82
- - **Arabic** (ar_*): various clitics (~1-2%)
83
- - **German** (de_*): zum, vom, am (~0.1-0.5%)
84
- - **Catalan** (ca_*): del, al, pels (~1-2%)
85
- - **Indonesian** (id_*): reduplications (~0.1%)
86
-
87
- **Action Required:**
88
-
89
- If your code assumes specific token counts or positions:
90
-
91
- ```python
92
- # v1.x code that might break:
93
- def get_third_token(example):
94
- return example["tokens"][2] # May return different token in v2.0
95
-
96
- # Migration fix:
97
- def get_third_syntactic_word(example):
98
- # v2.0: This is now correct - gets the 3rd syntactic word
99
- return example["tokens"][2]
100
-
101
- def get_third_surface_token(example):
102
- # v2.0: If you need surface forms, reconstruct from MWTs
103
- tokens = example["tokens"][:]
104
- mwts = example["mwt"]
105
-
106
- # Insert MWT forms at appropriate positions
107
- for mwt in reversed(mwts): # Process in reverse to maintain indices
108
- start, end = map(int, mwt["id"].split("-"))
109
- tokens[start-1:end] = [mwt["form"]]
110
-
111
- return tokens[2]
112
- ```
113
-
114
- ### 2. New Schema Field: `mwt`
115
-
116
- **Impact:** Dataset schema now includes an `mwt` field.
117
-
118
- **What Changed:**
119
- - Added: `mwt` field containing structured MWT information
120
- - Schema: `[{"id": "1-2", "form": "surface_form", "misc": "metadata"}]`
121
- - Empty list for treebanks without MWTs
122
-
123
- **Example Usage:**
124
-
125
- ```python
126
- from datasets import load_dataset
127
-
128
- dataset = load_dataset("commul/universal_dependencies", "fr_gsd", split="train")
129
-
130
- # Access MWT information
131
- for example in dataset:
132
- if example["mwt"]: # Has MWTs
133
- for mwt in example["mwt"]:
134
- print(f"MWT {mwt['id']}: {mwt['form']}")
135
- # Extract range
136
- start, end = map(int, mwt["id"].split("-"))
137
- syntactic_words = example["tokens"][start-1:end]
138
- print(f" → {' + '.join(syntactic_words)}")
139
-
140
- # Output example:
141
- # MWT 2-3: des
142
- # → de + les
143
- ```
144
-
145
- **Research Use Cases:**
146
-
147
- ```python
148
- # Count MWTs per treebank
149
- def count_mwts(dataset):
150
- return sum(len(ex["mwt"]) for ex in dataset)
151
-
152
- # Analyze MWT patterns
153
- def analyze_mwt_patterns(dataset):
154
- patterns = {}
155
- for ex in dataset:
156
- for mwt in ex["mwt"]:
157
- form = mwt["form"]
158
- patterns[form] = patterns.get(form, 0) + 1
159
- return patterns
160
-
161
- fr_gsd = load_dataset("commul/universal_dependencies", "fr_gsd", split="train")
162
- print(analyze_mwt_patterns(fr_gsd))
163
- # Output: {'des': 1234, 'du': 987, 'au': 654, 'aux': 321, ...}
164
- ```
165
-
166
- ### 3. Requires datasets >=4.0.0
167
-
168
- **Impact:** The Python script loader is deprecated (datasets >=4.0.0 policy).
169
-
170
- **What Changed:**
171
- - v1.x: Uses Python script with `trust_remote_code=True`
172
- - v2.0: Uses Parquet format (no remote code execution)
173
-
174
- **Security Benefit:**
175
- - No arbitrary code execution from dataset loading
176
- - Parquet files are data-only, sandboxed
177
- - Aligns with HuggingFace security policies
178
-
179
- **Migration:**
180
-
181
- ```bash
182
- # Check your datasets version
183
- python -c "import datasets; print(datasets.__version__)"
184
-
185
- # Upgrade if needed
186
- pip install --upgrade "datasets>=4.0.0"
187
- ```
188
-
189
- If you cannot upgrade datasets:
190
-
191
- ```python
192
- # Use v1.x with revision pinning
193
- dataset = load_dataset(
194
- "commul/universal_dependencies",
195
- "fr_gsd",
196
- trust_remote_code=True,
197
- revision="v1.0" # Pin to v1.x
198
- )
199
- ```
200
-
201
- ## Helper Functions Moved to External Library
202
-
203
- **Important:** Helper functions for CoNLL-U processing are now in a separate package.
204
-
205
- ### What Moved
206
-
207
- The following functions are **no longer part of the dataset**:
208
- - `parse_feats()`, `parse_misc()`, `parse_deps()` - Parse CoNLL-U field strings
209
- - `write_conllu()`, `example_to_conllu()` - Export data to CoNLL-U format
210
- - Various internal conversion utilities
211
-
212
- ### How to Access Helper Functions
213
-
214
- If you need CoNLL-U processing utilities, install the external library:
215
-
216
- ```bash
217
- pip install ud-hf-parquet-tools
218
- ```
219
-
220
- Then import from the package:
221
-
222
- ```python
223
- from datasets import load_dataset
224
- from ud_hf_parquet_tools import parse_feats, parse_misc, write_conllu
225
-
226
- # Load dataset
227
- ds = load_dataset("commul/universal_dependencies", "en_ewt", split="train")
228
-
229
- # Parse optional fields
230
- sentence = ds[0]
231
- for i, token in enumerate(sentence['tokens']):
232
- feats = parse_feats(sentence['feats'][i]) # Returns dict or {}
233
- misc = parse_misc(sentence['misc'][i]) # Returns dict or {}
234
- print(f"{token}: UPOS={sentence['upos'][i]}, feats={feats}, misc={misc}")
235
-
236
- # Export back to CoNLL-U format
237
- write_conllu(ds, "output.conllu")
238
- ```
239
-
240
- **Library Documentation:** https://github.com/bot-zen/ud-hf-parquet-tools
241
-
242
- ### If You Don't Need Helper Functions
243
-
244
- Most users only need the dataset itself and can work directly with the fields:
245
-
246
- ```python
247
- from datasets import load_dataset
248
 
249
- ds = load_dataset("commul/universal_dependencies", "en_ewt", split="train")
250
-
251
- # Access data directly
252
- sentence = ds[0]
253
- print(f"Tokens: {sentence['tokens']}")
254
- print(f"POS tags: {sentence['upos']}")
255
- print(f"Dependencies: {sentence['deprel']}")
256
-
257
- # FEATS and MISC are strings in CoNLL-U format
258
- print(f"Features (raw): {sentence['feats'][0]}") # e.g., "Case=Nom|Number=Sing"
259
- print(f"Misc (raw): {sentence['misc'][0]}") # e.g., "SpaceAfter=No"
260
-
261
- # Parse manually if needed (simple cases)
262
- feats_str = sentence['feats'][0]
263
- if feats_str:
264
- feats_dict = dict(kv.split('=') for kv in feats_str.split('|'))
265
- print(f"Features (parsed): {feats_dict}")
266
- ```
267
-
268
- ## New Features in v2.0
269
-
270
- ### 1. Parquet Format (5-10x Faster Loading)
271
-
272
- ```python
273
- # v1.x: Downloads CoNLL-U, parses on-the-fly (~10-30 seconds)
274
- dataset = load_dataset("commul/universal_dependencies", "fr_gsd", trust_remote_code=True)
275
-
276
- # v2.0: Loads pre-processed Parquet (~1-3 seconds)
277
- dataset = load_dataset("commul/universal_dependencies", "fr_gsd")
278
- ```
279
-
280
- **Benefits:**
281
- - Much faster loading (especially for large treebanks)
282
- - Lower memory usage
283
- - Better compression
284
- - Native support in datasets >=4.0.0
285
-
286
- ### 2. Multi-Word Token (MWT) Information
287
-
288
- ```python
289
- dataset = load_dataset("commul/universal_dependencies", "fr_gsd", split="train")
290
-
291
- # Find sentences with MWTs
292
- sentences_with_mwts = [ex for ex in dataset if ex["mwt"]]
293
- print(f"Sentences with MWTs: {len(sentences_with_mwts)}/{len(dataset)}")
294
-
295
- # Analyze MWT complexity
296
- complex_mwts = [ex for ex in dataset if any(
297
- int(mwt["id"].split("-")[1]) - int(mwt["id"].split("-")[0]) > 2
298
- for mwt in ex["mwt"]
299
- )]
300
- print(f"Sentences with 3+ word MWTs: {len(complex_mwts)}")
301
- ```
302
-
303
- ### 3. Enhanced Metadata
304
-
305
- ```python
306
- # Load dataset info
307
- from datasets import load_dataset_builder
308
-
309
- builder = load_dataset_builder("commul/universal_dependencies", "fr_gsd")
310
- info = builder.info
311
-
312
- # Now includes MWT statistics
313
- print(info.description) # Contains num_fused counts
314
- ```
315
-
316
- ## Verification Steps
317
-
318
- ### 1. Verify Token Counts Match UD Stats
319
-
320
- ```python
321
- from datasets import load_dataset
322
- import json
323
-
324
- # Load dataset and metadata
325
- dataset = load_dataset("commul/universal_dependencies", "fr_gsd", split="train")
326
-
327
- # Count syntactic words
328
- word_count = sum(len(ex["tokens"]) for ex in dataset)
329
-
330
- # Load metadata (if available)
331
- with open("metadata.json") as f:
332
- metadata = json.load(f)
333
-
334
- expected_words = int(metadata["fr_gsd"]["splits"]["train"]["num_words"])
335
- print(f"Dataset words: {word_count}")
336
- print(f"Expected words: {expected_words}")
337
- print(f"Match: {word_count == expected_words}")
338
-
339
- # This should be True in v2.0 (was False in v1.x for MWT treebanks)
340
- ```
341
-
342
- ### 2. Verify MWT Extraction
343
-
344
- ```python
345
- # Count MWTs
346
- mwt_count = sum(len(ex["mwt"]) for ex in dataset)
347
-
348
- expected_mwts = int(metadata["fr_gsd"]["splits"]["train"]["num_fused"])
349
- print(f"Dataset MWTs: {mwt_count}")
350
- print(f"Expected MWTs: {expected_mwts}")
351
- print(f"Match: {mwt_count == expected_mwts}")
352
- ```
353
-
354
- ### 3. Compare v1.x vs v2.0 Output
355
-
356
- ```python
357
- # Load both versions (if v1.x still available)
358
- v1 = load_dataset("commul/universal_dependencies", "en_ewt", split="test[:10]", revision="v1.0", trust_remote_code=True)
359
- v2 = load_dataset("commul/universal_dependencies", "en_ewt", split="test[:10]")
360
-
361
- # English-EWT has no MWTs, so should be identical except for new field
362
- for i in range(10):
363
- assert v1[i]["tokens"] == v2[i]["tokens"], f"Example {i} differs"
364
- assert v2[i]["mwt"] == [], f"Example {i} has unexpected MWTs"
365
-
366
- print("✓ English-EWT unchanged (no MWTs)")
367
-
368
- # French-GSD has MWTs, so v2.0 will differ
369
- v1_fr = load_dataset("commul/universal_dependencies", "fr_gsd", split="test[:10]", revision="v1.0", trust_remote_code=True)
370
- v2_fr = load_dataset("commul/universal_dependencies", "fr_gsd", split="test[:10]")
371
-
372
- # v1.x token count includes MWTs (WRONG)
373
- v1_token_count = sum(len(ex["tokens"]) for ex in v1_fr)
374
-
375
- # v2.0 token count excludes MWTs (CORRECT)
376
- v2_token_count = sum(len(ex["tokens"]) for ex in v2_fr)
377
-
378
- print(f"v1.x French token count: {v1_token_count} (includes MWT forms)")
379
- print(f"v2.0 French token count: {v2_token_count} (syntactic words only)")
380
- print(f"Difference: {v1_token_count - v2_token_count} MWT forms removed")
381
- ```
382
-
383
- ## Common Issues
384
-
385
- ### Issue 1: "Dataset script not supported" Error
386
-
387
- **Error:**
388
- ```
389
- RuntimeError: Dataset scripts are no longer supported
390
- ```
391
-
392
- **Cause:** Using datasets >=4.0.0 with v1.x loader
393
-
394
- **Solution:**
395
- ```bash
396
- pip install --upgrade "datasets>=4.0.0"
397
- # Then use v2.0 (Parquet-based)
398
- ```
399
-
400
- ### Issue 2: Token Count Mismatch
401
-
402
- **Issue:** Your code expects specific token counts that changed in v2.0
403
-
404
- **Solution:** Update your code to use `num_words` from metadata instead of `num_tokens`
405
-
406
- ```python
407
- # v1.x: Used num_tokens (WRONG for MWT treebanks)
408
- expected_count = metadata["splits"]["train"]["num_tokens"]
409
-
410
- # v2.0: Use num_words (CORRECT)
411
- expected_count = metadata["splits"]["train"]["num_words"]
412
- ```
413
-
414
- ### Issue 3: MWT Field Not Found (v1.x Code)
415
-
416
- **Issue:** Old code doesn't handle the new `mwt` field
417
-
418
- **Solution:** Gracefully handle the field or upgrade
419
-
420
- ```python
421
- # Backwards compatible code
422
- tokens = example["tokens"]
423
- mwts = example.get("mwt", []) # Empty list if not present
424
- ```
425
-
426
- ### Issue 4: Helper Function Import Errors
427
-
428
- **Error:**
429
- ```python
430
- from universal_dependencies import parse_feats
431
- # ImportError: No module named 'universal_dependencies'
432
- ```
433
-
434
- **Cause:** Helper functions moved to separate library
435
-
436
- **Solution:**
437
- ```bash
438
- # Install the helper library
439
- pip install ud-hf-parquet-tools
440
-
441
- # Update imports
442
- from ud_hf_parquet_tools import parse_feats, parse_misc, write_conllu
443
- ```
444
-
445
- Or work with raw strings directly (see "If You Don't Need Helper Functions" section above).
446
-
447
- ## Support
448
-
449
- If you encounter issues during migration:
450
-
451
- 1. Check the [CHANGELOG.md](CHANGELOG.md) for detailed changes
452
- 2. Review the [README.md](README.md) for updated examples
453
- 3. Helper library documentation: https://github.com/bot-zen/ud-hf-parquet-tools
454
- 4. Report issues at: https://huggingface.co/datasets/commul/universal_dependencies/discussions
455
 
456
  ## Summary
457
 
458
  **Key Takeaways:**
459
 
460
- ✅ **v2.0 is more correct:** Fixes critical MWT bug
461
- ✅ **v2.0 is faster:** Parquet format is 5-10x quicker
462
- ✅ **v2.0 is more secure:** No remote code execution
463
- ✅ **v2.0 adds features:** MWT information now available
464
- ✅ **v2.0 is modular:** Helper functions available as separate library
465
 
466
  **Migration Checklist:**
467
 
468
- - [ ] Upgrade to datasets >=4.0.0
469
- - [ ] Test your code with v2.0 data
470
- - [ ] Update token count expectations (if using MWT treebanks)
471
- - [ ] Update any hard-coded token indices (if applicable)
472
- - [ ] If using helper functions: Install `ud-hf-parquet-tools` and update imports
473
- - [ ] If exporting to CoNLL-U: Use `write_conllu()` from `ud-hf-parquet-tools`
474
- - [ ] Utilize new MWT field for research (optional)
475
-
476
- **Estimated Migration Time:**
477
- - Basic usage: 15-30 minutes
478
- - With helper functions: +10 minutes (install library, update imports)
479
 
480
  **Resources:**
481
- - Dataset repository: https://huggingface.co/datasets/commul/universal_dependencies
482
- - Helper library: https://github.com/bot-zen/ud-hf-parquet-tools
483
  - CHANGELOG: [CHANGELOG.md](CHANGELOG.md)
 
 
 
 
1
+ # Migration Guide: v2.x → v2.y
2
 
3
+ This guide helps you migrate from Universal Dependencies dataset loader v2.x to v2.y.
4
 
5
+ ## What's New in v2.y
 
 
 
 
 
6
 
7
  **Data Changes:**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
 
10
  ## Summary
11
 
12
  **Key Takeaways:**
13
 
14
+ ✅ **v2.y is more correct:** Fixes some bug
15
+ ✅ **v2.y adds features:** some information now available
 
 
 
16
 
17
  **Migration Checklist:**
18
 
19
+ - [ ] Utilize new field
 
 
 
 
 
 
 
 
 
 
20
 
21
  **Resources:**
 
 
22
  - CHANGELOG: [CHANGELOG.md](CHANGELOG.md)
23
+ - README: [README.md](README.md)
24
+ - Helper library: https://github.com/bot-zen/ud-hf-parquet-tools
25
+ - Dataset repository: https://huggingface.co/datasets/commul/universal_dependencies
RELEASE.md CHANGED
@@ -29,11 +29,11 @@ Use [semantic versioning](https://semver.org/): `MAJOR.MINOR.PATCH`
29
  **Breaking changes** that require user code modifications:
30
 
31
  - Schema changes (adding/removing/renaming fields)
32
- - Changed data format (e.g., v1.x script loader → v2.0 Parquet)
33
  - Incompatible API changes
34
  - Removing deprecated features
35
 
36
- **Example:** v1.x → v2.0 moved to Parquet format and removed Python script loader
37
 
38
  ### Minor Version (v2.0 → v2.1)
39
 
@@ -87,14 +87,6 @@ name = "universal-dependencies"
87
  version = "2.1.0" # Update this
88
  ```
89
 
90
- **File: MIGRATION.md** (if major/minor)
91
- Update the version references in examples:
92
- ```markdown
93
- # Migration Guide: v2.0 → v2.1
94
-
95
- This guide helps you migrate from v2.0 to v2.1...
96
- ```
97
-
98
  ### 3. Update CHANGELOG.md
99
 
100
  Create entry for new version:
@@ -121,7 +113,7 @@ Create entry for new version:
121
  ### Breaking Changes
122
  - **Description**: Clear explanation
123
  - **Impact**: Who is affected
124
- - **Migration**: How to update code
125
  ```
126
 
127
  ### 4. Update Documentation
@@ -129,7 +121,6 @@ Create entry for new version:
129
  **Files to review and update:**
130
 
131
  - **README.md** (root) - Update version badges, examples
132
- - **MIGRATION.md** - Add new section if breaking changes
133
  - **ADDING_NEW_UD_VERSION.md** - Update if workflow changes
134
  - **tools/README.md** - Update if scripts change
135
  - **templates/README.tmpl** - Update if dataset card needs changes
@@ -294,11 +285,7 @@ Do not use lightweight tags (`git tag v${NEW_VER}`) for framework releases.
294
 
295
  ### Breaking Changes (if any)
296
 
297
- - Change A: Migration instructions
298
-
299
- ### Upgrade Instructions
300
-
301
- For users: See [MIGRATION.md](MIGRATION.md) if breaking changes exist.
302
 
303
  For maintainers: Framework has been applied to all UD data branches (2.7-2.17).
304
 
@@ -428,7 +415,7 @@ git push origin v2.1.1
428
  # 6. Tag and release
429
  ```
430
 
431
- **Skip:** No migration guide needed, no schema changes
432
 
433
  ### Scenario 2: Minor Feature Release (v2.0 → v2.1)
434
 
@@ -440,8 +427,7 @@ git push origin v2.1.1
440
  # 3. Update CHANGELOG.md
441
  # 4. Test on sample branch
442
  # 5. Apply to all branches
443
- # 6. Update MIGRATION.md (optional, if users need guidance)
444
- # 7. Tag and release
445
  ```
446
 
447
  **Impact:** Users can optionally use new field, old code still works
@@ -453,15 +439,14 @@ git push origin v2.1.1
453
  ```bash
454
  # 1. Update all templates and scripts
455
  # 2. Update version in pyproject.toml
456
- # 3. Create detailed MIGRATION.md section
457
- # 4. Update CHANGELOG.md with breaking changes
458
- # 5. Test extensively on all branches
459
- # 6. Apply to all branches (may require regeneration)
460
- # 7. Tag and release
461
- # 8. Announce with migration guide
462
  ```
463
 
464
- **Impact:** Users may need to update code, provide clear migration path
465
 
466
  ## Version History
467
 
@@ -471,7 +456,6 @@ git push origin v2.1.1
471
  | v2.2.0 | 2026-03 | Minor | Parquet stale-artifact guard controls, `--check-extra`, `--prune-extra` |
472
  | v2.1.0 | 2026-02 | Minor | CLARIN snapshot pipeline, flag-driven `--ud-ver` workflow, validation blocked-treebank ignored count |
473
  | v2.0.0 | 2025-01 | Major | Parquet format, no Python script, external helpers |
474
- | v1.0.0 | 2024-XX | Major | Initial Python script loader |
475
 
476
  ## Best Practices
477
 
@@ -525,7 +509,6 @@ git commit -m "Update docs to reference v2.1"
525
 
526
  - **Framework documentation:** [tools/README.md](tools/README.md)
527
  - **UD data releases:** [ADDING_NEW_UD_VERSION.md](ADDING_NEW_UD_VERSION.md)
528
- - **User migration:** [MIGRATION.md](MIGRATION.md)
529
  - **External library:** https://github.com/bot-zen/ud-hf-parquet-tools
530
  - **Semantic versioning:** https://semver.org/
531
 
 
29
  **Breaking changes** that require user code modifications:
30
 
31
  - Schema changes (adding/removing/renaming fields)
32
+ - Changed data format or loading architecture
33
  - Incompatible API changes
34
  - Removing deprecated features
35
 
36
+ **Example:** v2.0 moved to Parquet format and removed Python script loader
37
 
38
  ### Minor Version (v2.0 → v2.1)
39
 
 
87
  version = "2.1.0" # Update this
88
  ```
89
 
 
 
 
 
 
 
 
 
90
  ### 3. Update CHANGELOG.md
91
 
92
  Create entry for new version:
 
113
  ### Breaking Changes
114
  - **Description**: Clear explanation
115
  - **Impact**: Who is affected
116
+ - **Upgrade**: How to update code
117
  ```
118
 
119
  ### 4. Update Documentation
 
121
  **Files to review and update:**
122
 
123
  - **README.md** (root) - Update version badges, examples
 
124
  - **ADDING_NEW_UD_VERSION.md** - Update if workflow changes
125
  - **tools/README.md** - Update if scripts change
126
  - **templates/README.tmpl** - Update if dataset card needs changes
 
285
 
286
  ### Breaking Changes (if any)
287
 
288
+ - Change A: Upgrade instructions
 
 
 
 
289
 
290
  For maintainers: Framework has been applied to all UD data branches (2.7-2.17).
291
 
 
415
  # 6. Tag and release
416
  ```
417
 
418
+ **Skip:** No upgrade notes needed, no schema changes
419
 
420
  ### Scenario 2: Minor Feature Release (v2.0 → v2.1)
421
 
 
427
  # 3. Update CHANGELOG.md
428
  # 4. Test on sample branch
429
  # 5. Apply to all branches
430
+ # 6. Tag and release
 
431
  ```
432
 
433
  **Impact:** Users can optionally use new field, old code still works
 
439
  ```bash
440
  # 1. Update all templates and scripts
441
  # 2. Update version in pyproject.toml
442
+ # 3. Update CHANGELOG.md with breaking changes and upgrade notes
443
+ # 4. Test extensively on all branches
444
+ # 5. Apply to all branches (may require regeneration)
445
+ # 6. Tag and release
446
+ # 7. Announce with release notes
 
447
  ```
448
 
449
+ **Impact:** Users may need to update code, provide a clear upgrade path
450
 
451
  ## Version History
452
 
 
456
  | v2.2.0 | 2026-03 | Minor | Parquet stale-artifact guard controls, `--check-extra`, `--prune-extra` |
457
  | v2.1.0 | 2026-02 | Minor | CLARIN snapshot pipeline, flag-driven `--ud-ver` workflow, validation blocked-treebank ignored count |
458
  | v2.0.0 | 2025-01 | Major | Parquet format, no Python script, external helpers |
 
459
 
460
  ## Best Practices
461
 
 
509
 
510
  - **Framework documentation:** [tools/README.md](tools/README.md)
511
  - **UD data releases:** [ADDING_NEW_UD_VERSION.md](ADDING_NEW_UD_VERSION.md)
 
512
  - **External library:** https://github.com/bot-zen/ud-hf-parquet-tools
513
  - **Semantic versioning:** https://semver.org/
514
 
tools/templates/README.tmpl CHANGED
@@ -65,19 +65,20 @@ configs:
65
 
66
  ## Dataset Card (v2.0) for Universal Dependencies Treebank
67
 
68
- **Version 2.0.0** introduces significant improvements and breaking changes:
69
- - **Parquet Format:** faster loading with HuggingFace datasets >=4.0.0
70
- - **MWT Support:** New `mwt` field provides structured multi-word token information
71
- - **Enhanced Security:** No more `trust_remote_code=True` required
72
- - **Separate Versioning:** Loader version (2.0.0) distinct from UD data version (2.17)
73
 
74
  **Breaking Changes:**
75
- - Token sequences now exclude MWT surface forms (matches UD guidelines)
76
- - Requires `datasets>=4.0.0` for Parquet support
77
 
78
  - **Migration Guide:** See [MIGRATION.md](MIGRATION.md) for detailed upgrade instructions
79
  - **Changelog:** See [CHANGELOG.md](CHANGELOG.md) for complete release notes
80
 
 
 
 
 
 
81
 
82
  ## Table of Contents
83
  - [Dataset Description](#dataset-description)
 
65
 
66
  ## Dataset Card (v2.0) for Universal Dependencies Treebank
67
 
68
+ **Version 2.y** introduces improvements and breaking changes:
69
+ - **Some Support:** Some new feature to support something
 
 
 
70
 
71
  **Breaking Changes:**
72
+ - Some sequence change
 
73
 
74
  - **Migration Guide:** See [MIGRATION.md](MIGRATION.md) for detailed upgrade instructions
75
  - **Changelog:** See [CHANGELOG.md](CHANGELOG.md) for complete release notes
76
 
77
+ This dataset is distributed as Parquet files for HuggingFace datasets >=4.0.0.
78
+ It includes structured multi-word token information in the `mwt` field and
79
+ keeps loader/framework versioning separate from the Universal Dependencies data
80
+ version.
81
+
82
 
83
  ## Table of Contents
84
  - [Dataset Description](#dataset-description)