update descriptive stats

CONTRIBUTING.md

@@ -54,3 +54,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-dynaword/discussions/11)
+- [Adding a new dataset](https://huggingface.co/datasets/danish-foundation-models/danish-dynaword/discussions/15)

README.md

@@ -116,11 +116,11 @@ https://github.com/huggingface/datasets/blob/main/templates/README_guide.md -->
 
 # 🧨 Danish Dynaword
 
-|              |                                                                                                                                                               |
-| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **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)                                              |
+|              |                                                                                                                                                             |
+| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **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-dynaword/discussions) |
 
 
@@ -145,6 +145,13 @@ https://github.com/huggingface/datasets/blob/main/templates/README_guide.md -->
 
 ## Dataset Description
 
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 546.77K
+- **Average document length (characters)**: 8461.25
+
+<!-- END-DESC-STATS -->
 
 ### Dataset Summary
 

data/adl/adl.md

@@ -17,8 +17,9 @@ task_ids:
 
 <!-- START-DESC-STATS -->
 
-- **Number of records:** 498
-- **Languages:** Danish
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 498
+- **Average document length (characters)**: 324932.24
 
 <!-- END-DESC-STATS -->
 

data/adl/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 498, "average_document_length": 324932.2429718876, "language": "dan, dansk, Danish"}

data/botxt/botxt.md

@@ -17,8 +17,9 @@ task_ids:
 
 <!-- START-DESC-STATS -->
 
-- **Number of records:** 106
-- **Languages:** Danish
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 106
+- **Average document length (characters)**: 18972.42
 
 <!-- END-DESC-STATS -->
 

data/botxt/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 106, "average_document_length": 18972.415094339623, "language": "dan, dansk, Danish"}

data/dannet/dannet.md

@@ -17,8 +17,9 @@ task_ids:
 
 <!-- START-DESC-STATS -->
 
-- **Number of records:** 49040
-- **Languages:** Danish
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 49.04K
+- **Average document length (characters)**: 90.80
 
 <!-- END-DESC-STATS -->
 

data/dannet/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 49040, "average_document_length": 90.80340538336053, "language": "dan, dansk, Danish"}

data/depbank/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 536, "average_document_length": 1018.8992537313433, "language": "dan, dansk, Danish"}

data/ep/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 4213, "average_document_length": 74063.40469973891, "language": "dan, dansk, Danish"}

data/ft/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 1315, "average_document_length": 266745.19163498096, "language": "dan, dansk, Danish"}

data/ft/ft.md

@@ -17,8 +17,9 @@ task_ids:
 
 <!-- START-DESC-STATS -->
 
-- **Number of records:** 1315
-- **Languages:** Danish
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 1.31K
+- **Average document length (characters)**: 266745.19
 
 <!-- END-DESC-STATS -->
 

data/gutenberg/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 66, "average_document_length": 290147.9393939394, "language": "dan, dansk, Danish"}

data/hest/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 14391, "average_document_length": 82950.79104996179, "language": "dan, dansk, Danish"}

data/jvj/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 42, "average_document_length": 254893.66666666666, "language": "dan, dansk, Danish"}

data/naat/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 129, "average_document_length": 6832.387596899225, "language": "dan, dansk, Danish"}

data/naat/naat.md

@@ -17,8 +17,9 @@ task_ids:
 
 <!-- START-DESC-STATS -->
 
-- **Number of records:** 129
-- **Languages:** Danish
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 129
+- **Average document length (characters)**: 6832.39
 
 <!-- END-DESC-STATS -->
 

data/nordjyllandnews/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 75219, "average_document_length": 1540.2673659580691, "language": "dan, dansk, Danish"}

data/nordjyllandnews/nordjyllandnews.md

@@ -21,8 +21,9 @@ source: https://huggingface.co/datasets/alexandrainst/nordjylland-news-summariza
 
 <!-- START-DESC-STATS -->
 
-- **Number of records:** 75200
-- **Languages:** Danish
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 75.22K
+- **Average document length (characters)**: 1540.27
 
 <!-- END-DESC-STATS -->
 

data/relig/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 66, "average_document_length": 53873.56060606061, "language": "dan, dansk, Danish"}

data/relig/relig.md

@@ -13,9 +13,18 @@ task_ids:
   - language-modeling
 ---
 # Dataset Card for Religious texts
+
 ## Dataset Description
-- **Number of records:** 66
-- **Languages:** Danish
+
+ <!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 66
+- **Average document length (characters)**: 53873.56
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/retsinformationdk/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 64043, "average_document_length": 22248.525506300455, "language": "dan, dansk, Danish"}

data/retspraksis/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 4413, "average_document_length": 46323.66915930206, "language": "dan, dansk, Danish"}

data/retspraksis/retspraksis.md

@@ -17,8 +17,9 @@ task_ids:
 
 <!-- START-DESC-STATS -->
 
-- **Number of records:** 4413
-- **Languages:** Danish
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 4.41K
+- **Average document length (characters)**: 46323.67
 
 <!-- END-DESC-STATS -->
 

data/skat/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 14716, "average_document_length": 24026.800964936123, "language": "dan, dansk, Danish"}

data/skat/skat.md

@@ -17,8 +17,9 @@ task_ids:
 
 <!-- START-DESC-STATS -->
 
-- **Number of records:** 14716
-- **Languages:** Danish
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 14.72K
+- **Average document length (characters)**: 24026.80
 
 <!-- END-DESC-STATS -->
 

data/spont/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 411, "average_document_length": 9736.79805352798, "language": "dan, dansk, Danish"}

data/synne/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 178, "average_document_length": 785.3258426966293, "language": "dan, dansk, Danish"}

data/synne/synne.md

@@ -17,8 +17,9 @@ task_ids:
 
 <!-- START-DESC-STATS -->
 
-- **Number of records:** 178
-- **Languages:** Danish
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 178
+- **Average document length (characters)**: 785.33
 
 <!-- END-DESC-STATS -->
 

data/tv2r/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 49137, "average_document_length": 1303.3820746077295, "language": "dan, dansk, Danish"}

data/wiki/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 264502, "average_document_length": 1386.6366794958071, "language": "dan, dansk, Danish"}

data/wikibooks/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 1319, "average_document_length": 13291.027293404093, "language": "dan, dansk, Danish"}

data/wikisource/descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 2429, "average_document_length": 6372.487855084397, "language": "dan, dansk, Danish"}

data/wikisource/wikisource.md

@@ -13,6 +13,7 @@ task_ids:
   - language-modeling
 ---
 # Dataset Card for Wikisource
+
 ## Dataset Description
 
 <!-- START-DESC-STATS -->
@@ -26,6 +27,7 @@ task_ids:
 
 ## Dataset Sturcture
 An example from the dataset looks as follows.
+
 ```yaml
 {
     'text': '&lt;poem&gt;

descriptive_stats.json

@@ -0,0 +1 @@
+{"number_of_samples": 546769, "average_document_length": 8461.252984349881, "language": "dan, dansk, Danish"}

pyproject.toml

@@ -6,6 +6,7 @@ readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
     "datasets>=3.0.0",
+    "gitpython>=3.1.43",
     "ipykernel>=6.29.5",
     "matplotlib>=3.10.0",
     "numpy>=2.2.0",

scripts/git_utilities.py

@@ -0,0 +1,26 @@
+from pathlib import Path
+
+from git import Repo
+
+repo_path = Path(__file__).parent.parent
+
+
+def get_current_revision(repo_path: Path = repo_path) -> str:
+    repo = Repo(repo_path)
+    commit_id = repo.head.object.hexsha
+    return commit_id
+
+
+def get_latest_revision(path: Path, repo_path=repo_path) -> str:
+    repo = Repo(repo_path)
+
+    if not path.exists():
+        raise ValueError("path does not exist.")
+
+    last_commit_for_file = next(repo.iter_commits(paths=path, max_count=1))
+    return last_commit_for_file.hexsha
+
+
+def check_is_ancestor(ancestor_rev: str, rev: str, repo_path=repo_path) -> bool:
+    repo = Repo(repo_path)
+    return repo.is_ancestor(repo.commit(ancestor_rev), repo.commit(rev))

scripts/update_descriptive_statistics.py

@@ -1,7 +1,14 @@
 """
-Updates descriptive stats on all datasets
+A simple CLI to updates descriptive statistics on all datasets.
+
+Example use:
+
+    python update_descriptive_statistics.py --dataset wikisource
+
 """
 
+import argparse
+import json
 import logging
 from dataclasses import dataclass
 from pathlib import Path
@@ -10,7 +17,11 @@ from typing import Self, cast
 
 from datasets import Dataset, load_dataset
 
-logger = logging.Logger(__file__)  # TODO: check this syntax (might be __name__)
+from .git_utilities import check_is_ancestor, get_current_revision, get_latest_revision
+
+logger = logging.getLogger(__name__)
+
+repo_path = Path(__file__).parent.parent
 
 
 def human_readable_large_int(value: int) -> str:
@@ -67,24 +78,108 @@ class DescriptiveStatsOverview:
         stats = self.to_markdown()
         return f"{start_md}{start_identifier}{stats}{end_identifier}{end_md}"
 
-
-def update_statitics(dataset_path: Path) -> None:
-    logger.info("Updating statistics for {dataset_path.name}")
-
-    ds = load_dataset(str(repo_path), dataset_path.name, split="train")
+    def to_disk(self, path: Path):
+        data = self.__dict__
+        data["revision"] = get_current_revision()
+        with path.with_suffix(".json").open("w") as f:
+            json.dump(self.__dict__, f)
+
+
+def update_statitics(
+    dataset_path: Path,
+    name: str,
+    readme_name: None | str = None,
+    force: bool = False,
+) -> None:
+    rev = get_latest_revision(dataset_path)
+
+    desc_stats_path = dataset_path / "descriptive_stats.json"
+    if desc_stats_path.exists() and force is False:
+        with desc_stats_path.open("r") as f:
+            last_update = json.load(f).get("revision", None)
+
+        if last_update is None:
+            logging.warning(f"revision is not defined in {desc_stats_path}.")
+        elif check_is_ancestor(ancestor_rev=last_update, rev=rev):
+            logging.info(
+                f"descriptive statistics for '{name}' is already up to date, skipping."
+            )
+            return
+
+    logger.info(f"Updating statistics for {name}")
+    ds = load_dataset(str(repo_path), name, split="train")
     ds = cast(Dataset, ds)
     desc_stats = DescriptiveStatsOverview.from_dataset(ds)
 
-    markdown_path = dataset_path / f"{dataset_path.name}.md"
+    readme_name = f"{name}.md" if readme_name is None else readme_name
+    markdown_path = dataset_path / readme_name
     with markdown_path.open("r") as f:
         new_markdown = desc_stats.add_to_markdown(f.read())
     with markdown_path.open("w") as f:
         f.write(new_markdown)
 
+    desc_stats.to_disk(desc_stats_path)
+
+
+def create_parser():
+    parser = argparse.ArgumentParser(
+        description="Calculated descriptive statistics of the datasets in tha data folder"
+    )
+    parser.add_argument(
+        "--dataset",
+        default=None,
+        type=str,
+        help="Use to specify if you only want to compute the statistics from a singular dataset.",
+    )
+    parser.add_argument(
+        "--logging_level",
+        default=20,
+        type=int,
+        help="Sets the logging level. Default to 20 (INFO), other reasonable levels are 10 (DEBUG) and 30 (WARNING).",
+    )
+    parser.add_argument(
+        "--force",
+        type=bool,
+        action=argparse.BooleanOptionalAction,
+        help="Should the statistics be forcefully recomputed. By default it checks the difference in commit ids.",
+    )
+    parser.add_argument(
+        "--repo_path",
+        default=str(repo_path),
+        type=str,
+        help="The repository where to calculate the descriptive statistics from",
+    )
+    return parser
+
+
+def main(
+    dataset: str | None = None,
+    logging_level: int = 20,
+    force: bool = False,
+    repo_path: Path = repo_path,
+):
+    logging.basicConfig(level=logging_level)
+
+    if dataset:
+        dataset_path = repo_path / "data" / dataset
+        update_statitics(repo_path, dataset_path.name, force=force)
+        return
 
-if __name__ == "__main__":
-    repo_path = Path(__file__).parent.parent
     datasets = (repo_path / "data").glob("*")
-
     for dataset_path in datasets:
-        update_statitics(dataset_path)
+        update_statitics(dataset_path, dataset_path.name, force=force)
+
+    update_statitics(repo_path, "default", "README.md", force=force)
+    # TODO: Only compute statistics is there has been changed in repo + add force flag
+
+
+if __name__ == "__main__":
+    parser = create_parser()
+    args = parser.parse_args()
+
+    main(
+        args.dataset,
+        logging_level=args.logging_level,
+        force=args.force,
+        repo_path=args.repo_path,
+    )

tests/conftest.py

@@ -1,9 +1,8 @@
 from pathlib import Path
+from typing import Any
 
 import pytest
-
-# from typing import Any
-# import yaml
+import yaml
 
 
 @pytest.fixture()
@@ -11,11 +10,11 @@ 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"
+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()
+    with readme_path.open("r") as f:
+        readme = f.read()
 
-#     frontmatter = readme.split("---")[1]
-#     return yaml.load()
+    frontmatter = readme.split("---")[1]
+    return yaml.safe_load(frontmatter)

uv.lock

@@ -199,10 +199,11 @@ wheels = [
 
 [[package]]
 name = "danish-dynaword"
-version = "1.0.2"
+version = "1.0.3"
 source = { virtual = "." }
 dependencies = [
     { name = "datasets" },
+    { name = "gitpython" },
     { name = "ipykernel" },
     { name = "matplotlib" },
     { name = "numpy" },
@@ -216,6 +217,7 @@ dependencies = [
 [package.metadata]
 requires-dist = [
     { name = "datasets", specifier = ">=3.0.0" },
+    { name = "gitpython", specifier = ">=3.1.43" },
     { name = "ipykernel", specifier = ">=6.29.5" },
     { name = "matplotlib", specifier = ">=3.10.0" },
     { name = "numpy", specifier = ">=2.2.0" },
@@ -355,6 +357,30 @@ http = [
     { name = "aiohttp" },
 ]
 
+[[package]]
+name = "gitdb"
+version = "4.0.11"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "smmap" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/19/0d/bbb5b5ee188dec84647a4664f3e11b06ade2bde568dbd489d9d64adef8ed/gitdb-4.0.11.tar.gz", hash = "sha256:bf5421126136d6d0af55bc1e7c1af1c397a34f5b7bd79e776cd3e89785c2b04b", size = 394469 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/fd/5b/8f0c4a5bb9fd491c277c21eff7ccae71b47d43c4446c9d0c6cff2fe8c2c4/gitdb-4.0.11-py3-none-any.whl", hash = "sha256:81a3407ddd2ee8df444cbacea00e2d038e40150acfa3001696fe0dcf1d3adfa4", size = 62721 },
+]
+
+[[package]]
+name = "gitpython"
+version = "3.1.43"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "gitdb" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/b6/a1/106fd9fa2dd989b6fb36e5893961f82992cf676381707253e0bf93eb1662/GitPython-3.1.43.tar.gz", hash = "sha256:35f314a9f878467f5453cc1fee295c3e18e52f1b99f10f6cf5b1682e968a9e7c", size = 214149 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/e9/bd/cc3a402a6439c15c3d4294333e13042b915bbeab54edc457c723931fed3f/GitPython-3.1.43-py3-none-any.whl", hash = "sha256:eec7ec56b92aad751f9912a73404bc02ba212a23adb2c7098ee668417051a1ff", size = 207337 },
+]
+
 [[package]]
 name = "huggingface-hub"
 version = "0.26.5"
@@ -396,7 +422,7 @@ name = "ipykernel"
 version = "6.29.5"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
-    { name = "appnope", marker = "platform_system == 'Darwin'" },
+    { name = "appnope", marker = "sys_platform == 'darwin'" },
     { name = "comm" },
     { name = "debugpy" },
     { name = "ipython" },
@@ -552,7 +578,7 @@ dependencies = [
     { name = "numpy" },
     { name = "pandas" },
     { name = "scipy" },
-    { name = "tzdata", marker = "platform_system == 'Emscripten' or platform_system == 'Windows'" },
+    { name = "tzdata", marker = "sys_platform == 'emscripten' or sys_platform == 'win32'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/91/c3/9f83c374314b2b42e7aec65f3bf87046415ab265f209fa8a04eb6da822ee/mizani-0.13.1.tar.gz", hash = "sha256:e3247ea12c746c8104767d7e42a2d16473173c7bc314f298d8294a58f4653353", size = 765181 }
 wheels = [
@@ -1062,6 +1088,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/b7/ce/149a00dd41f10bc29e5921b496af8b574d8413afcd5e30dfa0ed46c2cc5e/six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274", size = 11050 },
 ]
 
+[[package]]
+name = "smmap"
+version = "5.0.1"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/88/04/b5bf6d21dc4041000ccba7eb17dd3055feb237e7ffc2c20d3fae3af62baa/smmap-5.0.1.tar.gz", hash = "sha256:dceeb6c0028fdb6734471eb07c0cd2aae706ccaecab45965ee83f11c8d3b1f62", size = 22291 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/a7/a5/10f97f73544edcdef54409f1d839f6049a0d79df68adbc1ceb24d1aaca42/smmap-5.0.1-py3-none-any.whl", hash = "sha256:e6d8668fa5f93e706934a62d7b4db19c8d9eb8cf2adbb75ef1b675aa332b69da", size = 24282 },
+]
+
 [[package]]
 name = "stack-data"
 version = "0.6.3"
@@ -1129,7 +1164,7 @@ name = "tqdm"
 version = "4.67.1"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
-    { name = "colorama", marker = "platform_system == 'Windows'" },
+    { name = "colorama", marker = "sys_platform == 'win32'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/a8/4b/29b4ef32e036bb34e4ab51796dd745cdba7ed47ad142a9f4a1eb8e0c744d/tqdm-4.67.1.tar.gz", hash = "sha256:f8aef9c52c08c13a65f30ea34f4e5aac3fd1a34959879d7e59e63027286627f2", size = 169737 }
 wheels = [