Skip to content

Commit af6eaeb

Browse files
aloctavodiatwiecki
authored andcommitted
docstring update, fix missing space between varname and description
1 parent 70aa1f5 commit af6eaeb

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

pymc3/stats.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -271,36 +271,36 @@ def compare(traces, models, ic='WAIC'):
271271
272272
Parameters
273273
----------
274-
traces: list of PyMC3 traces
275-
models: list of PyMC3 models
274+
traces : list of PyMC3 traces
275+
models : list of PyMC3 models
276276
in the same order as traces.
277-
ic: string
277+
ic : string
278278
Information Criterion (WAIC or LOO) used to compare models.
279279
Default WAIC.
280280
281281
Returns
282282
-------
283283
A DataFrame, ordered from lowest to highest IC. The index reflects
284284
the order in which the models are passed to this function. The columns are:
285-
IC: Information Criteria (WAIC or LOO).
285+
IC : Information Criteria (WAIC or LOO).
286286
Smaller IC indicates higher out-of-sample predictive fit ("better" model).
287287
Default WAIC.
288-
pIC: Estimated effective number of parameters.
289-
dIC: Relative difference between each IC (WAIC or LOO)
288+
pIC : Estimated effective number of parameters.
289+
dIC : Relative difference between each IC (WAIC or LOO)
290290
and the lowest IC (WAIC or LOO).
291291
It's always 0 for the top-ranked model.
292292
weight: Akaike weights for each model.
293293
This can be loosely interpreted as the probability of each model
294294
(among the compared model) given the data. Be careful that these
295295
weights are based on point estimates of the IC (uncertainty is ignored).
296-
SE: Standard error of the IC estimate.
296+
SE : Standard error of the IC estimate.
297297
For a "large enough" sample size this is an estimate of the uncertainty
298298
in the computation of the IC.
299-
dSE: Standard error of the difference in IC between each model and
299+
dSE : Standard error of the difference in IC between each model and
300300
the top-ranked model.
301301
It's always 0 for the top-ranked model.
302-
warning: A value of 1 indicates that the computation of the IC may not be
303-
reliable see http://arxiv.org/abs/1507.04544 for details
302+
warning : A value of 1 indicates that the computation of the IC may not be
303+
reliable see http://arxiv.org/abs/1507.04544 for details.
304304
"""
305305
if ic == 'WAIC':
306306
ic_func = waic

0 commit comments

Comments
 (0)