Skip to content

Commit

Permalink
Add clarifications to sim.[soft_]reset docstrings
Browse files Browse the repository at this point in the history
In particular clarifying how the two relate, and the effect
sim.reset() has on model parameters.
  • Loading branch information
arvoelke committed Feb 10, 2020
1 parent e0c3479 commit de7c89d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion nengo_dl/simulator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit de7c89d

Please sign in to comment.