Skip to content

Commit

Permalink
Adapt docstring of BaseRecorder
Browse files Browse the repository at this point in the history
  • Loading branch information
knikolaou committed May 15, 2024
1 parent ee5af53 commit a4f1c86
Showing 1 changed file with 1 addition and 6 deletions.
7 changes: 1 addition & 6 deletions papyrus/recorders/base_recorder.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ class BaseRecorder(ABC):
A recorder is a class that applies and stores measurements. It is used to record
the learning process of a neural network.
Note
----
All recorders should inherit from this class and implement the apply method.
Recorders that return arrays with sizes that depend on the number of inputs
**cannot** be applied on varying number of inputs. This is because the number of
dimensions of the input need to be same for all subsequent calls, otherwise an error
Expand Down Expand Up @@ -159,8 +155,7 @@ def _measure(self, **neural_state):
Returns
-------
result : np.ndarray
The result of the recorder.
Updates self._results containing the results of the measurements.
"""
for measurement in self.measurements:
# Get the neural state keys that the measurement takes as input
Expand Down

0 comments on commit a4f1c86

Please sign in to comment.