使用说明

Ascend C提供一组Conv3D高阶API，方便用户快速实现3维卷积正向矩阵运算。3维正向卷积的示意图如图1，其计算公式为：

$\text{[math]}$

X为Conv3D卷积的特征矩阵Input。
W为Conv3D卷积的权重矩阵Weight。
B为Conv3D卷积的偏置矩阵Bias。
Y为完成卷积及偏置操作之后的结果矩阵Output。

图1 3维正向卷积示意图

Cin为Input的输入通道大小Channel；Din为Input的Depth维度大小；Hin为Input的Height维度大小；Win为Input的Width维度大小；Cout为Weight、Output的输出通道大小；Dout为Output的Depth维度的大小；Hout为Output的Height维度大小；Wout为Output的Width维度大小；下文中提及的M维度，为卷积正向操作过程中的输入Input在img2col展开后的纵轴，数值上等于Hout * Wout。

Channel、Depth、Height、Width后续简称为C、D、H、W。

除上述基础运算外，在Conv3D计算中可以设置参数Padding、Stride和Dilation，具体含义如下。

Padding代表在输入矩阵的三个维度上填充0，见图2。
Stride代表卷积核三个维度上滑动的距离，见图3。
Dilation代表卷积核三个维度上每个数据的间距，见图4。

图2 卷积3D正向Padding示意图

图3 卷积3D正向Stride示意图

图4 卷积3D正向Dilation示意图

使用Conv3D高阶API实现Conv3D运算的具体步骤如下：

创建Conv3D对象。
初始化操作。
设置3D卷积输入Input、Weight、Bias和输出Output。
完成3D卷积操作。
结束3D卷积操作。

创建Conv3D对象。

       
            #include "lib/conv/conv3d/conv3d_api.h"

using inputType = ConvApi::ConvType<AscendC::TPosition::GM, ConvFormat::NDC1HWC0, bfloat16_t>;
using weightType = ConvApi::ConvType<AscendC::TPosition::GM, ConvFormat::FRACTAL_Z_3D, bfloat16_t>;
using outputType = ConvApi::ConvType<AscendC::TPosition::GM, ConvFormat::NDC1HWC0, bfloat16_t>;
using biasType = ConvApi::ConvType<AscendC::TPosition::GM, ConvFormat::ND, float>; // 可选参数

Conv3dApi::Conv3D<inputType, weightType, outputType, biasType> conv3dApi;

创建对象时需要传入Input、Weight和Output参数类型信息；Bias的参数类型为可选参数，不带Bias输入的卷积计算场景，不传入该参数。类型信息通过ConvType来定义，包括：内存逻辑位置、数据格式、数据类型。

       
            template <TPosition POSITION, ConvFormat FORMAT, typename TYPE>
struct ConvType {
    constexpr static TPosition pos = POSITION;    // Conv3d输入或输出在内存上的位置
    constexpr static ConvFormat format = FORMAT;  // Conv3d输入或者输出的数据格式
    using T = TYPE;                               // Conv3d输入或输出的数据类型
};

表1 ConvType说明
参数	说明
TPosition	内存逻辑位置。 Input矩阵可设置为TPosition::GM Weight矩阵可设置为TPosition::GM Bias矩阵可设置为TPosition::GM Output矩阵可设置为TPosition::GM
ConvFormat	数据格式。 Input矩阵可设置为ConvFormat::NDC1HWC0 Weight矩阵可设置为ConvFormat::FRACTAL_Z_3D Bias矩阵可设置为ConvFormat::ND Output矩阵可设置为ConvFormat::NDC1HWC0
TYPE	数据类型。 Input矩阵可设置为half、bfloat16_t Weight矩阵可设置为half、bfloat16_t Bias矩阵可设置为half、float Output矩阵可设置为half、bfloat16_t 注意：输入输出的矩阵数据类型需要对应，具体支持的数据类型组合关系请参考表2。

表2 Conv3D输入输出数据类型的组合说明
Input矩阵	Weight矩阵	Bias	Output矩阵	支持平台
half	half	half	half	Atlas A3 训练系列产品/Atlas A3 推理系列产品 Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件
bfloat16_t	bfloat16_t	float	bfloat16_t	Atlas A3 训练系列产品/Atlas A3 推理系列产品 Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件

初始化操作。

       
            Conv3dApi::Conv3D<inputType, weightType, outputType, biasType> conv3dApi;
TPipe pipe;                                                        // 初始化TPipe
conv3dApi.Init(&tiling);                                           // 初始化conv3dApi

设置3D卷积的输入Input、Weight、Bias和输出Output。

       
            conv3dApi.SetWeight(weightGm);               // 设置当前核的输入weight在gm上的地址
if (biasFlag) {
    conv3dApi.SetBias(biasGm);               // 设置当前核的输入bias在gm上的地址
}
// 设置input各个维度在当前核的偏移
conv3dApi.SetInputStartPosition(diStartPos, mStartPos);
// 设置当前核的cout,dout,m大小
conv3dApi.SetSingleOutputShape(singleCoreCout, singleCoreDout, singleCoreM);

// 当前Conv3D仅支持单batch的卷积计算，多batch场景通过for循环实现，在循环间计算当前batch的地址偏移
for (uint64_t batchIter = 0; batchIter < singleCoreBatch; ++batchIter) {
    conv3dApi.SetInput(inputGm[batchIter * inputOneBatchSize]);    // 设置当前核的输入input在gm上的地址
}

完成3D卷积操作。

调用IterateAll完成单核上所有数据的计算。

        
             for (uint64_t batchIter = 0; batchIter < singleCoreBatch; ++batchIter) {
    ...
    conv3dApi.IterateAll(outputGm[batchIter * outputOneBatchSize]);    // 调用IterateAll完成Conv3D计算
    ...
}

结束3D卷积操作。

       
            for (uint64_t batchIter = 0; batchIter < singleCoreBatch; ++batchIter) {
    ...
    conv3dApi.End();    //清除EventID和释放内部申请的临时内存
}

父主题： Conv3D