[Refactor] Classification 2/n #1143

SkafteNicki · 2022-07-13T09:57:45Z

What does this PR do?

Continues work on classification refactor #1001
Prior work: #1054

This PR takes care of CohenKappa, JaccardIndex and MatthewsCorrCoef which all are subclassed from ConfusionMatrix.

Before submitting

Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
Did you read the contributor guideline, Pull Request section?
Did you make sure to update the docs?
Did you write any new necessary tests?

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 🙃

for more information, see https://pre-commit.ci

…hLightning/metrics into refactor/classification_1

for more information, see https://pre-commit.ci

…hLightning/metrics into refactor/classification_1

for more information, see https://pre-commit.ci

…hLightning/metrics into refactor/classification_1

for more information, see https://pre-commit.ci

docs/source/classification/jaccard_index.rst

src/torchmetrics/classification/cohen_kappa.py

Borda · 2022-07-15T09:31:51Z

src/torchmetrics/classification/jaccard.py

+
+ Accepts the following input tensors:
+
+ - ``preds`` (int or float tensor): ``(N, C, ...)``. If preds is a floating point tensor with values outside


Suggested change

- ``preds`` (int or float tensor): ``(N, C, ...)``. If preds is a floating point tensor with values outside

- ``preds``: ``(N, C, ...)``. If preds is a floating point tensor with values outside

this shall come from function footprint, right so I may skip it...
in case we have it elsewhere, lets prune/simplify in another PR package-wide

Is it clear from the function footprint? That basically just states that this is a tensor.
Maybe it is not as important for multilabel, but for multiclass it is quite important to state this since the dtype is dependent on the shape and vice versa
https://github.com/Lightning-AI/metrics/blob/4c7de2257e4f4b58be6738271d79fa67c505ea9f/src/torchmetrics/classification/jaccard.py#L106-L108

src/torchmetrics/functional/classification/jaccard.py

src/torchmetrics/functional/classification/matthews_corrcoef.py

tests/unittests/classification/test_cohen_kappa.py

* base structure * bincount * binary * files * stat score * multiclass + multilabel confmat * update * stat_score * change bincount * move back * del tests * rest of structure * confmat working * working binary stat scores * full testing * update * update * add missing tests * update * multilabel stat scores * disable old testing * more testing * flaky tests * changelog * refactor * class interface * fixes * typing * update * fix tests * Update src/torchmetrics/functional/classification/confusion_matrix.py * missing literal * add docstring to functional confusion matrix * add docstring to modular confusion matrix * add docstring to functional stat scores * add docstring to modular stat scores * make private * docs * fix mypy and doctests * fix docs formatting * literal backwards * custom movedim * docs * inits * fix * fix mistakes * working cohen kappa * Delete speed.py * cohen kappa done * working matthews * working jaccard * docstrings for jaccard * small improve * typing * fix doctest * try something * Apply suggestions from code review Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Daniel Stancl <46073029+stancld@users.noreply.github.com> Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com> Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>

SkafteNicki and others added 30 commits May 27, 2022 16:05

base structure

7c79801

bincount

121b9fa

binary

1074281

files

4f4dad6

stat score

e58c9a5

multiclass + multilabel confmat

0ba326f

update

85471c4

stat_score

336d277

change bincount

b9fdf6c

move back

e83c30a

del tests

b32000f

rest of structure

6d5ee70

confmat working

dee14cf

[pre-commit.ci] auto fixes from pre-commit.com hooks

b9bd9dc

for more information, see https://pre-commit.ci

working binary stat scores

f1c664d

Merge branch 'refactor/classification_1' of https://github.com/PyTorc…

c824c52

…hLightning/metrics into refactor/classification_1

full testing

a21fc0f

update

f11c1e7

update

5a1495c

[pre-commit.ci] auto fixes from pre-commit.com hooks

f82d807

for more information, see https://pre-commit.ci

add missing tests

c4cfef3

Merge branch 'refactor/classification_1' of https://github.com/PyTorc…

166772e

…hLightning/metrics into refactor/classification_1

update

fe0c12d

[pre-commit.ci] auto fixes from pre-commit.com hooks

5185139

for more information, see https://pre-commit.ci

merge master

9de5dde

Merge branch 'refactor/classification_1' of https://github.com/PyTorc…

45e5fd1

…hLightning/metrics into refactor/classification_1

[pre-commit.ci] auto fixes from pre-commit.com hooks

9bd7e76

for more information, see https://pre-commit.ci

multilabel stat scores

cb5eabf

merge

77a1afe

disable old testing

44df555

SkafteNicki requested review from Borda, justusschock, tchaton, ethanwharris and SeanNaren as code owners July 14, 2022 10:32

SkafteNicki added 2 commits July 14, 2022 12:34

small improve

43a5616

typing

3e814a0

justusschock approved these changes Jul 14, 2022

View reviewed changes

fix doctest

59162f7

SkafteNicki mentioned this pull request Jul 15, 2022

[Refactor] Classification 3/n #1145

Merged

4 tasks

try something

4c7de22

mergify bot added the ready label Jul 15, 2022

Borda reviewed Jul 15, 2022

View reviewed changes

Apply suggestions from code review

2f02092

Borda approved these changes Jul 15, 2022

View reviewed changes

SkafteNicki merged commit 087acad into devel/classification Jul 15, 2022

SkafteNicki deleted the refactor/classification_2 branch July 15, 2022 11:52

This was referenced Jul 19, 2022

[Refactor] Classification 4/n #1151

Merged

[Refactor] Classification 5/n #1159

Merged

This was referenced Jul 28, 2022

[Refactor] Classification 6/n #1163

Merged

[Refactor] Classification 7/n #1167

Merged

SkafteNicki mentioned this pull request Aug 5, 2022

[Refactor] Classification 8/n #1175

Merged

4 tasks

SkafteNicki mentioned this pull request Aug 20, 2022

[Refactor] Classification 9/n #1189

Merged

4 tasks

SkafteNicki mentioned this pull request Aug 28, 2022

Refactor/classification 10 #1197

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Refactor] Classification 2/n #1143

[Refactor] Classification 2/n #1143

SkafteNicki commented Jul 13, 2022 •

edited

Loading

Borda Jul 15, 2022

SkafteNicki Jul 15, 2022


		Accepts the following input tensors:

		- ``preds`` (int or float tensor): ``(N, C, ...)``. If preds is a floating point tensor with values outside

	- ``preds`` (int or float tensor): ``(N, C, ...)``. If preds is a floating point tensor with values outside
	- ``preds``: ``(N, C, ...)``. If preds is a floating point tensor with values outside

[Refactor] Classification 2/n #1143

[Refactor] Classification 2/n #1143

Conversation

SkafteNicki commented Jul 13, 2022 • edited Loading

What does this PR do?

Before submitting

PR review

Did you have fun?

Borda Jul 15, 2022

Choose a reason for hiding this comment

SkafteNicki Jul 15, 2022

Choose a reason for hiding this comment

SkafteNicki commented Jul 13, 2022 •

edited

Loading