Docs: fix trainer metric definitions #1924
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I think what should be listed here is perhaps a short description which is specifically summarising the meaning of the metrics in the imagery context - then users can lookup torch metrics for more specifics |
|
I'm just afraid that that short description will continue to blow up as people have questions unless we direct them to the torchmetrics docs for details. |
adamjstewart
commented
Mar 3, 2024
github-actions
bot
added
the
documentation
|
The docs rendering looks great, and the links to torchmetrics docs are a nice addition |
The only place we use |
|
I realised that and deleted comment after :) |
isaaccorley
approved these changes
Mar 3, 2024
isaaccorley
pushed a commit
that referenced
this pull request
Mar 3, 2024
* Docs: fix trainer metric definitions * Link to torchmetrics docs * Teach Sphinx where docs live
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #1923
We are nowhere near the limit of how much detail we could have. We can always start adding mathematical equations.
Alternative: why don't we just list the metrics and link to the torchmetrics docs? If a metric isn't properly explained, we can always improve the torchmetrics docs.
@robmarkcole @jdilger