API Documentation

Full API documentation of the convst Python package.

convst.classifiers: Classification algorithms

This module contains sklearn compatible transformers.

classifiers.R_DST_Ridge	A wrapper class which use R_DST as a transformer, followed by a Ridge Classifier.
classifiers.R_DST_Ensemble	Parameters:

convst.transformers: Transformation algorithms

This module contains sklearn compatible transformers.

transformers.R_DST

Base class for RDST transformer.

convst.interpreters: Interpretation tools

This module offers different interpreters for RDST classifiers and transformers.

interpreters.RDST_Ridge_interpreter	Interpreter for RDST Ridge models.
interpreters.RDST_interpreter	A class to interpret the result from a fitted RDST instance.

convst.utils: Utilities

This package contains utility functions such as data loading or format check functions.

utils.experiments_utils.cross_validate_UCR_UEA
utils.checks_utils.check_array_3D	Perform checks on the input to verify if it is a 3D array.
utils.checks_utils.check_array_2D	Perform checks on the input to verify if it is a 2D array.
utils.checks_utils.check_array_1D	Perform checks on the input to verify if it is a 1D array.
utils.checks_utils.check_is_numpy_or_pd	Check if the input is a numpy array or a pandas DataFrame, else raise an error
utils.checks_utils.check_is_numpy	Check if the input is a numpy array, else raise an error
utils.dataset_utils.return_all_dataset_names