Shortcuts

F-1 Score¶

Module Interface¶

F1Score¶

class torchmetrics.F1Score(task: Literal['binary', 'multiclass', 'multilabel'], threshold: float = 0.5, num_classes: = None, num_labels: = None, average: Optional[Literal['micro', 'macro', 'weighted', 'none']] = 'micro', multidim_average: Optional[Literal['global', 'samplewise']] = 'global', top_k: = 1, ignore_index: = None, validate_args: bool = True, **kwargs: Any)[source]

Computes F-1 score:

This function is a simple wrapper to get the task specific versions of this metric, which is done by setting the task argument to either 'binary', 'multiclass' or multilabel. See the documentation of BinaryF1Score, MulticlassF1Score and MultilabelF1Score for the specific details of each argument influence and examples.

Legacy Example:
>>> import torch
>>> target = torch.tensor([0, 1, 2, 0, 1, 2])
>>> preds = torch.tensor([0, 2, 1, 0, 0, 1])
>>> f1(preds, target)
tensor(0.3333)


BinaryF1Score¶

class torchmetrics.classification.BinaryF1Score(threshold=0.5, multidim_average='global', ignore_index=None, validate_args=True, **kwargs)[source]

Computes F-1 score for binary tasks:

As input to forward and update the metric accepts the following input:

• preds (Tensor): An int or float tensor of shape (N, ...). If preds is a floating point tensor with values outside [0,1] range we consider the input to be logits and will auto apply sigmoid per element. Addtionally, we convert to int tensor with thresholding using the value in threshold.

• target (Tensor): An int tensor of shape (N, ...)

As output to forward and compute the metric returns the following output:

• bf1s (Tensor): A tensor whose returned shape depends on the multidim_average argument:

• If multidim_average is set to global, the metric returns a scalar value.

• If multidim_average is set to samplewise, the metric returns (N,) vector consisting of a scalar value per sample.

Parameters
• threshold (float) – Threshold for transforming probability to binary {0,1} predictions

• multidim_average (Literal[‘global’, ‘samplewise’]) –

Defines how additionally dimensions ... should be handled. Should be one of the following:

• global: Additional dimensions are flatted along the batch dimension

• samplewise: Statistic will be calculated independently for each sample on the N axis. The statistics in this case are calculated over the additional dimensions.

• ignore_index (Optional[int]) – Specifies a target value that is ignored and does not contribute to the metric calculation

• validate_args (bool) – bool indicating if input arguments and tensors should be validated for correctness. Set to False for faster computations.

Example (preds is int tensor):
>>> from torchmetrics.classification import BinaryF1Score
>>> target = torch.tensor([0, 1, 0, 1, 0, 1])
>>> preds = torch.tensor([0, 0, 1, 1, 0, 1])
>>> metric = BinaryF1Score()
>>> metric(preds, target)
tensor(0.6667)

Example (preds is float tensor):
>>> from torchmetrics.classification import BinaryF1Score
>>> target = torch.tensor([0, 1, 0, 1, 0, 1])
>>> preds = torch.tensor([0.11, 0.22, 0.84, 0.73, 0.33, 0.92])
>>> metric = BinaryF1Score()
>>> metric(preds, target)
tensor(0.6667)

Example (multidim tensors):
>>> from torchmetrics.classification import BinaryF1Score
>>> target = torch.tensor([[[0, 1], [1, 0], [0, 1]], [[1, 1], [0, 0], [1, 0]]])
>>> preds = torch.tensor(
...     [
...         [[0.59, 0.91], [0.91, 0.99], [0.63, 0.04]],
...         [[0.38, 0.04], [0.86, 0.780], [0.45, 0.37]],
...     ]
... )
>>> metric = BinaryF1Score(multidim_average='samplewise')
>>> metric(preds, target)
tensor([0.5000, 0.0000])


Initializes internal Module state, shared by both nn.Module and ScriptModule.

MulticlassF1Score¶

class torchmetrics.classification.MulticlassF1Score(num_classes, top_k=1, average='macro', multidim_average='global', ignore_index=None, validate_args=True, **kwargs)[source]

Computes F-1 score for multiclass tasks:

As input to forward and update the metric accepts the following input:

• preds (Tensor): An int tensor of shape (N, ...) or float tensor of shape (N, C, ..). If preds is a floating point we apply torch.argmax along the C dimension to automatically convert probabilities/logits into an int tensor.

• target (Tensor): An int tensor of shape (N, ...)

As output to forward and compute the metric returns the following output:

• mcf1s (Tensor): A tensor whose returned shape depends on the average and multidim_average arguments:

• If multidim_average is set to global:

• If average='micro'/'macro'/'weighted', the output will be a scalar tensor

• If average=None/'none', the shape will be (C,)

• If multidim_average is set to samplewise:

• If average='micro'/'macro'/'weighted', the shape will be (N,)

• If average=None/'none', the shape will be (N, C)

Parameters
• preds – Tensor with predictions

• target – Tensor with true labels

• num_classes (int) – Integer specifing the number of classes

• average (Optional[Literal[‘micro’, ‘macro’, ‘weighted’, ‘none’]]) –

Defines the reduction that is applied over labels. Should be one of the following:

• micro: Sum statistics over all labels

• macro: Calculate statistics for each label and average them

• weighted: Calculates statistics for each label and computes weighted average using their support

• "none" or None: Calculates statistic for each label and applies no reduction

• top_k (int) – Number of highest probability or logit score predictions considered to find the correct label. Only works when preds contain probabilities/logits.

• multidim_average (Literal[‘global’, ‘samplewise’]) –

Defines how additionally dimensions ... should be handled. Should be one of the following:

• global: Additional dimensions are flatted along the batch dimension

• samplewise: Statistic will be calculated independently for each sample on the N axis. The statistics in this case are calculated over the additional dimensions.

• ignore_index (Optional[int]) – Specifies a target value that is ignored and does not contribute to the metric calculation

• validate_args (bool) – bool indicating if input arguments and tensors should be validated for correctness. Set to False for faster computations.

Example (preds is int tensor):
>>> from torchmetrics.classification import MulticlassF1Score
>>> target = torch.tensor([2, 1, 0, 0])
>>> preds = torch.tensor([2, 1, 0, 1])
>>> metric = MulticlassF1Score(num_classes=3)
>>> metric(preds, target)
tensor(0.7778)
>>> mcf1s = MulticlassF1Score(num_classes=3, average=None)
>>> mcf1s(preds, target)
tensor([0.6667, 0.6667, 1.0000])

Example (preds is float tensor):
>>> from torchmetrics.classification import MulticlassF1Score
>>> target = torch.tensor([2, 1, 0, 0])
>>> preds = torch.tensor([
...   [0.16, 0.26, 0.58],
...   [0.22, 0.61, 0.17],
...   [0.71, 0.09, 0.20],
...   [0.05, 0.82, 0.13],
... ])
>>> metric = MulticlassF1Score(num_classes=3)
>>> metric(preds, target)
tensor(0.7778)
>>> mcf1s = MulticlassF1Score(num_classes=3, average=None)
>>> mcf1s(preds, target)
tensor([0.6667, 0.6667, 1.0000])

Example (multidim tensors):
>>> from torchmetrics.classification import MulticlassF1Score
>>> target = torch.tensor([[[0, 1], [2, 1], [0, 2]], [[1, 1], [2, 0], [1, 2]]])
>>> preds = torch.tensor([[[0, 2], [2, 0], [0, 1]], [[2, 2], [2, 1], [1, 0]]])
>>> metric = MulticlassF1Score(num_classes=3, multidim_average='samplewise')
>>> metric(preds, target)
tensor([0.4333, 0.2667])
>>> mcf1s = MulticlassF1Score(num_classes=3, multidim_average='samplewise', average=None)
>>> mcf1s(preds, target)
tensor([[0.8000, 0.0000, 0.5000],
[0.0000, 0.4000, 0.4000]])


Initializes internal Module state, shared by both nn.Module and ScriptModule.

MultilabelF1Score¶

class torchmetrics.classification.MultilabelF1Score(num_labels, threshold=0.5, average='macro', multidim_average='global', ignore_index=None, validate_args=True, **kwargs)[source]

Computes F-1 score for multilabel tasks:

As input to forward and update the metric accepts the following input:

• preds (Tensor): An int or float tensor of shape (N, C, ...). If preds is a floating point tensor with values outside [0,1] range we consider the input to be logits and will auto apply sigmoid per element. Addtionally, we convert to int tensor with thresholding using the value in threshold.

• target (Tensor): An int tensor of shape (N, C, ...).

As output to forward and compute the metric returns the following output:

• mlf1s (Tensor): A tensor whose returned shape depends on the average and multidim_average arguments:

• If multidim_average is set to global:

• If average='micro'/'macro'/'weighted', the output will be a scalar tensor

• If average=None/'none', the shape will be (C,)

• If multidim_average is set to samplewise:

• If average='micro'/'macro'/'weighted', the shape will be (N,)

• If average=None/'none', the shape will be (N, C)

Parameters
• num_labels (int) – Integer specifing the number of labels

• threshold (float) – Threshold for transforming probability to binary (0,1) predictions

• average (Optional[Literal[‘micro’, ‘macro’, ‘weighted’, ‘none’]]) –

Defines the reduction that is applied over labels. Should be one of the following:

• micro: Sum statistics over all labels

• macro: Calculate statistics for each label and average them

• weighted: Calculates statistics for each label and computes weighted average using their support

• "none" or None: Calculates statistic for each label and applies no reduction

• multidim_average (Literal[‘global’, ‘samplewise’]) –

Defines how additionally dimensions ... should be handled. Should be one of the following:

• global: Additional dimensions are flatted along the batch dimension

• samplewise: Statistic will be calculated independently for each sample on the N axis. The statistics in this case are calculated over the additional dimensions.

• ignore_index (Optional[int]) – Specifies a target value that is ignored and does not contribute to the metric calculation

• validate_args (bool) – bool indicating if input arguments and tensors should be validated for correctness. Set to False for faster computations.

Example (preds is int tensor):
>>> from torchmetrics.classification import MultilabelF1Score
>>> target = torch.tensor([[0, 1, 0], [1, 0, 1]])
>>> preds = torch.tensor([[0, 0, 1], [1, 0, 1]])
>>> metric = MultilabelF1Score(num_labels=3)
>>> metric(preds, target)
tensor(0.5556)
>>> mlf1s = MultilabelF1Score(num_labels=3, average=None)
>>> mlf1s(preds, target)
tensor([1.0000, 0.0000, 0.6667])

Example (preds is float tensor):
>>> from torchmetrics.classification import MultilabelF1Score
>>> target = torch.tensor([[0, 1, 0], [1, 0, 1]])
>>> preds = torch.tensor([[0.11, 0.22, 0.84], [0.73, 0.33, 0.92]])
>>> metric = MultilabelF1Score(num_labels=3)
>>> metric(preds, target)
tensor(0.5556)
>>> mlf1s = MultilabelF1Score(num_labels=3, average=None)
>>> mlf1s(preds, target)
tensor([1.0000, 0.0000, 0.6667])

Example (multidim tensors):
>>> from torchmetrics.classification import MultilabelF1Score
>>> target = torch.tensor([[[0, 1], [1, 0], [0, 1]], [[1, 1], [0, 0], [1, 0]]])
>>> preds = torch.tensor(
...     [
...         [[0.59, 0.91], [0.91, 0.99], [0.63, 0.04]],
...         [[0.38, 0.04], [0.86, 0.780], [0.45, 0.37]],
...     ]
... )
>>> metric = MultilabelF1Score(num_labels=3, multidim_average='samplewise')
>>> metric(preds, target)
tensor([0.4444, 0.0000])
>>> mlf1s = MultilabelF1Score(num_labels=3, multidim_average='samplewise', average=None)
>>> mlf1s(preds, target)
tensor([[0.6667, 0.6667, 0.0000],
[0.0000, 0.0000, 0.0000]])


Initializes internal Module state, shared by both nn.Module and ScriptModule.

Functional Interface¶

f1_score¶

torchmetrics.functional.f1_score(preds, target, task, threshold=0.5, num_classes=None, num_labels=None, average='micro', multidim_average='global', top_k=1, ignore_index=None, validate_args=True)[source]

Computes F-1 score:

This function is a simple wrapper to get the task specific versions of this metric, which is done by setting the task argument to either 'binary', 'multiclass' or multilabel. See the documentation of binary_f1_score(), multiclass_f1_score() and multilabel_f1_score() for the specific details of each argument influence and examples.

Legacy Example:
>>> target = torch.tensor([0, 1, 2, 0, 1, 2])
>>> preds = torch.tensor([0, 2, 1, 0, 0, 1])
tensor(0.3333)

Return type

Tensor

binary_f1_score¶

torchmetrics.functional.classification.binary_f1_score(preds, target, threshold=0.5, multidim_average='global', ignore_index=None, validate_args=True)[source]

Computes F-1 score for binary tasks:

Accepts the following input tensors:

• preds (int or float tensor): (N, ...). If preds is a floating point tensor with values outside [0,1] range we consider the input to be logits and will auto apply sigmoid per element. Addtionally, we convert to int tensor with thresholding using the value in threshold.

• target (int tensor): (N, ...)

Parameters
• preds (Tensor) – Tensor with predictions

• target (Tensor) – Tensor with true labels

• threshold (float) – Threshold for transforming probability to binary {0,1} predictions

• multidim_average (Literal[‘global’, ‘samplewise’]) –

Defines how additionally dimensions ... should be handled. Should be one of the following:

• global: Additional dimensions are flatted along the batch dimension

• samplewise: Statistic will be calculated independently for each sample on the N axis. The statistics in this case are calculated over the additional dimensions.

• ignore_index (Optional[int]) – Specifies a target value that is ignored and does not contribute to the metric calculation

• validate_args (bool) – bool indicating if input arguments and tensors should be validated for correctness. Set to False for faster computations.

Return type

Tensor

Returns

If multidim_average is set to global, the metric returns a scalar value. If multidim_average is set to samplewise, the metric returns (N,) vector consisting of a scalar value per sample.

Example (preds is int tensor):
>>> from torchmetrics.functional.classification import binary_f1_score
>>> target = torch.tensor([0, 1, 0, 1, 0, 1])
>>> preds = torch.tensor([0, 0, 1, 1, 0, 1])
>>> binary_f1_score(preds, target)
tensor(0.6667)

Example (preds is float tensor):
>>> from torchmetrics.functional.classification import binary_f1_score
>>> target = torch.tensor([0, 1, 0, 1, 0, 1])
>>> preds = torch.tensor([0.11, 0.22, 0.84, 0.73, 0.33, 0.92])
>>> binary_f1_score(preds, target)
tensor(0.6667)

Example (multidim tensors):
>>> from torchmetrics.functional.classification import binary_f1_score
>>> target = torch.tensor([[[0, 1], [1, 0], [0, 1]], [[1, 1], [0, 0], [1, 0]]])
>>> preds = torch.tensor(
...     [
...         [[0.59, 0.91], [0.91, 0.99], [0.63, 0.04]],
...         [[0.38, 0.04], [0.86, 0.780], [0.45, 0.37]],
...     ]
... )
>>> binary_f1_score(preds, target, multidim_average='samplewise')
tensor([0.5000, 0.0000])


multiclass_f1_score¶

torchmetrics.functional.classification.multiclass_f1_score(preds, target, num_classes, average='macro', top_k=1, multidim_average='global', ignore_index=None, validate_args=True)[source]

Computes F-1 score for multiclass tasks:

Accepts the following input tensors:

• preds: (N, ...) (int tensor) or (N, C, ..) (float tensor). If preds is a floating point we apply torch.argmax along the C dimension to automatically convert probabilities/logits into an int tensor.

• target (int tensor): (N, ...)

Parameters
• preds (Tensor) – Tensor with predictions

• target (Tensor) – Tensor with true labels

• num_classes (int) – Integer specifing the number of classes

• average (Optional[Literal[‘micro’, ‘macro’, ‘weighted’, ‘none’]]) –

Defines the reduction that is applied over labels. Should be one of the following:

• micro: Sum statistics over all labels

• macro: Calculate statistics for each label and average them

• weighted: Calculates statistics for each label and computes weighted average using their support

• "none" or None: Calculates statistic for each label and applies no reduction

• top_k (int) – Number of highest probability or logit score predictions considered to find the correct label. Only works when preds contain probabilities/logits.

• multidim_average (Literal[‘global’, ‘samplewise’]) –

Defines how additionally dimensions ... should be handled. Should be one of the following:

• global: Additional dimensions are flatted along the batch dimension

• samplewise: Statistic will be calculated independently for each sample on the N axis. The statistics in this case are calculated over the additional dimensions.

• ignore_index (Optional[int]) – Specifies a target value that is ignored and does not contribute to the metric calculation

• validate_args (bool) – bool indicating if input arguments and tensors should be validated for correctness. Set to False for faster computations.

Returns

• If multidim_average is set to global:

• If average='micro'/'macro'/'weighted', the output will be a scalar tensor

• If average=None/'none', the shape will be (C,)

• If multidim_average is set to samplewise:

• If average='micro'/'macro'/'weighted', the shape will be (N,)

• If average=None/'none', the shape will be (N, C)

Return type

The returned shape depends on the average and multidim_average arguments

Example (preds is int tensor):
>>> from torchmetrics.functional.classification import multiclass_f1_score
>>> target = torch.tensor([2, 1, 0, 0])
>>> preds = torch.tensor([2, 1, 0, 1])
>>> multiclass_f1_score(preds, target, num_classes=3)
tensor(0.7778)
>>> multiclass_f1_score(preds, target, num_classes=3, average=None)
tensor([0.6667, 0.6667, 1.0000])

Example (preds is float tensor):
>>> from torchmetrics.functional.classification import multiclass_f1_score
>>> target = torch.tensor([2, 1, 0, 0])
>>> preds = torch.tensor([
...   [0.16, 0.26, 0.58],
...   [0.22, 0.61, 0.17],
...   [0.71, 0.09, 0.20],
...   [0.05, 0.82, 0.13],
... ])
>>> multiclass_f1_score(preds, target, num_classes=3)
tensor(0.7778)
>>> multiclass_f1_score(preds, target, num_classes=3, average=None)
tensor([0.6667, 0.6667, 1.0000])

Example (multidim tensors):
>>> from torchmetrics.functional.classification import multiclass_f1_score
>>> target = torch.tensor([[[0, 1], [2, 1], [0, 2]], [[1, 1], [2, 0], [1, 2]]])
>>> preds = torch.tensor([[[0, 2], [2, 0], [0, 1]], [[2, 2], [2, 1], [1, 0]]])
>>> multiclass_f1_score(preds, target, num_classes=3, multidim_average='samplewise')
tensor([0.4333, 0.2667])
>>> multiclass_f1_score(preds, target, num_classes=3, multidim_average='samplewise', average=None)
tensor([[0.8000, 0.0000, 0.5000],
[0.0000, 0.4000, 0.4000]])


multilabel_f1_score¶

torchmetrics.functional.classification.multilabel_f1_score(preds, target, num_labels, threshold=0.5, average='macro', multidim_average='global', ignore_index=None, validate_args=True)[source]

Computes F-1 score for multilabel tasks:

Accepts the following input tensors:

• preds (int or float tensor): (N, C, ...). If preds is a floating point tensor with values outside [0,1] range we consider the input to be logits and will auto apply sigmoid per element. Addtionally, we convert to int tensor with thresholding using the value in threshold.

• target (int tensor): (N, C, ...)

Parameters
• preds (Tensor) – Tensor with predictions

• target (Tensor) – Tensor with true labels

• num_labels (int) – Integer specifing the number of labels

• threshold (float) – Threshold for transforming probability to binary (0,1) predictions

• average (Optional[Literal[‘micro’, ‘macro’, ‘weighted’, ‘none’]]) –

Defines the reduction that is applied over labels. Should be one of the following:

• micro: Sum statistics over all labels

• macro: Calculate statistics for each label and average them

• weighted: Calculates statistics for each label and computes weighted average using their support

• "none" or None: Calculates statistic for each label and applies no reduction

• multidim_average (Literal[‘global’, ‘samplewise’]) –

Defines how additionally dimensions ... should be handled. Should be one of the following:

• global: Additional dimensions are flatted along the batch dimension

• samplewise: Statistic will be calculated independently for each sample on the N axis. The statistics in this case are calculated over the additional dimensions.

• ignore_index (Optional[int]) – Specifies a target value that is ignored and does not contribute to the metric calculation

• validate_args (bool) – bool indicating if input arguments and tensors should be validated for correctness. Set to False for faster computations.

Returns

• If multidim_average is set to global:

• If average='micro'/'macro'/'weighted', the output will be a scalar tensor

• If average=None/'none', the shape will be (C,)

• If multidim_average is set to samplewise:

• If average='micro'/'macro'/'weighted', the shape will be (N,)

• If average=None/'none', the shape will be (N, C)

Return type

The returned shape depends on the average and multidim_average arguments

Example (preds is int tensor):
>>> from torchmetrics.functional.classification import multilabel_f1_score
>>> target = torch.tensor([[0, 1, 0], [1, 0, 1]])
>>> preds = torch.tensor([[0, 0, 1], [1, 0, 1]])
>>> multilabel_f1_score(preds, target, num_labels=3)
tensor(0.5556)
>>> multilabel_f1_score(preds, target, num_labels=3, average=None)
tensor([1.0000, 0.0000, 0.6667])

Example (preds is float tensor):
>>> from torchmetrics.functional.classification import multilabel_f1_score
>>> target = torch.tensor([[0, 1, 0], [1, 0, 1]])
>>> preds = torch.tensor([[0.11, 0.22, 0.84], [0.73, 0.33, 0.92]])
>>> multilabel_f1_score(preds, target, num_labels=3)
tensor(0.5556)
>>> multilabel_f1_score(preds, target, num_labels=3, average=None)
tensor([1.0000, 0.0000, 0.6667])

Example (multidim tensors):
>>> from torchmetrics.functional.classification import multilabel_f1_score
>>> target = torch.tensor([[[0, 1], [1, 0], [0, 1]], [[1, 1], [0, 0], [1, 0]]])
>>> preds = torch.tensor(
...     [
...         [[0.59, 0.91], [0.91, 0.99], [0.63, 0.04]],
...         [[0.38, 0.04], [0.86, 0.780], [0.45, 0.37]],
...     ]
... )
>>> multilabel_f1_score(preds, target, num_labels=3, multidim_average='samplewise')
tensor([0.4444, 0.0000])
>>> multilabel_f1_score(preds, target, num_labels=3, multidim_average='samplewise', average=None)
tensor([[0.6667, 0.6667, 0.0000],
[0.0000, 0.0000, 0.0000]])


© Copyright Copyright (c) 2020-2023, Lightning-AI et al... Revision 6853c553`.

Built with Sphinx using a theme provided by Read the Docs.
Versions
latest
stable
v0.11.2
v0.11.1
v0.11.0
v0.10.3
v0.10.2
v0.10.1
v0.10.0
v0.9.3
v0.9.2
v0.9.1
v0.9.0
v0.8.2
v0.8.1
v0.8.0
v0.7.3
v0.7.2
v0.7.1
v0.7.0
v0.6.2
v0.6.1
v0.6.0
v0.5.1
v0.5.0
v0.4.1
v0.4.0
v0.3.2
v0.3.1
v0.3.0
v0.2.0
v0.1.0