updated descriptive stats

data/adl/adl.md

@@ -14,8 +14,15 @@ task_ids:
 ---
 # Dataset Card for  Archive for Danish Literature
 ## Dataset Description
+
+<!-- START-DESC-STATS -->
+
 - **Number of records:** 498
 - **Languages:** Danish
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/botxt/botxt.md

@@ -14,8 +14,15 @@ task_ids:
 ---
 # Dataset Card for Bornholmsk (Danish dialect)
 ## Dataset Description
+
+<!-- START-DESC-STATS -->
+
 - **Number of records:** 106
 - **Languages:** Danish
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/dannet/dannet.md

@@ -14,8 +14,15 @@ task_ids:
 ---
 # Dataset Card for DanNet (Danish WordNet)
 ## Dataset Description
+
+<!-- START-DESC-STATS -->
+
 - **Number of records:** 49040
 - **Languages:** Danish
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/depbank/depbank.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for Danish Dependency Treebank
 ## Dataset Description
-- **Number of records:** 536
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 536
+- **Average document length (characters)**: 1018.90
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/ep/ep.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for European Parliament
 ## Dataset Description
-- **Number of records:** 4213
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 4.21K
+- **Average document length (characters)**: 74063.40
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/ft/ft.md

@@ -14,8 +14,15 @@ task_ids:
 ---
 # Dataset Card for Folketinget (Danish Parliament)
 ## Dataset Description
+
+<!-- START-DESC-STATS -->
+
 - **Number of records:** 1315
 - **Languages:** Danish
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/gutenberg/gutenberg.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for Gutenberg
 ## Dataset Description
-- **Number of records:** 66
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 66
+- **Average document length (characters)**: 290147.94
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/hest/hest.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for Hestenettet (Danish debate forum)
 ## Dataset Description
-- **Number of records:** 14391
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 14.39K
+- **Average document length (characters)**: 82950.79
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/jvj/jvj.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for Johannes V. Jensen (Danish poet)
 ## Dataset Description
-- **Number of records:** 42
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 42
+- **Average document length (characters)**: 254893.67
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/naat/naat.md

@@ -14,8 +14,15 @@ task_ids:
 ---
 # Dataset Card for NAAT
 ## Dataset Description
+
+<!-- START-DESC-STATS -->
+
 - **Number of records:** 129
 - **Languages:** Danish
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/nordjyllandnews/nordjyllandnews.md

@@ -18,9 +18,15 @@ task_ids:
 source: https://huggingface.co/datasets/alexandrainst/nordjylland-news-summarization
 
 ## Dataset Description
+
+<!-- START-DESC-STATS -->
+
 - **Number of records:** 75200
 - **Languages:** Danish
 
+<!-- END-DESC-STATS -->
+
+
 ## Opportunities for Improvement
 
 An updated version of the this data could be fetched from their [API](https://developer.bazo.dk/#876ab6f9-e057-43e3-897a-1563de34397e).

data/retsinformationdk/retsinformationdk.md

@@ -14,8 +14,15 @@ task_ids:
 ---
 # Dataset Card for retsinformation.dk (Danish legal information)
 ## Dataset Description
-- **Number of records:** 64043
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 64.04K
+- **Average document length (characters)**: 22248.53
+
+<!-- END-DESC-STATS -->
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/retspraksis/retspraksis.md

@@ -14,8 +14,15 @@ task_ids:
 ---
 # Dataset Card for retspraksis (Danish legal information)
 ## Dataset Description
+
+<!-- START-DESC-STATS -->
+
 - **Number of records:** 4413
 - **Languages:** Danish
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/skat/skat.md

@@ -14,8 +14,15 @@ task_ids:
 ---
 # Dataset Card for Skat (Danish tax authority)
 ## Dataset Description
+
+<!-- START-DESC-STATS -->
+
 - **Number of records:** 14716
 - **Languages:** Danish
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/spont/spont.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for Spontaneous speech
 ## Dataset Description
-- **Number of records:** 411
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 411
+- **Average document length (characters)**: 9736.80
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/synne/synne.md

@@ -14,8 +14,15 @@ task_ids:
 ---
 # Dataset Card for Synderjysk (Danish dialect)
 ## Dataset Description
+
+<!-- START-DESC-STATS -->
+
 - **Number of records:** 178
 - **Languages:** Danish
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/tv2r/tv2r.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for TV 2 Radio (Danish news)
 ## Dataset Description
-- **Number of records:** 49137
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 49.14K
+- **Average document length (characters)**: 1303.38
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/wiki/wiki.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for Wikipedia
 ## Dataset Description
-- **Number of records:** 264502
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 264.50K
+- **Average document length (characters)**: 1386.64
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/wikibooks/wikibooks.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for Wikibooks
 ## Dataset Description
-- **Number of records:** 1319
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 1.32K
+- **Average document length (characters)**: 13291.03
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

data/wikisource/wikisource.md

@@ -14,8 +14,16 @@ task_ids:
 ---
 # Dataset Card for Wikisource
 ## Dataset Description
-- **Number of records:** 2429
-- **Languages:** Danish
+
+<!-- START-DESC-STATS -->
+
+- **Language**: dan, dansk, Danish
+- **Number of samples**: 2.43K
+- **Average document length (characters)**: 6372.49
+
+<!-- END-DESC-STATS -->
+
+
 ## Dataset Sturcture
 An example from the dataset looks as follows.
 ```yaml

makefile

@@ -6,11 +6,16 @@ test:
 	@echo "--- 🧪 Running tests ---"
 	uv run pytest tests/
 
-bump-version:
-	@echo "--- 🚀 Bumping patch version ---"
-	uv run scripts/bump_version.py
 
 lint:
 	@echo "--- 🧹 Running linters ---"
 	ruff format . 			# running ruff formatting
 	ruff check . --fix  	# running ruff linting
+
+bump-version:
+	@echo "--- 🚀 Bumping patch version ---"
+	uv run scripts/bump_version.py
+
+update-descriptive-statistics:
+	@echo "--- 🚀 Recomputing Descriptive statistics ---"
+	uv run scripts/update_descriptive_statistics.py

scripts/bump_version.py

@@ -10,7 +10,9 @@ pyproject = c_file.parent.parent / "pyproject.toml"
 with pyproject.open("r") as f:
     data = toml.load(f)
     version = Version(data["project"]["version"])
-    data["project"]["version"] = str(Version(f"{version.major}.{version.minor}.{version.micro + 1}"))
+    data["project"]["version"] = str(
+        Version(f"{version.major}.{version.minor}.{version.micro + 1}")
+    )
 
 with pyproject.open("w") as f:
-    toml.dump(data, f)
+    toml.dump(data, f)

scripts/update_descriptive_statistics.py

@@ -0,0 +1,90 @@
+"""
+Updates descriptive stats on all datasets
+"""
+
+import logging
+from dataclasses import dataclass
+from pathlib import Path
+from textwrap import dedent
+from typing import Self, cast
+
+from datasets import Dataset, load_dataset
+
+logger = logging.Logger(__file__)  # TODO: check this syntax (might be __name__)
+
+
+def human_readable_large_int(value: int) -> str:
+    thresholds = [
+        (1_000_000_000, "B"),
+        (1_000_000, "M"),
+        (1_000, "K"),
+    ]
+    for threshold, label in thresholds:
+        if value > threshold:
+            return f"{value/threshold:.2f}{label}"
+
+    return str(value)
+
+
+@dataclass()
+class DescriptiveStatsOverview:
+    number_of_samples: int
+    average_document_length: float
+    language: str = "dan, dansk, Danish"
+
+    @classmethod
+    def from_dataset(cls, dataset: Dataset) -> Self:
+        return cls(
+            number_of_samples=len(dataset),
+            average_document_length=cls.calculate_average_document_length(dataset),
+        )
+
+    @staticmethod
+    def calculate_average_document_length(dataset: Dataset) -> float:
+        texts = sum(len(t) for t in dataset["text"])
+        return texts / len(dataset)
+
+    def to_markdown(self) -> str:
+        format = dedent(f"""
+
+        - **Language**: {self.language}
+        - **Number of samples**: {human_readable_large_int(self.number_of_samples)}
+        - **Average document length (characters)**: {self.average_document_length:.2f}
+
+        """)
+        return format
+
+    def add_to_markdown(self, markdown: str) -> str:
+        start_identifier = "<!-- START-DESC-STATS -->"
+        end_identifier = "<!-- END-DESC-STATS -->"
+
+        if markdown.count(start_identifier) != 1 or markdown.count(end_identifier) != 1:
+            raise ValueError("Markers should appear exactly once in the markdown.")
+
+        start_md, _, remainder = markdown.partition(start_identifier)
+        _, _, end_md = remainder.partition(end_identifier)
+
+        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")
+    ds = cast(Dataset, ds)
+    desc_stats = DescriptiveStatsOverview.from_dataset(ds)
+
+    markdown_path = dataset_path / f"{dataset_path.name}.md"
+    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)
+
+
+if __name__ == "__main__":
+    repo_path = Path(__file__).parent.parent
+    datasets = (repo_path / "data").glob("*")
+
+    for dataset_path in datasets:
+        update_statitics(dataset_path)