Rename ignore to ignore_index for consistency

Author: BloodAxe

pytorch_toolbelt/losses/focal.py

@@ -8,19 +8,19 @@
 
 
 class BinaryFocalLoss(_Loss):
-    def __init__(self, alpha=0.5, gamma=2, ignore=None, reduction='mean', reduced=False, threshold=0.5):
+    def __init__(self, alpha=0.5, gamma=2, ignore_index=None, reduction='mean', reduced=False, threshold=0.5):
         """
 
         :param alpha:
         :param gamma:
-        :param ignore:
+        :param ignore_index:
         :param reduced:
         :param threshold:
         """
         super().__init__()
         self.alpha = alpha
         self.gamma = gamma
-        self.ignore = ignore
+        self.ignore_index = ignore_index
         if reduced:
             self.focal_loss = partial(reduced_focal_loss, gamma=gamma, threshold=threshold, reduction=reduction)
         else:
@@ -32,9 +32,9 @@ def forward(self, label_input, label_target):
         label_target = label_target.view(-1)
         label_input = label_input.view(-1)
 
-        if self.ignore is not None:
+        if self.ignore_index is not None:
             # Filter predictions with ignore label from loss computation
-            not_ignored = label_target != self.ignore
+            not_ignored = label_target != self.ignore_index
             label_input = label_input[not_ignored]
             label_target = label_target[not_ignored]
 
@@ -43,28 +43,32 @@ def forward(self, label_input, label_target):
 
 
 class FocalLoss(_Loss):
-    def __init__(self, alpha=0.5, gamma=2, ignore=None):
+    def __init__(self, alpha=0.5, gamma=2, ignore_index=None):
+        """
+        Focal loss for multi-class problem.
+
+        :param alpha:
+        :param gamma:
+        :param ignore_index: If not None, targets with given index are ignored
+        """
         super().__init__()
         self.alpha = alpha
         self.gamma = gamma
-        self.ignore = ignore
+        self.ignore_index = ignore_index
 
     def forward(self, label_input, label_target):
-        """Compute focal loss for multi-class problem.
-        Ignores anchors having -1 target label
-        """
         num_classes = label_input.size(1)
         loss = 0
 
         # Filter anchors with -1 label from loss computation
-        if self.ignore is not None:
-            not_ignored = label_target != self.ignore
+        if self.ignore_index is not None:
+            not_ignored = label_target != self.ignore_index
 
         for cls in range(num_classes):
             cls_label_target = (label_target == cls).long()
             cls_label_input = label_input[:, cls, ...]
 
-            if self.ignore is not None:
+            if self.ignore_index is not None:
                 cls_label_target = cls_label_target[not_ignored]
                 cls_label_input = cls_label_input[not_ignored]