Skip to content

Commit 3c65733

Browse files
committed
Update README: add cross-links, fix module list formatting
1 parent ac19bb8 commit 3c65733

1 file changed

Lines changed: 17 additions & 15 deletions

File tree

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,16 @@
55
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
66
[![Linkedin Badge](https://img.shields.io/badge/-LinkedIn-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/voiculaura/)](https://www.linkedin.com/in/voiculaura/)
77

8-
98
# Decision Security
109

1110
Reusable **decision-science utilities for security** — Monte Carlo risk bands, Bayesian updates & calibration, survival helpers, Value of Information, light causal helpers, and visualization.
1211

12+
Part of [Apropos Security](https://apropos-security.com) · [Notebooks](https://security-decision-science.github.io/security-decision-science/) · [Playground](https://github.com/security-decision-science/security-decision-labs) · [Blog](https://medium.com/apropos-security)
13+
1314
## Install
14-
Pre-release for now:
15+
1516
```bash
1617
pip install --pre decision-security
17-
# or pin:
18-
# pip install decision-security==0.1.0a9
1918
```
2019

2120
## Quickstart
@@ -31,22 +30,25 @@ print(var_es(losses)) # (VaR95, ES95)
3130
```
3231

3332
## Modules
34-
• synth: synthetic data (heavy-tail losses, counts, mixtures, survival with censoring, categorical/Dirichlet).
35-
• montecarlo: Poisson frequency + severity, risk bands, VaR/ES.
36-
• bayes: Beta-Binomial & Normal(known σ) updates, calibration helpers.
37-
• survival: simple Kaplan–Meier & Nelson–Aalen estimates.
38-
• voi: Expected Value of Perfect Information (EVPI) and simple ROI selection.
39-
• causal: tiny DAG utilities (parents, descendants, naive backdoor set).
40-
• viz: small matplotlib helpers (loss distribution, risk bands, KM curves).
33+
34+
- **synth** — synthetic data (heavy-tail losses, counts, mixtures, survival with censoring, categorical/Dirichlet)
35+
- **montecarlo** — Poisson frequency + severity, risk bands, VaR/ES
36+
- **bayes** — Beta-Binomial & Normal(known σ) updates, calibration helpers
37+
- **survival** — simple Kaplan-Meier & Nelson-Aalen estimates
38+
- **voi** — Expected Value of Perfect Information (EVPI) and simple ROI selection
39+
- **causal** — tiny DAG utilities (parents, descendants, naive backdoor set)
40+
- **viz** — small matplotlib helpers (loss distribution, risk bands, KM curves)
4141

4242
## Status
4343

44-
0.x (APIs may change).
44+
0.x pre-release (APIs may change).
4545

46-
## Docs & examples
46+
## Docs & examples
4747

48-
Security Decision Science Book and the Security Decision Labs playground (coming soon).
48+
- **Notebooks:** [Security Decision Science](https://security-decision-science.github.io/security-decision-science/) — 19 interactive notebooks using this library
49+
- **Playground:** [Security Decision Labs](https://github.com/security-decision-science/security-decision-labs) — FAIR Simulator app
50+
- **Hub:** [apropos-security.com](https://apropos-security.com)
4951

5052
## Contributing
5153

52-
Issues and PRs welcome. For non-public questions, contact me on LinkedIn.
54+
Issues and PRs welcome. For non-public questions, contact via [LinkedIn](https://www.linkedin.com/in/voiculaura/).

0 commit comments

Comments
 (0)