Skip to content

Adding link to all the metrics#2468

Closed
sayantan1410 wants to merge 2 commits intopytorch:masterfrom
sayantan1410:doc
Closed

Adding link to all the metrics#2468
sayantan1410 wants to merge 2 commits intopytorch:masterfrom
sayantan1410:doc

Conversation

@sayantan1410
Copy link
Contributor

Fixes #2437
Hey, I have made the changes only for the Accuracy, once it is done correctly I will update it for all the metrics in that style.
Check list:

  • New doc strings: description and/or example code are in RST format

@github-actions github-actions bot added docs module: metrics Metrics module labels Feb 15, 2022
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @sayantan1410 !
Let's now add that all metrics. Can you try to put it into defaults.rst before toggle part ?
cc @DevPranjal

@DevPranjal
Copy link
Contributor

DevPranjal commented Feb 16, 2022

Yes. That would reduce redundancy in the docstrings.

The defaults.rst file is included at the start of examples for almost all the metrics (except those in /ignite/metrics/nlp since we do not need the default setup there)

@sayantan1410
Copy link
Contributor Author

sayantan1410 commented Feb 16, 2022

@vfdev-5 Yeah, I will try to do that

@sayantan1410
Copy link
Contributor Author

Hey, I have done the work related to it in a different PR that is why I am closing this. #2468, this is the extension PR. Extremely sorry for the inconvenience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add an explanation on how metrics work with engine

3 participants