API reference#

Every public name lives in one of the modules below, reached through its subpackage; the subpackages and the top-level cultivars namespace hold modules only and re-export nothing. Names beginning with an underscore, and the _core and _internals packages, are implementation detail and may change between releases without notice.

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.data

Data access: the clients that bring series into the package, re-exported.

cultivars.summary

The reporting surface: the records every fitted result renders itself through.

cultivars.experimental

Recent models that are not yet packaged anywhere, under a looser contract.

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.

cultivars.exceptions

Public exception and warning hierarchy for cultivars.

cultivars.typing

Public type aliases for the categorical options a specification takes.