[RFC] Loss functions in quickvision

[oke-aditya]

🚀 Feature

Frequently re-used losses that can be added.

Motivation

Writing Losses is quite repetitive. PyTorch supports losses which are written with deep interoperability with C++ API. But most research losses aren't.

These losses are building blocks for other complicates losses as well.

Pitch

A non-exhaustive and probable list of losses that are not PyTorch but used often.

• [ ] gIoU loss -> Used in Detr (will make porting Detr easier, present in fvcore
• [ ] focal loss -> Used in RetinaNet (It will come in torchvision as well but we we can have here too for re-use, present in fvcore
• [ ] Jsd loss -> Used alternative to CrossEntropy in Classification here
• [ ] Varients of Cross Entropy -> Unsure if they are used often found them here
• [x] Dice Loss -> Used in U-Net and other segmentation models.
• [ ] Sigmoid Focal Loss -> Modification of Focal loss for segmentation.
• [ ] Huber loss -> Used in efficnet Det and similar loss. Implemented here

Alternatives

Wait for them to reach into fvcore or PyTorch. Till then we keep duplicating these code for models.

Additional context

Note, if we are re-using implementation from any repo. Please cite them on top of code.

[hassiahk]

Do we include sample_weight and reduction parameters as well for the user to choose? Currently dice_loss does not consider sample_weight and takes reduction = sum as shown below. https://github.com/Quick-AI/quickvision/blob/c6bd28e8d77905c6e4f9538644df5d875af654d2/quickvision/losses/segmentation.py#L6 https://github.com/Quick-AI/quickvision/blob/c6bd28e8d77905c6e4f9538644df5d875af654d2/quickvision/losses/segmentation.py#L21

Below is a part of huber_loss from the implementation you mentioned which considers both sample_weight and reduction.

def huber_loss(input, target, delta: float = 1., weights: Optional[torch.Tensor] = None, size_average: bool = True):
    # rest of the code
    if weights is not None:
        loss *= weights
    return loss.mean() if size_average else loss.sum()

I will start working on this simultaneously, if it is up for grabs. :smile:

[oke-aditya]

Yes ! I was about to tell about these. We include weights and reduction.

Reduction can be none, sum or mean.

P.S. We also keep consistent with torchvision and if it gets a losses API we will support only other losses. We won't duplicate torchvision losses unless necessary.

P.P.S. Up For Grabs !!

[hassiahk]

What should be the structure for these losses? I can think of these three ways:

• Each loss will have a separate file.
• Club losses together in a single file based on the downstream task.
• Do it like how we did it for models (one single folder for a downstream task and one file for each loss).

[oke-aditya]

@zhiqwang you are welcome to contribute 😄

[zhiqwang]

Hi @oke-aditya , I'm looking for anything I can do in this vigorous repo 🚀

[oke-aditya]

Join on Slack here

All the development talks go here ! You can freely communicate your ideas, RFCs and thoughts.

[oke-aditya]

Each loss in separate file is better This keeps abstraction minimal.

If We could create a folder called nn but that would interfere with torch which we can avoid.

Also, should we implement losses as Classes / functions ?

If we implement as classes we should inherit from nn.Module. Otherwise we can continue to use them as functions. This is slight confusion. I see no advantage of one over the other. PyTorch creates them as classes and gives a functional API too.

Eg.

loss_fn = nn.CrossEntropyLoss()
loss_v = F.CrossEntropy(inp, op)

I think we should follow that and provide a functional API too (if possible)

Losses tied to models can be implemented as mixture of both. Since their use will be only with the model. Preferabbly like detr_loss.

I propose to keep API Simple.

==>losses
====>functional
=======>loss_dice.py
====>__init__.py
====> loss_dice.py
====> loss_detr.py

Thoughts @zhiqwang @hassiahk @ramaneswaran ?

[hassiahk]

I agree with implementing losses as both classes and functions since it would be easier for people coming from torch to use them. We can just do this:

def loss_function(input, target):
    return loss

class LossFunction(nn.Module):
    def forward(self, input, target):
        return loss_function(input, target)

I did not get this part. How are we avoiding by naming the folder as nn?

If We could create a folder called nn but that would interfere with torch which we can avoid.

[oke-aditya]

If we call our folder as nn people will have to do from quickvision.nn import loss_fn While nn is something torch uses whose code is bonded to C++ API. So this doesn't serve this purpose. Safer side we can keep losses.

[hassiahk]

Based on whatever we discussed above, I will start working on this and let's see how it goes.

[oke-aditya]

@zhiqwang @hassiahk I think we can start with this for release 2.0, Let;s propsose a template API for this.

[hassiahk]

@oke-aditya, are we implementing all the losses mentioned in the initial comment?

[oke-aditya]

Yes 😀