Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Fixes #865
Currently #1916 is blocked because we currently cannot reference our own metrics in our own docs due to the use of
:noindex:
. I propose that we remove the:noindex:
from docs. The reason it is there as far as I am aware is to not have double entries when searching for something.This is also true. Currently with
:noindex:
a search forBinaryAccuracy
looks likewithout
:noindex:
it would look like:I think it would not be too destructive to have multiple of the same search results if we compare with the benefit that we can begin to actually reference our own metrics in the docs. This change also solves the linked issue, such that others can cross-reference torchmetrics in their own documentation.
Before submitting
PR review
Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
Did you have fun?
Make sure you had fun coding 🙃
📚 Documentation preview 📚: https://torchmetrics--1998.org.readthedocs.build/en/1998/