kats.models.model module¶

class kats.models.model.Model(data: Optional[kats.consts.TimeSeriesData], params: kats.models.model.ParamsType, validate_frequency: bool = False, validate_dimension: bool = False)[source]¶

Bases: Generic[kats.models.model.ParamsType]

fit()[source]¶

abstract method to fit model

This is a declaration for model fitting

static get_parameter_search_space()[source]¶

method to query default parameter search space

abstract method to be implemented by downstream forecasting models

static plot(data: kats.consts.TimeSeriesData, fcst: pandas.core.frame.DataFrame, include_history=False) → None[source]¶

plot method for forecasting models

This method provides the plotting functionality for all forecasting models.

Parameters

  • data – TimeSeriesData, the historical time series data set

  • fcst – forecasted results from forecasting models

  • include_history – if True, include the historical data when plotting.

predict(*_args, **_kwargs)[source]¶

abstract method to predict

This is a declaration for predict method

setup_data()[source]¶

abstract method to set up dataset

This is a declaration for setup data method

validate_inputs()[source]¶

abstract method to validate the inputs

This is a declaration for validate_inputs method