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.

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

fix typo in specificity_at_sensitivity #2199

Merged
merged 20 commits into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
fix typo of specicity
  • Loading branch information
oguz-hanoglu committed Nov 2, 2023
commit ee58904cbc28ce470d4775e91dbed94c2b2ffc25
4 changes: 2 additions & 2 deletions src/torchmetrics/functional/classification/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@
binary_specificity_at_sensitivity,
multiclass_specificity_at_sensitivity,
multilabel_specificity_at_sensitivity,
specicity_at_sensitivity,
specificity_at_sensitivity,
)
from torchmetrics.functional.classification.stat_scores import (
binary_stat_scores,
Expand Down Expand Up @@ -211,7 +211,7 @@
"binary_specificity_at_sensitivity",
"multiclass_specificity_at_sensitivity",
"multilabel_specificity_at_sensitivity",
"specicity_at_sensitivity",
"specificity_at_sensitivity",
"binary_stat_scores",
"multiclass_stat_scores",
"multilabel_stat_scores",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ def multilabel_specificity_at_sensitivity(
return _multilabel_specificity_at_sensitivity_compute(state, num_labels, thresholds, ignore_index, min_sensitivity)


def specicity_at_sensitivity(
def specificity_at_sensitivity(
preds: Tensor,
target: Tensor,
task: Literal["binary", "multiclass", "multilabel"],
Expand All @@ -414,7 +414,7 @@ def specicity_at_sensitivity(
ignore_index: Optional[int] = None,
validate_args: bool = True,
) -> Union[Tensor, Tuple[Tensor, Tensor, Tensor], Tuple[List[Tensor], List[Tensor], List[Tensor]]]:
r"""Compute the highest possible specicity value given the minimum sensitivity thresholds provided.
r"""Compute the highest possible specificity value given the minimum sensitivity thresholds provided.

This is done by first calculating the Receiver Operating Characteristic (ROC) curve for different thresholds and
the find the specificity for a given sensitivity level.
Expand Down