mindspore/docs/api/api_python/ops/mindspore.ops.Im2Col.rst

60 lines
4.2 KiB
ReStructuredText
Raw Normal View History

2022-11-14 18:10:38 +08:00
mindspore.ops.Im2Col
====================
.. py:class:: mindspore.ops.Im2Col(ksizes, strides=1, dilations=1, padding_mode="CALCULATED", pads=0)
从一个batch的输入Tensor中提取滑动局部块。
考虑一个batch的输入Tensor其shape为 :math:`(N, C, *)` ,其中 :math:`N` 是batch维度
:math:`C` 是channel维度 :math:`*` 表示任意的空间维度。此操作将展平输入 `x` 空间维度内每个滑动的
`ksize` 大小的滑块为输出的4-D Tensor中的一列(如,最后一维)输出Tensor的shape为 :math:`(N, C, \prod(\text{kernel_size}), L)`
其中 :math:`C \times \prod(\text{kernel_size})` 为每个滑块内值的总数量(一个滑块有 :math:`\prod(\text{kernel_size})` 个空间位置,
每个位置都包含一个 `C` 通道的向量),共有 :math:`L` 个这样的滑块:
.. math::
L = \prod_d \left\lfloor\frac{\text{spatial_size}[d] + 2 \times \text{pads}[d] %
- \text{dilations}[d] \times (\text{kernel_size}[d] - 1) - 1}{\text{strides}[d]} + 1\right\rfloor,
其中, :math:`\text{spatial_size}` 由输入 `x` 的空间维度(上面的 :math:`*` )决定, :math:`d` 遍历所有的空间维度。
因此,在最后一个维度(列维度)上 `output` 包含特定块内的所有值。
`pads` `strides``dilations` 决定了滑块如何被取出。
.. note::
目前只支持4-D Tensor(一个batch的图像Tensor)。
参数:
- **ksizes** (Union[int, tuple[int], list[int]]) - 内核的大小,应该是两个整数,分别代表高度和宽度。如果是一个整数,则表示高度等于宽度。必须被指定。
- **strides** (Union[int, tuple[int], list[int]],可选) - 窗口的滑动步幅应该是高度和宽度两个整数。如果只有一个整数则表示高度等于宽度。默认值1。
- **dilations** (Union[int, tuple[int], list[int]],可选) - 窗口的扩张系数应该是高度和宽度两个整数。如果只有一个整数则表示高度等于宽度。默认值1。
- **padding_mode** (str可选) - 可选的填充模式,支持"CALCULATED""SAME"和"VALID"。默认值:"CALCULATED"。
- "SAME",输出的宽度和高度分别与输入的宽高除以 `strides` 后向上取整的值相同。
- "VALID",在不填充的前提下返回有效计算所得的输出。不满足计算的多余像素会被丢弃。
- "CALCULATED",对输入进行填充,在输入的高度和宽度方向上填充 `pads` 大小的0。
- **pads** (Union[int, tuple[int], list[int]],可选) - 窗口的填充必须是1个、2个或4个整数来指定高宽和宽度方向的填充。默认值0。
2022-12-26 11:52:49 +08:00
- 如果是1个整数:math:`pad\_height = pad\_width`
- 如果是2个整数:math:`pad\_height = pads[0]`, :math:`pad\_width = pads[1]`
- 如果是4个整数:math:`pads = [pad\_height\_top, pad\_height\_bottom, pad\_width\_left, pad\_width\_right]`
2022-11-14 18:10:38 +08:00
输入:
- **x** (Tensor) - 输入Tensor只支持4-D Tensor(1个batch的图像Tensor)。支持所有的实数类型。
输出:
Tensor一个4-D Tensor与输入 `x` 的数据类型相同。
异常:
- **TypeError** - 如果 `ksizes` 的类型不在Union[int, tuple[int], list[int]]内。
- **TypeError** - 如果 `strides` 的类型不在Union[int, tuple[int], list[int]]内。
- **TypeError** - 如果 `dilations` 的类型不在Union[int, tuple[int], list[int]]内。
- **TypeError** - 如果 `padding_mode` 的类型不是str。
- **TypeError** - 如果 `padding_mode` 为"CALCULATED"时, `pads` 类型不在Union[int, tuple[int], list[int]]内。
- **ValueError** - 如果 `ksizes` 的值不大于0或其元素数量大于2。
- **ValueError** - 如果 `strides` 的值不大于0或其元素数量大于2。
- **ValueError** - 如果 `dilations` 的值不大于0或其元素数量大于2。
- **ValueError** - 如果 `padding_mode` 的值不在["SAME", "VALID", "CALCULATED"]范围内。
- **ValueError** - 如果 `pads` 的值不大于0。