---
title: "PixelShuffle"
sidebar_label: "PixelShuffle"
description: "The clika_runtime.nn PixelShuffle class."
---

<!-- Generated by tools/api_reference/generate_api_docs.py. Do not edit. -->

PixelShuffle(upscale_factor, mode="crd")

    Moves channels into the spatial axes: ``[N, H, W, C * r * r]`` to ``[N, H *
    r, W * r, C]`` for the factor ``r``.

    The module form of ``clika_runtime.nn.functional.pixel_shuffle``: construct
    it once with the settings, then call it like a function.

    Args:
        upscale_factor: the factor ``r``.
        mode: the channel ordering of the packed input.
    

## `__init__`

```python
__init__(self, upscale_factor: 'int', mode: '_PixelShuffleMode' = 'crd') -> 'None'
```

Initialize self.  See help(type(self)) for accurate signature.

## `extra_repr`

```python
extra_repr(self) -> 'str'
```

extra_repr() -> str

One line of per-class detail for :meth:`__repr__`; a layer prints
its geometry here (``in_features=64, out_features=256``).

## `forward`

```python
forward(self, input: 'Tensor') -> 'Tensor'
```

forward(input) -> Tensor

Runs ``clika_runtime.nn.functional.pixel_shuffle`` on ``input`` with
the stored settings; returns a new tensor.