Skip to content

Commit

Permalink
adding to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tfm000 committed Nov 28, 2023
1 parent 3fe558f commit 544fdb7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ Named after Sklar's theorem and Abe Sklar, the American mathematician who proved

This library has many different possible use cases, ranging from machine learning to finance.

## Read the Docs
Official SklarPy documentation can be found <a href="https://sklarpy.readthedocs.io/en/latest/"> here</a>.

## Table of contents

Expand Down
12 changes: 10 additions & 2 deletions docs/source/Univariate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you try::

from sklarpy.univariate import normal

You will likely find that your interpreter flags an error along the lines of "cannot find reference 'normal' in __init__.py"
You will likely find that your interpreter flags an error along the lines of "cannot find reference 'normal' in __init__.py".
Do not worry, this is to be expected an a side effect of the dynamic way SklarPy univariate distributions are created from scipy.stats distributions.
At runtime, *your code will work without any errors*!

Expand All @@ -36,7 +36,7 @@ For scipy version 1.11.4 you should get an output along the lines of:
So you have a lot to choose from!

.. automodule:: sklarpy.univariate
.. automodule:: sklarpy.univariate.univariate_fitter
:members:
:exclude-members: UnivariateFitter

Expand All @@ -51,7 +51,15 @@ So you have a lot to choose from!

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:: get_summary

.. automethod:: get_best

.. automethod:: plot

.. automethod:: fitted_distributions


.. automodule:: sklarpy.univariate._prefit
:members:
:exclude-members: PreFitUnivariateBase, PreFitNumericalUnivariateBase
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import os
import sys

sys.path.insert(0, os.path.abspath(".."))
sys.path.insert(0, os.path.abspath("..."))

# -- Project information

Expand Down

0 comments on commit 544fdb7

Please sign in to comment.