From 95db0f50b6b524d626bc61fd04349434d0053e44 Mon Sep 17 00:00:00 2001 From: Matt Graham Date: Thu, 20 Aug 2020 17:36:37 +0100 Subject: [PATCH] Fixing mispelt references in docstrings --- mici/samplers.py | 4 ++-- mici/states.py | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/mici/samplers.py b/mici/samplers.py index 81b1c22..2a9c0e0 100644 --- a/mici/samplers.py +++ b/mici/samplers.py @@ -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 @@ -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 diff --git a/mici/states.py b/mici/states.py index 1942e40..11d95c7 100644 --- a/mici/states.py +++ b/mici/states.py @@ -16,7 +16,7 @@ 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 @@ -24,8 +24,8 @@ def cache_in_state(*depends_on): 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 @@ -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 @@ -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