Skip to content

Commit 8ed4c89

Browse files
aloctavodiaaloctavodia
authored
reorganize and update docs (#594)
* reorganize and update docs * update backup links
1 parent 9c8b408 commit 8ed4c89

19 files changed

+2786
-1162
lines changed

‎docs/api_reference.rst

+7-197
Original file line numberDiff line numberDiff line change
@@ -1,204 +1,14 @@
11
API Reference
2-
***************
2+
*************
33

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

66

77
.. toctree::
8-
:maxdepth: 2
8+
:maxdepth: 1
99

10-
11-
:mod:`preliz.unidimensional`
12-
======================================
13-
14-
.. automodule:: preliz.unidimensional
15-
:members:
16-
17-
18-
:mod:`preliz.multidimensional`
19-
======================================
20-
21-
.. automodule:: preliz.multidimensional
22-
:members:
23-
24-
25-
:mod:`preliz.predictive`
26-
======================================
27-
28-
.. automodule:: preliz.predictive
29-
:members:
30-
31-
:mod:`preliz.ppls`
32-
======================================
33-
34-
.. automodule:: preliz.ppls
35-
:members:
36-
37-
:mod:`preliz.distributions.continuous`
38-
======================================
39-
40-
.. automodule:: preliz.distributions.asymmetric_laplace
41-
:members:
42-
43-
.. automodule:: preliz.distributions.beta
44-
:members:
45-
46-
.. automodule:: preliz.distributions.betascaled
47-
:members:
48-
49-
.. automodule:: preliz.distributions.cauchy
50-
:members:
51-
52-
.. automodule:: preliz.distributions.chi_squared
53-
:members:
54-
55-
.. automodule:: preliz.distributions.exgaussian
56-
:members:
57-
58-
.. automodule:: preliz.distributions.exponential
59-
:members:
60-
61-
.. automodule:: preliz.distributions.gamma
62-
:members:
63-
64-
.. automodule:: preliz.distributions.gumbel
65-
:members:
66-
67-
.. automodule:: preliz.distributions.halfcauchy
68-
:members:
69-
70-
.. automodule:: preliz.distributions.halfnormal
71-
:members:
72-
73-
.. automodule:: preliz.distributions.halfstudentt
74-
:members:
75-
76-
.. automodule:: preliz.distributions.inversegamma
77-
:members:
78-
79-
.. automodule:: preliz.distributions.kumaraswamy
80-
:members:
81-
82-
.. automodule:: preliz.distributions.laplace
83-
:members:
84-
85-
.. automodule:: preliz.distributions.logistic
86-
:members:
87-
88-
.. automodule:: preliz.distributions.loglogistic
89-
:members:
90-
91-
.. automodule:: preliz.distributions.logitnormal
92-
:members:
93-
94-
.. automodule:: preliz.distributions.lognormal
95-
:members:
96-
97-
.. automodule:: preliz.distributions.moyal
98-
:members:
99-
100-
.. automodule:: preliz.distributions.normal
101-
:members:
102-
103-
.. automodule:: preliz.distributions.pareto
104-
:members:
105-
106-
.. automodule:: preliz.distributions.rice
107-
:members:
108-
109-
.. automodule:: preliz.distributions.skewnormal
110-
:members:
111-
112-
.. automodule:: preliz.distributions.skew_studentt
113-
:members:
114-
115-
.. automodule:: preliz.distributions.studentt
116-
:members:
117-
118-
.. automodule:: preliz.distributions.triangular
119-
:members:
120-
121-
.. automodule:: preliz.distributions.truncatednormal
122-
:members:
123-
124-
.. automodule:: preliz.distributions.uniform
125-
:members:
126-
127-
.. automodule:: preliz.distributions.vonmises
128-
:members:
129-
130-
.. automodule:: preliz.distributions.wald
131-
:members:
132-
133-
.. automodule:: preliz.distributions.weibull
134-
:members:
135-
136-
.. automodule:: preliz.distributions.continuous
137-
:members:
138-
139-
:mod:`preliz.distributions.discrete`
140-
====================================
141-
142-
.. automodule:: preliz.distributions.bernoulli
143-
:members:
144-
145-
.. automodule:: preliz.distributions.betabinomial
146-
:members:
147-
148-
.. automodule:: preliz.distributions.binomial
149-
:members:
150-
151-
.. automodule:: preliz.distributions.categorical
152-
:members:
153-
154-
.. automodule:: preliz.distributions.discrete_uniform
155-
:members:
156-
157-
.. automodule:: preliz.distributions.discrete_weibull
158-
:members:
159-
160-
.. automodule:: preliz.distributions.geometric
161-
:members:
162-
163-
.. automodule:: preliz.distributions.hypergeometric
164-
:members:
165-
166-
.. automodule:: preliz.distributions.poisson
167-
:members:
168-
169-
.. automodule:: preliz.distributions.negativebinomial
170-
:members:
171-
172-
.. automodule:: preliz.distributions.zi_binomial
173-
:members:
174-
175-
.. automodule:: preliz.distributions.zi_negativebinomial
176-
:members:
177-
178-
.. automodule:: preliz.distributions.zi_poisson
179-
:members:
180-
181-
.. automodule:: preliz.distributions.discrete
182-
:members:
183-
184-
185-
:mod:`preliz.distributions.continuous_multivariate`
186-
====================================
187-
188-
.. automodule:: preliz.distributions.continuous_multivariate
189-
:members:
190-
191-
:mod:`preliz.distributions`
192-
====================================
193-
194-
.. automodule:: preliz.distributions.censored
195-
:members:
196-
197-
.. automodule:: preliz.distributions.hurdle
198-
:members:
199-
200-
.. automodule:: preliz.distributions.mixture
201-
:members:
202-
203-
.. automodule:: preliz.distributions.truncated
204-
:members:
10+
unidimensional
11+
multidimensional
12+
predictive
13+
ppls
14+
distributions

‎docs/distributions.rst

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
Distributions
2+
*************
3+
4+
5+
:mod:`preliz.distributions.continuous`
6+
======================================
7+
8+
.. automodule:: preliz.distributions.asymmetric_laplace
9+
:members:
10+
11+
.. automodule:: preliz.distributions.beta
12+
:members:
13+
14+
.. automodule:: preliz.distributions.betascaled
15+
:members:
16+
17+
.. automodule:: preliz.distributions.cauchy
18+
:members:
19+
20+
.. automodule:: preliz.distributions.chi_squared
21+
:members:
22+
23+
.. automodule:: preliz.distributions.exgaussian
24+
:members:
25+
26+
.. automodule:: preliz.distributions.exponential
27+
:members:
28+
29+
.. automodule:: preliz.distributions.gamma
30+
:members:
31+
32+
.. automodule:: preliz.distributions.gumbel
33+
:members:
34+
35+
.. automodule:: preliz.distributions.halfcauchy
36+
:members:
37+
38+
.. automodule:: preliz.distributions.halfnormal
39+
:members:
40+
41+
.. automodule:: preliz.distributions.halfstudentt
42+
:members:
43+
44+
.. automodule:: preliz.distributions.inversegamma
45+
:members:
46+
47+
.. automodule:: preliz.distributions.kumaraswamy
48+
:members:
49+
50+
.. automodule:: preliz.distributions.laplace
51+
:members:
52+
53+
.. automodule:: preliz.distributions.logistic
54+
:members:
55+
56+
.. automodule:: preliz.distributions.loglogistic
57+
:members:
58+
59+
.. automodule:: preliz.distributions.logitnormal
60+
:members:
61+
62+
.. automodule:: preliz.distributions.lognormal
63+
:members:
64+
65+
.. automodule:: preliz.distributions.moyal
66+
:members:
67+
68+
.. automodule:: preliz.distributions.normal
69+
:members:
70+
71+
.. automodule:: preliz.distributions.pareto
72+
:members:
73+
74+
.. automodule:: preliz.distributions.rice
75+
:members:
76+
77+
.. automodule:: preliz.distributions.skewnormal
78+
:members:
79+
80+
.. automodule:: preliz.distributions.skew_studentt
81+
:members:
82+
83+
.. automodule:: preliz.distributions.studentt
84+
:members:
85+
86+
.. automodule:: preliz.distributions.triangular
87+
:members:
88+
89+
.. automodule:: preliz.distributions.truncatednormal
90+
:members:
91+
92+
.. automodule:: preliz.distributions.uniform
93+
:members:
94+
95+
.. automodule:: preliz.distributions.vonmises
96+
:members:
97+
98+
.. automodule:: preliz.distributions.wald
99+
:members:
100+
101+
.. automodule:: preliz.distributions.weibull
102+
:members:
103+
104+
.. automodule:: preliz.distributions.continuous
105+
:members:
106+
107+
:mod:`preliz.distributions.discrete`
108+
====================================
109+
110+
.. automodule:: preliz.distributions.bernoulli
111+
:members:
112+
113+
.. automodule:: preliz.distributions.betabinomial
114+
:members:
115+
116+
.. automodule:: preliz.distributions.binomial
117+
:members:
118+
119+
.. automodule:: preliz.distributions.categorical
120+
:members:
121+
122+
.. automodule:: preliz.distributions.discrete_uniform
123+
:members:
124+
125+
.. automodule:: preliz.distributions.discrete_weibull
126+
:members:
127+
128+
.. automodule:: preliz.distributions.geometric
129+
:members:
130+
131+
.. automodule:: preliz.distributions.hypergeometric
132+
:members:
133+
134+
.. automodule:: preliz.distributions.poisson
135+
:members:
136+
137+
.. automodule:: preliz.distributions.negativebinomial
138+
:members:
139+
140+
.. automodule:: preliz.distributions.zi_binomial
141+
:members:
142+
143+
.. automodule:: preliz.distributions.zi_negativebinomial
144+
:members:
145+
146+
.. automodule:: preliz.distributions.zi_poisson
147+
:members:
148+
149+
.. automodule:: preliz.distributions.discrete
150+
:members:
151+
152+
153+
:mod:`preliz.distributions.continuous_multivariate`
154+
====================================
155+
156+
.. automodule:: preliz.distributions.continuous_multivariate
157+
:members:
158+
159+
:mod:`preliz.distributions`
160+
====================================
161+
162+
.. automodule:: preliz.distributions.censored
163+
:members:
164+
165+
.. automodule:: preliz.distributions.hurdle
166+
:members:
167+
168+
.. automodule:: preliz.distributions.mixture
169+
:members:
170+
171+
.. automodule:: preliz.distributions.truncated
172+
:members:

0 commit comments

Comments
 (0)