Skip to content

Commit

Permalink
improve init docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vict0rsch committed Mar 5, 2024
1 parent 0322a41 commit 8b27ac3
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions gflownet/evaluator/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
"""
Create a new evaluator by subclassing this class and extending the :meth:`eval`
method to add more metrics and plots.
An ``Evaluator`` is a class that is used to compute metrics and plots.
It serves two complementary purposes:
1. It is used to evaluate the performance of the agent during training and to log the
results.
2. It is intended to be used to evaluate the performance of a trained agent, from a
directory containing the agent's checkpoints for instance.
.. note::
This dual use explains some seaminlgy redundant methods / or arguments to methods.
For instance in :`gflownet.evaluator.abstract.AbstractEvaluator.eval` the
``metrics`` argument will never change during the training of a GflowNet (it will
always be ``None``, *i.e.* inherited from the config file) but a user looking to
evaluate a trained agent may want to specify different metrics to compute without
altering the config file.
.. important::
Expand Down

0 comments on commit 8b27ac3

Please sign in to comment.