Skip to content

[Docs] Warning on metric states #4388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 28, 2020
Merged

[Docs] Warning on metric states #4388

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8a09b69
warning on states
SkafteNicki Oct 27, 2020
609c0bb
suggestion
SkafteNicki Oct 27, 2020
a7e009e
Update metrics.rst
SkafteNicki Oct 28, 2020
fe1be06
Merge branch 'master' into metrics/doc_warning
SeanNaren Oct 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/source/metrics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ If ``on_epoch`` is True, the logger automatically logs the end of epoch metric v
self.valid_acc(logits, y)
self.log('valid_acc', self.valid_acc, on_step=True, on_epoch=True)


This metrics API is independent of PyTorch Lightning. Metrics can directly be used in PyTorch as shown in the example:

.. code-block:: python
Expand All @@ -105,6 +104,13 @@ This metrics API is independent of PyTorch Lightning. Metrics can directly be us
# total accuracy over all validation batches
total_valid_accuracy = valid_accuracy.compute()

.. note::

Metrics contain internal states that keep track of the data seen so far.
Do not mix metric states across training, validation and testing.
It is highly recommended to re-initialize the metric per mode as
shown in the examples above.

*********************
Implementing a Metric
*********************
Expand Down