API Reference#

Welcome to the API reference for predctiably.

The API reference provides a technical manual, describing the class and function interface provided by the package. See the User Guide for additional details.

predictably provides a unified time series forecasting interface.

Predictable, well-documented interfaces so you can predict ably.

Configure predictably#

predictably provides a unified time series forecasting interface.

Predictable, well-documented interfaces so you can predict ably.

get_config()

Retrieve current values for configuration set by set_config.

get_default_config()

Retrieve the default global configuration.

set_config(*[, dataframe_backend, ...])

Set global configuration.

reset_config()

Reset the global configuration to the default.

config_context(*[, dataframe_backend, ...])

Context manager for global configuration.

Object Validation and Comparison#

check_sequence(input_seq[, sequence_type, ...])

Check whether an object is a sequence with optional check of element types.

check_sequence_named_objects()

Check if input is a sequence of named BaseObject instances.

check_type(input_, expected_type[, ...])

Check the input is the expected type.

is_sequence(input_seq[, sequence_type, ...])

Indicate if an object is a sequence with optional check of element types.

is_sequence_named_objects(seq_to_check[, ...])

Indicate if input is a sequence of named BaseObject instances.

Utils#

predictably.utils includes utility functionality used through predictably.

This module includes general utilities. Statistical utilities will be kept in predictably.stats.utils.