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

Fix the dice metric. Incorrect anotation #1684

Merged
merged 5 commits into from
Apr 4, 2023
Merged

Fix the dice metric. Incorrect anotation #1684

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6a7bc1d
Fix the dice metric. Incorrect anotation
YeaMerci Apr 3, 2023
c3263fa
Merge branch 'master' into bugfix/dice
Borda Apr 3, 2023
a53ba82
Merge branch 'master' into bugfix/dice
Borda Apr 4, 2023
5ed978e
Merge branch 'master' into bugfix/dice
mergify[bot] Apr 4, 2023
b88c8d7
Merge branch 'master' into bugfix/dice
mergify[bot] Apr 4, 2023
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
8 changes: 4 additions & 4 deletions src/torchmetrics/classification/dice.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ class Dice(Metric):

Args:
num_classes:
Number of classes. Necessary for ``'macro'``, ``'weighted'`` and ``None`` average methods.
Number of classes. Necessary for ``'macro'``, and ``None`` average methods.
threshold:
Threshold for transforming probability or logit predictions to binary (0,1) predictions, in the case
of binary or multi-label inputs. Default value of 0.5 corresponds to input being probabilities.
Expand Down Expand Up @@ -116,7 +116,7 @@ class Dice(Metric):

Raises:
ValueError:
If ``average`` is none of ``"micro"``, ``"macro"``, ``"weighted"``, ``"samples"``, ``"none"``, ``None``.
If ``average`` is none of ``"micro"``, ``"macro"``, ``"samples"``, ``"none"``, ``None``.
ValueError:
If ``mdmc_average`` is not one of ``None``, ``"samplewise"``, ``"global"``.
ValueError:
Expand Down Expand Up @@ -146,15 +146,15 @@ def __init__(
zero_division: int = 0,
num_classes: Optional[int] = None,
threshold: float = 0.5,
average: Optional[Literal["micro", "macro", "weighted", "none"]] = "micro",
average: Optional[Literal["micro", "macro", "none"]] = "micro",
mdmc_average: Optional[str] = "global",
ignore_index: Optional[int] = None,
top_k: Optional[int] = None,
multiclass: Optional[bool] = None,
**kwargs: Any,
) -> None:
super().__init__(**kwargs)
allowed_average = ("micro", "macro", "weighted", "samples", "none", None)
allowed_average = ("micro", "macro", "samples", "none", None)
if average not in allowed_average:
raise ValueError(f"The `average` has to be one of {allowed_average}, got {average}.")

Expand Down