From c1807e818bb9dbe70e611839c6a45cba92220d01 Mon Sep 17 00:00:00 2001 From: Tyler Date: Tue, 28 Nov 2023 20:17:22 +0000 Subject: [PATCH] adding to docs --- README.md | 3 +++ docs/source/Univariate.rst | 24 ++++++++++++++++++++++++ docs/source/index.rst | 3 +++ 3 files changed, 30 insertions(+) diff --git a/README.md b/README.md index a724507..2cbc243 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,9 @@ build   + + build   downloads   diff --git a/docs/source/Univariate.rst b/docs/source/Univariate.rst index 03bd91c..f730c7a 100644 --- a/docs/source/Univariate.rst +++ b/docs/source/Univariate.rst @@ -4,3 +4,27 @@ Univariate Distributions ######################### +This SklarPy package contains many different univariate distributions in addition to objects allowing for easy fitting. +With the exception of a handful of distributions, all univariate distribution objects are wrappers of scipy.stats univariate distributions, with added functionalities for plotting, fitting and saving. + +There is also the UnivariateFitter object, which allows for easy fitting of univariate distributions to data and for determining the best / statistically significant distribution(s). + +.. automodule:: sklarpy.univariate + :members: + :exclude-members: UnivariateFitter + + .. autoclass:: UnivariateFitter + :members: + + .. automethod:: __init__ + + .. automethod:: fit + + .. caution:: + + If 'use_processpoolexecutor' is set to True, the UnivariateFitter object will use the ProcessPoolExecutor to parallelize the fitting process. However, if the code is ran outside 'if __name__ == "__main__":', you may receive a runtime error. + + .. automethod:: plot + + .. automethod:: fitted_distributions + diff --git a/docs/source/index.rst b/docs/source/index.rst index 782d8d7..55a20bf 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,6 +17,9 @@ build   + + build   downloads