Skip to content

Commit c7ad21c

Browse files
committed
docs(readme): add mermaid architecture diagram
1 parent 602ef24 commit c7ad21c

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# A/B Testing Framework
22

3+
4+
## Architecture
5+
6+
```mermaid
7+
flowchart LR
8+
DESIGN["src/01_design.py<br/>Power analysis · sample size"] --> SPEC["outputs/01_design_summary.txt"]
9+
DESIGN --> SIM["src/02_simulate.py<br/>60k users, 2 arms"]
10+
SIM --> DATA["data/experiment.parquet"]
11+
DATA --> VAL["src/03_validity_checks.py<br/>SRM (chi²) · AA test"]
12+
DATA --> ANA["src/04_analyze.py<br/>Welch t · Bootstrap · CUPED · BH"]
13+
VAL --> REPORT["stdout — pass/fail"]
14+
ANA --> DOC["outputs/DECISION_DOC.md<br/>(auto-generated ship/no-ship memo)"]
15+
ANA --> CHARTS["outputs/02_results.png<br/>outputs/03_cuped_comparison.png"]
16+
17+
subgraph STATS["src/stats.py — reusable lib"]
18+
Z["two-proportion z"]
19+
T["Welch t"]
20+
B["bootstrap CI"]
21+
C["CUPED"]
22+
S["SRM chi²"]
23+
end
24+
STATS -.-> VAL
25+
STATS -.-> ANA
26+
```
27+
328
> 🌐 **Live walkthrough:** https://ucazin.github.io/ab-testing-framework/
429
530
A working framework for designing, analyzing, and **deciding on** A/B experiments — the kind every product analyst gets handed in their first week. Built around a realistic synthetic experiment ("we changed the checkout button color and want to know if conversion went up"), but the toolkit is dataset-agnostic.

0 commit comments

Comments
 (0)