mindspore/docs/api/api_python/nn/mindspore.nn.PixelShuffle.rst

mindspore.nn.PixelShuffle
==========================

.. py:class:: mindspore.nn.PixelShuffle(upscale_factor)

    对 `x` 应用像素重组操作，它实现了步长为 :math:`1/r` 的子像素卷积。关于PixelShuffle算法详细介绍，请参考 `Real-Time Single Image and Video Super-Resolution Using an Efficient Sub-Pixel Convolutional Neural Network <https://arxiv.org/abs/1609.05158>`_ 。

    通常情况下，输入shape :math:`(*, C \times r^2, H, W)` ，输出shape :math:`(*, C, H \times r, W \times r)` 。`r` 是缩小因子。 `*` 是大于等于0的维度。

    .. note::
        Ascend上输入Tensor的维度要小于7。

    参数：
        - **upscale_factor** (int) - 打乱输入Tensor的因子，是正整数。 `upscale_factor` 是上面提到的 :math:`r` 。

    输入：
        - **x** (Tensor) - Tensor，shape为 :math:`(*, C \times r^2, H, W)` 。输入Tensor的维度需要大于2，并且倒数第三维length可以被 `upscale_factor` 的平方整除。

    输出：
        - **output** (Tensor) - Tensor，shape为 :math:`(*, C, H \times r, W \times r)` 。

    异常：
        - **ValueError** - `upscale_factor` 不是正整数。
        - **ValueError** - 输入 `x` 倒数第三维度的length不能被 `upscale_factor` 的平方整除。
        - **TypeError** - 输入 `x` 维度小于3。