Skip to content

Commit

Permalink
reorganize and update docs (#594)
Browse files Browse the repository at this point in the history
* reorganize and update docs

* update backup links
  • Loading branch information
aloctavodia authored Nov 21, 2024
1 parent 9c8b408 commit 8ed4c89
Show file tree
Hide file tree
Showing 19 changed files with 2,786 additions and 1,162 deletions.
204 changes: 7 additions & 197 deletions docs/api_reference.rst
Original file line number Diff line number Diff line change
@@ -1,204 +1,14 @@
API Reference
***************
*************

This reference provides detailed documentation for user functions in the current release of PreliZ.


.. toctree::
:maxdepth: 2
:maxdepth: 1


:mod:`preliz.unidimensional`
======================================

.. automodule:: preliz.unidimensional
:members:


:mod:`preliz.multidimensional`
======================================

.. automodule:: preliz.multidimensional
:members:


:mod:`preliz.predictive`
======================================

.. automodule:: preliz.predictive
:members:

:mod:`preliz.ppls`
======================================

.. automodule:: preliz.ppls
:members:

:mod:`preliz.distributions.continuous`
======================================

.. automodule:: preliz.distributions.asymmetric_laplace
:members:

.. automodule:: preliz.distributions.beta
:members:

.. automodule:: preliz.distributions.betascaled
:members:

.. automodule:: preliz.distributions.cauchy
:members:

.. automodule:: preliz.distributions.chi_squared
:members:

.. automodule:: preliz.distributions.exgaussian
:members:

.. automodule:: preliz.distributions.exponential
:members:

.. automodule:: preliz.distributions.gamma
:members:

.. automodule:: preliz.distributions.gumbel
:members:

.. automodule:: preliz.distributions.halfcauchy
:members:

.. automodule:: preliz.distributions.halfnormal
:members:

.. automodule:: preliz.distributions.halfstudentt
:members:

.. automodule:: preliz.distributions.inversegamma
:members:

.. automodule:: preliz.distributions.kumaraswamy
:members:

.. automodule:: preliz.distributions.laplace
:members:

.. automodule:: preliz.distributions.logistic
:members:

.. automodule:: preliz.distributions.loglogistic
:members:

.. automodule:: preliz.distributions.logitnormal
:members:

.. automodule:: preliz.distributions.lognormal
:members:

.. automodule:: preliz.distributions.moyal
:members:

.. automodule:: preliz.distributions.normal
:members:

.. automodule:: preliz.distributions.pareto
:members:

.. automodule:: preliz.distributions.rice
:members:

.. automodule:: preliz.distributions.skewnormal
:members:

.. automodule:: preliz.distributions.skew_studentt
:members:

.. automodule:: preliz.distributions.studentt
:members:

.. automodule:: preliz.distributions.triangular
:members:

.. automodule:: preliz.distributions.truncatednormal
:members:

.. automodule:: preliz.distributions.uniform
:members:

.. automodule:: preliz.distributions.vonmises
:members:

.. automodule:: preliz.distributions.wald
:members:

.. automodule:: preliz.distributions.weibull
:members:

.. automodule:: preliz.distributions.continuous
:members:

:mod:`preliz.distributions.discrete`
====================================

.. automodule:: preliz.distributions.bernoulli
:members:

.. automodule:: preliz.distributions.betabinomial
:members:

.. automodule:: preliz.distributions.binomial
:members:

.. automodule:: preliz.distributions.categorical
:members:

.. automodule:: preliz.distributions.discrete_uniform
:members:

.. automodule:: preliz.distributions.discrete_weibull
:members:

.. automodule:: preliz.distributions.geometric
:members:

.. automodule:: preliz.distributions.hypergeometric
:members:

.. automodule:: preliz.distributions.poisson
:members:

.. automodule:: preliz.distributions.negativebinomial
:members:

.. automodule:: preliz.distributions.zi_binomial
:members:

.. automodule:: preliz.distributions.zi_negativebinomial
:members:

.. automodule:: preliz.distributions.zi_poisson
:members:

.. automodule:: preliz.distributions.discrete
:members:


:mod:`preliz.distributions.continuous_multivariate`
====================================

.. automodule:: preliz.distributions.continuous_multivariate
:members:

:mod:`preliz.distributions`
====================================

.. automodule:: preliz.distributions.censored
:members:

.. automodule:: preliz.distributions.hurdle
:members:

.. automodule:: preliz.distributions.mixture
:members:

.. automodule:: preliz.distributions.truncated
:members:
unidimensional
multidimensional
predictive
ppls
distributions
172 changes: 172 additions & 0 deletions docs/distributions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
Distributions
*************


:mod:`preliz.distributions.continuous`
======================================

.. automodule:: preliz.distributions.asymmetric_laplace
:members:

.. automodule:: preliz.distributions.beta
:members:

.. automodule:: preliz.distributions.betascaled
:members:

.. automodule:: preliz.distributions.cauchy
:members:

.. automodule:: preliz.distributions.chi_squared
:members:

.. automodule:: preliz.distributions.exgaussian
:members:

.. automodule:: preliz.distributions.exponential
:members:

.. automodule:: preliz.distributions.gamma
:members:

.. automodule:: preliz.distributions.gumbel
:members:

.. automodule:: preliz.distributions.halfcauchy
:members:

.. automodule:: preliz.distributions.halfnormal
:members:

.. automodule:: preliz.distributions.halfstudentt
:members:

.. automodule:: preliz.distributions.inversegamma
:members:

.. automodule:: preliz.distributions.kumaraswamy
:members:

.. automodule:: preliz.distributions.laplace
:members:

.. automodule:: preliz.distributions.logistic
:members:

.. automodule:: preliz.distributions.loglogistic
:members:

.. automodule:: preliz.distributions.logitnormal
:members:

.. automodule:: preliz.distributions.lognormal
:members:

.. automodule:: preliz.distributions.moyal
:members:

.. automodule:: preliz.distributions.normal
:members:

.. automodule:: preliz.distributions.pareto
:members:

.. automodule:: preliz.distributions.rice
:members:

.. automodule:: preliz.distributions.skewnormal
:members:

.. automodule:: preliz.distributions.skew_studentt
:members:

.. automodule:: preliz.distributions.studentt
:members:

.. automodule:: preliz.distributions.triangular
:members:

.. automodule:: preliz.distributions.truncatednormal
:members:

.. automodule:: preliz.distributions.uniform
:members:

.. automodule:: preliz.distributions.vonmises
:members:

.. automodule:: preliz.distributions.wald
:members:

.. automodule:: preliz.distributions.weibull
:members:

.. automodule:: preliz.distributions.continuous
:members:

:mod:`preliz.distributions.discrete`
====================================

.. automodule:: preliz.distributions.bernoulli
:members:

.. automodule:: preliz.distributions.betabinomial
:members:

.. automodule:: preliz.distributions.binomial
:members:

.. automodule:: preliz.distributions.categorical
:members:

.. automodule:: preliz.distributions.discrete_uniform
:members:

.. automodule:: preliz.distributions.discrete_weibull
:members:

.. automodule:: preliz.distributions.geometric
:members:

.. automodule:: preliz.distributions.hypergeometric
:members:

.. automodule:: preliz.distributions.poisson
:members:

.. automodule:: preliz.distributions.negativebinomial
:members:

.. automodule:: preliz.distributions.zi_binomial
:members:

.. automodule:: preliz.distributions.zi_negativebinomial
:members:

.. automodule:: preliz.distributions.zi_poisson
:members:

.. automodule:: preliz.distributions.discrete
:members:


:mod:`preliz.distributions.continuous_multivariate`
====================================

.. automodule:: preliz.distributions.continuous_multivariate
:members:

:mod:`preliz.distributions`
====================================

.. automodule:: preliz.distributions.censored
:members:

.. automodule:: preliz.distributions.hurdle
:members:

.. automodule:: preliz.distributions.mixture
:members:

.. automodule:: preliz.distributions.truncated
:members:
Loading

0 comments on commit 8ed4c89

Please sign in to comment.