Update README.md

README.md

@@ -5,31 +5,102 @@ language:
 tags:
 - intrusion-detection
 - network-logs
-- security
+- cybersecurity
 pretty_name: Network Traffic Dataset
 ---
 
 # Network Traffic Detection Dataset
 
-A curated dataset for **network traffic anomaly detection**, derived from the **[BCCC-CSE-CIC-IDS2018](https://www.yorku.ca/research/bccc/ucs-technical/cybersecurity-datasets-cds/large-scale-intrusion-detection-dataset-bccc-cse-cic-ids2018/)** intrusion detection dataset, which is itself an enhanced version of the [CSE-CIC-IDS2018](https://www.unb.ca/cic/datasets/ids-2018.html)  
-This dataset is designed for machine learning and deep learning research on **network security and intrusion detection**.
+A curated dataset for **network traffic anomaly detection**, derived from the **[BCCC-CSE-CIC-IDS2018](https://www.yorku.ca/research/bccc/ucs-technical/cybersecurity-datasets-cds/large-scale-intrusion-detection-dataset-bccc-cse-cic-ids2018/)** intrusion detection dataset, which itself is an enhanced version of the [CSE-CIC-IDS2018](https://www.unb.ca/cic/datasets/ids-2018.html)  
+This dataset is restructured for modern machine learning and deep learning research on **network security** and **intrusion detection**.
 
-Dataset link: https://huggingface.co/datasets/init5iv3/network-traffic-detection
+> [!IMPORTANT]  
+> The raw dataset (~90GB) was fragmented across 34 `.csv` files. To optimize for ML workflows, the data was merged and compressed into `.parquet` chunks using the `polars` Python library.  
+> During the merge, 18 columns exhibited data-type mismatches (e.g., containing both `float64` values and strings like *"not a complete handshake"*). To resolve this, these specific columns were type-cast to `Utf8`.  
+> - [View Schema Comparison Output](https://huggingface.co/datasets/init5iv3/network-traffic-detection/raw/main/schema_comparison_output.txt)  
+> - [View Merge Script](https://huggingface.co/datasets/init5iv3/network-traffic-detection/raw/main/merge-upload.py)
 
-> **Important:**  
-> This dataset is created from the **[BCCC-CSE-CIC-IDS2018](https://www.yorku.ca/research/bccc/ucs-technical/cybersecurity-datasets-cds/large-scale-intrusion-detection-dataset-bccc-cse-cic-ids2018/)** and restructured to be easier to use for modern ML workflows.
+## Usage
 
----
+You can load the dataset directly using the Hugging Face `datasets` library:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("init5iv3/network-traffic-detection")
+```
+
+## Overview
+
+Raw intrusion detection datasets like BCCC-CSE-CIC-IDS2018 are large, fragmented across multiple files, and often difficult to use directly for ML experiments. \
+This dataset was created to provide an ML-ready format to the raw data, containing over 300 network flow features extracted via [NTLFlowLyzer](https://github.com/ahlashkari/NTLFlowLyzer). \
+It is suitable for binary and multi-class classification.
+
+## Labels
+
+### Binary Classification
+1. **Benign**
+2. **Non-benign:** Aggregated from all specific attack classes below 
+
+### Multi‑Class Classification
+- Benign  
+- DoS-Hulk
+- DoS-Slowhttptest
+- DoS-GoldenEye
+- DoS-Slowloris
+- DDoS-LOIC
+- DDoS-HOIC
+- Brute-Force-XSS
+- Brute-Force-Web
+- Brute-Force-FTP
+- Brute-Force-SSH
+- SQL-Injection
+- Botnet
+- Infiltration
 
+## Citation
 
+If you use this dataset, please cite both this repository and the original source:
+
+### This dataset
+
+```bibtex
+@misc{init5iv32026networktraffic,
+  title={Network Traffic Dataset},
+  author={init5iv3},
+  year={2026},
+  publisher={Hugging Face},
+  url={https://huggingface.co/datasets/init5iv3/network-traffic-detection}
+}
+```
+
+### Original dataset (BCCC-CSE-CIC-IDS2018) and paper
+
+```bibtex
+@misc{bccc_cse_cic_ids2018_dataset,
+  title={BCCC-CSE-CIC-IDS2018: Large-Scale Intrusion Detection Dataset},
+  author={Shafi, MohammadMoein and Lashkari, Arash Habibi and Roudsari, Arousha Haghighian},
+  year={2025},
+  publisher={Behaviour-Centric Cybersecurity Center - York University},
+  url={https://www.yorku.ca/research/bccc/ucs-technical/cybersecurity-datasets-cds/large-scale-intrusion-detection-dataset-bccc-cse-cic-ids2018/}
+}
+
+@article{shafi2025toward,
+  title={Toward Generating a Large Scale Intrusion Detection Dataset and Intruders Behavioral Profiling Using Network and Transportation Layers Traffic Flow Analyzer (NTLFlowLyzer)},
+  author={Shafi, MohammadMoein and Lashkari, Arash Habibi and Roudsari, Arousha Haghighian},
+  journal={Journal of Network and Systems Management},
+  volume={33},
+  number={44},
+  year={2025},
+  publisher={Springer}
+}
+```
 
 ## License
 
 This dataset is released under the **MIT License**.  
 The original **BCCC-CSE-CIC-IDS2018** dataset is subject to its own licensing terms.
 
----
-
 ## Contributions
 
 Feedback is welcome via the [community page](https://huggingface.co/datasets/init5iv3/network-traffic-detection/discussions)