Skip to content
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

Jump to bottom

Refactor/classification 10 #1197

Merged
merged 21 commits into from
Sep 12, 2022
Merged

Refactor/classification 10 #1197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
2b63edf
example
SkafteNicki Aug 28, 2022
758dd18
stat scores
SkafteNicki Aug 28, 2022
7bb1f9d
revert
SkafteNicki Aug 28, 2022
00d97a2
remove old tests
SkafteNicki Aug 31, 2022
955f29e
deprecate binned
SkafteNicki Aug 31, 2022
8c87e67
remove init
SkafteNicki Sep 6, 2022
6bf873f
Merge branch 'devel/classification' into refactor/classification_10
SkafteNicki Sep 6, 2022
6d72e4b
Merge branch 'refactor/classification_10' of https://github.com/PyTor…
SkafteNicki Sep 6, 2022
bfb60aa
warning functionals
SkafteNicki Sep 7, 2022
684ff19
docs update
SkafteNicki Sep 7, 2022
6ab3f93
add __new__ for class wrapping
SkafteNicki Sep 7, 2022
367dd66
update imports in docstrings
SkafteNicki Sep 8, 2022
8681e66
fix one mistake
SkafteNicki Sep 8, 2022
f38f072
fix doctests
SkafteNicki Sep 8, 2022
18a9bdd
Apply suggestions from code review
Borda Sep 9, 2022
dacf9af
elif
Borda Sep 9, 2022
5b4edd0
kwargs
Borda Sep 9, 2022
37f7b5b
kwargs + elif
Borda Sep 9, 2022
e24d2b0
text
Borda Sep 9, 2022
72e89e9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 9, 2022
84c4f1d
fix gpu testing
SkafteNicki Sep 9, 2022
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
14 changes: 7 additions & 7 deletions docs/source/classification/accuracy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,41 +16,41 @@ ________________
BinaryAccuracy
^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.BinaryAccuracy
.. autoclass:: torchmetrics.classification.BinaryAccuracy
:noindex:

MulticlassAccuracy
^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassAccuracy
.. autoclass:: torchmetrics.classification.MulticlassAccuracy
:noindex:

MultilabelAccuracy
^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MultilabelAccuracy
.. autoclass:: torchmetrics.classification.MultilabelAccuracy
:noindex:

Functional Interface
____________________

.. autofunction:: torchmetrics.functional.accuracy
.. autofunction:: torchmetrics.functional.classification.accuracy
:noindex:

binary_accuracy
^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_accuracy
.. autofunction:: torchmetrics.functional.classification.binary_accuracy
:noindex:

multiclass_accuracy
^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_accuracy
.. autofunction:: torchmetrics.functional.classification.multiclass_accuracy
:noindex:

multilabel_accuracy
^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multilabel_accuracy
.. autofunction:: torchmetrics.functional.classification.multilabel_accuracy
:noindex:
12 changes: 6 additions & 6 deletions docs/source/classification/auroc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ ________________
BinaryAUROC
^^^^^^^^^^^

.. autoclass:: torchmetrics.BinaryAUROC
.. autoclass:: torchmetrics.classification.BinaryAUROC
:noindex:

MulticlassAUROC
^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassAUROC
.. autoclass:: torchmetrics.classification.MulticlassAUROC
:noindex:

MultilabelAUROC
^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MultilabelAUROC
.. autoclass:: torchmetrics.classification.MultilabelAUROC
:noindex:

Functional Interface
Expand All @@ -42,17 +42,17 @@ ____________________
binary_auroc
^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_auroc
.. autofunction:: torchmetrics.functional.classification.binary_auroc
:noindex:

multiclass_auroc
^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_auroc
.. autofunction:: torchmetrics.functional.classification.multiclass_auroc
:noindex:

multilabel_auroc
^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multilabel_auroc
.. autofunction:: torchmetrics.functional.classification.multilabel_auroc
:noindex:
12 changes: 6 additions & 6 deletions docs/source/classification/average_precision.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ ________________
BinaryAveragePrecision
^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.BinaryAveragePrecision
.. autoclass:: torchmetrics.classification.BinaryAveragePrecision
:noindex:

MulticlassAveragePrecision
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassAveragePrecision
.. autoclass:: torchmetrics.classification.MulticlassAveragePrecision
:noindex:

MultilabelAveragePrecision
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MultilabelAveragePrecision
.. autoclass:: torchmetrics.classification.MultilabelAveragePrecision
:noindex:

Functional Interface
Expand All @@ -40,17 +40,17 @@ ____________________
binary_average_precision
^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_average_precision
.. autofunction:: torchmetrics.functional.classification.binary_average_precision
:noindex:

multiclass_average_precision
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_average_precision
.. autofunction:: torchmetrics.functional.classification.multiclass_average_precision
:noindex:

multilabel_average_precision
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multilabel_average_precision
.. autofunction:: torchmetrics.functional.classification.multilabel_average_precision
:noindex:
8 changes: 4 additions & 4 deletions docs/source/classification/calibration_error.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ ________________
BinaryCalibrationError
^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.BinaryCalibrationError
.. autoclass:: torchmetrics.classification.BinaryCalibrationError
:noindex:

MulticlassCalibrationError
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassCalibrationError
.. autoclass:: torchmetrics.classification.MulticlassCalibrationError
:noindex:

Functional Interface
Expand All @@ -36,11 +36,11 @@ ____________________
binary_calibration_error
^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_calibration_error
.. autofunction:: torchmetrics.functional.classification.binary_calibration_error
:noindex:

multiclass_calibration_error
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_calibration_error
.. autofunction:: torchmetrics.functional.classification.multiclass_calibration_error
:noindex:
8 changes: 4 additions & 4 deletions docs/source/classification/cohen_kappa.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ CohenKappa
BinaryCohenKappa
^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.BinaryCohenKappa
.. autoclass:: torchmetrics.classification.BinaryCohenKappa
:noindex:
:exclude-members: update, compute

MulticlassCohenKappa
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassCohenKappa
.. autoclass:: torchmetrics.classification.MulticlassCohenKappa
:noindex:
:exclude-members: update, compute

Expand All @@ -44,11 +44,11 @@ cohen_kappa
binary_cohen_kappa
^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_cohen_kappa
.. autofunction:: torchmetrics.functional.classification.binary_cohen_kappa
:noindex:

multiclass_cohen_kappa
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_cohen_kappa
.. autofunction:: torchmetrics.functional.classification.multiclass_cohen_kappa
:noindex:
15 changes: 6 additions & 9 deletions docs/source/classification/confusion_matrix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,20 @@ ConfusionMatrix
BinaryConfusionMatrix
^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.BinaryConfusionMatrix
.. autoclass:: torchmetrics.classification.BinaryConfusionMatrix
:noindex:
:exclude-members: update, compute

MulticlassConfusionMatrix
^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassConfusionMatrix
.. autoclass:: torchmetrics.classification.MulticlassConfusionMatrix
:noindex:
:exclude-members: update, compute

MultilabelConfusionMatrix
^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MultilabelConfusionMatrix
.. autoclass:: torchmetrics.classification.MultilabelConfusionMatrix
:noindex:
:exclude-members: update, compute

Functional Interface
____________________
Expand All @@ -51,17 +48,17 @@ confusion_matrix
binary_confusion_matrix
^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_confusion_matrix
.. autofunction:: torchmetrics.functional.classification.binary_confusion_matrix
:noindex:

multiclass_confusion_matrix
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_confusion_matrix
.. autofunction:: torchmetrics.functional.classification.multiclass_confusion_matrix
:noindex:

multilabel_confusion_matrix
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multilabel_confusion_matrix
.. autofunction:: torchmetrics.functional.classification.multilabel_confusion_matrix
:noindex:
4 changes: 2 additions & 2 deletions docs/source/classification/coverage_error.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ________________
.. autoclass:: torchmetrics.CoverageError
:noindex:

.. autoclass:: torchmetrics.MultilabelCoverageError
.. autoclass:: torchmetrics.classification.MultilabelCoverageError
:noindex:

Functional Interface
Expand All @@ -22,5 +22,5 @@ ____________________
.. autofunction:: torchmetrics.functional.coverage_error
:noindex:

.. autofunction:: torchmetrics.functional.multilabel_coverage_error
.. autofunction:: torchmetrics.functional.classification.multilabel_coverage_error
:noindex:
4 changes: 2 additions & 2 deletions docs/source/classification/exact_match.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ________________
MultilabelExactMatch
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MultilabelExactMatch
.. autoclass:: torchmetrics.classification.MultilabelExactMatch
:noindex:

Functional Interface
Expand All @@ -22,5 +22,5 @@ ____________________
multilabel_exact_match
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multilabel_exact_match
.. autofunction:: torchmetrics.functional.classification.multilabel_exact_match
:noindex:
12 changes: 6 additions & 6 deletions docs/source/classification/f1_score.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ F1Score
BinaryF1Score
^^^^^^^^^^^^^

.. autoclass:: torchmetrics.BinaryF1Score
.. autoclass:: torchmetrics.classification.BinaryF1Score
:noindex:

MulticlassF1Score
^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassF1Score
.. autoclass:: torchmetrics.classification.MulticlassF1Score
:noindex:

MultilabelF1Score
^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MultilabelF1Score
.. autoclass:: torchmetrics.classification.MultilabelF1Score
:noindex:

Functional Interface
Expand All @@ -46,17 +46,17 @@ f1_score
binary_f1_score
^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_f1_score
.. autofunction:: torchmetrics.functional.classification.binary_f1_score
:noindex:

multiclass_f1_score
^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_f1_score
.. autofunction:: torchmetrics.functional.classification.multiclass_f1_score
:noindex:

multilabel_f1_score
^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multilabel_f1_score
.. autofunction:: torchmetrics.functional.classification.multilabel_f1_score
:noindex:
12 changes: 6 additions & 6 deletions docs/source/classification/fbeta_score.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ FBetaScore
BinaryFBetaScore
^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.BinaryFBetaScore
.. autoclass:: torchmetrics.classification.BinaryFBetaScore
:noindex:

MulticlassFBetaScore
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassFBetaScore
.. autoclass:: torchmetrics.classification.MulticlassFBetaScore
:noindex:

MultilabelFBetaScore
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MultilabelFBetaScore
.. autoclass:: torchmetrics.classification.MultilabelFBetaScore
:noindex:

Functional Interface
Expand All @@ -48,17 +48,17 @@ fbeta_score
binary_fbeta_score
^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_fbeta_score
.. autofunction:: torchmetrics.functional.classification.binary_fbeta_score
:noindex:

multiclass_fbeta_score
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_fbeta_score
.. autofunction:: torchmetrics.functional.classification.multiclass_fbeta_score
:noindex:

multilabel_fbeta_score
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multilabel_fbeta_score
.. autofunction:: torchmetrics.functional.classification.multilabel_fbeta_score
:noindex:
Loading