TheRock/rocm-libraries/projects/hipdnn/test_sdk/tests/utilities/TestTensorDiff.cpp

// Copyright © Advanced Micro Devices, Inc., or its affiliates.
// SPDX-License-Identifier: MIT

#include <gtest/gtest.h>

#include <hipdnn_data_sdk/utilities/Tensor.hpp>
#include <hipdnn_test_sdk/utilities/CpuFpReferenceValidation.hpp>
#include <hipdnn_test_sdk/utilities/TensorDiff.hpp>
#include <sstream>

using namespace hipdnn_test_sdk::utilities;
using namespace hipdnn_data_sdk::utilities;

// =================================================================================================
// computeTensorDiff
// =================================================================================================

TEST(TestComputeTensorDiff, IdenticalTensorsHaveNoMismatches)
{
    const std::vector<int64_t> dims = {4, 4};
    Tensor<float> ref(dims);
    ref.fillTensorWithRandomValues(-1.0f, 1.0f);

    Tensor<float> impl(dims);
    TensorView<float> refView(ref);
    const TensorView<float> implView(impl);
    iterateAlongDimensions(dims, [&](const std::vector<int64_t>& indices) {
        impl.setHostValue(refView.getHostValue(indices), indices);
    });

    auto summary = computeTensorDiff<float>(ref, impl, 1e-5f, 1e-5f);

    EXPECT_EQ(summary.totalElements, 16u);
    EXPECT_EQ(summary.mismatchCount, 0u);
    EXPECT_FLOAT_EQ(summary.maxAbsDiff, 0.0f);
    EXPECT_FLOAT_EQ(summary.meanAbsDiff, 0.0f);
    EXPECT_TRUE(summary.worstMismatches.empty());
}

TEST(TestComputeTensorDiff, DetectsSingleMismatch)
{
    const std::vector<int64_t> dims = {2, 3};
    Tensor<float> ref(dims);
    Tensor<float> impl(dims);

    // Fill both with zeros
    iterateAlongDimensions(dims, [&](const std::vector<int64_t>& indices) {
        ref.setHostValue(0.0f, indices);
        impl.setHostValue(0.0f, indices);
    });

    // Introduce a single difference
    ref.setHostValue(1.0f, std::vector<int64_t>{1, 2});
    impl.setHostValue(2.0f, std::vector<int64_t>{1, 2});

    auto summary = computeTensorDiff<float>(ref, impl, 0.0f, 0.0f);

    EXPECT_EQ(summary.totalElements, 6u);
    EXPECT_EQ(summary.mismatchCount, 1u);
    EXPECT_FLOAT_EQ(summary.maxAbsDiff, 1.0f);
    EXPECT_FLOAT_EQ(summary.meanAbsDiff, 1.0f);
    ASSERT_EQ(summary.maxDiffIndices.size(), 2u);
    EXPECT_EQ(summary.maxDiffIndices[0], 1);
    EXPECT_EQ(summary.maxDiffIndices[1], 2);
    ASSERT_EQ(summary.worstMismatches.size(), 1u);
    EXPECT_FLOAT_EQ(summary.worstMismatches[0].refValue, 1.0f);
    EXPECT_FLOAT_EQ(summary.worstMismatches[0].implValue, 2.0f);
}

TEST(TestComputeTensorDiff, MismatchesWithinToleranceAreIgnored)
{
    const std::vector<int64_t> dims = {2, 2};
    Tensor<float> ref(dims);
    Tensor<float> impl(dims);

    iterateAlongDimensions(dims, [&](const std::vector<int64_t>& indices) {
        ref.setHostValue(1.0f, indices);
        impl.setHostValue(1.0f, indices);
    });

    // Introduce a small difference (0.001) within tolerance
    impl.setHostValue(1.001f, std::vector<int64_t>{0, 0});

    auto summary = computeTensorDiff<float>(ref, impl, 0.01f, 0.0f);

    EXPECT_EQ(summary.mismatchCount, 0u);
}

TEST(TestComputeTensorDiff, ShapeMismatchReturnsEmptySummary)
{
    Tensor<float> ref({2, 3});
    Tensor<float> impl({3, 2});

    auto summary = computeTensorDiff<float>(ref, impl, 0.0f, 0.0f);

    EXPECT_EQ(summary.totalElements, 0u);
    EXPECT_EQ(summary.mismatchCount, 0u);
    EXPECT_TRUE(summary.worstMismatches.empty());
}

TEST(TestComputeTensorDiff, WorstMismatchesCappedAtMaxMismatches)
{
    const std::vector<int64_t> dims = {10};
    Tensor<float> ref(dims);
    Tensor<float> impl(dims);

    // Every element differs
    for(int64_t i = 0; i < 10; ++i)
    {
        ref.setHostValue(0.0f, std::vector<int64_t>{i});
        impl.setHostValue(static_cast<float>(i + 1), std::vector<int64_t>{i});
    }

    const size_t maxMismatches = 3;
    auto summary = computeTensorDiff<float>(ref, impl, 0.0f, 0.0f, maxMismatches);

    EXPECT_EQ(summary.mismatchCount, 10u);
    ASSERT_EQ(summary.worstMismatches.size(), maxMismatches);

    // Must retain the largest 3 diffs (10, 9, 8), sorted descending
    EXPECT_FLOAT_EQ(summary.worstMismatches[0].absDiff, 10.0f);
    EXPECT_FLOAT_EQ(summary.worstMismatches[1].absDiff, 9.0f);
    EXPECT_FLOAT_EQ(summary.worstMismatches[2].absDiff, 8.0f);
}

TEST(TestComputeTensorDiff, ZeroMaxMismatchesSuppressesEntries)
{
    const std::vector<int64_t> dims = {4};
    Tensor<float> ref(dims);
    Tensor<float> impl(dims);

    for(int64_t i = 0; i < 4; ++i)
    {
        ref.setHostValue(0.0f, std::vector<int64_t>{i});
        impl.setHostValue(1.0f, std::vector<int64_t>{i});
    }

    auto summary = computeTensorDiff<float>(ref, impl, 0.0f, 0.0f, 0);

    EXPECT_EQ(summary.mismatchCount, 4u);
    EXPECT_TRUE(summary.worstMismatches.empty());
    EXPECT_GT(summary.maxAbsDiff, 0.0f);
}

// =================================================================================================
// printTensorDiffSummary
// =================================================================================================

TEST(TestPrintTensorDiffSummary, OutputContainsExpectedFields)
{
    TensorDiffSummary summary{};
    summary.totalElements = 100;
    summary.mismatchCount = 5;
    summary.maxAbsDiff = 0.01f;
    summary.meanAbsDiff = 0.005f;
    summary.maxDiffIndices = {1, 2, 3};
    summary.worstMismatches = {{{1, 2, 3}, 1.0f, 1.01f, 0.01f}};

    std::ostringstream oss;
    printTensorDiffSummary(oss, "testTensor", summary);
    const std::string output = oss.str();

    EXPECT_NE(output.find("testTensor"), std::string::npos);
    EXPECT_NE(output.find("Total elements: 100"), std::string::npos);
    EXPECT_NE(output.find("Mismatched:     5"), std::string::npos);
    EXPECT_NE(output.find("Worst mismatches:"), std::string::npos);
}

TEST(TestPrintTensorDiffSummary, NoMismatchesOmitsWorstSection)
{
    TensorDiffSummary summary{};
    summary.totalElements = 50;
    summary.mismatchCount = 0;
    summary.maxAbsDiff = 0.0f;
    summary.meanAbsDiff = 0.0f;

    std::ostringstream oss;
    printTensorDiffSummary(oss, "clean", summary);
    const std::string output = oss.str();

    EXPECT_EQ(output.find("Worst mismatches:"), std::string::npos);
}

// =================================================================================================
// validateAndReport
// =================================================================================================

TEST(TestValidateAndReport, PassingValidationPrintsSuccessful)
{
    const std::vector<int64_t> dims = {3, 3};
    Tensor<float> ref(dims);
    ref.fillTensorWithRandomValues(-1.0f, 1.0f);

    Tensor<float> impl(dims);
    TensorView<float> refView(ref);
    iterateAlongDimensions(dims, [&](const std::vector<int64_t>& indices) {
        impl.setHostValue(refView.getHostValue(indices), indices);
    });

    const CpuFpReferenceValidation<float> validator(1e-5f, 1e-5f);

    std::ostringstream oss;
    const bool result = validateAndReport<float>(oss, "y", validator, ref, impl, 1e-5f, 1e-5f);

    EXPECT_TRUE(result);
    EXPECT_NE(oss.str().find("successful"), std::string::npos);
}

TEST(TestValidateAndReport, FailingValidationPrintsDiff)
{
    const std::vector<int64_t> dims = {3, 3};
    Tensor<float> ref(dims);
    Tensor<float> impl(dims);

    iterateAlongDimensions(dims, [&](const std::vector<int64_t>& indices) {
        ref.setHostValue(0.0f, indices);
        impl.setHostValue(0.0f, indices);
    });

    ref.setHostValue(0.0f, std::vector<int64_t>{1, 1});
    impl.setHostValue(100.0f, std::vector<int64_t>{1, 1});

    const CpuFpReferenceValidation<float> validator(0.0f, 0.0f);

    std::ostringstream oss;
    const bool result = validateAndReport<float>(oss, "output", validator, ref, impl, 0.0f, 0.0f);

    EXPECT_FALSE(result);
    const std::string output = oss.str();
    EXPECT_NE(output.find("failed"), std::string::npos);
    EXPECT_NE(output.find("Tensor diff"), std::string::npos);
}

TEST(TestValidateAndReport, ShapeMismatchPrintsShapeError)
{
    Tensor<float> ref({2, 3});
    Tensor<float> impl({3, 2});

    const CpuFpReferenceValidation<float> validator(0.0f, 0.0f);

    std::ostringstream oss;
    const bool result = validateAndReport<float>(oss, "x", validator, ref, impl, 0.0f, 0.0f);

    EXPECT_FALSE(result);
    EXPECT_NE(oss.str().find("shape mismatch"), std::string::npos);
}