Skip to content

Commit 15f1224

Browse files
committed
docs: replace pip install with uv add in README
1 parent e46df91 commit 15f1224

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ GLMs have been the industry standard for decades. They're interpretable, well-un
1616
## Quick Start
1717

1818
```bash
19-
pip install "insurance-gam[ebm]"
19+
uv add "insurance-gam[ebm]"
2020
```
2121

2222
> 💬 Questions or feedback? Start a [Discussion](https://github.com/burning-cost/insurance-gam/discussions). Found it useful? A ⭐ helps others find it.
@@ -64,7 +64,7 @@ print(rt.summary())
6464

6565
Wraps [interpretML's](https://github.com/interpretml/interpret) `ExplainableBoostingRegressor` with insurance-specific tooling: exposure-aware fit/predict, relativity table extraction, post-fit monotonicity enforcement, and GLM comparison tools. If you want the interpretability of a GLM with the predictive power of a gradient booster, start here.
6666

67-
Requires the `[ebm]` extra: `pip install "insurance-gam[ebm]"`
67+
Requires the `[ebm]` extra: `uv add "insurance-gam[ebm]"`
6868

6969
```python
7070
import numpy as np
@@ -107,7 +107,7 @@ print(rt.summary())
107107

108108
Neural Additive Model (Laub, Pho, Wong 2025) adapted for insurance. One MLP subnetwork per feature, additive aggregation, Poisson/Tweedie/Gamma losses, and Dykstra-projected monotonicity constraints. Beats GLMs on deviance metrics while producing per-feature shape functions that a pricing team can actually inspect.
109109

110-
Requires the `[neural]` extra: `pip install "insurance-gam[neural]"`
110+
Requires the `[neural]` extra: `uv add "insurance-gam[neural]"`
111111

112112
```python
113113
import numpy as np
@@ -146,7 +146,7 @@ shapes["vehicle_age"].plot()
146146

147147
Neural GA2M (Richman, Scognamiglio, Wüthrich 2025). The prediction decomposes as a sum of pairwise interaction terms — one shared network serving all feature pairs, differentiated by learned interaction tokens. Diagonal terms recover main effects. Captures interactions a GLM would miss while keeping the output interpretable as a sum of 2D shape functions.
148148

149-
Requires the `[neural]` extra: `pip install "insurance-gam[neural]"`
149+
Requires the `[neural]` extra: `uv add "insurance-gam[neural]"`
150150

151151
```python
152152
import numpy as np
@@ -187,25 +187,25 @@ effects = model.main_effects(df)
187187
## Installation
188188

189189
```bash
190-
pip install insurance-gam
190+
uv add insurance-gam
191191
```
192192

193193
With neural subpackages (requires PyTorch):
194194

195195
```bash
196-
pip install "insurance-gam[neural]"
196+
uv add "insurance-gam[neural]"
197197
```
198198

199199
With EBM subpackage (requires interpretML):
200200

201201
```bash
202-
pip install "insurance-gam[ebm]"
202+
uv add "insurance-gam[ebm]"
203203
```
204204

205205
Everything:
206206

207207
```bash
208-
pip install "insurance-gam[all]"
208+
uv add "insurance-gam[all]"
209209
```
210210

211211
## Design rationale

0 commit comments

Comments
 (0)