# resnet

Python API: `luxonis_train.nodes.backbones.resnet`

来自 `torchvision` 的 ResNet 主干。

## 类

### ResNet

ResNet 主干，返回四个残差阶段的输出。

ResNet 在每个残差块周围添加了一个快捷连接。该节点封装了 `torchvision` ResNet，其深度由 `variant` 选择。它运行 stem 并返回残差阶段 `layer1` 到 `layer4` 的输出。

 * `输入:`: * `inputs` (`Tensor`): [B, 3, H, W]
 * `输出:`: * `features` (`list[Tensor]`): `layer1` 到 `layer4`，步长为 4、8、16、32；对于 `"18"` 和 `"34"`，通道数为 64、128、256、512，对于其他深度，通道数是其四倍

> **参考**
> * 来源: 封装了 [torchvision.models.resnet](https://docs.pytorch.org/vision/stable/models/resnet.html) (BSD-3-Clause)。论文: [用于图像识别的深度残差学习](https://arxiv.org/abs/1512.03385)。
 * 许可证: Apache-2.0 (本项目)

> **注意事项**
> 输入必须有 3 个通道。`groups`、`width_per_group` 和 `replace_stride_with_dilation` 只有在深度为 `"50"`、`"101"` 和 `"152"` 时才接受非默认值。该节点保留了 `torchvision` 模型中未使用的 `avgpool` 和 `fc` 层。

 * `变体:`: - * `"18"`:`: * 默认: 是
       * 别名: 无
       * * `参数:`: * `variant`: `"18"`
    * * `"34"`:`: * 默认: 否
          * 别名: 无
          * * `参数:`: * `variant`: `"34"`
    * * `"50"`:`: * 默认: 否
          * 别名: 无
          * * `参数:`: * `variant`: `"50"`
    * * `"101"`:`: * 默认: 否
          * 别名: 无
          * * `参数:`: * `variant`: `"101"`
    * * `"152"`:`: * 默认: 否
          * 别名: 无
          * * `参数:`: * `variant`: `"152"`

> **示例**
> 配置的 `model.nodes` 部分中的节点条目:

```yaml
- name: ResNet
  variant: 18
```

 * `兼容:`: * 附加索引: `-1`，输入节点的最后一个输出
    * 由以下使用:
      [ClassificationModel](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/config/predefined_models/classification/v1/model.md)

#### 方法

##### init

```python
def __init__(variant: Literal['18', '34', '50', '101', '152'] = '18', zero_init_residual: bool = False, groups: int = 1, width_per_group: int = 64, replace_stride_with_dilation: tuple[bool, bool, bool] = (False, False, False), weights: Literal['download', 'none'] | None = None, **kwargs):
```

构建所选深度的 `torchvision` ResNet。

参数

 * `variant` (`Literal['18', '34', '50', '101', '152']`): 网络的深度。`"18"` 和 `"34"`
   使用基本块。其他深度使用瓶颈块，输出通道数是其四倍。[get_variants](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/backbones/resnet.md)
   的每个变体都将其设置为变体名称。默认为 `"18"`。
 * `zero_init_residual` (`bool`): 是否将每个残差块中最后一个批归一化层的权重设置为零。每个块的残差分支将以零输出开始，因此只有快捷连接到达块的最终 ReLU。预训练权重会替换此初始化。请参阅 [Accurate, Large
   Minibatch SGD](https://arxiv.org/abs/1706.02677)。默认为 `False`。
 * `groups` (`int`): 每个瓶颈块中 `3x3` 卷积的组数。深度 `"18"` 和 `"34"` 只接受 `1`。对于其他值，`torchvision` 会引发 `ValueError`。默认为 `1`。
 * `width_per_group` (`int`): 每个瓶颈块中每组的通道数。块的 `3x3` 卷积有 `int(planes * width_per_group / 64) * groups` 个通道。`planes` 对于 `layer1` 到
   `layer4` 分别是 64、128、256 或 512。深度 `"18"` 和 `"34"` 只接受 `64`。对于其他值，`torchvision` 会引发 `ValueError`。默认为 `64`。
 * `replace_stride_with_dilation` (`tuple[bool, bool, bool]`): 对于 `layer2`、`layer3` 和 `layer4`，是否用膨胀替换步长
   `2`。带有膨胀的阶段会保持其前一个阶段的分辨率。深度 `"18"` 和 `"34"` 只接受 `False`。对于 `True`，`torchvision` 会引发 `NotImplementedError`。
 * `weights` (`Literal['download', 'none'] | None`): 值 `"download"` 加载 `torchvision` 的 `DEFAULT` ImageNet 权重。任何其他值都保持随机初始化。该值不会到达
   [BaseNode](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)，因此检查点
   URL 或 `"yolo"` 无效。
 * `**kwargs`: 转发给
   [BaseNode](/software-v3/ai-inference/model-source/training/luxonis-train/luxonis-train-api-reference/nodes/base_node.md)
   的关键字参数。

引发

 * `ValueError`: 当 `variant` 不是五个深度之一时。

##### forward

```python
def forward(inputs: Tensor) -> list[Tensor]:
```

运行 stem 和四个残差阶段。

stem 是 `torchvision` 模型的 `conv1`、`bn1`、`relu` 和 `maxpool`，总步长为 `4`。该节点跳过 `avgpool` 和 `fc`。

> **示例**
> ```pycon
>>> import torch
>>> from luxonis_train.nodes import ResNet
>>> node = ResNet(variant="18")
>>> [tuple(t.shape) for t in node(torch.zeros(1, 3, 64, 64))]
[(1, 64, 16, 16), (1, 128, 8, 8), (1, 256, 4, 4), (1, 512, 2, 2)]
```

参数

 * `inputs` (`Tensor`): 形状为 `[B, 3, H, W]` 的图像批次。

返回

 * `list[Tensor]`: `layer1` 到 `layer4` 的输出，步长分别为 4、8、16 和 32。对于深度 `"18"` 和 `"34"`，它们有 64、128、256 和 512 个通道，对于其他深度，通道数是其四倍。带有膨胀的阶段会保持其前一个阶段的步长。

##### get_variants

```python
def get_variants() -> tuple[str, dict[str, Kwargs]]:
```

返回默认变体名称和 ResNet 深度。

每个变体只将 `variant` 设置为其自己的名称。`"18"` 是默认值。

> **示例**
> ```pycon
>>> from luxonis_train.nodes import ResNet
>>> default, variants = ResNet.get_variants()
>>> default, list(variants)
('18', ['18', '34', '50', '101', '152'])
>>> variants["50"]
{'variant': '50'}
```

返回

 * `tuple[str, dict[str, Kwargs]]`: 名称 `"18"`，以及一个将 `"18"`、`"34"`、`"50"`、`"101"` 和 `"152"` 中的每一个映射到 `{"variant": name}` 的字典。

#### 属性

##### backbone
