RegressionMSELoss

class lightning_pose.losses.losses.RegressionMSELoss(data_module: BaseDataModule | UnlabeledDataModule | None = None, epsilon: float = 0.0, log_weight: float = 0.0, **kwargs)

Bases: Loss

MSE loss between ground truth and predicted coordinates.

Methods Summary

__call__(keypoints_targ, keypoints_pred[, stage])	Call self as a function.
compute_loss(targets, predictions)
remove_nans(targets, predictions)

Methods Documentation

__call__(keypoints_targ: Tensor, {'__torchtyping__': True, 'details': ('batch', 'two_x_num_keypoints'), 'cls_name': 'TensorType'}], keypoints_pred: Tensor, {'__torchtyping__': True, 'details': ('batch', 'two_x_num_keypoints'), 'cls_name': 'TensorType'}], stage: Literal['train', 'val', 'test'] | None = None, **kwargs) → Tensor, {'__torchtyping__': True, 'details': ((),), 'cls_name': 'TensorType'}], list[dict]]

Call self as a function.

compute_loss(targets: Tensor, {'__torchtyping__': True, 'details': ('batch_x_two_x_num_keypoints',), 'cls_name': 'TensorType'}], predictions: Tensor, {'__torchtyping__': True, 'details': ('batch_x_two_x_num_keypoints',), 'cls_name': 'TensorType'}]) → Tensor, {'__torchtyping__': True, 'details': ('batch_x_two_x_num_keypoints',), 'cls_name': 'TensorType'}]

remove_nans(targets: Tensor, {'__torchtyping__': True, 'details': ('batch', 'two_x_num_keypoints'), 'cls_name': 'TensorType'}], predictions: Tensor, {'__torchtyping__': True, 'details': ('batch', 'two_x_num_keypoints'), 'cls_name': 'TensorType'}]) → Tensor, {'__torchtyping__': True, 'details': ('num_valid_keypoints',), 'cls_name': 'TensorType'}]]

__init__(data_module: BaseDataModule | UnlabeledDataModule | None = None, epsilon: float = 0.0, log_weight: float = 0.0, **kwargs) → None

Parameters:

• data_module – give losses access to data for computing data-specific loss params

• epsilon – loss values below epsilon will be zeroed out

• log_weight – natural log of the weight in front of the loss term in the final objective function