data: publish verified NetFlow V3 Parquet

Reorganize the four UQ NetFlow V3 Parquet files under data/, move the supplied feature dictionary under metadata/, and replace the dataset card with measured row counts, source DOIs, conversion checks, schema differences, leakage warnings, and corrected UQ Open Access terms.

README.md

@@ -1,57 +1,148 @@
 ---
-license: cc-by-nc-sa-4.0
 pretty_name: NetFlow V3
+license: other
+license_name: uq-open-access-data-terms
+license_link: https://web.library.uq.edu.au/research-and-publish/manage-research-data/share-and-reuse-research-data
 language:
   - en
 tags:
-  - IDS
-  - NIDS
-  - NetFlow
-  - parquet
+  - tabular
+  - timeseries
   - cybersecurity
+  - netflow
+  - network-intrusion-detection
 size_categories:
   - 10M<n<100M
+task_categories:
+  - tabular-classification
 configs:
-  - config_name: NF-CICIDS2018
+  - config_name: NF-UNSW-NB15-v3
+    default: true
     data_files:
-      - split: train
-        path: NF-CICIDS2018-v3.parquet
-
-  - config_name: NF-BoT-IoT
+      - split: full
+        path: data/NF-UNSW-NB15-v3.parquet
+  - config_name: NF-BoT-IoT-v3
     data_files:
-      - split: train
-        path: NF-BoT-IoT-v3.parquet
-
-  - config_name: NF-ToN-IoT
+      - split: full
+        path: data/NF-BoT-IoT-v3.parquet
+  - config_name: NF-ToN-IoT-v3
     data_files:
-      - split: train
-        path: NF-ToN-IoT-v3.parquet
-
-  - config_name: NF-UNSW-NB15
+      - split: full
+        path: data/NF-ToN-IoT-v3.parquet
+  - config_name: NF-CSE-CIC-IDS2018-v3
     data_files:
-      - split: train
-        path: NF-UNSW-NB15-v3.parquet
+      - split: full
+        path: data/NF-CICIDS2018-v3.parquet
 ---
 
 # NetFlow V3
 
-NetFlow V3 datasets for machine learning-based network intrusion detection research.
+Parquet mirror of the four NetFlow V3 datasets published by the University of
+Queensland. The files contain 53 flow and temporal features plus the binary
+`Label` and multiclass `Attack` targets. Together they contain 66,935,021
+completed bidirectional flow records.
+
+## Contents
+
+| Configuration | Rows | Attack rows | `Attack` values | Observed flow period (UTC) | Official record |
+|---|---:|---:|---:|---|---|
+| `NF-UNSW-NB15-v3` | 2,365,424 | 127,693 | 10 | 2015-01-22 to 2015-02-18 | [10.48610/6E0EDA1](https://doi.org/10.48610/6E0EDA1) |
+| `NF-BoT-IoT-v3` | 16,933,808 | 16,881,819 | 5 | 2018-05-15 to 2018-06-19 | [10.48610/73C4EBC](https://doi.org/10.48610/73C4EBC) |
+| `NF-ToN-IoT-v3` | 27,520,260 | 10,728,046 | 10 | 2019-04-23 to 2019-04-29 | [10.48610/44D7C5E](https://doi.org/10.48610/44D7C5E) |
+| `NF-CSE-CIC-IDS2018-v3` | 20,115,529 | 2,600,903 | 15 | 2018-02-14 to 2018-03-02 | [10.48610/ECE9B83](https://doi.org/10.48610/ECE9B83) |
+
+The source archive names the final CSV `NF-CICIDS2018-v3.csv`; the Hub
+configuration retains the official `NF-CSE-CIC-IDS2018-v3` dataset name.
+`metadata/NetFlow_v3_Features.csv` is the feature dictionary supplied by UQ.
+
+## Loading
+
+```python
+from datasets import load_dataset
+
+flows = load_dataset(
+    "keys-i/netFlow",
+    "NF-UNSW-NB15-v3",
+    split="full",
+)
+```
+
+`full` is a storage split only. UQ does not provide one common leakage-safe
+train/validation/test split for these four files. Do not interpret it as a
+training partition.
+
+## Conversion and checks
+
+The source packages were downloaded from the four UQ records above. Their
+BagIt payload SHA-1 checks passed before conversion. Each CSV was converted
+with Zstandard compression using
+[`tools/scripts/convert.py`](https://github.com/keys-i/FlowIDS/blob/main/tools/scripts/convert.py):
+
+```console
+pixi run python tools/scripts/convert.py \
+  --input <source.csv> \
+  --output <dataset.parquet> \
+  --overwrite
+```
+
+No filtering, relabelling, deduplication, or feature engineering is performed
+by that converter. Verification on 2026-08-16 established that every Parquet
+row count equals its source CSV line count minus the header, all files have the
+same 55 column names in the same order, and every file opens as Zstandard
+Parquet.
+
+Three inferred numeric types differ across configurations because the source
+values differ:
+
+| Field | UNSW / BoT-IoT | ToN-IoT / CSE-CIC-IDS2018 |
+|---|---|---|
+| `L7_PROTO` | `float64` | `int64` |
+| `SRC_TO_DST_SECOND_BYTES` | `float64` | `int64` |
+| `DST_TO_SRC_SECOND_BYTES` | `float64` | `int64` |
+
+Cast these fields explicitly before concatenating configurations. Do not rely
+on an implicit cross-dataset coercion.
 
-This repository republishes the NetFlow V3 datasets introduced in *Temporal Analysis of NetFlow Datasets for Network Intrusion Detection Systems* by Majed Luay, Siamak Layeghy, Seyedehfaezeh Hosseininoorbin, Mohanad Sarhan, Nour Moustafa, and Marius Portmann. [arXiv](https://arxiv.org/abs/2503.04404)
+## Research-use limits
 
-## Description
+- These are converted benchmark lineages, not four independent operational
+  networks collected under one protocol.
+- The files include endpoint addresses, absolute timestamps, labels, and other
+  fields that can leak capture or scenario identity. A random row split does
+  not demonstrate temporal, endpoint, attack-family, or cross-network
+  generalisation.
+- `Label` and `Attack` must be hidden from self-supervised pretraining. Dataset
+  taxonomies are configuration-specific and must not be merged by fuzzy name
+  matching.
+- Duplicate and near-duplicate flows must be audited before constructing any
+  evaluation split.
+- Results on these four files alone are benchmark evidence, not proof of a
+  general-purpose network foundation model or operational intrusion detector.
 
-NetFlow V3 extends earlier NetFlow datasets with temporal features for time-based analysis in NIDS research. [arXiv](https://arxiv.org/abs/2503.04404)
+## Rights and attribution
 
-## Citation
+Each UQ catalogue record reports open access and lists its licence as “Other.”
+UQ currently defines open access research data as available for access, use,
+reuse, and redistribution. This mirror therefore uses Hugging Face's `other`
+licence marker, links to that UQ guidance, and does not relicense the source
+data. Review the applicable UQ record and terms before reuse. The previous
+dataset card's CC-BY-NC-SA-4.0 label was not supported by the UQ records and
+has been removed.
 
-If you use this dataset, please cite the original paper:
+Please cite the applicable dataset DOI from the contents table and the V3
+feature paper:
 
 ```bibtex
-@article{luay2025temporal,
-  title={Temporal Analysis of NetFlow Datasets for Network Intrusion Detection Systems},
-  author={Luay, Majed and Layeghy, Siamak and Hosseininoorbin, Seyedehfaezeh and Sarhan, Mohanad and Moustafa, Nour and Portmann, Marius},
-  journal={arXiv preprint arXiv:2503.04404},
-  year={2025},
-  doi={10.48550/arXiv.2503.04404}
-}
+@article{luay2026time,
+  author  = {Majed Luay and Siamak Layeghy and Niloufar Noorbin and
+             Mohanad Sarhan and Gayan Kulatilleke and Nour Moustafa and
+             Marius Portmann},
+  title   = {Time Matters: Temporal NetFlow Features for ML-Based Network
+             Intrusion Detection},
+  journal = {IEEE Access},
+  volume  = {14},
+  pages   = {66899--66913},
+  year    = {2026},
+  doi     = {10.1109/ACCESS.2026.3688204}
+}
+```

NF-BoT-IoT-v3.parquet → data/NF-BoT-IoT-v3.parquet

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:0679550f7b6cd09d487f5c78f4b8e7f13c7fcd5e70970210b06e1e5295b9c13e
-size 63896742
+oid sha256:4228c33fea2c599d572d92e4d25256153e1113b8b1ac2aea01ff236144a7ae34
+size 70270946

NF-CICIDS2018-v3.parquet → data/NF-CICIDS2018-v3.parquet

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:cd4f64d381eebe56029876868bc7dc1f96f4e681b38d154c9a465b0388b51636
-size 809943210
+oid sha256:80f67e99c71808bfe57b34932fa35c9eaff8dbb856b5a0aefb9d278ee81230ea
+size 815742559

NF-ToN-IoT-v3.parquet → data/NF-ToN-IoT-v3.parquet

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:3b4bb7506c9a2a56f3782cab3f9ca9bd67fbda2e6950418943148a7bfdd6bb53
-size 442356435
+oid sha256:074edcc2cf1e75b7dc7098acd628525d4c0a23e9d60ed43ff379edddf31c8a21
+size 450120816

NF-UNSW-NB15-v3.parquet → data/NF-UNSW-NB15-v3.parquet

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:c3ac1d4d4d0ff7f199e1db36886f18e36567f5fc464051fdfb5ecbd94842e713
-size 103828433
+oid sha256:780ae4846881a047d1c8ddb08cdbae17ab9dcb8acbbd42982e45bab07beb8d59
+size 105425657

NetFlow_v3_Features.csv → metadata/NetFlow_v3_Features.csv

@@ -1,54 +1,54 @@
-Feature,Description
-IPV4_SRC_ADDR,IPv4 source address
-IPV4_DST_ADDR,IPv4 destination address
-L4_SRC_PORT,IPv4 source port number
-L4_DST_PORT,IPv4 destination port number
-PROTOCOL,IP protocol identifier byte
-L7_PROTO,Layer 7 protocol (numeric)
-IN_BYTES,Incoming number of bytes
-OUT_BYTES,Outgoing number of bytes
-IN_PKTS,Incoming number of packets
-OUT_PKTS,Outgoing number of packets
-FLOW_DURATION_MILLISECONDS,Flow duration in milliseconds
-TCP_FLAGS,Cumulative of all TCP flags
-CLIENT_TCP_FLAGS,Cumulative of all client TCP flags
-SERVER_TCP_FLAGS,Cumulative of all server TCP flags
-DURATION_IN,Client to Server stream duration (msec)
-DURATION_OUT,Client to Server stream duration (msec)
-MIN_TTL,Min flow TTL
-MAX_TTL,Max flow TTL
-LONGEST_FLOW_PKT,Longest packet (bytes) of the flow
-SHORTEST_FLOW_PKT,Shortest packet (bytes) of the flow
-MIN_IP_PKT_LEN,Len of the smallest flow IP packet observed
-MAX_IP_PKT_LEN,Len of the largest flow IP packet observed
-SRC_TO_DST_SECOND_BYTES,Src to dst Bytes/sec
-DST_TO_SRC_SECOND_BYTES,Dst to src Bytes/sec
-RETRANSMITTED_IN_BYTES,Number of retransmitted TCP flow bytes (src->dst)
-RETRANSMITTED_IN_PKTS,Number of retransmitted TCP flow packets (src->dst)
-RETRANSMITTED_OUT_BYTES,Number of retransmitted TCP flow bytes (dst->src)
-RETRANSMITTED_OUT_PKTS,Number of retransmitted TCP flow packets (dst->src)
-SRC_TO_DST_AVG_THROUGHPUT,Src to dst average thpt (bps)
-DST_TO_SRC_AVG_THROUGHPUT,Dst to src average thpt (bps)
-NUM_PKTS_UP_TO_128_BYTES,Packets whose IP size <= 128
-NUM_PKTS_128_TO_256_BYTES,Packets whose IP size > 128 and <= 256
-NUM_PKTS_256_TO_512_BYTES,Packets whose IP size > 256 and <= 512
-NUM_PKTS_512_TO_1024_BYTES,Packets whose IP size > 512 and <= 1024
-NUM_PKTS_1024_TO_1514_BYTES,Packets whose IP size >��1024 and <= 1514
-TCP_WIN_MAX_IN,Max TCP Window (src->dst)
-TCP_WIN_MAX_OUT,Max TCP Window (dst->src)
-ICMP_TYPE,ICMP Type * 256 + ICMP code
-ICMP_IPV4_TYPE,ICMP Type
-DNS_QUERY_ID,DNS query transaction Id
-DNS_QUERY_TYPE,"DNS query type (e.g. 1=A, 2=NS..)"
-DNS_TTL_ANSWER,TTL of the first A record (if any)
-FTP_COMMAND_RET_CODE,FTP client command return code
-FLOW_START_MILLISECONDS,Flow start timestamp in milliseconds
-FLOW_END_MILLISECONDS,Flow end timestamp in milliseconds
-SRC_TO_DST_IAT_MIN                ,Minimum Inter-Packet Arrval Time (src->dst)
-SRC_TO_DST_IAT_MAX                ,Maximum Inter-Packet Arrval Time (src->dst)
-SRC_TO_DST_IAT_AVG                ,Average Inter-Packet Arrval Time (src->dst)
-SRC_TO_DST_IAT_STDDEV             ,Sandard Deviaion Inter-Packet Arrval Time (src->dst)
-DST_TO_SRC_IAT_MIN                ,Minimum Inter-Packet Arrval Time (dst > src)
-DST_TO_SRC_IAT_MAX                ,Minimum Inter-Packet Arrval Time  (dst > src)
-DST_TO_SRC_IAT_AVG                ,Minimum Inter-Packet Arrval Time  (dst > src)
-DST_TO_SRC_IAT_STDDEV             ,Minimum Inter-Packet Arrval Time  (dst > src)
+Feature,Description
+IPV4_SRC_ADDR,IPv4 source address
+IPV4_DST_ADDR,IPv4 destination address
+L4_SRC_PORT,IPv4 source port number
+L4_DST_PORT,IPv4 destination port number
+PROTOCOL,IP protocol identifier byte
+L7_PROTO,Layer 7 protocol (numeric)
+IN_BYTES,Incoming number of bytes
+OUT_BYTES,Outgoing number of bytes
+IN_PKTS,Incoming number of packets
+OUT_PKTS,Outgoing number of packets
+FLOW_DURATION_MILLISECONDS,Flow duration in milliseconds
+TCP_FLAGS,Cumulative of all TCP flags
+CLIENT_TCP_FLAGS,Cumulative of all client TCP flags
+SERVER_TCP_FLAGS,Cumulative of all server TCP flags
+DURATION_IN,Client to Server stream duration (msec)
+DURATION_OUT,Client to Server stream duration (msec)
+MIN_TTL,Min flow TTL
+MAX_TTL,Max flow TTL
+LONGEST_FLOW_PKT,Longest packet (bytes) of the flow
+SHORTEST_FLOW_PKT,Shortest packet (bytes) of the flow
+MIN_IP_PKT_LEN,Len of the smallest flow IP packet observed
+MAX_IP_PKT_LEN,Len of the largest flow IP packet observed
+SRC_TO_DST_SECOND_BYTES,Src to dst Bytes/sec
+DST_TO_SRC_SECOND_BYTES,Dst to src Bytes/sec
+RETRANSMITTED_IN_BYTES,Number of retransmitted TCP flow bytes (src->dst)
+RETRANSMITTED_IN_PKTS,Number of retransmitted TCP flow packets (src->dst)
+RETRANSMITTED_OUT_BYTES,Number of retransmitted TCP flow bytes (dst->src)
+RETRANSMITTED_OUT_PKTS,Number of retransmitted TCP flow packets (dst->src)
+SRC_TO_DST_AVG_THROUGHPUT,Src to dst average thpt (bps)
+DST_TO_SRC_AVG_THROUGHPUT,Dst to src average thpt (bps)
+NUM_PKTS_UP_TO_128_BYTES,Packets whose IP size <= 128
+NUM_PKTS_128_TO_256_BYTES,Packets whose IP size > 128 and <= 256
+NUM_PKTS_256_TO_512_BYTES,Packets whose IP size > 256 and <= 512
+NUM_PKTS_512_TO_1024_BYTES,Packets whose IP size > 512 and <= 1024
+NUM_PKTS_1024_TO_1514_BYTES,Packets whose IP size >��1024 and <= 1514
+TCP_WIN_MAX_IN,Max TCP Window (src->dst)
+TCP_WIN_MAX_OUT,Max TCP Window (dst->src)
+ICMP_TYPE,ICMP Type * 256 + ICMP code
+ICMP_IPV4_TYPE,ICMP Type
+DNS_QUERY_ID,DNS query transaction Id
+DNS_QUERY_TYPE,"DNS query type (e.g. 1=A, 2=NS..)"
+DNS_TTL_ANSWER,TTL of the first A record (if any)
+FTP_COMMAND_RET_CODE,FTP client command return code
+FLOW_START_MILLISECONDS,Flow start timestamp in milliseconds
+FLOW_END_MILLISECONDS,Flow end timestamp in milliseconds
+SRC_TO_DST_IAT_MIN                ,Minimum Inter-Packet Arrval Time (src->dst)
+SRC_TO_DST_IAT_MAX                ,Maximum Inter-Packet Arrval Time (src->dst)
+SRC_TO_DST_IAT_AVG                ,Average Inter-Packet Arrval Time (src->dst)
+SRC_TO_DST_IAT_STDDEV             ,Sandard Deviaion Inter-Packet Arrval Time (src->dst)
+DST_TO_SRC_IAT_MIN                ,Minimum Inter-Packet Arrval Time (dst > src)
+DST_TO_SRC_IAT_MAX                ,Minimum Inter-Packet Arrval Time  (dst > src)
+DST_TO_SRC_IAT_AVG                ,Minimum Inter-Packet Arrval Time  (dst > src)
+DST_TO_SRC_IAT_STDDEV             ,Minimum Inter-Packet Arrval Time  (dst > src)