Skip to content

Adding link to all the metrics #2468

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

Closed
sayantan1410 wants to merge 2 commits into from
Closed

Adding link to all the metrics #2468

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7319e8b
Added link to accuracy module
sayantan1410 Feb 15, 2022
c09bbde
Updated the texts
sayantan1410 Feb 16, 2022
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
2 changes: 2 additions & 0 deletions docs/source/metrics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ ignite.metrics
Metrics provide a way to compute various quantities of interest in an online
fashion without having to store the entire output history of a model.

.. _attach-engine:

Attach Engine API
------------------

Expand Down
3 changes: 3 additions & 0 deletions ignite/metrics/accuracy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ class Accuracy(_BaseClassification):
default, CPU.

Examples:
Here, we first declare the metric which is accuracy in this case, then we attach the metric instance to the
engine ( ``default_evaluator`` here) for a very specific reason which is explained in :ref:`attach-engine`. After that, we run the
engine or the ``default_evaluator`` and print the metric value.

.. include:: defaults.rst
:start-after: :orphan:
Expand Down