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//! - [`artifact`]: the envelope of saved models (format, version,
16//! provenance) and its JSON helpers;
17//! - [`simulate`]: predictive distributions from fitted means, for engines
18//! that give only a mean per row (the boosting adapters).
19//!
20//! This crate has no heavy dependencies; engines live in their own crates.
21
22pub mod artifact;
23pub mod compare;
24pub mod design;
25pub mod encode;
26pub mod family;
27pub mod link;
28pub mod metrics;
29pub mod model;
30pub mod monitor;
31pub mod resample;
32pub mod simulate;
33pub mod stack;
34
35pub use design::{Coding, Column, Design, Frame, Term, Terms};
36pub use family::Family;
37pub use link::Link;
38pub use model::{Fitted, Model};