From 395d2b01cb566e52cab63f351489522834594b28 Mon Sep 17 00:00:00 2001 From: luk-f-a Date: Fri, 30 Aug 2019 09:42:30 +0200 Subject: [PATCH 1/2] Statistical functions module __init__ (with docs) --- numba_scipy/stats/__init__.py | 121 ++++++++++++++++++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100644 numba_scipy/stats/__init__.py diff --git a/numba_scipy/stats/__init__.py b/numba_scipy/stats/__init__.py new file mode 100644 index 0000000..62f737e --- /dev/null +++ b/numba_scipy/stats/__init__.py @@ -0,0 +1,121 @@ +""" +========================================== +Statistical functions (:mod:`numba-scipy.stats`) +========================================== + +.. currentmodule:: numba-scipy.stats + +This module aims to provide the existing functionality in SciPy's stats_ module +This module contains a large number of probability distributions as +well as a growing library of statistical functions. + +Each univariate distribution is an instance of a subclass of `rv_continuous` +(`rv_discrete` for discrete distributions): + +.. _stats: https://docs.scipy.org/doc/scipy/reference/stats.html + +.. autosummary:: + :toctree: generated/ + + rv_continuous + rv_discrete + rv_histogram + +Continuous distributions +======================== + +.. autosummary:: + :toctree: generated/ + + norm -- Normal (Gaussian) + +Multivariate distributions +========================== + +.. autosummary:: + :toctree: generated/ + + +Discrete distributions +====================== + +.. autosummary:: + :toctree: generated/ + + +An overview of statistical functions is given below. + + +Summary statistics +================== + +.. autosummary:: + :toctree: generated/ + + + +Frequency statistics +==================== + + +Correlation functions +===================== + + +Statistical tests +================= + + + +Transformations +=============== + + + +Statistical distances +===================== + + + +Random variate generation +========================= + + +Circular statistical functions +============================== + + + +Contingency table functions +=========================== + + +Plot-tests +========== + + + +Masked statistics functions +=========================== + + + +Univariate and multivariate kernel density estimation +===================================================== + + + +Warnings used in :mod:`scipy.stats` +=================================== + + + +""" + + +from .stats import * +from .distributions import * + +__all__ = [s for s in dir() if not s.startswith("_")] # Remove dunders. + + From cb0cee71b222fdb4227de9536565c06c7aafb139 Mon Sep 17 00:00:00 2001 From: luk-f-a Date: Fri, 30 Aug 2019 09:48:28 +0200 Subject: [PATCH 2/2] Statistical functions doc source --- docs/source/supported/stats.rst | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/source/supported/stats.rst diff --git a/docs/source/supported/stats.rst b/docs/source/supported/stats.rst new file mode 100644 index 0000000..dfea2f2 --- /dev/null +++ b/docs/source/supported/stats.rst @@ -0,0 +1,8 @@ +.. automodule:: numba-scipy.stats + :no-members: + :no-inherited-members: + :no-special-members: + +.. toctree:: + :hidden: +