From de7c89dc88d1da21e8da568c3dfb937439a8a9c4 Mon Sep 17 00:00:00 2001 From: Aaron Voelker Date: Mon, 10 Feb 2020 13:52:44 -0500 Subject: [PATCH] Add clarifications to sim.[soft_]reset docstrings In particular clarifying how the two relate, and the effect sim.reset() has on model parameters. --- nengo_dl/simulator.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/nengo_dl/simulator.py b/nengo_dl/simulator.py index bc1d2327a..2fe0f6c6b 100644 --- a/nengo_dl/simulator.py +++ b/nengo_dl/simulator.py @@ -564,6 +564,11 @@ def reset(self, seed=None): """ Resets the simulator to initial conditions. + This involves calling + ``soft_reset(include_trainable=True, include_probes=True)`` + which resets the simulator state (if stateful), all model parameters, + and all probe data. In addition, the graph is rebuilt. + Parameters ---------- seed : int @@ -604,7 +609,8 @@ def soft_reset(self, include_trainable=False, include_probes=False): ---------- include_trainable : bool If True, also reset any training that has been performed on - simulator parameters (e.g., connection weights). + simulator parameters (e.g., connection weights), including + any weights that may have been loaded. include_probes : bool If True, also clear probe data.