Skip to content
  • Code Reference
  • careamics
  • losses
  • loss_factory

loss_factory

Loss factory module.

This module contains a factory function for creating loss functions.

FCNLossParameters dataclass #

Dataclass for FCN loss.

Source code in src/careamics/losses/loss_factory.py 
19
20
21
22
23
24
25
26
27
28
@dataclass
class FCNLossParameters:
    """Dataclass for FCN loss."""

    # TODO check
    prediction: tensor
    targets: tensor
    mask: tensor
    current_epoch: int
    loss_weight: float

loss_factory(loss) #

Return loss function.

Parameters:

Name Type Description Default
loss Union[SupportedLoss, str]

Requested loss.

 required

Returns:

Type Description
Callable

Loss function.

Raises:

Type Description
NotImplementedError

If the loss is unknown.
Source code in src/careamics/losses/loss_factory.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def loss_factory(loss: Union[SupportedLoss, str]) -> Callable:
    """Return loss function.

    Parameters
    ----------
    loss : Union[SupportedLoss, str]
        Requested loss.

    Returns
    -------
    Callable
        Loss function.

    Raises
    ------
    NotImplementedError
        If the loss is unknown.
    """
    if loss == SupportedLoss.N2V:
        return n2v_loss

    # elif loss_type == SupportedLoss.PN2V:
    #     return pn2v_loss

    elif loss == SupportedLoss.MAE:
        return mae_loss

    elif loss == SupportedLoss.MSE:
        return mse_loss

    elif loss == SupportedLoss.MUSPLIT:
        return musplit_loss

    elif loss == SupportedLoss.DENOISPLIT:
        return denoisplit_loss

    elif loss == SupportedLoss.DENOISPLIT_MUSPLIT:
        return denoisplit_musplit_loss

    else:
        raise NotImplementedError(f"Loss {loss} is not yet supported.")