Revert README.md to 541812f0 and update with tools/ content

tools/templates/README.tmpl

@@ -110,6 +110,23 @@ config_names:
 
 # Dataset Card for Universal Dependencies Treebank
 
+## What's New in v2.0
+
+**Version 2.0.0** introduces significant improvements and breaking changes:
+
+- **Parquet Format:** faster loading with HuggingFace datasets >=4.0.0
+- **MWT Support:** New `mwt` field provides structured multi-word token information
+- **Enhanced Security:** No more `trust_remote_code=True` required
+- **Separate Versioning:** Loader version (2.0.0) distinct from UD data version (2.17)
+
+**Breaking Changes:**
+- Token sequences now exclude MWT surface forms (matches UD guidelines)
+- Requires `datasets>=4.0.0` for Parquet support
+
+- **Migration Guide:** See [MIGRATION.md](MIGRATION.md) for detailed upgrade instructions
+- **Changelog:** See [CHANGELOG.md](CHANGELOG.md) for complete release notes
+
+
 ## Table of Contents
 - [Dataset Description](#dataset-description)
   - [Dataset Summary](#dataset-summary)
@@ -176,7 +193,7 @@ For technical details, see [`tools/CONLLU_PARSING_ISSUES.md`](https://huggingfac
 from datasets import load_dataset
 
 # Load a specific treebank
-ds = load_dataset("commul/universal_dependencies", "en_ewt", split="train", trust_remote_code=True)
+ds = load_dataset("commul/universal_dependencies", "en_ewt", revision="{{ ud_ver }}", split="train")
 
 # Access sentence data
 sentence = ds[0]
@@ -225,28 +242,105 @@ break, including an LF character at the end of file).
 
 ### Data Instances
 
-This dataset has {{ data.items()|length }} configurations.
+This dataset has {{ data.items()|length }} configurations (treebanks).
 ```python
-from datasets import get_dataset_config_names
-
-# Get the revision specific configurations
-get_dataset_config_names("commul/universal_dependencies", revision="{{ ud_ver }}", trust_remote_code=True)  # 179
-['af_afribooms',
- 'akk_pisandub',
- 'aqz_tudet',
- 'sq_tsa',
- 'gsw_uzh',
- 'am_att',
- ...
-]
+from datasets import get_dataset_config_names, load_dataset
+
+# Get all available treebank configurations for revision="{{ ud_ver }}"
+configs = get_dataset_config_names("commul/universal_dependencies", revision="{{ ud_ver }}")
+print(f"Available treebanks: {len(configs)}")
+
+# Example configurations:
+# ['af_afribooms',
+#  'akk_pisandub',
+#  'aqz_tudet',
+#  'sq_tsa',
+#  'gsw_uzh',
+#  'am_att',
+#   ...
+# ]
 
 # Get the latest configurations
-get_dataset_config_names("commul/universal_dependencies", trust_remote_code=True)
+get_dataset_config_names("commul/universal_dependencies")
+
+# Load a specific treebank
+dataset = load_dataset("commul/universal_dependencies", "en_ewt")
+print(dataset)
+
+# Output:
+# DatasetDict({
+#     train: Dataset({
+#         features: ['idx', 'text', 'tokens', 'lemmas', 'upos', 'xpos', 'feats', 'head', 'deprel', 'deps', 'misc', 'mwt'],
+#         num_rows: 12543
+#     })
+#     validation: Dataset({
+#         features: ['idx', 'text', 'tokens', 'lemmas', 'upos', 'xpos', 'feats', 'head', 'deprel', 'deps', 'misc', 'mwt'],
+#         num_rows: 2001
+#     })
+#     test: Dataset({
+#         features: ['idx', 'text', 'tokens', 'lemmas', 'upos', 'xpos', 'feats', 'head', 'deprel', 'deps', 'misc', 'mwt'],
+#         num_rows: 2077
+#     })
+# })
 ```
 
 ### Data Fields
 
-[More Information Needed]
+Each example in the dataset contains the following fields:
+
+- **idx** (string): Sentence ID from the CoNLL-U file metadata
+- **text** (string): Full sentence text (surface form)
+- **tokens** (list of strings): Syntactic word forms (MWT surface forms excluded)
+- **lemmas** (list of strings): Lemmas for each syntactic word
+- **upos** (list of strings): Universal POS tags
+- **xpos** (list of strings): Language-specific POS tags
+- **feats** (list of strings): Morphological features in UD format
+- **head** (list of strings): Head indices for dependency relations
+- **deprel** (list of strings): Dependency relation labels
+- **deps** (list of strings): Enhanced dependency graph
+- **misc** (list of strings): Miscellaneous annotations
+- **mwt** (list of dicts): Multi-Word Token information (NEW in v2.0)
+  - **id** (string): Token range (e.g., "1-2")
+  - **form** (string): Surface form (e.g., "don't")
+  - **misc** (string): MWT-specific metadata
+
+**Example:**
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("commul/universal_dependencies", "en_ewt", split="train")
+print(dataset[0])
+
+# Output:
+{
+    'idx': 'weblog-blogspot.com_nominations_20041117172713_ENG_20041117_172713-0001',
+    'text': 'From the AP comes this story:',
+    'tokens': ['From', 'the', 'AP', 'comes', 'this', 'story', ':'],
+    'lemmas': ['from', 'the', 'AP', 'come', 'this', 'story', ':'],
+    'upos': ['ADP', 'DET', 'PROPN', 'VERB', 'DET', 'NOUN', 'PUNCT'],
+    'xpos': ['IN', 'DT', 'NNP', 'VBZ', 'DT', 'NN', ':'],
+    'feats': ['_', 'Definite=Def|PronType=Art', 'Number=Sing', 'Mood=Ind|Number=Sing|Person=3|Tense=Pres|VerbForm=Fin', 'Number=Sing|PronType=Dem', 'Number=Sing', '_'],
+    'head': ['4', '3', '4', '0', '6', '4', '4'],
+    'deprel': ['case', 'det', 'obl', 'root', 'det', 'nsubj', 'punct'],
+    'deps': ['_', '_', '_', '_', '_', '_', '_'],
+    'misc': ['_', '_', '_', '_', '_', '_', 'SpaceAfter=No'],
+    'mwt': []  # No MWTs in this sentence
+}
+```
+
+*MWT Example (French):**
+
+```python
+dataset = load_dataset("commul/universal_dependencies", "fr_gsd", split="train")
+# Find sentence with MWT
+example = [ex for ex in dataset if ex['mwt']][0]
+print(example['mwt'])
+
+# Output:
+[{'id': '2-3', 'form': 'des', 'misc': ''}]
+# This means tokens[1:3] = ['de', 'les'] are combined as MWT surface form "des"
+```
 
 ### Data Splits