Related to #2114: reformat docstrings in the 'metrics' folder #2221
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
toxa23
changed the title
|
There is an error with code formatting, we use flake8, black, and isort, please check the formatting part in our contribution guide. |
ignite/metrics/accuracy.py
Outdated
| @@ -105,18 +105,7 @@ class Accuracy(_BaseClassification): | |||
| - `y` and `y_pred` must be in the following shape of (batch_size, num_categories, ...) and | |||
| num_categories must be greater than 1 for multilabel cases. | |||
|
|
|||
| In binary and multilabel cases, the elements of `y` and `y_pred` should have 0 or 1 values. Thresholding of | |||
There was a problem hiding this comment.
I don't agree with splitting this part, this line and the example should stay close IMO, what do you think @vfdev-5?
There was a problem hiding this comment.
Thanks @KickItLikeShika , yes, I agree with your comment. @toxa23 let's not split this part
KickItLikeShika
approved these changes
Sep 28, 2021
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.
Related to #2114
Description:
part 6 of 7, reformat docstrings in the 'metrics' folder, make sure all examples have "Examples:" header, move "Args:" block to the top of method documentation
Check list: