test_upsample_bilinear2d.py

# Copyright 2025-2026 Arm Limited and/or its affiliates.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.

from typing import Optional, Tuple

import torch
from executorch.backends.arm.quantizer.arm_quantizer import (
    get_symmetric_a16w8_quantization_config,
)
from executorch.backends.arm.test import common
from executorch.backends.arm.test.tester.test_pipeline import (
    EthosU85PipelineINT,
    OpNotSupportedPipeline,
    TosaPipelineFP,
    TosaPipelineINT,
    VgfPipeline,
)

aten_op = "torch.ops.aten.upsample_bilinear2d.vec"
exir_op = "executorch_exir_dialects_edge__ops_aten_upsample_bilinear2d_vec"
input_t1 = Tuple[torch.Tensor]  # Input x

test_data_suite_tosa = {
    # (test_name, test_data, size, scale_factor, compare_outputs)
    "rand_double_scale": (torch.rand(2, 4, 8, 3), None, 2.0, True),
    "rand_double_scale_one_dim": (torch.rand(2, 4, 8, 3), None, (1.0, 2.0), True),
    "rand_double_size": (torch.rand(2, 4, 8, 3), (16, 6), None, True),
    "rand_one_double_scale": (torch.rand(2, 4, 1, 1), None, 2.0, True),
    "rand_one_double_size": (torch.rand(2, 4, 1, 1), (2, 2), None, True),
    "rand_one_same_scale": (torch.rand(2, 4, 1, 1), None, 1.0, True),
    "rand_one_same_size": (torch.rand(2, 4, 1, 1), (1, 1), None, True),
    # Can't compare outputs as the rounding when selecting the nearest pixel is
    # different between PyTorch and TOSA. Just check the legalization went well.
    # TODO Improve the test infrastructure to support more in depth verification
    # of the TOSA legalization results.
    "rand_half_scale": (torch.rand(2, 4, 8, 6), None, 0.5, False),
    "rand_half_size": (torch.rand(2, 4, 8, 6), (4, 3), None, False),
    "rand_one_and_half_scale": (torch.rand(2, 4, 8, 3), None, 1.5, False),
    "rand_one_and_half_size": (torch.rand(2, 4, 8, 3), (12, 4), None, False),
    # Use randn for a bunch of tests to get random numbers from the
    # normal distribution where negative is also a possibilty
    "randn_double_scale_negative": (torch.randn(2, 4, 8, 3), None, 2.0, True),
    "randn_double_scale_one_dim_negative": (
        torch.randn(2, 4, 8, 3),
        None,
        (1.0, 2.0),
        True,
    ),
    "randn_double_size_negative": (torch.randn(2, 4, 8, 3), (16, 6), None, True),
    "randn_one_double_scale_negative": (torch.randn(2, 4, 1, 1), None, 2.0, True),
    "randn_one_double_size_negative": (torch.randn(2, 4, 1, 1), (2, 2), None, True),
    "randn_one_same_scale_negative": (torch.randn(2, 4, 1, 1), None, 1.0, True),
    "randn_one_same_size_negative": (torch.randn(2, 4, 1, 1), (1, 1), None, True),
}
test_data_suite_tosa_bf16 = {
    "randn_double_scale_bf16": (
        torch.randn(1, 2, 2, 2, dtype=torch.bfloat16),
        None,
        2.0,
        True,
    ),
    "randn_double_size_bf16": (
        torch.randn(1, 1, 3, 2, dtype=torch.bfloat16),
        (6, 4),
        None,
        True,
    ),
}
test_data_suite_tosa_fp16 = {
    "randn_double_scale_fp16": (
        torch.randn(1, 2, 2, 2, dtype=torch.float16),
        None,
        2.0,
        True,
    ),
    "randn_double_size_fp16": (
        torch.randn(1, 1, 3, 2, dtype=torch.float16),
        (6, 4),
        None,
        True,
    ),
}

test_data_suite_Uxx = {
    "rand_half_scale": (torch.rand(2, 4, 8, 6), None, 0.5, False),
    "rand_half_size": (torch.rand(2, 4, 8, 6), (4, 3), None, False),
    "rand_one_and_half_scale": (torch.rand(2, 4, 8, 3), None, 1.5, False),
    "rand_one_and_half_size": (torch.rand(2, 4, 8, 3), (12, 4), None, False),
}

test_data_u55 = {
    "rand_double_size": (torch.rand(2, 4, 8, 3), (16, 6), None, True),
}


class UpsamplingBilinear2d(torch.nn.Module):
    def __init__(
        self,
        size: Optional[Tuple[int]],
        scale_factor: Optional[float | Tuple[float]],
    ):
        super().__init__()
        self.upsample = torch.nn.UpsamplingBilinear2d(  # noqa: TOR101
            size=size, scale_factor=scale_factor
        )

    def forward(self, x):
        return self.upsample(x)


class Upsample(torch.nn.Module):
    def __init__(
        self,
        size: Optional[Tuple[int]],
        scale_factor: Optional[float | Tuple[float]],
    ):
        super().__init__()
        self.upsample = torch.nn.Upsample(
            size=size, scale_factor=scale_factor, mode="bilinear", align_corners=True
        )

    def forward(self, x):
        return self.upsample(x)


class Interpolate(torch.nn.Module):
    def __init__(
        self,
        size: Optional[Tuple[int]],
        scale_factor: Optional[float | Tuple[float]],
    ):
        super().__init__()
        self.upsample = lambda x: torch.nn.functional.interpolate(
            x, size=size, scale_factor=scale_factor, mode="bilinear", align_corners=True
        )

    def forward(self, x):
        return self.upsample(x)


class InterpolateAlignCornersFalse(torch.nn.Module):
    def __init__(
        self,
        size: Optional[Tuple[int]],
        scale_factor: Optional[float | Tuple[float]],
    ):
        super().__init__()
        self.upsample = lambda x: torch.nn.functional.interpolate(
            x,
            size=size,
            scale_factor=scale_factor,
            mode="bilinear",
            align_corners=False,
        )

    def forward(self, x):
        return self.upsample(x)


@common.parametrize(
    "test_data",
    test_data_suite_tosa | test_data_suite_tosa_bf16 | test_data_suite_tosa_fp16,
)
def test_upsample_bilinear2d_vec_tosa_FP_UpsamplingBilinear2d(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data
    match test_data.dtype:
        case torch.bfloat16:
            atol = 1e-2
            rtol = 1e-2
        case _:
            atol = 1e-3
            rtol = 1e-3

    pipeline = TosaPipelineFP[input_t1](
        UpsamplingBilinear2d(size, scale_factor),
        (test_data,),
        aten_op,
        exir_op=[],
        tosa_extensions=["bf16"],
        atol=atol,
        rtol=rtol,
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize(
    "test_data",
    test_data_suite_tosa | test_data_suite_tosa_bf16 | test_data_suite_tosa_fp16,
)
def test_upsample_bilinear2d_vec_tosa_FP_Upsample(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data
    match test_data.dtype:
        case torch.bfloat16:
            atol = 1e-2
            rtol = 1e-2
        case _:
            atol = 1e-3
            rtol = 1e-3

    pipeline = TosaPipelineFP[input_t1](
        Upsample(size, scale_factor),
        (test_data,),
        aten_op,
        exir_op=[],
        tosa_extensions=["bf16"],
        atol=atol,
        rtol=rtol,
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)

    pipeline.run()


@common.parametrize(
    "test_data",
    test_data_suite_tosa | test_data_suite_tosa_bf16 | test_data_suite_tosa_fp16,
)
def test_upsample_bilinear2d_vec_tosa_FP_Interpolate(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data
    match test_data.dtype:
        case torch.bfloat16:
            atol = 1e-2
            rtol = 1e-2
        case _:
            atol = 1e-3
            rtol = 1e-3

    pipeline = TosaPipelineFP[input_t1](
        Interpolate(size, scale_factor),
        (test_data,),
        aten_op,
        exir_op=[],
        tosa_extensions=["bf16"],
        atol=atol,
        rtol=rtol,
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)
    pipeline.run()


def test_upsample_bilinear2d_vec_tosa_does_not_delegate_exact_one_sixteenth_downscale():
    pipeline = OpNotSupportedPipeline[input_t1](
        InterpolateAlignCornersFalse(size=None, scale_factor=1.0 / 16.0),
        (torch.randn(1, 3, 256, 448),),
        {exir_op: 1},
        n_expected_delegates=0,
    )

    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa)
def test_upsample_bilinear2d_vec_tosa_INT_intropolate(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data

    pipeline = TosaPipelineINT[input_t1](
        UpsamplingBilinear2d(size, scale_factor),
        (test_data,),
        aten_op,
        exir_op=[],
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa)
def test_upsample_bilinear2d_vec_tosa_INT_Upsample(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data

    pipeline = TosaPipelineINT[input_t1](
        Upsample(size, scale_factor),
        (test_data,),
        aten_op,
        exir_op=[],
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa)
def test_upsample_bilinear2d_vec_tosa_INT_a16w8(
    test_data: torch.Tensor,
):
    """Test upsample_bilinear2d vector op with int16 I/O quantization for TOSA
    INT.
    """
    test_data, size, scale_factor, compare_outputs = test_data
    pipeline = TosaPipelineINT[input_t1](
        Upsample(size, scale_factor),
        (test_data,),
        aten_op,
        exir_op=[],
        tosa_extensions=["int16"],
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_u55)
@common.XfailIfNoCorstone300
def test_upsample_bilinear2d_vec_u55_INT_Upsample_not_delegated(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data
    pipeline = OpNotSupportedPipeline[input_t1](
        Upsample(size, scale_factor),
        (test_data,),
        {exir_op: 1},
        n_expected_delegates=0,
        quantize=True,
        u55_subset=True,
    )

    pipeline.run()


@common.parametrize("test_data", test_data_u55)
@common.XfailIfNoCorstone300
def test_upsample_bilinear2d_vec_u55_INT_Interpolate_not_delegated(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data
    pipeline = OpNotSupportedPipeline[input_t1](
        Interpolate(size, scale_factor),
        (test_data,),
        {exir_op: 1},
        n_expected_delegates=0,
        quantize=True,
        u55_subset=True,
    )

    pipeline.run()


@common.parametrize("test_data", test_data_u55)
@common.XfailIfNoCorstone300
def test_upsample_bilinear2d_vec_u55_INT_UpsamplingBilinear2d_not_delegated(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data
    pipeline = OpNotSupportedPipeline[input_t1](
        UpsamplingBilinear2d(size, scale_factor),
        (test_data,),
        {exir_op: 1},
        n_expected_delegates=0,
        quantize=True,
        u55_subset=True,
    )

    pipeline.run()


@common.parametrize("test_data", test_data_suite_Uxx)
@common.XfailIfNoCorstone320
def test_upsample_bilinear2d_vec_u85_INT_Upsample(test_data: input_t1):
    test_data, size, scale_factor, compare_outputs = test_data

    pipeline = EthosU85PipelineINT[input_t1](
        Upsample(size, scale_factor),
        (test_data,),
        aten_op,
        qtol=1,
        use_to_edge_transform_and_lower=True,
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_Uxx)
@common.XfailIfNoCorstone320
def test_upsample_bilinear2d_vec_u85_INT_Interpolate(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data

    pipeline = EthosU85PipelineINT[input_t1](
        Interpolate(size, scale_factor),
        (test_data,),
        aten_op,
        qtol=1,
        use_to_edge_transform_and_lower=True,
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_Uxx)
@common.XfailIfNoCorstone320
def test_upsample_bilinear2d_vec_u85_INT_UpsamplingBilinear2d(
    test_data: torch.Tensor,
):
    test_data, size, scale_factor, compare_outputs = test_data

    pipeline = EthosU85PipelineINT[input_t1](
        UpsamplingBilinear2d(size, scale_factor),
        (test_data,),
        aten_op,
        qtol=1,
        use_to_edge_transform_and_lower=True,
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_Uxx)
@common.XfailIfNoCorstone320
def test_upsample_bilinear2d_vec_u85_INT_a16w8(
    test_data: input_t1,
):
    """Test upsample_bilinear2d vec op with 16A8W quantization on U85 (16-bit
    activations, 8-bit weights)
    """
    data, size, scale_factor, compare_outputs = test_data

    pipeline = EthosU85PipelineINT[input_t1](
        UpsamplingBilinear2d(size, scale_factor),
        (data,),
        aten_op,
        per_channel_quantization=False,
        a16w8_quantization=True,
        use_to_edge_transform_and_lower=True,
    )
    if not compare_outputs:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa | test_data_suite_tosa_fp16)
@common.SkipIfNoModelConverter
def test_upsample_bilinear2d_vec_vgf_no_quant_UpsamplingBilinear2d(
    test_data: torch.Tensor,
):
    data, size, scale_factor, compare = test_data
    pipeline = VgfPipeline[input_t1](
        UpsamplingBilinear2d(size, scale_factor),
        (data,),
        aten_op,
        exir_op,
        quantize=False,
        atol=2e-3,
        rtol=2e-3,
    )
    if not compare:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa | test_data_suite_tosa_fp16)
@common.SkipIfNoModelConverter
def test_upsample_bilinear2d_vec_vgf_no_quant_Upsample(test_data: torch.Tensor):
    data, size, scale_factor, compare = test_data
    match test_data[0].dtype:
        case torch.float16:
            atol = 1e-2
            rtol = 1e-2
        case _:
            atol = 1e-3
            rtol = 1e-3
    pipeline = VgfPipeline[input_t1](
        Upsample(size, scale_factor),
        (data,),
        aten_op,
        exir_op,
        quantize=False,
        atol=atol,
        rtol=rtol,
    )
    if not compare:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa | test_data_suite_tosa_fp16)
@common.SkipIfNoModelConverter
def test_upsample_bilinear2d_vec_vgf_no_quant_Interpolate(test_data: torch.Tensor):
    data, size, scale_factor, compare = test_data
    pipeline = VgfPipeline[input_t1](
        Interpolate(size, scale_factor),
        (data,),
        aten_op,
        exir_op,
        quantize=False,
    )
    if not compare:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa)
@common.SkipIfNoModelConverter
def test_upsample_bilinear2d_vec_vgf_quant_UpsamplingBilinear2d(
    test_data: torch.Tensor,
):
    data, size, scale_factor, compare = test_data
    pipeline = VgfPipeline[input_t1](
        UpsamplingBilinear2d(size, scale_factor),
        (data,),
        aten_op,
        exir_op,
        quantize=True,
    )
    if not compare:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa)
@common.SkipIfNoModelConverter
def test_upsample_bilinear2d_vec_vgf_quant_Upsample(test_data: torch.Tensor):
    data, size, scale_factor, compare = test_data
    pipeline = VgfPipeline[input_t1](
        Upsample(size, scale_factor),
        (data,),
        aten_op,
        exir_op,
        quantize=True,
    )
    if not compare:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa)
@common.SkipIfNoModelConverter
def test_upsample_bilinear2d_vec_vgf_quant_Interpolate(test_data: torch.Tensor):
    data, size, scale_factor, compare = test_data
    pipeline = VgfPipeline[input_t1](
        Interpolate(size, scale_factor),
        (data,),
        aten_op,
        exir_op,
        quantize=True,
    )
    if not compare:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa)
@common.SkipIfNoModelConverter
def test_upsample_bilinear2d_vec_vgf_quant_a16w8_UpsamplingBilinear2d(
    test_data: torch.Tensor,
):
    data, size, scale_factor, compare = test_data
    pipeline = VgfPipeline[input_t1](
        UpsamplingBilinear2d(size, scale_factor),
        (data,),
        aten_op,
        exir_op,
        quantize=True,
        tosa_extensions=["int16"],
    )
    pipeline.quantizer.set_global(get_symmetric_a16w8_quantization_config())
    if not compare:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa)
@common.SkipIfNoModelConverter
def test_upsample_bilinear2d_vec_vgf_quant_a16w8_Upsample(
    test_data: torch.Tensor,
):
    data, size, scale_factor, compare = test_data
    pipeline = VgfPipeline[input_t1](
        Upsample(size, scale_factor),
        (data,),
        aten_op,
        exir_op,
        quantize=True,
        tosa_extensions=["int16"],
    )
    pipeline.quantizer.set_global(get_symmetric_a16w8_quantization_config())
    if not compare:
        pipeline.pop_stage(-1)
    pipeline.run()


@common.parametrize("test_data", test_data_suite_tosa)
@common.SkipIfNoModelConverter
def test_upsample_bilinear2d_vec_vgf_quant_a16w8_Interpolate(
    test_data: torch.Tensor,
):
    data, size, scale_factor, compare = test_data
    pipeline = VgfPipeline[input_t1](
        Interpolate(size, scale_factor),
        (data,),
        aten_op,
        exir_op,
        quantize=True,
        tosa_extensions=["int16"],
    )
    pipeline.quantizer.set_global(get_symmetric_a16w8_quantization_config())
    if not compare:
        pipeline.pop_stage(-1)
    pipeline.run()