# sigmoid_focal_loss

Python API: `luxonis_train.attached_modules.losses.sigmoid_focal_loss`

二元焦点损失，降低了简单样本的权重。

## 类

### SigmoidFocalLoss

独立 sigmoid 输出上的焦点损失。

该损失将 logits 的每个元素视为一个二元决策，因此它适用于二元和多标签任务。焦点因子降低了模型已经很好预测的元素的损失。

 * `输入：`： * `predictions` (`Tensor`): `[B, C, ...]` logits
    * `target` (`Tensor`): 相同形状，`[0, 1]` 中的浮点值
 * `输出：`： * `Tensor`: 标量，或当 `reduction` 为 `"none"` 时为 `[B, C, ...]`
 * `公式：`： 对于目标为 y 的 logit x，令 p = σ(x) 且 pt = p**y + (1 − p)(1 − y)。一个元素的损失为 ℓ = − αt (1 − pt)γ[ylogp + (1 − y)log(1 − p)] 其中 αt =
   α**y + (1 − α)(1 − y)，`alpha` 为 `-1` 时 αt = 1。`reduction` 然后对所有元素取平均值或求和，或保留每个元素的损失。

> **参考**
> * 来源：封装 [torchvision.ops.sigmoid_focal_loss](https://docs.pytorch.org/vision/stable/generated/torchvision.ops.sigmoid_focal_loss.html) (BSD-3-Clause)。
 * 论文：[Focal Loss for Dense Object Detection](https://arxiv.org/abs/1708.02002)
 * 许可证：Apache-2.0（本项目）

> **注意**
> 该类封装了 `torchvision.ops.sigmoid_focal_loss`，并且没有添加自己的检查。

> **示例**
> 附加到 `model.nodes` 中的 `DDRNetSegmentationHead`：

```yaml
- name: DDRNetSegmentationHead
  inputs: [DDRNet]
  losses:
    - name: SigmoidFocalLoss
```

 * `兼容：`： * 节点： *
   [BiSeNetHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/bisenet_head.md)
       * [ClassificationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/classification_head.md)
       * [DDRNetSegmentationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/ddrnet_segmentation_head.md)
       * [SegmentationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/segmentation_head.md)
       * [TransformerClassificationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/transformer_classification_head.md)
       * [TransformerSegmentationHead](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/heads/transformer_segmentation_head.md)

#### 方法

##### init

```python
def __init__(alpha: float = 0.25, gamma: float = 2.0, reduction: Literal['none', 'mean', 'sum'] = 'mean', **kwargs):
```

初始化损失并存储焦点参数。

构造函数不检查值。[forward](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/sigmoid_focal_loss.md)
将它们传递给 `torchvision`，后者会为不接受的值引发 `ValueError`。

参数

 * `alpha` (`float`): 正元素的权重 α，范围为 `[0, 1]`。负元素获得 1 − α。`-1` 关闭加权。
 * `gamma` (`float`): 焦点因子 (1 − pt) 的指数。值越大，对预测良好的元素的损失降低越多。`0` 给出二元交叉熵，按 `alpha` 加权。
 * `reduction` (`Literal['none', 'mean', 'sum']`): 如何减少元素的损失： * `"none"`: 返回每个元素的损失。
    * `"mean"`: 返回所有元素的平均值。
    * `"sum"`: 返回所有元素的总和。
 * `**kwargs`: 转发到
   [BaseLoss](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/attached_modules/losses/base_loss.md)
   的关键字参数，例如 `final_loss_weight` 和 `node`。

##### forward

```python
def forward(predictions: Tensor, target: Tensor) -> Tensor:
```

计算 logits 和 targets 之间的 sigmoid 焦点损失。

当形状不同，以及当 `alpha` 或 `reduction` 具有不接受的值时，`torchvision` 会引发 `ValueError`。

> **示例**
> 当 `alpha=-1` 和 `gamma=0` 时，损失是二元交叉熵。默认的焦点因子使其更小：

```pycon
>>> import torch
>>> import torch.nn.functional as F
>>> logits = torch.tensor([[2.0, -1.0]])
>>> target = torch.tensor([[1.0, 0.0]])
>>> bce = F.binary_cross_entropy_with_logits(logits, target)
>>> plain = SigmoidFocalLoss(alpha=-1.0, gamma=0.0)
>>> torch.allclose(plain(logits, target), bce)
True
>>> bool(SigmoidFocalLoss()(logits, target) < bce)
True
```

参数

 * `predictions` (`Tensor`): 形状为 `[B, C, ...]` 的 logits，是节点的主要输出。
 * `target` (`Tensor`): 形状与 `predictions` 相同的 `[0, 1]` 中的浮点目标。

返回

 * `Tensor`: 对于 `"mean"` 和 `"sum"` 归约，是一个标量。对于 `"none"`，是每个元素的损失，形状为 `[B, C, ...]`。

#### 属性

##### supported_tasks
