.. _api_ref:

=============
API Reference
=============

This is the class and function reference of destructive-deep-learning (ddl).

:mod:`ddl.autoregressive`
=========================

.. automodule:: ddl.autoregressive
    :no-members:
    :no-inherited-members:

.. _ddl_autoregressive_ref:

Autoregressive classes
----------------------

.. currentmodule:: ddl

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

    autoregressive.AutoregressiveDestructor (ddl.autoregressive)

:mod:`ddl.base`
===============

.. automodule:: ddl.base
    :no-members:
    :no-inherited-members:

.. _ddl_base_ref:

Base classes
------------

.. currentmodule:: ddl

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

    base.BaseDensityDestructor (ddl.base)
    base.BoundaryWarning (ddl.base)
    base.CompositeDestructor (ddl.base)
    base.DestructorMixin (ddl.base)
    base.IdentityDestructor (ddl.base)
    base.ScoreMixin (ddl.base)
    base.UniformDensity (ddl.base)

Base functions
--------------

.. currentmodule:: ddl

.. autosummary::
    :toctree: ../generated
    :template: function.rst

    base.create_implicit_density (ddl.base)
    base.create_inverse_canonical_destructor (ddl.base)
    base.create_inverse_transformer (ddl.base)
    base.get_implicit_density (ddl.base)
    base.get_inverse_canonical_destructor (ddl.base)
    base.get_n_features (ddl.base)

:mod:`ddl.datasets`
===================

.. automodule:: ddl.datasets
    :no-members:
    :no-inherited-members:

.. _ddl_datasets_ref:

Datasets functions
------------------

.. currentmodule:: ddl

.. autosummary::
    :toctree: ../generated
    :template: function.rst

    datasets.make_toy_data (ddl.datasets)

:mod:`ddl.deep`
===============

.. automodule:: ddl.deep
    :no-members:
    :no-inherited-members:

.. _ddl_deep_ref:

Deep classes
------------

.. currentmodule:: ddl

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

    deep.DeepDestructor (ddl.deep)
    deep.DeepDestructorCV (ddl.deep)

:mod:`ddl.externals`
====================

.. automodule:: ddl.externals
    :no-members:
    :no-inherited-members:

.. _ddl_externals_ref:

:mod:`ddl.externals.mlpack`
===========================

.. automodule:: ddl.externals.mlpack
    :no-members:
    :no-inherited-members:

.. _ddl_externals_mlpack_ref:

Mlpack classes
--------------

.. currentmodule:: ddl.externals

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

    mlpack.MlpackDensityTreeEstimator (ddl.externals.mlpack._mlpack_estimators)

:mod:`ddl.gaussian`
===================

.. automodule:: ddl.gaussian
    :no-members:
    :no-inherited-members:

.. _ddl_gaussian_ref:

Gaussian classes
----------------

.. currentmodule:: ddl

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

    gaussian.GaussianDensity (ddl.gaussian)

:mod:`ddl.independent`
======================

.. automodule:: ddl.independent
    :no-members:
    :no-inherited-members:

.. _ddl_independent_ref:

Independent classes
-------------------

.. currentmodule:: ddl

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

    independent.IndependentDensity (ddl.independent)
    independent.IndependentDestructor (ddl.independent)
    independent.IndependentInverseCdf (ddl.independent)

:mod:`ddl.linear`
=================

.. automodule:: ddl.linear
    :no-members:
    :no-inherited-members:

.. _ddl_linear_ref:

Linear classes
--------------

.. currentmodule:: ddl

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

    linear.BestLinearReconstructionDestructor (ddl.linear)
    linear.IdentityLinearEstimator (ddl.linear)
    linear.LinearProjector (ddl.linear)
    linear.RandomOrthogonalEstimator (ddl.linear)

:mod:`ddl.local`
================

.. automodule:: ddl.local
    :no-members:
    :no-inherited-members:

.. _ddl_local_ref:

Local classes
-------------

.. currentmodule:: ddl

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

    local.FeatureGroupsDestructor (ddl.local)
    local.ImageFeaturePairs (ddl.local)
    local.RandomFeaturePairs (ddl.local)

:mod:`ddl.mixture`
==================

.. automodule:: ddl.mixture
    :no-members:
    :no-inherited-members:

.. _ddl_mixture_ref:

Mixture classes
---------------

.. currentmodule:: ddl

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

    mixture.FirstFixedGaussianMixtureDensity (ddl.mixture)
    mixture.GaussianMixtureDensity (ddl.mixture)

:mod:`ddl.tree`
===============

.. automodule:: ddl.tree
    :no-members:
    :no-inherited-members:

.. _ddl_tree_ref:

Tree classes
------------

.. currentmodule:: ddl

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

    tree.RandomTreeEstimator (ddl.tree)
    tree.TreeDensity (ddl.tree)
    tree.TreeDestructor (ddl.tree)

:mod:`ddl.univariate`
=====================

.. automodule:: ddl.univariate
    :no-members:
    :no-inherited-members:

.. _ddl_univariate_ref:

Univariate classes
------------------

.. currentmodule:: ddl

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

    univariate.HistogramUnivariateDensity (ddl.univariate)
    univariate.ScipyUnivariateDensity (ddl.univariate)

:mod:`ddl.utils`
================

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

.. _ddl_utils_ref:

Utils functions
---------------

.. currentmodule:: ddl

.. autosummary::
    :toctree: ../generated
    :template: function.rst

    utils.check_X_in_interval (ddl.utils)
    utils.check_X_in_interval_decorator (ddl.utils)
    utils.check_domain (ddl.utils)
    utils.get_domain_or_default (ddl.utils)
    utils.get_support_or_default (ddl.utils)
    utils.has_method (ddl.utils)
    utils.make_finite (ddl.utils)
    utils.make_interior (ddl.utils)
    utils.make_interior_probability (ddl.utils)
    utils.make_positive (ddl.utils)

:mod:`ddl.validation`
=====================

.. automodule:: ddl.validation
    :no-members:
    :no-inherited-members:

.. _ddl_validation_ref:

Validation functions
--------------------

.. currentmodule:: ddl

.. autosummary::
    :toctree: ../generated
    :template: function.rst

    validation.check_density (ddl.validation)
    validation.check_destructor (ddl.validation)