Engine reference#

The layers behind the public API, for contributors. _core holds the pure numerics, validators, converters, and defaults; _internals the model bases, fits, mixins, priors, records, and solvers the public classes delegate to. The public modules appear a second time below with each class’s own private members, the ones it defines itself rather than inherits; inherited private members are on the page of the base that defines them. Everything on these pages may change between releases without notice.

Private layers#

cultivars.engine._core

Primitive layer: constants, value objects, contracts, and pure functions.

cultivars.engine._internals

Public surface, private members#

cultivars.univariate

Univariate models: one series, its mean, its variance, and its components.

cultivars.multivariate

Multivariate time series: one closed-system contract, five families on it.

cultivars.state_space

State-space substrates: linear-Gaussian, nonlinear, and regime-switching.

cultivars.bayes

Bayesian workflow for the package's samplers: priors, chains, checks, evidence, combination.

cultivars.diagnostics

Diagnostics: what a series is before a model is fitted, and what a fit left behind.

cultivars.forecast

Forecast evaluation: scoring, comparison, and calibration of densities.

cultivars.spectral

Frequency-domain views of fitted systems and data, filters, cycle dating, and wavelets.