.. _api:

=================
API Documentation
=================

Full API documentation of the *convst* Python package.

:mod:`convst.classifiers`: Classification algorithms
====================================================

.. automodule:: convst.transformers
    :no-members:
    :no-inherited-members:

.. currentmodule:: convst

.. autosummary::
   :nosignatures:
   :toctree: generated/
   :template: class.rst

   classifiers.R_DST_Ridge
   classifiers.R_DST_Ensemble


:mod:`convst.transformers`: Transformation algorithms
=====================================================

.. automodule:: convst.transformers
    :no-members:
    :no-inherited-members:

.. currentmodule:: convst

.. autosummary::
   :nosignatures:
   :toctree: generated/
   :template: class.rst

   transformers.R_DST
   
:mod:`convst.interpreters`: Interpretation tools
================================================

.. automodule:: convst.interpreters
    :no-members:
    :no-inherited-members:

.. currentmodule:: convst

.. autosummary::
   :nosignatures:
   :toctree: generated/
   :template: class.rst

   interpreters.RDST_Ridge_interpreter
   interpreters.RDST_interpreter

:mod:`convst.utils`: Utilities
==============================

.. automodule:: convst.utils
   :no-members:
   :no-inherited-members:

.. currentmodule:: convst

.. autosummary::
  :nosignatures:
  :toctree: generated/
  :template: class.rst
  
  utils.experiments_utils.cross_validate_UCR_UEA
  utils.experiments_utils.ARFF_stratified_resample
  
  :template: function.rst

  utils.checks_utils.check_array_3D
  utils.checks_utils.check_array_2D
  utils.checks_utils.check_array_1D
  utils.checks_utils.check_is_numpy_or_pd
  utils.checks_utils.check_is_numpy
  utils.dataset_utils.load_sktime_dataset_split
  utils.dataset_utils.load_sktime_dataset
  utils.dataset_utils.load_sktime_arff_file_resample_id
  utils.dataset_utils.load_sktime_arff_file
  utils.dataset_utils.return_all_dataset_names
  utils.dataset_utils.load_sktime_ts_file