/******************************************************************************* * * MIT License * * Copyright (c) 2024 Advanced Micro Devices, Inc. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. * *******************************************************************************/ #ifndef GUARD_MIOPEN_T5LAYERNORM_DRIVER_HPP #define GUARD_MIOPEN_T5LAYERNORM_DRIVER_HPP #include <../test/tensor_holder.hpp> #include <../test/verify.hpp> #include "InputFlags.hpp" #include "driver.hpp" #include "random.hpp" #include "tensor_driver.hpp" #include "timer.hpp" #include #include #include #include #include template int32_t mloT5LayerNormForwardRunHost(miopenTensorDescriptor_t xDesc, Tgpu* x, Tgpu* weight, Tcheck* yhost, Tcheck* rstdhost, float eps, miopenNormMode_t mode, bool use_multithread) { auto dims = miopen::deref(xDesc).GetLengths(); size_t outer_size = 1; size_t inner_size = dims[dims.size() - 1]; for(size_t i = 0ULL; i < dims.size() - 1; ++i) { outer_size *= dims[i]; } int32_t ret = 0; size_t min_grain = use_multithread ? 8 : outer_size; miopen::par_for(outer_size, min_grain, [&](int32_t o) { Tcheck pvar = static_cast(0); for(int32_t i = 0; i < inner_size; i++) { Tcheck tmp = static_cast(x[o * inner_size + i]); pvar += tmp * tmp; } pvar = pvar / inner_size; Tcheck prstd = static_cast(1.0) / sqrt(pvar + eps); rstdhost[o] = prstd; for(int32_t i = 0; i < inner_size; i++) { Tcheck pweight = (mode == MIOPEN_ELEMENTWISE_AFFINE_T5) ? static_cast(1) : static_cast(weight[i]); yhost[o * inner_size + i] = (static_cast(x[o * inner_size + i])) * prstd * pweight; } }); return ret; } template int32_t mloT5LayerNormBackwardRunHost(miopenTensorDescriptor_t dyDesc, Tgpu* dy, Tgpu* x, Tgpu* weight, Tcheck* rstdhost, Tcheck* dxhost, miopenNormMode_t mode, bool use_multithread) { auto dims = miopen::deref(dyDesc).GetLengths(); size_t outer_size = 1; size_t inner_size = dims[dims.size() - 1]; for(size_t i = 0ULL; i < dims.size() - 1; ++i) { outer_size *= dims[i]; } int32_t ret = 0; size_t min_grain = use_multithread ? 8 : outer_size; miopen::par_for(outer_size, min_grain, [&](int32_t o) { Tcheck sum = static_cast(0); for(int32_t i = 0; i < inner_size; i++) { Tcheck pweight = (mode == MIOPEN_ELEMENTWISE_AFFINE_T5) ? static_cast(1) : static_cast(weight[i]); Tcheck pdy = dy ? static_cast(dy[o * inner_size + i]) : static_cast(0); Tcheck px = static_cast(x[o * inner_size + i]); sum += pdy * px * pweight; } Tcheck ds = sum; Tcheck s = static_cast(1) / inner_size; Tcheck prstd = rstdhost[o]; Tcheck a = ds * prstd * prstd * prstd * s; for(int32_t i = 0; i < inner_size; i++) { Tcheck pweight = (mode == MIOPEN_ELEMENTWISE_AFFINE_T5) ? static_cast(1) : static_cast(weight[i]); Tcheck pdy = dy ? static_cast(dy[o * inner_size + i]) : static_cast(0); Tcheck val = prstd * pdy * pweight - a * static_cast(x[o * inner_size + i]); dxhost[o * inner_size + i] = static_cast(val); } }); return ret; } template int32_t mloT5LayerNormBackwardweightRunHost(miopenTensorDescriptor_t dyDesc, Tgpu* dy, Tgpu* x, Tcheck* rstdhost, Tcheck* dwhost, bool use_multithread) { auto dims = miopen::deref(dyDesc).GetLengths(); size_t outer_size = 1; size_t inner_size = dims[dims.size() - 1]; for(size_t i = 0ULL; i < dims.size() - 1; ++i) { outer_size *= dims[i]; } int32_t ret = 0; size_t min_grain = use_multithread ? 8 : inner_size; miopen::par_for(inner_size, min_grain, [&](int32_t o) { Tcheck sum = static_cast(0); for(uint64_t i = 0; i < outer_size; ++i) { Tcheck prstd = static_cast(rstdhost[i]); Tcheck pdy = dy ? static_cast(dy[i * inner_size + o]) : 0; Tcheck px = static_cast(x[i * inner_size + o]); sum += pdy * px * prstd; } dwhost[o] = sum; }); return ret; } template class T5LayerNormDriver : public Driver { public: T5LayerNormDriver() : Driver() { miopenCreateTensorDescriptor(&xDesc); miopenCreateTensorDescriptor(&weightDesc); miopenCreateTensorDescriptor(&yDesc); miopenCreateTensorDescriptor(&rstdDesc); miopenCreateTensorDescriptor(&dyDesc); miopenCreateTensorDescriptor(&dxDesc); miopenCreateTensorDescriptor(&dwDesc); data_type = miopen_type{}; } int AddCmdLineArgs() override; int ParseCmdLineArgs(int argc, char* argv[]) override; InputFlags& GetInputFlags() override { return inflags; } int GetandSetData() override; std::vector GetInputTensorLengthsFromCmdLine(); int AllocateBuffersAndCopy() override; int RunForwardGPU() override; int RunForwardCPU(); int RunBackwardGPU() override; int RunBackwardCPU(); Tref GetTolerance(); int VerifyBackward() override; int VerifyForward() override; ~T5LayerNormDriver() override { miopenDestroyTensorDescriptor(xDesc); miopenDestroyTensorDescriptor(weightDesc); miopenDestroyTensorDescriptor(yDesc); miopenDestroyTensorDescriptor(rstdDesc); miopenDestroyTensorDescriptor(dyDesc); miopenDestroyTensorDescriptor(dxDesc); miopenDestroyTensorDescriptor(dwDesc); } private: InputFlags inflags; int dim_size; miopenTensorDescriptor_t xDesc; miopenTensorDescriptor_t weightDesc; miopenTensorDescriptor_t yDesc; miopenTensorDescriptor_t rstdDesc; miopenTensorDescriptor_t dyDesc; miopenTensorDescriptor_t dxDesc; miopenTensorDescriptor_t dwDesc; std::unique_ptr x_dev; std::unique_ptr weight_dev; std::unique_ptr y_dev; std::unique_ptr rstd_dev; std::unique_ptr dy_dev; std::unique_ptr dx_dev; std::unique_ptr dw_dev; std::unique_ptr workspace_dev; std::vector x; std::vector weight; std::vector y; std::vector rstd; std::vector yhost; std::vector rstdhost; std::vector yhost_mt; std::vector rstdhost_mt; std::vector dy; std::vector dx; std::vector dw; std::vector dxhost; std::vector dwhost; std::vector dxhost_mt; std::vector dwhost_mt; size_t ws_sizeInBytes; float eps; miopenNormMode_t mode; bool use_multithread; }; template int T5LayerNormDriver::ParseCmdLineArgs(int argc, char* argv[]) { inflags.Parse(argc, argv); if(inflags.GetValueInt("time") == 1) { miopenEnableProfiling(GetHandle(), true); } use_multithread = (inflags.GetValueInt("mt") != 0); return miopenStatusSuccess; } template int T5LayerNormDriver::GetandSetData() { auto inTensorParam = inflags.GetValueTensor("input"); auto in_len = inTensorParam.lengths; std::vector inner_len; inner_len = {in_len[in_len.size() - 1]}; MIOPEN_THROW_IF(inner_len[0] == 0, "Final dimension must be nonzero"); std::vector outer_len; outer_len = {in_len.begin(), in_len.end() - 1}; if(SetTensorNd(xDesc, in_len, data_type) != miopenStatusSuccess) MIOPEN_THROW("Error parsing input tensor: " + inflags.GetValueStr("input") + "."); if(SetTensorNd(weightDesc, inner_len, data_type) != miopenStatusSuccess) MIOPEN_THROW("Error setting weight tensor."); if(SetTensorNd(yDesc, in_len, data_type) != miopenStatusSuccess) MIOPEN_THROW("Error setting output tensor."); if(SetTensorNd(rstdDesc, outer_len, data_type) != miopenStatusSuccess) MIOPEN_THROW("Error setting rstd tensor."); if(SetTensorNd(dyDesc, in_len, data_type) != miopenStatusSuccess) MIOPEN_THROW("Error setting dy tensor."); if(SetTensorNd(dxDesc, in_len, data_type) != miopenStatusSuccess) MIOPEN_THROW("Error setting dx tensor."); if(SetTensorNd(dwDesc, inner_len, data_type) != miopenStatusSuccess) MIOPEN_THROW("Error setting dw tensor."); eps = static_cast(inflags.GetValueDouble("eps")); mode = miopenNormMode_t(inflags.GetValueInt("mode")); return 0; } template int T5LayerNormDriver::AddCmdLineArgs() { inflags.AddInputFlag("forw", 'F', "0", "Run only Forward T5LayerNorm (Default=1)", "int"); inflags.AddTensorFlag("input", 'X', "100x3x32x32", "input tensor descriptor"); inflags.AddInputFlag("eps", 'e', "0.00001", "Alpha (Default=0.00001)", "double"); inflags.AddInputFlag( "mode", 'm', "5", "elemwise affine mode (5), weight mode (6) (Default=5)", "int"); inflags.AddInputFlag("iter", 'i', "10", "Number of Iterations (Default=10)", "int"); inflags.AddInputFlag("verify", 'V', "1", "Verify Each Layer (Default=1)", "int"); inflags.AddInputFlag("time", 't', "0", "Time Each Layer (Default=0)", "int"); inflags.AddInputFlag( "wall", 'w', "0", "Wall-clock Time Each Layer, Requires time == 1 (Default=0)", "int"); inflags.AddInputFlag("mt", 'u', "0", "Use multithreaded version (Default=0)", "int"); return miopenStatusSuccess; } template int T5LayerNormDriver::AllocateBuffersAndCopy() { const Tgpu Tgpu0val = static_cast(0.0); const Tgpu Tgpu1val = static_cast(1.0); const Tgpu Tgpuminus1val = static_cast(-1.0); const Tref Tref0ref = static_cast(0.0); size_t x_sz = GetTensorSize(xDesc); size_t weight_sz = GetTensorSize(weightDesc); size_t y_sz = GetTensorSize(yDesc); size_t rstd_sz = GetTensorSize(rstdDesc); size_t dy_sz = GetTensorSize(dyDesc); size_t dx_sz = GetTensorSize(dxDesc); size_t dw_sz = GetTensorSize(dwDesc); miopenGetT5LayerNormBackwardWorkspaceSize( GetHandle(), mode, dyDesc, xDesc, weightDesc, rstdDesc, dxDesc, dwDesc, &ws_sizeInBytes); if(ws_sizeInBytes == static_cast(-1)) return miopenStatusAllocFailed; uint32_t ctx = 0; x_dev = std::unique_ptr(new GPUMem(ctx, x_sz, sizeof(Tgpu))); weight_dev = std::unique_ptr(new GPUMem(ctx, weight_sz, sizeof(Tgpu))); y_dev = std::unique_ptr(new GPUMem(ctx, y_sz, sizeof(Tgpu))); rstd_dev = std::unique_ptr(new GPUMem(ctx, rstd_sz, sizeof(Tgpu))); dy_dev = std::unique_ptr(new GPUMem(ctx, dy_sz, sizeof(Tgpu))); dx_dev = std::unique_ptr(new GPUMem(ctx, dx_sz, sizeof(Tgpu))); dw_dev = std::unique_ptr(new GPUMem(ctx, dw_sz, sizeof(Tgpu))); workspace_dev = std::unique_ptr(new GPUMem(ctx, ws_sizeInBytes, sizeof(std::byte))); x = std::vector(x_sz, Tgpu0val); weight = std::vector(weight_sz, Tgpu0val); y = std::vector(y_sz, Tgpu0val); rstd = std::vector(rstd_sz, Tgpu0val); dy = std::vector(dy_sz, Tgpu0val); dx = std::vector(dx_sz, Tgpu0val); dw = std::vector(dw_sz, Tgpu0val); yhost = std::vector(y_sz, Tref0ref); rstdhost = std::vector(rstd_sz, Tref0ref); dxhost = std::vector(dx_sz, Tref0ref); dwhost = std::vector(dw_sz, Tref0ref); for(int i = 0; i < x_sz; i++) { x[i] = prng::gen_A_to_B(Tgpuminus1val, Tgpu1val); dy[i] = prng::gen_A_to_B(Tgpuminus1val, Tgpu1val); } if(x_dev->ToGPU(GetStream(), x.data()) != 0) std::cerr << "Error copying (x) to GPU, size: " << x_dev->GetSize() << std::endl; if(dy_dev->ToGPU(GetStream(), dy.data()) != 0) std::cerr << "Error copying (dy) to GPU, size: " << dy_dev->GetSize() << std::endl; for(int i = 0; i < weight_sz; i++) { if(mode == MIOPEN_ELEMENTWISE_AFFINE_T5) weight[i] = Tgpu1val; else weight[i] = prng::gen_A_to_B(Tgpuminus1val, Tgpu1val); } if(weight_dev->ToGPU(GetStream(), weight.data()) != 0) std::cerr << "Error copying (weight) to GPU, size: " << weight_dev->GetSize() << std::endl; if(y_dev->ToGPU(GetStream(), y.data()) != 0) std::cerr << "Error copying (y) to GPU, size: " << y_dev->GetSize() << std::endl; if(rstd_dev->ToGPU(GetStream(), rstd.data()) != 0) std::cerr << "Error copying (rstd) to GPU, size: " << rstd_dev->GetSize() << std::endl; if(dx_dev->ToGPU(GetStream(), dx.data()) != 0) std::cerr << "Error copying (dx) to GPU, size: " << dx_dev->GetSize() << std::endl; if(dw_dev->ToGPU(GetStream(), dw.data()) != 0) std::cerr << "Error copying (dw) to GPU, size: " << dw_dev->GetSize() << std::endl; return miopenStatusSuccess; } template int T5LayerNormDriver::RunForwardGPU() { float kernel_total_time = 0.0; float kernel_first_time = 0.0; Timer t; START_TIME for(int i = 0; i < inflags.GetValueInt("iter"); i++) { miopenT5LayerNormForward(GetHandle(), mode, xDesc, x_dev->GetMem(), weightDesc, weight_dev->GetMem(), eps, yDesc, y_dev->GetMem(), rstdDesc, rstd_dev->GetMem()); float time = 0.0; miopenGetKernelTime(GetHandle(), &time); kernel_total_time += time; if(i == 0) kernel_first_time = time; } if(inflags.GetValueInt("time") == 1) { STOP_TIME int iter = inflags.GetValueInt("iter"); if(WALL_CLOCK) std::cout << "Wall-clock Time Forward T5LayerNorm Elapsed: " << t.gettime_ms() / iter << " ms\n"; float kernel_average_time = iter > 1 ? (kernel_total_time - kernel_first_time) / (iter - 1) : kernel_first_time; std::cout << "GPU Kernel Time Forward T5LayerNorm Elapsed: " << kernel_average_time << " ms\n"; } if(y_dev->FromGPU(GetStream(), y.data()) != 0) std::cerr << "Error copying (y_dev) from GPU, size: " << y_dev->GetSize() << std::endl; if(rstd_dev->FromGPU(GetStream(), rstd.data()) != 0) std::cerr << "Error copying (rstd_dev) from GPU, size: " << rstd_dev->GetSize() << std::endl; return miopenStatusSuccess; } template int T5LayerNormDriver::RunForwardCPU() { mloT5LayerNormForwardRunHost( xDesc, x.data(), weight.data(), yhost.data(), rstdhost.data(), eps, mode, use_multithread); return miopenStatusSuccess; } template int T5LayerNormDriver::RunBackwardGPU() { float kernel_total_time = 0.0; float kernel_first_time = 0.0; Timer t; START_TIME for(int i = 0; i < inflags.GetValueInt("iter"); i++) { miopenT5LayerNormBackward(GetHandle(), mode, workspace_dev->GetMem(), ws_sizeInBytes, dyDesc, dy_dev->GetMem(), xDesc, x_dev->GetMem(), weightDesc, weight_dev->GetMem(), rstdDesc, rstd_dev->GetMem(), dxDesc, dx_dev->GetMem(), dwDesc, dw_dev->GetMem()); float time = 0.0; miopenGetKernelTime(GetHandle(), &time); kernel_total_time += time; if(i == 0) kernel_first_time = time; } if(inflags.GetValueInt("time") == 1) { STOP_TIME int iter = inflags.GetValueInt("iter"); if(WALL_CLOCK) std::cout << "Wall-clock Time Backward T5LayerNorm Elapsed: " << t.gettime_ms() / iter << " ms\n"; float kernel_average_time = iter > 1 ? (kernel_total_time - kernel_first_time) / (iter - 1) : kernel_first_time; std::cout << "GPU Kernel Time Backward T5LayerNorm Elapsed: " << kernel_average_time << " ms\n"; } if(dx_dev->FromGPU(GetStream(), dx.data()) != 0) std::cerr << "Error copying (dx_dev) from GPU, size: " << dx_dev->GetSize() << std::endl; if(dw_dev->FromGPU(GetStream(), dw.data()) != 0) std::cerr << "Error copying (dw_dev) from GPU, size: " << dw_dev->GetSize() << std::endl; return miopenStatusSuccess; } template int T5LayerNormDriver::RunBackwardCPU() { mloT5LayerNormBackwardRunHost(dyDesc, dy.data(), x.data(), weight.data(), rstdhost.data(), dxhost.data(), mode, use_multithread); mloT5LayerNormBackwardweightRunHost( dyDesc, dy.data(), x.data(), rstdhost.data(), dwhost.data(), use_multithread); return miopenStatusSuccess; } template Tref T5LayerNormDriver::GetTolerance() { // Computation error of fp16 is ~2^13 (=8192) bigger than // the one of fp32 because mantissa is shorter by 13 bits. auto tolerance = std::is_same::value ? 1.5e-6 : 8.2e-3; // bf16 mantissa has 7 bits, by 3 bits shorter than fp16. if(std::is_same::value) tolerance *= 8.0; return tolerance; } template int T5LayerNormDriver::VerifyForward() { RunForwardCPU(); const Tref tolerance = GetTolerance(); auto error = miopen::rms_range(yhost, y); std::string solver_type = use_multithread ? "multi-threaded" : "single-threaded"; if(!std::isfinite(error) || error > tolerance) { std::cout << "Forward T5LayerNorm FAILED against " << solver_type << " CPU reference: " << error << " > " << tolerance << std::endl; return EC_VerifyFwd; } else { std::cout << "Forward T5LayerNorm Verifies OK against " << solver_type << " CPU reference (" << error << " < " << tolerance << ')' << std::endl; } auto rstderror = miopen::rms_range(rstdhost, rstd); if(!std::isfinite(rstderror) || rstderror > tolerance) { std::cout << "Forward T5LayerNorm rstd FAILED against " << solver_type << " CPU reference: " << rstderror << " > " << tolerance << std::endl; return EC_VerifyFwd; } else { std::cout << "Forward T5LayerNorm rstd Verifies OK against " << solver_type << " CPU reference (" << rstderror << " < " << tolerance << ')' << std::endl; } return miopenStatusSuccess; } template int T5LayerNormDriver::VerifyBackward() { RunBackwardCPU(); const Tref tolerance = GetTolerance(); auto error = miopen::rms_range(dxhost, dx); std::string solver_type = use_multithread ? "multi-threaded" : "single-threaded"; if(!std::isfinite(error) || error > tolerance) { std::cout << "Backward T5LayerNorm FAILED against " << solver_type << " CPU reference: " << error << " > " << tolerance << std::endl; return EC_VerifyBwd; } else { std::cout << "Backward T5LayerNorm Verifies OK against " << solver_type << " CPU reference (" << error << " < " << tolerance << ')' << std::endl; } auto dwerror = miopen::rms_range(dwhost, dw); if(!std::isfinite(dwerror) || dwerror > tolerance) { std::cout << "Backward T5LayerNorm dw FAILED against " << solver_type << " CPU reference: " << dwerror << " > " << tolerance << std::endl; return EC_VerifyBwd; } else { std::cout << "Backward T5LayerNorm dw Verifies OK against " << solver_type << " CPU reference (" << dwerror << " < " << tolerance << ')' << std::endl; } return miopenStatusSuccess; } #endif // GUARD_MIOPEN_T5LAYERNORM_DRIVER_HPP