prospicio_models/lib.rs
1//! The model interface and its life cycle, shared by every engine (GLM,
2//! GAM, neural networks, boosting adapters, Bayesian models). See
3//! `docs/design/models.md`.
4//!
5//! - [`Family`] and [`Link`]: exponential dispersion families and link
6//! functions, the likelihoods and losses engines share;
7//! - [`Terms`], [`Coding`] and [`Design`]: model terms, factor coding
8//! learned on training data, and the design matrix with offset and
9//! weights;
10//! - [`Model`] and [`Fitted`]: fit, predict, and joint predictive
11//! distributions;
12//! - [`metrics`]: deviance, Gini, lift, CRPS, coverage;
13//! - [`resample`]: k-fold, grouped and time-ordered splits,
14//! cross-validation and grid search;
15//! - [`simulate`]: predictive distributions from fitted means, for engines
16//! that give only a mean per row (the boosting adapters).
17//!
18//! This crate has no heavy dependencies; engines live in their own crates.
19
20pub mod compare;
21pub mod design;
22pub mod family;
23pub mod link;
24pub mod metrics;
25pub mod model;
26pub mod monitor;
27pub mod resample;
28pub mod simulate;
29pub mod stack;
30
31pub use design::{Coding, Column, Design, Frame, Term, Terms};
32pub use family::Family;
33pub use link::Link;
34pub use model::{Fitted, Model};