docs(monitor): add docstring to the `BaseMonitor`
@@ -14,6 +14,15 @@ from .generators import Generator3D
class BaseMonitor(ABC):
+ r"""A tool for checking the status of the neural network during training.
+
+ A monitor keeps track of a matplotlib.figure.Figure instance and updates the plot
+ whenever its ``check()`` method is called (usually by a ``neurodiffeq.solvers.BaseSolver` instance).
+
+ .. note::
+ Currently, the ``check()`` method can only run synchronously.
+ It blocks the training / validation process, so don't call the ``check()`` method too often.
+ """
@abstractmethod
def check(self, nets, conditions, history):
pass
