Skip to content

Commit d709a70

Browse files
springcoiltwiecki
authored andcommitted
DOC: Adding an arraystep docstring (#1312)
Fixes the docstring
1 parent aabeabb commit d709a70

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

pymc3/step_methods/arraystep.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
__all__ = ['ArrayStep', 'ArrayStepShared', 'metrop_select', 'SamplerHist',
1111
'Competence', 'Constant']
1212

13-
# TODO Add docstrings to ArrayStep
13+
1414
@unique
1515
class Competence(IntEnum):
1616
"""Enum for charaterizing competence classes of step methods.
@@ -81,6 +81,17 @@ def _competence(cls, vars):
8181

8282

8383
class ArrayStep(BlockedStep):
84+
"""
85+
Blocked step method that is generalized to accept vectors of variables.
86+
87+
Parameters
88+
----------
89+
vars : list
90+
List of variables for sampler.
91+
allvars: Boolean (default False)
92+
blocked: Boolean (default True)
93+
fs: logp theano function
94+
"""
8495
def __init__(self, vars, fs, allvars=False, blocked=True):
8596
self.vars = vars
8697
self.ordering = ArrayOrdering(vars)

0 commit comments

Comments
 (0)