Updated changelog

CHANGELOG.md

@@ -5,6 +5,27 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
+## [v1.1.0] - 2025-04-29
+
+### Added
+
+- Added multiple quality controls
+  - Removed all empty string
+  - Removed duplicates across within datasets
+  - Removed 
+- Restructured datasets
+  - Removed columns from the dataset to make the structure more lightweight, these include domain, metadata, and license. These have been moved to the individual datasheets. It is still possible to filter for license by using the dataset name
+  - Added column for number of tokens
+- For developers
+  - Restructered CI codebase substantially
+    - Added `DataSheet` to make CI for convenient 
+    - factored out plots and tables
+
+### Docs
+
+- Sorted overview table
+- Minor changes to dataset documentation
+
 ## [v1.0.11] - 2025-03-29
 
 ### Added
@@ -21,4 +42,4 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 - Sorted main table in readme
 - Added Changelog
-- Minor changs to 
+- Minor changes to dataset documentation 

README.md

@@ -4,7 +4,7 @@ configs:
 - config_name: default
   data_files:
   - split: train
-    path: 'data/*/*.parquet'
+    path: data/*/*.parquet
 - config_name: ai-aktindsigt
   data_files:
   - split: train
@@ -268,15 +268,12 @@ Each entry in the dataset consists of a single text with associated metadata
 
 An entry in the dataset consists of the following fields:
 
+- `id` (`str`): An unique identifier for each document.
 - `text`(`str`): The content of the document.
 - `source` (`str`): The source of the document (see [Source Data](#source-data)).
-- `id` (`str`): An unique identifier for each document.
 - `added` (`str`): An date for when the document was added to this collection.
 - `created` (`str`): An date range for when the document was originally created.
-- `license` (`str`): The license of the document. The licenses vary according to the source. 
-- `domain` (`str`): The domain of the source
-- `metadata/source-pretty` (`str`): The long form version of the short-form source name
-- `metadata/*`: Potentially additional metadata
+- `token_count` (`int`): The number of tokens in the sample computed using the Llama 8B tokenizer
 <!-- END-SAMPLE -->
 
 ### Data Splits
@@ -298,39 +295,39 @@ This data generally contains no annotation besides the metadata attached to each
 Below follows a brief overview of the sources in the corpus along with their individual license.
 
 <!-- START-MAIN TABLE -->
-| Source              | Description                                                                                                                                   | N. Tokens   | License                |
-|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|:------------|:-----------------------|
-| [synne]             | Dataset collected from [synnejysk forening's website](https://www.synnejysk.dk), covering the Danish dialect sønderjysk                       | 52.02K      | [CC-0]                 |
-| [depbank]           | The Danish subsection of the [Universal Dependencies Treebank](https://github.com/UniversalDependencies/UD_Danish-DDT)                        | 185.45K     | [CC-BY-SA 4.0]         |
-| [naat]              | Danish speeches from 1930-2022                                                                                                                | 286.68K     | [CC-0]                 |
-| [botxt]             | The Bornholmsk Ordbog Dictionary Projec                                                                                                       | 847.97K     | [CC-0]                 |
-| [relig]             | Danish religious text from the 1700-2022                                                                                                      | 1.24M       | [CC-0]                 |
-| [dannet]            | [DanNet](https://cst.ku.dk/projekter/dannet) is a Danish WordNet                                                                              | 1.48M       | [DanNet 1.0]           |
-| [spont]             | Conversational samples collected as a part of research projects at Aarhus University                                                          | 1.56M       | [CC-0]                 |
-| [jvj]               | The works of the Danish author and poet, [Johannes V. Jensen](https://da.wikipedia.org/wiki/Johannes_V._Jensen)                               | 3.55M       | [CC-BY-SA 4.0]         |
-| [wikisource]        | The Danish subsection of [Wikisource](https://en.wikisource.org/wiki/Main_Page)                                                               | 5.34M       | [CC-0]                 |
-| [wikibooks]         | The Danish Subsection of [Wikibooks](https://www.wikibooks.org)                                                                               | 6.24M       | [CC-0]                 |
-| [gutenberg]         | The Danish subsection from Project [Gutenberg](https://www.gutenberg.org)                                                                     | 6.76M       | [Gutenberg]            |
-| [nota]              | The text only part of the [Nota lyd- og tekstdata](https://sprogteknologi.dk/dataset/nota-lyd-og-tekstdata) dataset                           | 7.30M       | [CC-0]                 |
-| [danske-taler]      | Danish Speeches from [dansketaler.dk](https://www.dansketaler.dk                                                                              | 8.23M       | [CC-0]                 |
-| [memo]              | The MeMo corpus comprising almost all Danish novels from the period 1870-1899, known as the Modern Breakthrough                               | 9.28M       | [CC-BY-SA 4.0]         |
-| [tv2r]              | Contemporary Danish newswire articles published between 2010 and 2019                                                                         | 21.67M      | [CC-BY-SA 4.0]         |
-| [eur-lex-sum-da]    | The Danish subsection of EUR-lex SUM consisting of EU legislation paired with professionally written summaries                                | 31.37M      | [CC-BY-SA 4.0]         |
-| [nordjyllandnews]   | Articles from the Danish Newspaper [TV2 Nord](https://www.tv2nord.dk)                                                                         | 37.90M      | [CC-0]                 |
-| [fm-udgivelser]     | The official publication series of the Danish Ministry of Finance containing economic analyses, budget proposals, and fiscal policy documents | 50.34M      | [CC-BY-SA 4.0]         |
-| [retspraksis]       | Case law or judical practice in Denmark derived from [Retspraksis](https://da.wikipedia.org/wiki/Retspraksis)                                 | 56.26M      | [CC-0]                 |
-| [adl]               | Danish literature from 1700-2023 from the Archive for Danish Literature (ADL)                                                                 | 58.49M      | [CC-0]                 |
-| [ep]                | The Danish subsection of [Europarl](https://aclanthology.org/2005.mtsummit-papers.11/)                                                        | 100.84M     | [CC-0]                 |
-| [ft]                | Records from all meetings of The Danish parliament (Folketinget) in the parliament hall                                                       | 114.09M     | [CC-0]                 |
-| [wiki]              | The Danish subsection of [wikipedia](https://en.wikipedia.org/wiki/Main_Page)                                                                 | 122.00M     | [CC-0]                 |
-| [skat]              | Skat is the Danish tax authority. This dataset contains content from its website skat.dk                                                      | 122.11M     | [CC-0]                 |
-| [miljoeportalen]    | Data from [Danmarks Miljøportalen](https://www.miljoeportal.dk/om-danmarks-miljoeportal/) (Denmark's Environment Portal                       | 127.38M     | [CC-0]                 |
-| [ai-aktindsigt]     | Multiple web scrapes from municipality websites collected as a part of the [AI-aktindsigt](https://ai-aktindsigt.dk) project                  | 139.23M     | [Apache 2.0]           |
-| [opensubtitles]     | Danish subsection of [OpenSubtitles](https://opus.nlpl.eu/OpenSubtitles/corpus/version/OpenSubtitles)                                         | 271.60M     | [CC-0]                 |
-| [hest]              | Samples from the Danish debate forum www.heste-nettet.dk                                                                                      | 389.32M     | [CC-0]                 |
-| [retsinformationdk] | [retsinformation.dk](https://www.retsinformation.dk) (legal-information.dk) the official legal information system of Denmark                  | 516.35M     | [Danish Copyright Law] |
-| [cellar]            | The official digital repository for European Union legal documents and open data                                                              | 1.15B       | [CC-BY-SA 4.0]         |
-| **Total**           |                                                                                                                                               | 3.36B       |                        |
+| Source              | Description                                                                                                                                   | Domain        | N. Tokens   | License                |
+|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:------------|:-----------------------|
+| **Total**           |                                                                                                                                               |               | 3.36B       |                        |
+| [cellar]            | The official digital repository for European Union legal documents and open data                                                              | Legal         | 1.15B       | [CC-BY-SA 4.0]         |
+| [retsinformationdk] | [retsinformation.dk](https://www.retsinformation.dk) (legal-information.dk) the official legal information system of Denmark                  | Legal         | 516.35M     | [Danish Copyright Law] |
+| [hest]              | Samples from the Danish debate forum www.heste-nettet.dk                                                                                      | Social Media  | 389.32M     | [CC-0]                 |
+| [opensubtitles]     | Danish subsection of [OpenSubtitles](https://opus.nlpl.eu/OpenSubtitles/corpus/version/OpenSubtitles)                                         | Conversations | 271.60M     | [CC-0]                 |
+| [ai-aktindsigt]     | Multiple web scrapes from municipality websites collected as a part of the [AI-aktindsigt](https://ai-aktindsigt.dk) project                  | Web           | 139.23M     | [Apache 2.0]           |
+| [miljoeportalen]    | Data from [Danmarks Miljøportalen](https://www.miljoeportal.dk/om-danmarks-miljoeportal/) (Denmark's Environment Portal)                      | Web           | 127.38M     | [CC-0]                 |
+| [skat]              | Skat is the Danish tax authority. This dataset contains content from its website skat.dk                                                      | Legal         | 122.11M     | [CC-0]                 |
+| [wiki]              | The Danish subsection of [wikipedia](https://en.wikipedia.org/wiki/Main_Page)                                                                 | Encyclopedic  | 122.00M     | [CC-0]                 |
+| [ft]                | Records from all meetings of The Danish parliament (Folketinget) in the parliament hall                                                       | Conversation  | 114.09M     | [CC-0]                 |
+| [ep]                | The Danish subsection of [Europarl](https://aclanthology.org/2005.mtsummit-papers.11/)                                                        | Conversation  | 100.84M     | [CC-0]                 |
+| [adl]               | Danish literature from 1700-2023 from the Archive for Danish Literature (ADL)                                                                 | Books         | 58.49M      | [CC-0]                 |
+| [retspraksis]       | Case law or judical practice in Denmark derived from [Retspraksis](https://da.wikipedia.org/wiki/Retspraksis)                                 | Legal         | 56.26M      | [CC-0]                 |
+| [fm-udgivelser]     | The official publication series of the Danish Ministry of Finance containing economic analyses, budget proposals, and fiscal policy documents | Legal         | 50.34M      | [CC-BY-SA 4.0]         |
+| [nordjyllandnews]   | Articles from the Danish Newspaper [TV2 Nord](https://www.tv2nord.dk)                                                                         | News          | 37.90M      | [CC-0]                 |
+| [eur-lex-sum-da]    | The Danish subsection of EUR-lex SUM consisting of EU legislation paired with professionally written summaries                                | Legal         | 31.37M      | [CC-BY-SA 4.0]         |
+| [tv2r]              | Contemporary Danish newswire articles published between 2010 and 2019                                                                         | News          | 21.67M      | [CC-BY-SA 4.0]         |
+| [memo]              | The MeMo corpus comprising almost all Danish novels from the period 1870-1899, known as the Modern Breakthrough                               | Books         | 9.28M       | [CC-BY-SA 4.0]         |
+| [danske-taler]      | Danish Speeches from [dansketaler.dk](https://www.dansketaler.dk)                                                                             | Speeches      | 8.23M       | [CC-0]                 |
+| [nota]              | The text only part of the [Nota lyd- og tekstdata](https://sprogteknologi.dk/dataset/nota-lyd-og-tekstdata) dataset                           | Readaloud     | 7.30M       | [CC-0]                 |
+| [gutenberg]         | The Danish subsection from Project [Gutenberg](https://www.gutenberg.org)                                                                     | Books         | 6.76M       | [Gutenberg]            |
+| [wikibooks]         | The Danish Subsection of [Wikibooks](https://www.wikibooks.org)                                                                               | Encyclopedic  | 6.24M       | [CC-0]                 |
+| [wikisource]        | The Danish subsection of [Wikisource](https://en.wikisource.org/wiki/Main_Page)                                                               | Encyclopedic  | 5.34M       | [CC-0]                 |
+| [jvj]               | The works of the Danish author and poet, [Johannes V. Jensen](https://da.wikipedia.org/wiki/Johannes_V._Jensen)                               | Books         | 3.55M       | [CC-BY-SA 4.0]         |
+| [spont]             | Conversational samples collected as a part of research projects at Aarhus University                                                          | Conversations | 1.56M       | [CC-0]                 |
+| [dannet]            | [DanNet](https://cst.ku.dk/projekter/dannet) is a Danish WordNet                                                                              | Other         | 1.48M       | [DanNet 1.0]           |
+| [relig]             | Danish religious text from the 1700-2022                                                                                                      | Books         | 1.24M       | [CC-0]                 |
+| [botxt]             | The Bornholmsk Ordbog Dictionary Project                                                                                                      | Dialect       | 847.97K     | [CC-0]                 |
+| [naat]              | Danish speeches from 1930-2022                                                                                                                | Conversations | 286.68K     | [CC-0]                 |
+| [depbank]           | The Danish subsection of the [Universal Dependencies Treebank](https://github.com/UniversalDependencies/UD_Danish-DDT)                        | Other         | 185.45K     | [CC-BY-SA 4.0]         |
+| [synne]             | Dataset collected from [synnejysk forening's website](https://www.synnejysk.dk), covering the Danish dialect sønderjysk                       | Other         | 52.02K      | [CC-0]                 |
 
 [ai-aktindsigt]: data/ai-aktindsigt/ai-aktindsigt.md
 [cellar]: data/cellar/cellar.md
@@ -389,8 +386,7 @@ TODO:
 
 <!-- START-DATASET PLOTS -->
 <p align="center">
-<img src="./images/dist_document_length.png" width="600" style="margin-right: 10px;" /> 
-<img>
+<img src="./images/dist_document_length.png" width="600" style="margin-right: 10px;" />
 </p>
 <!-- END-DATASET PLOTS -->
 
@@ -423,4 +419,4 @@ We will comply with legitimate requests by removing the affected sources from th
     <img src="./docs/icon.png" width="30" style="margin-right: 10px;" />
   </a>
   A&nbsp;<a href=https://www.foundationmodels.dk>Danish Foundation Models</a>&nbsp;dataset
-</h3>
+</h3>

data/danske-taler/danske-taler.md

@@ -14,7 +14,7 @@ domains:
 - Spoken
 ---
 
-# Dataset Card for Nordjylland News
+# Dataset Card for Danske Taler
 
 <!-- START-SHORT DESCRIPTION -->
 Danish Speeches from [dansketaler.dk](https://www.dansketaler.dk).

data/wikisource/descriptive_stats.json

@@ -2,5 +2,5 @@
   "number_of_samples": 2419,
   "average_document_length": 6398.767259198015,
   "number_of_tokens": 5344862,
-  "revision": "ec36d0ad0ba8ac5d76f6dd32b75b90f75dd1d40a"
+  "revision": "43d839aa9331a74eaa55c04d23d77b7dc19a20d8"
 }

data/wikisource/wikisource.md

@@ -29,7 +29,7 @@ The Danish subsection of [Wikisource](https://en.wikisource.org/wiki/Main_Page).
 
 <!-- START-DESC-STATS -->
 - **Language**: dan, dansk, Danish
-- **Domains**: ['Encyclopedic']
+- **Domains**: Encyclopedic
 - **Number of samples**: 2.42K
 - **Number of tokens (Llama 3)**: 5.34M
 - **Average document length (characters)**: 6398.77

descriptive_stats.json

@@ -2,5 +2,5 @@
   "number_of_samples": 846387,
   "average_document_length": 12453.449737531413,
   "number_of_tokens": 3363395483,
-  "revision": "ec36d0ad0ba8ac5d76f6dd32b75b90f75dd1d40a"
+  "revision": "43d839aa9331a74eaa55c04d23d77b7dc19a20d8"
 }

src/dynaword/datasheet.py

@@ -168,6 +168,8 @@ class DataSheet(BaseModel):
         raise ValueError(f"tag ({tag}) not found in readme")
 
     def get_tag_content(self, tag: str | DEFAULT_SECTION_TAGS) -> str:
+        if isinstance(tag, Enum):
+            tag = tag.value
         s, e = self.get_tag_idx(tag=tag)
         tag_start = f"<!-- START-{tag} -->"
         return self.body[s + len(tag_start) : e].strip()
@@ -191,12 +193,16 @@ class DataSheet(BaseModel):
 
         if self.domains:
             domains = ", ".join(self.domains)
-            package += f"- **Domains**: {domains}"
+            package += f"- **Domains**: {domains}\n"
 
-        package = dedent(f"""- **Number of samples**: {human_readable_large_int(d_stats.number_of_samples)}
+        package += (
+            dedent(f"""
+        - **Number of samples**: {human_readable_large_int(d_stats.number_of_samples)}
         - **Number of tokens (Llama 3)**: {human_readable_large_int(d_stats.number_of_tokens)}
         - **Average document length (characters)**: {d_stats.average_document_length:.2f}
-        """)
+        """).strip()
+            + "\n"
+        )
 
         return self.replace_tag(
             package=package,

src/dynaword/plots.py

@@ -8,6 +8,12 @@ from datasets import Dataset
 logger = logging.getLogger(__name__)
 
 
+# TODO:
+# make double pie chart
+# inner layer: Domains
+# Outer layer: source
+
+
 def create_descriptive_statistics_plots(
     dataset: Dataset,
     save_dir: Path,

src/dynaword/tables.py

@@ -60,9 +60,11 @@ def create_overview_table(repo_path: Path = repo_path) -> pd.DataFrame:
 
         sheet = DataSheet.load_from_path(readme_path)
         desc_stats = sheet.get_descritive_stats()
+        main_domain = sheet.domains[0] if sheet.domains else ""
 
         table["Source"] += [f"[{dataset_path.name}]"]
         table["License"] += [f"[{sheet.license_name}]"]
+        table["Domain"] += [main_domain]
         table["Description"] += [sheet.short_description]
         table["N. Tokens"] += [desc_stats.number_of_tokens]
 
@@ -74,7 +76,7 @@ def create_overview_table(repo_path: Path = repo_path) -> pd.DataFrame:
     table["N. Tokens"] += [sum(table["N. Tokens"])]
 
     df = pd.DataFrame.from_dict(table)
-    df = df.sort_values("N. Tokens")
+    df = df.sort_values("N. Tokens", ascending=False)
     df["N. Tokens"] = df["N. Tokens"].apply(human_readable_large_int)
 
     return df

src/dynaword/update_descriptive_statistics.py

@@ -75,8 +75,8 @@ def update_dataset(
     sheet.body = sheet.add_sample_and_description(ds)
     sheet.body = sheet.add_dataset_plots(ds, create_plot=True)
 
-    logger.info("Updating Overview table")
     if dataset_name == "default":
+        logger.info("Updating Overview table")
         package = create_overview_table_str()
         sheet.body = sheet.replace_tag(package=package, tag="MAIN TABLE")