Skip to content

Commit

Permalink
Fixing mispelt references in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
matt-graham committed Aug 20, 2020
1 parent aaaad1a commit 95db0f5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions mici/samplers.py
Original file line number Diff line number Diff line change
Expand Up @@ -968,7 +968,7 @@ def sample_chains_with_adaptive_warm_up(
Args:
n_warm_up_iter (int): Number of adaptive warm up iterations per
chain. Depending on the `mici.stages.Stager` instance specified
chain. Depending on the `mici.stagers.Stager` instance specified
by the `stage arguments the warm up iterations may be split
between one or more adaptive stages.
n_main_iter (int): Number of iterations (samples to draw) per chain
Expand Down Expand Up @@ -1431,7 +1431,7 @@ def sample_chains_with_adaptive_warm_up(
Args:
n_warm_up_iter (int): Number of adaptive warm up iterations per
chain. Depending on the `mici.stages.Stager` instance specified
chain. Depending on the `mici.stagers.Stager` instance specified
by the `stage arguments the warm up iterations may be split
between one or more adaptive stages.
n_main_iter (int): Number of iterations (samples to draw) per chain
Expand Down
12 changes: 6 additions & 6 deletions mici/states.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ def _cache_key_func(system, method):
def cache_in_state(*depends_on):
"""Memoizing decorator for system methods.
Used to decorate `mici.system.System` methods which compute a function of
Used to decorate `mici.systems.System` methods which compute a function of
one or more chain state variable(s), with the decorated method caching the
value returned by the method being wrapped in the `ChainState` object to
prevent the need for recomputation on future calls if the state variables
the returned value depends on have not been changed in between the calls.
Additionally for `ChainState` instances initialized with a `_call_counts`
argument, the memoized method will update a counter for the method in the
`ChainState._call_counts` attribute every time the method being decorated is
called (i.e. when there isn't a valid cached value available).
`_call_counts` attribute every time the method being decorated is called
(i.e. when there isn't a valid cached value available).
Args:
*depends_on: One or more strings corresponding to the names of any state
Expand Down Expand Up @@ -53,7 +53,7 @@ def wrapper(self, state):
def cache_in_state_with_aux(depends_on, auxiliary_outputs):
"""Memoizing decorator for system methods with possible auxiliary outputs.
Used to decorate `mici.system.System` methods which compute a function of
Used to decorate `mici.systems.System` methods which compute a function of
one or more chain state variable(s), with the decorated method caching the
value or values returned by the method being wrapped in the `ChainState`
object to prevent the need for recomputation on future calls if the state
Expand All @@ -80,8 +80,8 @@ def cache_in_state_with_aux(depends_on, auxiliary_outputs):
Additionally for `ChainState` instances initialized with a `_call_counts`
argument, the memoized method will update a counter for the method in the
`ChainState._call_counts` attribute every time the method being decorated is
called (i.e. when there isn't a valid cached value available).
`_call_counts` attribute every time the method being decorated is called
(i.e. when there isn't a valid cached value available).
Args:
depends_on (str or Tuple[str]): A string or tuple of strings, with each
Expand Down

0 comments on commit 95db0f5

Please sign in to comment.