API Reference¶

Full auto-generated API documentation from source code docstrings.

Core¶

Module	Description
`Estimators`	`FlagGAMClassifier` / `FlagGAMRegressor` — the sklearn-compatible entry points
`Core`	Rule discovery and `Z(X)` basis-matrix construction
`Screening`	UFA screening statistics used to select candidate rules
`Bases`	Basis objects — one column of `Z(X)` each, with screening metadata
`Missing`	Missing-indicator discovery
`Heads`	Prediction heads (additive / flexible) fit on `Z(X)`
`Weighting`	Feature-weight statistics and the compact score representation
`Inspection`	Rule export (`export_rules`) and per-row reason codes (`explain`)

Original additions beyond Zhao & Welsch (2026); see Extensions.

Module	Description
`Calibration`	PD calibration diagnostics and recalibration
`Monotonic`	Exact monotonicity constraints for the additive head
`Fairness`	Group metrics and rule-level proxy audit

Module	Description
`Datasets`	Benchmark dataset loaders with local caching
`Plots`	Matplotlib visualization helpers (optional `viz` extra)
`Explorer`	Self-contained interactive HTML rules explorer