Shortcuts

# Weighted MAPE¶

## Module Interface¶

class torchmetrics.WeightedMeanAbsolutePercentageError(**kwargs)[source]

Computes weighted mean absolute percentage error (WMAPE). The output of WMAPE metric is a non-negative floating point, where the optimal value is 0. It is computes as:

Where is a tensor of target values, and is a tensor of predictions.

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

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

• wmape (Tensor): A tensor with non-negative floating point wmape value between 0 and 1

Parameters

kwargs (Any) – Additional keyword arguments, see Advanced metric settings for more info.

Example

>>> import torch
>>> _ = torch.manual_seed(42)
>>> preds = torch.randn(20,)
>>> target = torch.randn(20,)
>>> wmape = WeightedMeanAbsolutePercentageError()
>>> wmape(preds, target)
tensor(1.3967)


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

## Functional Interface¶

torchmetrics.functional.weighted_mean_absolute_percentage_error(preds, target)[source]

Computes weighted mean absolute percentage error (WMAPE).

The output of WMAPE metric is a non-negative floating point, where the optimal value is 0. It is computes as:

Where is a tensor of target values, and is a tensor of predictions.

Parameters
Return type

Tensor

Returns

Tensor with WMAPE.

Example

>>> import torch
>>> _ = torch.manual_seed(42)
>>> preds = torch.randn(20,)
>>> target = torch.randn(20,)
>>> weighted_mean_absolute_percentage_error(preds, target)
tensor(1.3967)


© Copyright Copyright (c) 2020-2023, Lightning-AI et al... Revision 54a06013.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: stable
Versions
latest
stable
v0.11.4
v0.11.3
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
Downloads
pdf
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.