pradeep-xpert commited on
Commit
df49526
·
verified ·
1 Parent(s): 6d7c5d8

Add link to trained baseline classifier

Browse files
Files changed (1) hide show
  1. README.md +27 -0
README.md CHANGED
@@ -25,6 +25,11 @@ Dataset** product. It contains roughly **1 / 60th of the full dataset** at
25
  identical schema, label distribution, and statistical fingerprint, so you can
26
  evaluate fit before licensing the full product.
27
 
 
 
 
 
 
28
  | File | Rows (sample) | Rows (full) | Description |
29
  |-------------------------|---------------|---------------|--------------------------------------------|
30
  | `network_topology.csv` | ~200 | ~3,200 | Network segments and defender configs |
@@ -48,6 +53,24 @@ management plane, zero-trust, guest Wi-Fi, data centre spine), with:
48
 
49
  All IP addresses are SHA-256 pseudonyms (`IP_<12 hex>`) — no real network data.
50
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
51
  ## Calibrated Benchmark Targets
52
 
53
  The full product is calibrated to 12 benchmark metrics; the sample preserves
@@ -133,6 +156,10 @@ flows_enriched = flows.merge(topology, on="segment_id", how="left")
133
  y = (flows["label"] == "MALICIOUS").astype(int)
134
  ```
135
 
 
 
 
 
136
  ## License
137
 
138
  This **sample** is released under **CC-BY-NC-4.0** (free for non-commercial
 
25
  identical schema, label distribution, and statistical fingerprint, so you can
26
  evaluate fit before licensing the full product.
27
 
28
+ > 🤖 **Trained baseline available:**
29
+ > [**xpertsystems/cyb001-baseline-classifier**](https://huggingface.co/xpertsystems/cyb001-baseline-classifier)
30
+ > — XGBoost + PyTorch MLP, copy-paste inference notebook, full metrics and
31
+ > honest limitations in the model card.
32
+
33
  | File | Rows (sample) | Rows (full) | Description |
34
  |-------------------------|---------------|---------------|--------------------------------------------|
35
  | `network_topology.csv` | ~200 | ~3,200 | Network segments and defender configs |
 
53
 
54
  All IP addresses are SHA-256 pseudonyms (`IP_<12 hex>`) — no real network data.
55
 
56
+ ## Trained Baseline Available
57
+
58
+ A working baseline classifier trained on this sample is published at
59
+ **[xpertsystems/cyb001-baseline-classifier](https://huggingface.co/xpertsystems/cyb001-baseline-classifier)**.
60
+
61
+ | Component | Detail |
62
+ |---|---|
63
+ | Task | 3-class flow classification (`BENIGN` / `MALICIOUS` / `AMBIGUOUS`) |
64
+ | Models | XGBoost (`model_xgb.json`) + PyTorch MLP (`model_mlp.safetensors`) |
65
+ | Features | 101 (after one-hot encoding); pipeline included as `feature_engineering.py` |
66
+ | Demo | `inference_example.ipynb` — end-to-end copy-paste |
67
+ | Headline metrics | XGBoost test accuracy 0.998, macro-F1 0.996 — synthetic; see model card for limitations |
68
+
69
+ This is a reference baseline, not a production IDS. The model card documents
70
+ the calibrated signals it picks up, an ablation showing the model is not
71
+ session-dominated, and six explicit limitations including the gap between
72
+ synthetic and real-world traffic.
73
+
74
  ## Calibrated Benchmark Targets
75
 
76
  The full product is calibrated to 12 benchmark metrics; the sample preserves
 
156
  y = (flows["label"] == "MALICIOUS").astype(int)
157
  ```
158
 
159
+ For a worked end-to-end example including the 3-class classification target,
160
+ feature engineering, and predictions, see the inference notebook in the
161
+ [baseline classifier repo](https://huggingface.co/xpertsystems/cyb001-baseline-classifier/blob/main/inference_example.ipynb).
162
+
163
  ## License
164
 
165
  This **sample** is released under **CC-BY-NC-4.0** (free for non-commercial