Update README with parquet dataset documentation

README.md

@@ -1,80 +1,170 @@
 ---
+dataset_info:
+  features:
+    - name: thread_no
+      dtype: int64
+    - name: archived_on
+      dtype: int64
+    - name: semantic_url
+      dtype: string
+    - name: "no"
+      dtype: int64
+    - name: resto
+      dtype: int64
+    - name: time
+      dtype: int64
+    - name: now
+      dtype: string
+    - name: name
+      dtype: string
+    - name: trip
+      dtype: string
+    - name: sub
+      dtype: string
+    - name: com
+      dtype: string
+    - name: country
+      dtype: string
+    - name: country_name
+      dtype: string
+    - name: filename
+      dtype: string
+    - name: ext
+      dtype: string
+    - name: fsize
+      dtype: int64
+    - name: md5
+      dtype: string
+    - name: w
+      dtype: int32
+    - name: h
+      dtype: int32
+    - name: tn_w
+      dtype: int32
+    - name: tn_h
+      dtype: int32
+    - name: tim
+      dtype: int64
+    - name: replies
+      dtype: int32
+    - name: images
+      dtype: int32
+    - name: bumplimit
+      dtype: int32
+    - name: imagelimit
+      dtype: int32
+    - name: archived
+      dtype: int32
+    - name: closed
+      dtype: int32
+    - name: toxicity
+      dtype: float32
+    - name: severe_toxicity
+      dtype: float32
+    - name: inflammatory
+      dtype: float32
+    - name: profanity
+      dtype: float32
+    - name: insult
+      dtype: float32
+    - name: obscene
+      dtype: float32
+    - name: spam
+      dtype: float32
+    - name: entities
+      dtype: string
+  splits:
+    - name: train
+      num_bytes: 19440000000
+      num_examples: 134529233
+  download_size: 19440000000
+  dataset_size: 134529233
+configs:
+  - config_name: default
+    data_files:
+      - split: train
+        path: data/train-*-of-00270.parquet
 license: cc-by-4.0
 task_categories:
   - text-classification
-  - token-classification
 language:
   - en
 tags:
   - 4chan
-  - political-discourse
   - toxicity
-  - named-entity-recognition
   - perspective-api
-  - social-media
-  - imageboard
+  - named-entities
+  - political
+pretty_name: "/pol/ 4chan Augmented (Jun 2016 - Nov 2019)"
 size_categories:
-  - 10M<n<100M
-source_datasets:
-  - original
+  - 100M<n<1B
 ---
 
-# Raiders of the Lost Kek: 3.5 Years of Augmented 4chan /pol/ Posts
+# /pol/ 4chan Augmented Dataset
 
-## Dataset Description
-
-Academic research dataset containing 3.5 years of 4chan /pol/ (Politically Incorrect) board content with enriched metadata. Published alongside the paper "Raiders of the Lost Kek: 3.5 Years of Augmented 4chan Posts from the Politically Incorrect Board" (ICWSM 2020).
-
-**Authors:** Antonis Papasavva, Savvas Zannettou, Emiliano De Cristofaro, Gianluca Stringhini, Jeremy Blackburn
-
-**Institutions:** University College London, Max Planck Institute, Boston University, Binghamton University
+**134.5M posts** from 3.4M threads on 4chan's /pol/ board (June 2016 - November 2019), augmented with Perspective API toxicity scores and named entity recognition.
 
-## Content
+## Dataset Description
 
-- **Format:** Newline-delimited JSON (NDJSON), one line per thread
-- **Date range:** June 2016 — November 2019
-- **Source:** 4chan /pol/ board via the 4chan API
-- **Size:** ~24 GB compressed (tar.zst)
+This dataset contains posts from 4chan's Politically Incorrect (/pol/) board, collected between June 2016 and November 2019. Each post has been augmented with:
 
-## Augmented Annotations
+- **Perspective API toxicity scores** (7 dimensions): toxicity, severe_toxicity, inflammatory, profanity, insult, obscene, spam
+- **Named Entity Recognition**: extracted entities stored as JSON arrays
 
-Three supplementary data layers beyond the standard 4chan API fields:
+### Source
 
-1. **Named Entities** — Extracted using spaCy NLP pipeline
-2. **Perspective API Scores** — 7 toxicity dimension scores in [0, 1] from Google's Perspective API
-3. **Extracted Poster ID** — Additional identifier field
+Original data from [Papasavva et al. (2020)](https://zenodo.org/records/3606810) — "Raiders of the Lost Kek: 3.5 Years of Augmented 4chan Posts from the Politically Incorrect Board".
 
-## Usage
+### Format
 
-```bash
-# Decompress
-tar --zstd -xf pol_0616-1119_labeled.tar.zst
+270 parquet shards with zstd compression (~70MB each). The dataset is directly loadable with HuggingFace `datasets`:
 
-# Stream process with Python
-import json
-with open('pol_0616-1119_labeled.ndjson') as f:
-    for line in f:
-        thread = json.loads(line)
-        # thread contains posts with entities, toxicity scores, etc.
+```python
+from datasets import load_dataset
+ds = load_dataset("ylelauta/pol-4chan-augmented")
 ```
 
-## Citation
+### Schema
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `thread_no` | int64 | Thread number (from OP) |
+| `no` | int64 | Post number |
+| `resto` | int64 | 0 = OP, >0 = reply-to thread number |
+| `time` | int64 | Unix timestamp |
+| `com` | string | Comment HTML |
+| `country` / `country_name` | string | Poster's country flag |
+| `sub` | string | Subject (OP only) |
+| `name` / `trip` | string | Poster identity |
+| `filename` / `ext` / `fsize` / `md5` / `w` / `h` / `tim` | mixed | Image metadata |
+| `replies` / `images` | int32 | Thread stats (OP only) |
+| `toxicity` | float32 | Perspective API toxicity score (0-1) |
+| `severe_toxicity` | float32 | Severe toxicity score |
+| `inflammatory` | float32 | Inflammatory score |
+| `profanity` | float32 | Profanity score |
+| `insult` | float32 | Insult score |
+| `obscene` | float32 | Obscene score |
+| `spam` | float32 | Spam score |
+| `entities` | string | JSON array of named entities |
+
+### Statistics
+
+- **134,529,233** posts
+- **3,397,911** threads
+- **270** parquet shards
+- Date range: June 2016 - November 2019
+
+### Citation
 
 ```bibtex
 @inproceedings{papasavva2020raiders,
   title={Raiders of the Lost Kek: 3.5 Years of Augmented 4chan Posts from the Politically Incorrect Board},
   author={Papasavva, Antonis and Zannettou, Savvas and De Cristofaro, Emiliano and Stringhini, Gianluca and Blackburn, Jeremy},
-  booktitle={Proceedings of the International AAAI Conference on Web and Social Media (ICWSM)},
+  booktitle={Proceedings of the International AAAI Conference on Web and Social Media},
   year={2020}
 }
 ```
 
-## License
-
-Creative Commons Attribution 4.0 International (CC-BY-4.0)
-
-**DOI:** [10.5281/zenodo.3606810](https://doi.org/10.5281/zenodo.3606810)
-
-## Intended Use
+### License
 
-This dataset is intended for academic research on online discourse, toxicity detection, and social media analysis. It is mirrored here from Zenodo for easier programmatic access.
+CC-BY-4.0 (following the original dataset license)