THUgewu commited on
Commit
d8bbcb3
·
verified ·
1 Parent(s): 0e56632

Add TsFile (converted from DeepTempo/cic-ids-2017-flowprep)

Browse files
Files changed (3) hide show
  1. .gitattributes +1 -0
  2. README.md +136 -0
  3. cic_ids_2017_flowprep.tsfile +3 -0
.gitattributes CHANGED
@@ -58,3 +58,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
58
  # Video files - compressed
59
  *.mp4 filter=lfs diff=lfs merge=lfs -text
60
  *.webm filter=lfs diff=lfs merge=lfs -text
 
 
58
  # Video files - compressed
59
  *.mp4 filter=lfs diff=lfs merge=lfs -text
60
  *.webm filter=lfs diff=lfs merge=lfs -text
61
+ cic_ids_2017_flowprep.tsfile filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,136 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ license_name: cic-ids-2017-research-use
4
+ license_link: https://www.unb.ca/cic/datasets/ids-2017.html
5
+ task_categories:
6
+ - tabular-classification
7
+ language:
8
+ - en
9
+ tags:
10
+ - tsfile
11
+ - time-series
12
+ - network-security
13
+ - cybersecurity
14
+ - netflow
15
+ - flow
16
+ - intrusion-detection
17
+ - nids
18
+ - canonical-schema
19
+ - flowprep
20
+ - deeptempo
21
+ pretty_name: CIC-IDS-2017 Canonical NetFlow Flowprep TsFile
22
+ size_categories:
23
+ - 100K<n<1M
24
+ modality: timeseries
25
+ configs:
26
+ - config_name: default
27
+ data_files:
28
+ - split: train
29
+ path: cic_ids_2017_flowprep.tsfile
30
+ ---
31
+
32
+ # CIC-IDS-2017 Canonical NetFlow Flowprep (TsFile)
33
+
34
+ This repository contains an Apache TsFile conversion of
35
+ [`DeepTempo/cic-ids-2017-flowprep`](https://huggingface.co/datasets/DeepTempo/cic-ids-2017-flowprep),
36
+ a small CIC-IDS-2017 demonstration slice canonicalized by DeepTempo's
37
+ `flowprep` tool into a typed NetFlow schema.
38
+
39
+ Modalities: Time-series.
40
+
41
+ ## Source Dataset
42
+
43
+ - **Original dataset:** [`DeepTempo/cic-ids-2017-flowprep`](https://huggingface.co/datasets/DeepTempo/cic-ids-2017-flowprep)
44
+ - **Source artifact:** `data/cic-ids-2017-canonical.parquet`
45
+ - **Rows:** 101,094 flows
46
+ - **Columns:** 13 source columns
47
+ - **Task:** binary intrusion-detection / tabular classification
48
+ - **Source format:** ZSTD-compressed Parquet, single row group
49
+ - **Source timestamp encoding:** int64 epoch microseconds
50
+ - **Source license metadata:** `other`, `cic-ids-2017-research-use`
51
+ - **License link:** https://www.unb.ca/cic/datasets/ids-2017.html
52
+
53
+ The source dataset is a clean canonical NetFlow table produced by `flowprep`
54
+ from a CIC-IDS-2017 sample. It is a demonstration slice, not the full
55
+ CIC-IDS-2017 dataset. For research use, refer to the official UNB CIC dataset
56
+ page and cite the original CIC-IDS-2017 paper.
57
+
58
+ ## Converted Data
59
+
60
+ - **TsFile path:** `cic_ids_2017_flowprep.tsfile`
61
+ - **TsFile table:** `cic_ids_2017_flowprep`
62
+ - **Rows:** 101,094
63
+ - **Converted columns:** 14 including `Time` and generated `event_rank`
64
+ - **Device/TAG groups:** 1,780
65
+ - **Time precision:** microseconds
66
+ - **Time range:** 2017-03-07 01:00:01 UTC to 2017-07-07 12:59:00 UTC
67
+ - **Class balance:** 81,171 benign / 19,923 attack
68
+
69
+ ## TsFile Schema
70
+
71
+ `timestamp` is converted to the TsFile `Time` column as epoch microseconds and
72
+ is not retained as a duplicate FIELD.
73
+
74
+ TAG columns:
75
+
76
+ - `attack`
77
+ - `label`
78
+ - `event_rank`
79
+
80
+ FIELD columns:
81
+
82
+ - `src_ip`
83
+ - `dest_ip`
84
+ - `src_port`
85
+ - `dest_port`
86
+ - `fwd_bytes`
87
+ - `bwd_bytes`
88
+ - `fwd_pkts`
89
+ - `bwd_pkts`
90
+ - `flow_dur`
91
+ - `protocol`
92
+
93
+ `protocol` is null for all rows in this source slice and is preserved as a
94
+ nullable numeric FIELD for canonical-schema fidelity.
95
+
96
+ ## Conversion Notes
97
+
98
+ This is a network-flow event table. High-cardinality endpoint columns such as
99
+ `src_ip`, `dest_ip`, `src_port`, and `dest_port` are kept as FIELD columns rather
100
+ than TAG/device keys. The low-cardinality ground-truth columns `attack` and
101
+ `label` are TAGs for efficient filtering.
102
+
103
+ `event_rank` is a generated TAG that preserves all concurrent flows without
104
+ modifying `Time`. It is the duplicate order within `(attack, label, Time)`.
105
+ In this source snapshot, `event_rank` ranges from 0 to 1,587 and 88,916 rows
106
+ have a nonzero rank. The final `(attack, label, event_rank, Time)` key has no
107
+ duplicates.
108
+
109
+ No source rows are dropped. The source `timestamp` column is represented by
110
+ TsFile `Time`; all other source columns are represented either as TAG or FIELD
111
+ columns.
112
+
113
+ ## Minimal Read Example
114
+
115
+ Read the `.tsfile` file with the Apache TsFile Java or Python SDK.
116
+
117
+ Example logical filter:
118
+
119
+ ```sql
120
+ SELECT *
121
+ FROM cic_ids_2017_flowprep
122
+ WHERE attack = 'attack'
123
+ ```
124
+
125
+ ## Citation
126
+
127
+ If you use the data, cite the original CIC-IDS-2017 paper:
128
+
129
+ ```bibtex
130
+ @inproceedings{sharafaldin2018toward,
131
+ title = {Toward Generating a New Intrusion Detection Dataset and Intrusion Traffic Characterization},
132
+ author = {Sharafaldin, Iman and Lashkari, Arash Habibi and Ghorbani, Ali A.},
133
+ booktitle = {Proceedings of the 4th International Conference on Information Systems Security and Privacy (ICISSP)},
134
+ year = {2018}
135
+ }
136
+ ```
cic_ids_2017_flowprep.tsfile ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:fe490f3be77ef5fe799442ec553503bd5e40d3a131cc2dcb8bad41a0a080023e
3
+ size 5102054