Skip to content

Remove unreachable lines of sampling code #4261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 27, 2020
Merged

Remove unreachable lines of sampling code #4261

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f2967dd
remove unreachable code
MarcoGorelli Nov 26, 2020
032b9e7
clarify docs, invert guard
MarcoGorelli Nov 26, 2020
ed70514
clarify that steps is a sequence
MarcoGorelli Nov 26, 2020
6ab2c4f
:memo: update docstring
MarcoGorelli Nov 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions pymc3/sampling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,31 +111,31 @@ def instantiate_steppers(_model, steps, selected_steps, step_kwargs=None):
----------
model : Model object
A fully-specified model object; legacy argument -- ignored
steps : step function or vector of step functions
steps : sequence of step functions
One or more step functions that have been assigned to some subset of
the model's parameters. Defaults to None (no assigned variables).
the model's parameters.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None has no .append method

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SHould be like this:

steps : list
        A list of zero or more step function instances that have been assigned to some subset of
        the model's parameters.

selected_steps : dictionary of step methods and variables
The step methods and the variables that have were assigned to them.
The step methods and the (possibly zero) variables that have were assigned to them.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And here, it should say

selected_steps : dict
    A dictionary that maps a step method class to a list of model variables.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And here, it should say

selected_steps : dict
    A dictionary that maps a step method class to a list of model variables.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure - I've added zero or more here because it's the fact that there could be zero here which was causing the continue line to be uncovered

step_kwargs : dict
Parameters for the samplers. Keys are the lower case names of
the step method, values a dict of arguments.
the step method, values a dict of arguments. Defaults to None.

Returns
-------
methods : list
List of step methods associated with the model's variables.
methods : list or step
List of step methods associated with the model's variables, or step method
if there is only one.
"""
if step_kwargs is None:
step_kwargs = {}

used_keys = set()
for step_class, vars in selected_steps.items():
if len(vars) == 0:
continue
args = step_kwargs.get(step_class.name, {})
used_keys.add(step_class.name)
step = step_class(vars=vars, **args)
steps.append(step)
if vars:
args = step_kwargs.get(step_class.name, {})
used_keys.add(step_class.name)
step = step_class(vars=vars, **args)
steps.append(step)

unused_args = set(step_kwargs).difference(used_keys)
if unused_args:
Expand Down