Add test for to ensure yaml is up to date

CONTRIBUTING.md

@@ -3,8 +3,8 @@
 A huggingface datasets repository is a GitHub repository like any other. You can simply download it like so:
 
 ```bash
-git clone https://huggingface.co/datasets/danish-foundation-models/danish-gigaword-2
-cd danish-gigaword-2
+git clone https://huggingface.co/datasets/danish-foundation-models/danish-dynaword
+cd danish-dynaword
 ```
 
 You can the work with the dataset locally like so:
@@ -12,7 +12,7 @@ You can the work with the dataset locally like so:
 ```py
 from datasets import load_dataset
 
-name = "../."  # instead of "danish-foundation-models/danish-gigaword-2"
+name = "../."  # instead of "danish-foundation-models/danish-dynaword"
 dataset = load_dataset("../.", split="train")
 # make transformations here
 ```
@@ -53,4 +53,4 @@ Before you make the PR do be sure to make sure that the tests have been run.
 
 To see example PR you can see the following:
 
-- [Restructuring columns in the dataset](https://huggingface.co/datasets/danish-foundation-models/danish-gigaword-2/discussions/11)
+- [Restructuring columns in the dataset](https://huggingface.co/datasets/danish-foundation-models/danish-dynaword/discussions/11)

README.md

@@ -117,7 +117,7 @@ https://github.com/huggingface/datasets/blob/main/templates/README_guide.md -->
 | **Language** | dan, dansk, Danish                                                                                                                                            |
 | **License**  | Permissible, See the respective dataset                                                                                                                       |
 | **Models**   | For model trained used this data see [danish-foundation-models](https://huggingface.co/danish-foundation-models)                                              |
-| **Contact**  | If you have question about this project please create an issue [here](https://huggingface.co/datasets/danish-foundation-models/danish-gigaword-2/discussions) |
+| **Contact**  | If you have question about this project please create an issue [here](https://huggingface.co/datasets/danish-foundation-models/danish-dynaword/discussions) |
 
 
 ## Table of Contents

tests/conftest.py

@@ -0,0 +1,21 @@
+from pathlib import Path
+
+import pytest
+
+# from typing import Any
+# import yaml
+
+
+@pytest.fixture()
+def repo_path() -> Path:
+    return Path(__file__).parent.parent
+
+
+# def readme_yaml_header(repo_path: Path) -> dict[str, Any]:
+#     readme_path = repo_path / "README.md"
+
+#     with readme_path.open("r") as f:
+#         readme = f.read()
+
+#     frontmatter = readme.split("---")[1]
+#     return yaml.load()

tests/test_load.py

@@ -1,9 +1,22 @@
-from datasets import load_dataset
 from pathlib import Path
 
+from datasets import load_dataset
+
+
 def test_dataset_loads():
+    """Ensures that the dataset can load as intended"""
     repo = Path(__file__).parent.parent
-    name = str(repo.resolve())  # "danish-foundation-models/danish-gigaword-2"
+    name = str(repo.resolve())
     ds = load_dataset(name, split="train", streaming=True)
     sample = next(iter(ds))
     assert isinstance(sample, dict)
+
+
+# def test_all_datasets_in_yaml(repo_path: Path, readme_yaml_header: dict[str, Any]):
+#     configs = readme_yaml_header["configs"]
+
+#     data_folder = repo_path / "data"
+#     datasets = data_folder.glob("*")
+
+#     for dataset in datasets:
+#         assert dataset in configs

tests/test_unique_ids.py

@@ -4,9 +4,9 @@ from typing import cast
 from datasets import Dataset, load_dataset
 
 
-def test_ensure_ids_are_unique():
-    repo = Path(__file__).parent.parent
-    name = str(repo.resolve())  # "danish-foundation-models/danish-gigaword-2"
+def test_ensure_ids_are_unique(repo_path: Path):
+    # repo = Path(__file__).parent.parent
+    name = str(repo_path.resolve())
     ds = load_dataset(name, split="train")
     ds = cast(Dataset, ds)
     assert len(set(ds["id"])) == len(ds)