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

[Refactor] Classification 4/n #1151

Merged
merged 24 commits into from
Jul 23, 2022
Merged

[Refactor] Classification 4/n #1151

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
e38cffc
docs
SkafteNicki Jul 18, 2022
ad1de73
update
SkafteNicki Jul 18, 2022
920be5a
hamming
SkafteNicki Jul 18, 2022
8590539
working specificity
SkafteNicki Jul 19, 2022
e83680a
hamming base structure
SkafteNicki Jul 19, 2022
1d36ea8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 19, 2022
47ab387
init files for specificity
SkafteNicki Jul 19, 2022
b241203
done with specificity
SkafteNicki Jul 19, 2022
8e1f2c2
Merge branch 'refactor/classification_4' of https://github.com/PyTorc…
SkafteNicki Jul 19, 2022
74fe5ab
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 19, 2022
cf07f01
bit working hamming
SkafteNicki Jul 20, 2022
36bb2c3
Merge branch 'refactor/classification_4' of https://github.com/PyTorc…
SkafteNicki Jul 20, 2022
4c0db32
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 20, 2022
dcc50fe
working hamming
SkafteNicki Jul 21, 2022
02f0c38
init files
SkafteNicki Jul 21, 2022
8dee9c9
docstring
SkafteNicki Jul 21, 2022
cb1b33b
specificity fix docs
SkafteNicki Jul 22, 2022
a575b3c
fix float division
SkafteNicki Jul 22, 2022
ec07d4d
Merge branch 'devel/classification' into refactor/classification_4
SkafteNicki Jul 22, 2022
c547392
local/global
Borda Jul 22, 2022
864fa35
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 22, 2022
4ff82eb
Apply suggestions from code review
Borda Jul 22, 2022
fefd84a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 22, 2022
130feb0
.
Borda Jul 23, 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
42 changes: 42 additions & 0 deletions docs/source/classification/hamming_distance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,53 @@ Hamming Distance
Module Interface
________________

HammingDistance
^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.HammingDistance
:noindex:

BinaryHammingDistance
^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.BinaryHammingDistance
:noindex:

MulticlassHammingDistance
^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassHammingDistance
:noindex:

MultilabelHammingDistance
^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MultilabelHammingDistance
:noindex:

Functional Interface
____________________

hamming_distance
^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.hamming_distance
:noindex:

binary_hamming_distance
^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_hamming_distance
:noindex:

multiclass_hamming_distance
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_hamming_distance
:noindex:

multilabel_hamming_distance
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multilabel_hamming_distance
:noindex:
37 changes: 37 additions & 0 deletions docs/source/classification/specificity.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,45 @@ ________________
.. autoclass:: torchmetrics.Specificity
:noindex:

BinarySpecificity
^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.BinarySpecificity
:noindex:

MulticlassSpecificity
^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MulticlassSpecificity
:noindex:

MultilabelSpecificity
^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: torchmetrics.MultilabelSpecificity
:noindex:


Functional Interface
____________________

.. autofunction:: torchmetrics.functional.specificity
:noindex:

binary_specificity
^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.binary_specificity
:noindex:

multiclass_specificity
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multiclass_specificity
:noindex:

multilabel_specificity
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: torchmetrics.functional.multilabel_specificity
:noindex:
12 changes: 12 additions & 0 deletions src/torchmetrics/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,12 @@
BinaryConfusionMatrix,
BinaryF1Score,
BinaryFBetaScore,
BinaryHammingDistance,
BinaryJaccardIndex,
BinaryMatthewsCorrCoef,
BinaryPrecision,
BinaryRecall,
BinarySpecificity,
BinaryStatScores,
BinnedAveragePrecision,
BinnedPrecisionRecallCurve,
Expand All @@ -56,18 +58,22 @@
MulticlassConfusionMatrix,
MulticlassF1Score,
MulticlassFBetaScore,
MulticlassHammingDistance,
MulticlassJaccardIndex,
MulticlassMatthewsCorrCoef,
MulticlassPrecision,
MulticlassRecall,
MulticlassSpecificity,
MulticlassStatScores,
MultilabelConfusionMatrix,
MultilabelF1Score,
MultilabelFBetaScore,
MultilabelHammingDistance,
MultilabelJaccardIndex,
MultilabelMatthewsCorrCoef,
MultilabelPrecision,
MultilabelRecall,
MultilabelSpecificity,
MultilabelStatScores,
Precision,
PrecisionRecallCurve,
Expand Down Expand Up @@ -173,6 +179,9 @@
"MulticlassFBetaScore",
"MultilabelFBetaScore",
"HammingDistance",
"BinaryHammingDistance",
"MultilabelHammingDistance",
"MulticlassHammingDistance",
"HingeLoss",
"JaccardIndex",
"BinaryJaccardIndex",
Expand Down Expand Up @@ -231,6 +240,9 @@
"SignalNoiseRatio",
"SpearmanCorrCoef",
"Specificity",
"BinarySpecificity",
"MulticlassSpecificity",
"MultilabelSpecificity",
"SpectralAngleMapper",
"SpectralDistortionIndex",
"SQuAD",
Expand Down
14 changes: 12 additions & 2 deletions src/torchmetrics/classification/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,12 @@
MultilabelF1Score,
MultilabelFBetaScore,
)
from torchmetrics.classification.hamming import HammingDistance # noqa: F401
from torchmetrics.classification.hamming import ( # noqa: F401
BinaryHammingDistance,
HammingDistance,
MulticlassHammingDistance,
MultilabelHammingDistance,
)
from torchmetrics.classification.hinge import HingeLoss # noqa: F401
from torchmetrics.classification.jaccard import ( # noqa: F401
BinaryJaccardIndex,
Expand Down Expand Up @@ -76,4 +81,9 @@
LabelRankingLoss,
)
from torchmetrics.classification.roc import ROC # noqa: F401
from torchmetrics.classification.specificity import Specificity # noqa: F401
from torchmetrics.classification.specificity import ( # noqa: F401
BinarySpecificity,
MulticlassSpecificity,
MultilabelSpecificity,
Specificity,
)
Loading