vkatg commited on
Commit
88e9efb
·
verified ·
1 Parent(s): dc16344

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -18
README.md CHANGED
@@ -1,4 +1,4 @@
1
-
2
  license: mit
3
  language:
4
  - en
@@ -33,6 +33,40 @@ It is useful for:
33
  - Evaluating privacy-utility tradeoffs in streaming systems
34
  - Reproducing results from the associated research implementation
35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
  ## Dataset structure
37
 
38
  The primary file is `audit_log.jsonl`. Each line is one masking decision for one event.
@@ -74,18 +108,6 @@ Five masking policies are included for comparison:
74
  - `redact` — full redaction
75
  - `adaptive` — risk-governed dynamic policy selection
76
 
77
- ## Policy benchmark results
78
-
79
- | Policy | Leak Total | Utility Proxy | Mean Latency (ms) | P90 Latency (ms) |
80
- | --- | --- | --- | --- | --- |
81
- | raw | 3.03 | 1.0 | 0.123 | 0.154 |
82
- | weak | 2.0 | 0.51 | 0.141 | 0.18 |
83
- | pseudo | 0.51 | 1.0 | 0.159 | 0.188 |
84
- | redact | 0.51 | 0.51 | 0.157 | 0.192 |
85
- | adaptive | 0.56 | 1.0 | 1.16 | 1.237 |
86
-
87
- The adaptive policy achieves full utility while keeping leakage close to the redact floor — without the utility collapse that full redaction causes.
88
-
89
  ## Additional files
90
 
91
  | File | Description |
@@ -93,20 +115,21 @@ The adaptive policy achieves full utility while keeping leakage close to the red
93
  | `policy_metrics.csv` | Aggregated per-policy evaluation metrics |
94
  | `latency_summary.csv` | Latency distribution per policy |
95
  | `audit_log_signed_adaptive.jsonl` | Cryptographically signed adaptive policy audit trail |
96
- | `audit_fhir_adaptive.jsonl` | FHIR-structured audit events for the adaptive policy |
97
- | `dcpg_snapshot.json` | Final exposure graph state snapshot |
98
- | `rl_reward_stats.json` | RL reward statistics from the adaptive controller |
99
- | `sample_dag.json` | Sample dependency graph structure |
100
 
101
  ## Source code and reproduction
102
 
103
  All data in this dataset was generated by the open-source research implementation:
104
 
105
- GitHub: [azithteja91/amphi_rl_dpgraph](https://github.com/azithteja91/amphi_rl_dpgraph)
 
 
106
 
107
  To regenerate:
108
 
109
  ```bash
 
 
110
  pip install -e .
111
  python -m amphi_rl_dpgraph.run_demo
112
  ```
 
1
+ ---
2
  license: mit
3
  language:
4
  - en
 
33
  - Evaluating privacy-utility tradeoffs in streaming systems
34
  - Reproducing results from the associated research implementation
35
 
36
+ ## Quick start
37
+
38
+ # Install the package first
39
+ pip install phi-exposure-guard
40
+
41
+ import pandas as pd
42
+ import json
43
+
44
+ # Load policy benchmark results
45
+ df = pd.read_csv("policy_metrics.csv")
46
+ print(df)
47
+
48
+ # Load full audit log
49
+ with open("audit_log.jsonl") as f:
50
+ events = [json.loads(line) for line in f]
51
+
52
+ # Example: filter adaptive policy events
53
+ adaptive = [e for e in events if e["policy_run"] == "adaptive"]
54
+ ## Privacy-Utility Tradeoff
55
+
56
+ ![Privacy-Utility Tradeoff](privacy_utility_curve.png)
57
+
58
+ The adaptive policy achieves full utility while keeping leakage close to the redact floor. It only escalates masking strength when cumulative exposure actually justifies it, not on every record by default.
59
+
60
+ ## Policy benchmark results
61
+
62
+ | Policy | Leak Total | Utility Proxy | Mean Latency (ms) | P90 Latency (ms) |
63
+ | --- | --- | --- | --- | --- |
64
+ | raw | 3.03 | 1.0 | 0.123 | 0.154 |
65
+ | weak | 2.0 | 0.51 | 0.141 | 0.18 |
66
+ | pseudo | 0.51 | 1.0 | 0.159 | 0.188 |
67
+ | redact | 0.51 | 0.51 | 0.157 | 0.192 |
68
+ | adaptive | 0.56 | 1.0 | 1.16 | 1.237 |
69
+
70
  ## Dataset structure
71
 
72
  The primary file is `audit_log.jsonl`. Each line is one masking decision for one event.
 
108
  - `redact` — full redaction
109
  - `adaptive` — risk-governed dynamic policy selection
110
 
 
 
 
 
 
 
 
 
 
 
 
 
111
  ## Additional files
112
 
113
  | File | Description |
 
115
  | `policy_metrics.csv` | Aggregated per-policy evaluation metrics |
116
  | `latency_summary.csv` | Latency distribution per policy |
117
  | `audit_log_signed_adaptive.jsonl` | Cryptographically signed adaptive policy audit trail |
118
+ | `EXPERIMENT_REPORT.md` | Full experiment report with leakage breakdown by modality |
 
 
 
119
 
120
  ## Source code and reproduction
121
 
122
  All data in this dataset was generated by the open-source research implementation:
123
 
124
+ GitHub: [azithteja91/phi-exposure-guard](https://github.com/azithteja91/phi-exposure-guard)
125
+
126
+ Hugging Face Space: [vkatg/amphi-rl-dpgraph](https://huggingface.co/spaces/vkatg/amphi-rl-dpgraph)
127
 
128
  To regenerate:
129
 
130
  ```bash
131
+ git clone https://github.com/azithteja91/phi-exposure-guard.git
132
+ cd phi-exposure-guard
133
  pip install -e .
134
  python -m amphi_rl_dpgraph.run_demo
135
  ```