Update README.md

README.md

@@ -20,95 +20,161 @@ size_categories:
 
 A 1-billion-token representative sample of a much larger cleaned New Zealand web-text corpus derived from Common Crawl. This sample is released alongside the JoeyLLM project's ongoing research into regional English language models. 🌐
 
-**The full 60.7B-token corpus is not publicly released due to its size and potential commercial use.** 🔒 Researchers seeking access to the full corpus for non-commercial testing may contact the project leads (see [Dataset Card Contact](#contact)).
+**The full 60.7B-token corpus is not publicly released due to its size, operational cost, and intended controlled use in research and model development.** 🔒 Researchers seeking access to the full corpus for non-commercial testing or academic collaboration may contact the project leads using the details in the [Dataset Card Contact](#contact) section.
 
 ## 📊 Dataset Summary 📌
 
 | Property | Full cleaned corpus (not released) | This sample |
 | :--- | :--- | :--- |
-| **Tokens** | 60,714,120,289 (~60.7 B) | ~1,000,000,000 (1.00 B) |
-| **Rows (documents)** | 108,370,331 | 1,749,277 |
+| **Tokens** | 60,714,120,289 (~60.7 B) | ~1,000,000,000 (~1.00 B) |
+| **Rows / documents** | 108,370,331 | 1,749,277 |
 | **Compressed size** | 180.48 GB | 2.97 GB |
 | **Source parquet files** | 27,168 | 10 shards |
 | **Common Crawl dumps** | 109 | 109 |
-| **Years covered** | 2013 – 2025 | 2013 – 2025 |
+| **Years covered** | 2013–2025 | 2013–2025 |
+| **Language** | English | English |
 
-The sample represents approximately **1.65%** of the full internal New Zealand corpus by token count, providing full coverage across 13 years of web data. ⏱️
+The sample represents approximately **1.65%** of the full internal New Zealand corpus by token count, while preserving coverage across the Common Crawl dumps and years represented in the full cleaned corpus. ⏱️
 
 ## 🎯 Intended Uses
 
 ### 💡 Direct Use
-* Pre-training and continued pre-training of language models on New Zealand-domain text. 🤖
-* Research into New Zealand English linguistic patterns, spelling variations, and cultural nuances. 📝
-* Benchmarking regional data attribution and filtering pipelines. ⚙️
+
+- Pre-training and continued pre-training of language models on New Zealand-domain text. 🤖
+- Domain-adaptation experiments involving New Zealand English usage, place names, institutions, and topics. 📝
+- Research into Common Crawl-derived language-model datasets. 🔬
+- Inspection and reproducibility of JoeyLLM data pipeline outputs. ⚙️
 
 ### 🚫 Out-of-Scope Use
-* Extracting personal information (PII) or deanonymizing individuals. 🕵️‍♂️
-* Commercial use of the unreleased 60.7B-token corpus without explicit authorization. 💼
-* Training models for malicious use, hate speech, or harassment. 🛑
+
+- Extracting personal information or deanonymizing individuals. 🕵️‍♂️
+- Using the unreleased 60.7B-token corpus without explicit authorization. 💼
+- Training models for malicious use, hate speech, harassment, or other harmful applications. 🛑
 
 ## 🧱 Dataset Structure 🗂️
 
+Each row represents one cleaned web document or document-like text segment.
+
 | Field | Type | Description |
 | :--- | :--- | :--- |
 | `text` | string | Cleaned document body. |
-| `id` | string | Stable document identifier (URL-hash based). |
-| `dump` | string | Common Crawl dump identifier (e.g., CC-MAIN-2024-30). |
-| `url` | string | Original page URL. |
-| `date` | string | Crawl date (ISO 8601). |
-| `file_path` | string | Path inside the original Common Crawl dump. |
-| `language` | string | Language label (always en). |
-| `language_score` | float | Language-detector confidence (≥ 0.85). |
-| `token_count` | int | Token count used for sampling. |
+| `id` | string | Stable document identifier, based on upstream document identity. |
+| `dump` | string | Common Crawl dump identifier, e.g. `CC-MAIN-2024-30`. |
+| `url` | string | Original source URL. |
+| `date` | string | Crawl date, where available. |
+| `file_path` | string | Path inside the original Common Crawl WARC data. |
+| `language` | string | Language label assigned upstream, expected to be `en`. |
+| `language_score` | float | Language-detector confidence score. |
+| `token_count` | int | Token count used for sampling and filtering. |
+| `index` | int | Source row index from the processed shard, if present. |
+| `country` | string | Country attribution, expected to be `New Zealand`, if present. |
+| `year` | string | Common Crawl dump year, e.g. `2024`, if present. |
+| `source_file` | string | Source parquet shard used to construct the public sample, if present. |
 
 ## 🏗️ Dataset Creation
 
 ### 🔍 Curation Rationale
-Regional linguistic nuances—like New Zealand spelling, Te Reo Māori loanwords, and institutional references—are often diluted in global datasets. JoeyLLM provides these targeted slices to enable the development of "civic foundation models" that prioritize regional utility over general benchmarks. 🏙️
+
+Regional linguistic nuances — including New Zealand spelling, Te Reo Māori loanwords, place names, institutions, public services, media references, and local web conventions — are often diluted in global web-scale datasets. JoeyLLM provides targeted regional English web-text samples to support research into foundation models with stronger New Zealand and regional coverage. 🏙️
+
+### 🌍 Source
+
+The dataset was derived from Common Crawl using a FineWeb-style web-text processing pipeline.
+
+Documents were selected as New Zealand web text by the upstream country-attribution stage of the JoeyLLM pipeline. Country attribution may use signals such as top-level domains, URL/domain features, crawl metadata, and content-derived features.
+
+This dataset should be interpreted as **New Zealand-attributed web text**, not necessarily text authored by New Zealanders or officially published in New Zealand.
 
 ### 🎲 Sampling Methodology
-The sample was produced using **stratified random sampling** proportional to the token count of each Common Crawl dump (2013–2025). This ensures the sample preserves the same temporal distribution as the full internal corpus. Documents were selected in their entirety to maintain context and avoid truncation.
+
+The sample was produced using **stratified random sampling** by Common Crawl dump, proportional to each dump's token count.
+
+- A per-dump token quota was allocated proportional to each dump's share of total corpus tokens.
+- Documents were selected in a reproducible random order.
+- Documents were appended in their entirety to avoid mid-text truncation.
+- Because documents are not truncated, the realised token count may slightly overshoot the 1B-token target.
 
 ### 🧹 Cleaning Pipeline
+
 The dataset was processed using a FineWeb-style pipeline including:
-* **Quality Filtering:** Heuristics to remove low-quality pages, boilerplate, and navigation text. ✨
-* **Country Attribution:** Targeted selection using .nz TLDs, URL features, and New Zealand-specific content signals. 📍
-* **Deduplication:** MinHash-based deduplication applied at the corpus level. ✂️
+
+- **Language filtering:** documents retained only when classified as English with sufficient language confidence. ✨
+- **Quality filtering:** heuristics to reduce low-quality pages, boilerplate, repetitive text, navigation text, and obvious extraction artefacts. 🧽
+- **Country attribution:** targeted selection using signals such as `.nz` domains, URL features, crawl metadata, and New Zealand-specific content signals. 📍
+- **Deduplication:** MinHash-style deduplication applied at the corpus level. ✂️
 
 ### 🛡️ Personal and Sensitive Information
-Derived from public web crawls, this dataset may contain names or contact details. No dedicated PII masking was performed. Users should apply additional filters before production use. ⚠️
+
+This dataset is derived from public web crawls and may contain names, contact details, opinions, offensive content, copyrighted text, or other sensitive material. No dedicated PII masking was performed. ⚠️
+
+Users should apply additional filtering, redaction, and safety review before using this dataset in production systems or public-facing models.
 
 ## 🚀 Loading the Dataset 💻
 
-    from datasets import load_dataset
-    
-    # Load the full 1B sample
-    ds = load_dataset("JoeyLLM/NewZealand-dataset-1b", split="train")
-    
-    # For streaming (recommended for rapid inspection)
-    ds_stream = load_dataset("JoeyLLM/NewZealand-dataset-1b", split="train", streaming=True)
+```python
+from datasets import load_dataset
+
+# Load the full 1B-token sample
+ds = load_dataset("JoeyLLM/NewZealand-dataset-1b", split="train")
+
+print(ds)
+print(ds[0]["text"][:500])
+```
+
+For streaming, which is recommended for rapid inspection:
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("JoeyLLM/NewZealand-dataset-1b", split="train", streaming=True)
+
+for ex in ds.take(3):
+    print(ex["url"], ex["token_count"])
+```
+
+## ⚠️ Limitations and Known Issues
+
+This dataset is derived from public web crawl data and inherits the usual limitations of Common Crawl-derived corpora.
+
+Known limitations include:
+
+- **Heuristic country attribution.** New Zealand attribution is based on automated signals and may contain false positives or non-New Zealand content.
+- **Web-text noise.** Boilerplate, navigation text, advertisements, duplicate fragments, low-quality pages, and formatting artefacts may remain.
+- **Residual duplication.** Deduplication may not remove all near-duplicates.
+- **Potential personal information.** Public web data may contain personal names, contact details, or other sensitive material.
+- **Copyright and source terms.** The underlying text originates from public web pages and may remain subject to the rights and terms of the original publishers.
+- **Not balanced by domain or genre.** The dataset reflects the distribution of selected web crawl data rather than a deliberately balanced linguistic corpus.
 
 ## 📜 License ⚖️
-Released under **CC BY 4.0**. Underlying text remains subject to the rights of the original publishers.
+
+The dataset card, metadata, selection, and processing outputs are released under CC BY 4.0.
+
+The underlying text is derived from publicly crawled web pages via Common Crawl and may remain subject to the rights, licences, and terms of the original publishers. Users are responsible for ensuring that their downstream use complies with applicable law and source terms.
 
 ## 📚 Citation ✒️
 
-    @misc{joeyllm_newzealand_1b,
-      title        = {New Zealand Web Text -- 1B-token Sample},
-      author       = {JoeyLLM Team},
-      year         = {2026},
-      howpublished = {\url{https://huggingface.co/datasets/JoeyLLM/NewZealand-dataset-1b}}
-    }
+A citation entry for the JoeyLLM project paper will be added once available. Until then, please cite this dataset card by URL:
+
+```bibtex
+@misc{joeyllm_newzealand_1b,
+  title        = {New Zealand Web Text -- 1B-token Sample},
+  author       = {JoeyLLM Team},
+  year         = {2026},
+  howpublished = {https://huggingface.co/datasets/JoeyLLM/NewZealand-dataset-1b}
+}
+```
 
 ## 🙏 Acknowledgements 🤝
-Built using Common Crawl data and a FineWeb-style processing pipeline. While dataset selection, cleaning, sampling, and publication were carried out by the JoeyLLM team, this project would not have been possible without the invaluable tools, feedback, and ongoing support of the broader open-source AI community. We extend our deepest gratitude to all the open-source contributors and researchers whose collaborative efforts continue to drive this field forward. 🌟
+
+Built using Common Crawl data and a FineWeb-style processing pipeline. While dataset selection, cleaning, sampling, and publication were carried out by the JoeyLLM team, this project would not have been possible without the invaluable tools, feedback, and ongoing support of the broader open-source AI community. We extend our deepest gratitude to all open-source contributors and researchers whose collaborative efforts continue to drive this field forward. 🌟
 
 <a id="contact"></a>
+
 ## 📬 Dataset Card Contact ✉️
 
 For inquiries regarding research access to the full 60.7B-token New Zealand corpus for non-commercial testing or academic collaboration, please contact:
 
-**Matthew Altenburg**
-AI Scientist & Lead Researcher, JoeyLLM
-matthew.altenburg@anu.edu.au
-*(Backup: mattaltenburg@gmail.com)*
+**Matthew Altenburg**  
+AI Scientist & Lead Researcher, JoeyLLM  
+`matthew.altenburg@anu.edu.au`  
+Backup: `mattaltenburg@gmail.com`