alpine.metrics package#

Submodules#

alpine.metrics.ssim module#

class alpine.metrics.ssim.SSIM#

Bases: Metric

Structural Similarity Index (SSIM) metric. Example shows how to use a subclass torchmetrics.Metric to create a custom metric.

__init__(signal_shape, data_range=1.0, kernel_size=11, sigma=1.5, reduction='elementwise_mean')#: Initialize internal Module state, shared by both nn.Module and ScriptModule.

compute()#

Override this method to compute the final metric value.

This method will automatically synchronize state variables when running in distributed backend.

property higher_is_better#

update(x, y)#: Override this method to update the state variables of your metric class.

Module contents#