Add comprehensive dataset card

README.md

@@ -4,75 +4,19 @@ language:
 - de
 multilinguality:
 - monolingual
-size_categories:
-- 100K<n<1M
 source_datasets:
 - original
 task_categories:
 - text-generation
 task_ids:
 - language-modeling
-pretty_name: DCLM German Dataset
+paperswithcode_id: null
+pretty_name: DCLM-German
 tags:
 - pretraining
 - german
 - common-crawl
 - fasttext-filtered
-dataset_info:
-  features:
-  - name: text
-    dtype: string
-  - name: metadata
-    struct:
-    - name: Content-Length
-      dtype: string
-    - name: Content-Type
-      dtype: string
-    - name: WARC-Block-Digest
-      dtype: string
-    - name: WARC-Concurrent-To
-      dtype: string
-    - name: WARC-Date
-      dtype: string
-    - name: WARC-IP-Address
-      dtype: string
-    - name: WARC-Identified-Payload-Type
-      dtype: string
-    - name: WARC-Payload-Digest
-      dtype: string
-    - name: WARC-Record-ID
-      dtype: string
-    - name: WARC-Target-URI
-      dtype: string
-    - name: WARC-Truncated
-      dtype: string
-    - name: WARC-Type
-      dtype: string
-    - name: WARC-Warcinfo-ID
-      dtype: string
-  - name: warcinfo
-    dtype: string
-  - name: url
-    dtype: string
-  - name: language_id_whole_page_fasttext
-    struct:
-    - name: de
-      dtype: float64
-  - name: previous_word_count
-    dtype: int64
-  - name: fasttext_oh25_german_prob
-    dtype: float64
-  splits:
-  - name: train
-    num_bytes: 1098988939
-    num_examples: 160812
-  download_size: 646832471
-  dataset_size: 1098988939
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
 ---
 
 # DCLM German Dataset
@@ -84,33 +28,7 @@ This dataset contains German language data processed for LLM pretraining, filter
 - **Language**: German (de)
 - **Size**: 43,452 compressed JSONL files
 - **Source**: Common Crawl data
-- **Processing**: FastText language filtering
-- **Format**: JSONL compressed with gzip
-
-## Dataset Structure
-
-The data is organized by Common Crawl snapshots:
-
-```
-/data/horse/ws/fapa811h-dclm-de/fasttext_de_filter_output/processed_data/CC-MAIN-2014-35/
-├── cc_snapshot_1/
-│   ├── subfolder_1/
-│   │   ├── file_001.jsonl.gz
-│   │   ├── file_002.jsonl.gz
-│   │   └── ...
-│   └── subfolder_2/
-│       └── ...
-└── cc_snapshot_2/
-    └── ...
-```
-
-## Data Fields
-
-Each line in the JSONL files contains:
-- `text`: The filtered German text content
-- `url`: Source URL (if available)
-- `timestamp`: Processing timestamp
-- Additional metadata fields
+- **Processing**: RefinedWeb, Deduplication, FastText filtering
 
 ## Usage
 
@@ -120,64 +38,41 @@ from datasets import load_dataset
 # Load the entire dataset
 dataset = load_dataset("faidrap/DCLM_German")
 
-# Load specific files/patterns
-dataset = load_dataset("faidrap/DCLM_German", data_files="**/cc_snapshot_1/**/*.jsonl.gz")
-
-# Stream for large datasets
+# Stream for large datasets (recommended)
 dataset = load_dataset("faidrap/DCLM_German", streaming=True)
+
+# Access the data
+for example in dataset['train']:
+    print(example['text'][:100])  # Print first 100 chars
 ```
 
 ## Example Data
 
-```python
-[
-  {
-    "text": "Link zu diesem Datensatz\nPerson Benn, Tony\nAndere Namen Benn, Anthony W.\nWedgewood Benn, Anthony N.\nBenn, Anthony N.\nQuelle LCAuth, BLC (1976) gegen B 1986\nZeit Lebensdaten: 1925-2014\nLand Großbritann...",
-    "metadata": {
-      "WARC-Type": "response",
-      "WARC-Date": "2014-08-31T00:55:33Z",
-      "WARC-Record-ID": "<urn:uuid:7c1eb6e4-ca7d-45db-8532-327512f38e85>",
-      "Content-Length": "7963",
-      "Content-Type": "application/http; msgtype=response",
-      "WARC-Warcinfo-ID": "<urn:uuid:7986c2c0-02c6-4aa2-bf61-e0ba102eec83>",
-      "WARC-Concurrent-To": "<urn:uuid:8fac34c7-8aeb-4172-ac59-901f0cf8f5c4>",
-      "WARC-IP-Address": "193.175.100.140",
-      "WARC-Target-URI": "http://d-nb.info/gnd/118983296/about/html",
-      "WARC-Payload-Digest": "sha1:LCYNHVTW44EVGQUJVSACQDW2LYWR5BMR",
-      "WARC-Block-Digest": "sha1:LAXUCR2PMR5HYXFBDDJPAXQQHUWIH6CD"
-    },
-    "warcinfo": "robots: classic\r\nhostname: ip-10-180-136-8.ec2.internal\r\nsoftware: Nutch 1.6 (CC)/CC WarcExport 1.0\r\nisPartOf: CC-MAIN-2014-35\r\noperator: CommonCrawl Admin\r\ndescription: Wide crawl of the web with URLs provided by Blekko for August 2014\r\npublisher: CommonCrawl\r\nformat: WARC File Format 1.0\r\nconformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf",
-    "url": "http://d-nb.info/gnd/118983296/about/html",
-    "language_id_whole_page_fasttext": {
-      "de": 0.9169723987579346
-    },
-    "previous_word_count": 51,
-    "fasttext_oh25_german_prob": 0.19228917360305786
+```json
+{
+  "text": "Link zu diesem Datensatz\nPerson Benn, Tony\nAndere Namen Benn, Anthony W.\nWedgewood Benn, Anthony N.\nBenn, Anthony N.\nQuelle LCAuth, BLC (1976) gegen B 1986\nZeit Lebensdaten: 1925-2014\nLand Großbritann...",
+  "metadata": {
+    "WARC-Type": "response",
+    "WARC-Date": "2014-08-31T00:55:33Z",
+    "WARC-Record-ID": "<urn:uuid:7c1eb6e4-ca7d-45db-8532-327512f38e85>",
+    "Content-Length": "7963",
+    "Content-Type": "application/http; msgtype=response",
+    "WARC-Warcinfo-ID": "<urn:uuid:7986c2c0-02c6-4aa2-bf61-e0ba102eec83>",
+    "WARC-Concurrent-To": "<urn:uuid:8fac34c7-8aeb-4172-ac59-901f0cf8f5c4>",
+    "WARC-IP-Address": "193.175.100.140",
+    "WARC-Target-URI": "http://d-nb.info/gnd/118983296/about/html",
+    "WARC-Payload-Digest": "sha1:LCYNHVTW44EVGQUJVSACQDW2LYWR5BMR",
+    "WARC-Block-Digest": "sha1:LAXUCR2PMR5HYXFBDDJPAXQQHUWIH6CD",
+    "WARC-Truncated": ""
+  },
+  "warcinfo": "robots: classic\r\nhostname: ip-10-180-136-8.ec2.internal\r\nsoftware: Nutch 1.6 (CC)/CC WarcExport 1.0\r\nisPartOf: CC-MAIN-2014-35\r\noperator: CommonCrawl Admin\r\ndescription: Wide crawl of the web with URLs provided by Blekko for August 2014\r\npublisher: CommonCrawl\r\nformat: WARC File Format 1.0\r\nconformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf",
+  "url": "http://d-nb.info/gnd/118983296/about/html",
+  "language_id_whole_page_fasttext": {
+    "de": 0.9169723987579346
   },
-  {
-    "text": "Sozialethiker Peter Schallenberg unterstreicht Bedeutung der Familie\n\nTagung der Katholischen Bundesarbeitsgemeinschaft für Einrichtungen der Familienbildung\n\n| 1100 klicks\n\nKÖLN, 1. Juni 2007 ( Der F...",
-    "metadata": {
-      "WARC-Type": "response",
-      "WARC-Date": "2014-08-31T00:44:28Z",
-      "WARC-Record-ID": "<urn:uuid:d3fe5c8a-5737-4b73-9642-85dc7a1a7cb0>",
-      "Content-Length": "44468",
-      "Content-Type": "application/http; msgtype=response",
-      "WARC-Warcinfo-ID": "<urn:uuid:7986c2c0-02c6-4aa2-bf61-e0ba102eec83>",
-      "WARC-Concurrent-To": "<urn:uuid:aa8fb03d-8433-4dab-90b9-9a3f531ac285>",
-      "WARC-IP-Address": "144.202.233.155",
-      "WARC-Target-URI": "http://www.zenit.org/de/articles/sozialethiker-peter-schallenberg-unterstreicht-bedeutung-der-familie",
-      "WARC-Payload-Digest": "sha1:4ESTPSMFSGF2A7ACWF3FTSDYDIAGKSKB",
-      "WARC-Block-Digest": "sha1:MPRG2PNQJA2A5RJEXHKELWKP2GD76OEN"
-    },
-    "warcinfo": "robots: classic\r\nhostname: ip-10-180-136-8.ec2.internal\r\nsoftware: Nutch 1.6 (CC)/CC WarcExport 1.0\r\nisPartOf: CC-MAIN-2014-35\r\noperator: CommonCrawl Admin\r\ndescription: Wide crawl of the web with URLs provided by Blekko for August 2014\r\npublisher: CommonCrawl\r\nformat: WARC File Format 1.0\r\nconformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf",
-    "url": "http://www.zenit.org/de/articles/sozialethiker-peter-schallenberg-unterstreicht-bedeutung-der-familie",
-    "language_id_whole_page_fasttext": {
-      "de": 0.9930596947669983
-    },
-    "previous_word_count": 293,
-    "fasttext_oh25_german_prob": 0.043831586837768555
-  }
-]
+  "previous_word_count": 51,
+  "fasttext_oh25_german_prob": 0.19228917360305786
+}
 ```
 
 ## License
@@ -190,8 +85,8 @@ If you use this dataset, please cite:
 
 ```bibtex
 @dataset{dclm_german,
-  title={DCLM German Dataset},
-  author={Your Name},
+  title={DCLM-German Dataset},
+  author={Faidra Anastasia Patsatzi},
   year={2024},
   url={https://huggingface.co/datasets/faidrap/DCLM_German}
 }