.. _distributions_ref:

Probability distributions
=========================

The :mod:`skpro.distributions` module contains
probability distributions which combine a ``pandas.DataFrame``-like API
with a ``scikit-base`` compatible object interface.

All distributions in ``skpro`` can be listed using the ``skpro.registry.all_objects`` utility,
using ``object_types="distribution"``, optionally filtered by tags.
Valid tags can be listed using ``skpro.registry.all_tags``.

Base
----

.. currentmodule:: skpro.distributions.base

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

    BaseDistribution

Parametric distributions
------------------------

Continuous support - full reals
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: skpro.distributions

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

    Cauchy
    Laplace
    Logistic
    Normal
    SkewNormal
    TDistribution
    TruncatedNormal
    Uniform


Continuous support - non-negative reals
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: skpro.distributions

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

    Alpha
    Beta
    BurrIII
    BurrXII
    ChiSquared
    Exponential
    Erlang
    FatigueLife
    FDist
    Fisk
    Gamma
    GeneralizedPareto
    GumbelL
    GumbelR
    Levy
    LogGamma
    LogNormal
    HalfCauchy
    HalfLogistic
    HalfNormal
    InverseGamma
    InverseGaussian
    LogLaplace
    Pareto
    Rayleigh
    TruncatedPareto
    Weibull


Integer support
~~~~~~~~~~~~~~~

.. currentmodule:: skpro.distributions

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

    Binomial
    Geometric
    NegativeBinomial
    Poisson
    ZeroInflated
    Skellam

Non-parametric and empirical distributions
------------------------------------------

.. currentmodule:: skpro.distributions

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

    Delta
    Empirical
    Histogram
    QPD_Empirical
    QPD_Johnson
    QPD_U
    QPD_S
    QPD_B


Composite distributions
-----------------------

Transformation composition
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: skpro.distributions

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

    MeanScale
    TransformedDistribution

Truncated and inflated distributions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: skpro.distributions

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

    Hurdle
    LeftTruncated
    TruncatedDistribution
    ZeroInflated

Mixture composition
~~~~~~~~~~~~~~~~~~~

.. currentmodule:: skpro.distributions

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

    KernelMixture
    Mixture
    NormalMixture

Sampling and multivariate composition
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: skpro.distributions

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

    IID