Skip to content

Fixed #2195, improved ConfusionMatrix docs #2196

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

Merged
merged 3 commits into from
Sep 15, 2021
Merged

Fixed #2195, improved ConfusionMatrix docs #2196

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa000ff
Fixed #2195, improved ConfusionMatrix docs
Sep 15, 2021
a411b19
Updated docstring
Sep 15, 2021
d1d5f2b
Merge branch 'master' into fix-docs-2195
vfdev-5 Sep 15, 2021
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
4 changes: 4 additions & 0 deletions ignite/metrics/confusion_matrix.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
class ConfusionMatrix(Metric):
"""Calculates confusion matrix for multi-class data.

The confusion matrix is formatted such that columns are predictions and rows are targets.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's move this details below after the line L67 and use Note: :

Note:
    The confusion matrix is formatted such that columns are predictions and rows are targets.
    For example, if you were to plot the matrix, you could correctly assign to the horizontal axis
    the label "predicted values" and to the vertical axis the label "actual values".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds great! @vfdev-5 , should I do the edit? If yes, how? :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, let's edit the file locally as suggested. Next, commit and push: git commit -a -m "Updated docstring" && git push origin fix-docs-2195

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. Let me know if that's fine.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, IMO looks good now! Thanks for the PR !

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the guidance!

For example, if you were to plot the matrix, you could correctly assign to the horizontal axis
the label "predicted values" and to the vertical axis the label "actual values".

- ``update`` must receive output of the form ``(y_pred, y)`` or ``{'y_pred': y_pred, 'y': y}``.
- `y_pred` must contain logits and has the following shape (batch_size, num_classes, ...).
If you are doing binary classification, see Note for an example on how to get this.
Expand Down