aclnnSilentCheckV2

支持的产品型号

Atlas A2 训练系列产品/Atlas 800I A2 推理产品。

接口原型

每个算子分为两段式接口，必须先调用“aclnnSilentCheckV2GetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnSilentCheckV2”接口执行计算。

aclnnStatus aclnnSilentCheckV2GetWorkspaceSize(const aclTensor* val, const aclTensor* max, aclTensor* avgRef, aclTensor* inputGradRef, aclTensor* stepRef, aclIntArray* dstSize, aclIntArray* dstStride, aclIntArray* dstOffset, float cThreshL1, float cCoeffL1, float cThreshL2, float beta1, int32_t npuAsdDetect, aclTensor* result, uint64_t* workspaceSize, aclOpExecutor** executor)
aclnnStatus aclnnSilentCheckV2(void* workspace, uint64_t workspaceSize, aclOpExecutor* executor, aclrtStream stream)

功能描述

算子功能：新增aclnnSilentCheckV2接口，该版本与aclnnSilentCheck接口的计算逻辑做了改变，根据stepRef参数判断val与新增马尔可夫不等式阈值进行对比校验。
计算公式：
- 如果stepRef==0:
  - 如果当前输入val为inf/nan，或val超过avgRef * cThreshL1，则识别为L1级故障，打印ERROR日志，若环境变量npuAsdDetect为1，则更新avgRef与stepRef后正常返回，否则将inputGradRef置零、触发断点续训。
  - 如果当前输入val超过avgRef * cThreshL2，则识别为L2级告警；打印WARNING日志，并更新avgRef与stepRef后正常返回。
- 如果stepRef>0:
  - 如果当前输入val为inf/nan，或val超过马尔可夫不等式阈值(avgRef/(1-beta1)^stepRef) * cThreshL1，则识别为L1级故障，打印ERROR日志。若环境变量npuAsdDetect为2，触发断点续训；若环境变量npuAsdDetect为1，则更新vagRef与stepRef后正常返回。
  - 如果当前输入val超过马尔可夫不等式阈值(avgRef/(1-beta1)^stepRef) * cThreshL2，则识别为L2级告警；打印WARNING日志，并更新avgRef与stepRef后正常返回。
  - 如果没有触发L1级故障、L2级告警，正常情况下：若npuAsdDetect为3，则打印val特征值；否则更新avgRef与stepRef后正常返回。
- 其中stepRef为检测次数。

aclnnSilentCheckV2GetWorkspaceSize

参数说明：
- val（aclTensor*, 计算输入）：shape要求是[1]，Device侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16。数据格式支持ND。
- max（aclTensor*, 计算输入）：shape要求是[1]，Device侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16。据格式支持ND。
- avgRef（aclTensor*, 计算输入）：shape要求是[1]，Device侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16。数据格式支持ND。
- inputGradRef（aclTensor*, 计算输入）：模型输入的梯度tensor，Device侧的aclTensor，数据类型支持FLOAT、FLOAT16、BFLOAT16。支持非连续的Tensor，数据格式支持ND
- stepRef（aclIntArray*, 计算输入）：当前步数stepRef，Device侧的aclTensor，数据类型支持INT64，shape要求是[1]且不支持负数。数据格式支持ND。
- dstSize（aclIntArray*, 计算输入）：Device侧的aclIntArray，数据类型支持INT64。数据格式支持ND。
- dstStride（aclIntArray*, 计算输入）：Device侧的aclIntArray，数据类型支持INT64。数据格式支持ND。
- dstOffset（aclTensor*, 计算输入）：Device侧的aclIntArray，数据类型支持INT64。数据格式支持ND。
- cThreshL1（float, 计算输入）：绝对数值L1级故障阈值，Host侧浮点型，数据类型支持FLOAT，参考传参100000。
- cThreshLl2（float, 计算输入）：绝对数值L2级告警阈值，Host侧浮点型，数据类型支持FLOAT，参考传参10000，cThreshL1 > cThreshL2。
- beta1（float, 计算输入）：Host侧浮点型，数据类型支持FLOAT参考传参0.99，范围0 < beta1 < 1，建议数据无限接近1。
- npuAsdDetect（int32_t, 计算输入）：环境变量，Host侧整型，数据类型支持INT32。
- result（aclTensor*, 计算输出）：返回静默检测结果，Device侧的aclTensor，数据类型支持INT32，数据格式支持ND。
- workspaceSize(uint64_t*, 出参)：返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor**, 出参)：返回op执行器，包含了算子计算流程。
返回值：

aclnnStatus：返回状态码，具体参见aclnn返回码。

第一段接口完成入参校验，出现以下场景时报错：
返回161001 (ACLNN_ERR_PARAM_NULLPTR)：1.传入的val, max, avgRef, inputGradRef, stepRef, dstSize, dstStride, dstOffset是空指针。 
返回161002 (ACLNN_ERR_PARAM_INVALID)：1.传入的val, max, avgRef, inputGradRef, stepRef, dstSize, dstStride, dstOffset的数据类型不在支持的范围内。
                                     2.传入的val, max, avgRef, inputGradRef, stepRef, dstSize, dstStride, dstOffset的shape不满足要求。
                                     3.传入的cThreshL1, cThreshL2, beta1的范围不满足要求。

aclnnSilentCheckV2

参数说明：
- workspace（void*, 入参）：在Device侧申请的workspace内存地址。
- workspaceSize（uint64_t, 入参）：在Device侧申请的workspace大小，由第一段接口aclnnSilentCheckV2GetWorkspaceSize获取。
- executor（aclOpExecutor*, 入参）：op执行器，包含了算子计算流程。
- stream（aclrtStream, 入参）：指定执行任务的AscendCL Stream流。
返回值：

aclnnStatus：返回状态码，具体参见aclnn返回码。

约束与限制

无

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考编译与运行样例。

#include <iostream>
#include <vector>
#include "acl/acl.h"
#include "aclnnop/aclnn_silent_check_v2.h"

#define CHECK_RET(cond, return_expr) \
    do {                               \
        if (!(cond)) {                   \
        return_expr;                   \
        }                                \
    } while (0)

#define LOG_PRINT(message, ...)     \
    do {                              \
        printf(message, ##__VA_ARGS__); \
    } while (0)

int64_t GetShapeSize(std::vector<int64_t>& shape) {
    int64_t shapeSize = 1;
    for (auto i : shape) {
        shapeSize *= i;
  }
    return shapeSize;
}

void PrintOutResult(std::vector<int64_t> &shape, void** deviceAddr) {
  auto size = GetShapeSize(shape);
  std::vector<int32_t> resultData(size, 0);
  auto ret = aclrtMemcpy(resultData.data(), resultData.size() * sizeof(resultData[0]),
                         *deviceAddr, size * sizeof(resultData[0]), ACL_MEMCPY_DEVICE_TO_HOST);
  CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("copy result from device to host failed. ERROR: %d\n", ret); return);
  for (int64_t i = 0; i < size; i++) {
    LOG_PRINT("result[%ld] is: %d\n", i, resultData[i]);
  }
}

int Init(int32_t deviceId, aclrtStream* stream) {
    // 固定写法，acl初始化
    auto ret = aclInit(nullptr);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclInit failed. ERROR: %d\n", ret); return ret);
    ret = aclrtSetDevice(deviceId);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); return ret);
    ret = aclrtCreateStream(stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtCreateStream failed. ERROR: %d\n", ret); return ret);
    return 0;
}

template <typename T>
int CreateAclTensor(std::vector<T>& hostData, std::vector<int64_t>& shape, void** deviceAddr,
                    aclDataType dataType, aclTensor** tensor) {
    auto size = GetShapeSize(shape) * sizeof(T);
    // 调用aclrtMalloc申请device侧内存
    auto ret = aclrtMalloc(deviceAddr, size, ACL_MEM_MALLOC_HUGE_FIRST);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMalloc failed. ERROR: %d\n", ret); return ret);

    // 调用aclrtMemcpy将host侧数据拷贝到device侧内存上
    ret = aclrtMemcpy(*deviceAddr, size, hostData.data(), size, ACL_MEMCPY_HOST_TO_DEVICE);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtMemcpy failed. ERROR: %d\n", ret); return ret);

    // 计算连续tensor的strides
    std::vector<int64_t> strides(shape.size(), 1);
    for (int64_t i = shape.size() - 2; i >= 0; i--) {
       strides[i] = shape[i + 1] * strides[i + 1];
    }

    // 调用aclCreateTensor接口创建aclTensor
    *tensor = aclCreateTensor(shape.data(), shape.size(), dataType, strides.data(), 0, aclFormat::ACL_FORMAT_ND,
                              shape.data(), shape.size(), *deviceAddr);
    return 0;
}

int main() {
    // 1.(固定写法)device/stream初始化, 参考acl对外接口列表
    // 根据自己的实际device填写deviceId
    int32_t deviceId = 0;
    aclrtStream stream;
    auto ret = Init(deviceId, &stream);
    // check根据自己的需要处理
    CHECK_RET(ret == 0, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);
    // 2.构造输入与输出，需要根据API的接口自定义构造
    std::vector<int64_t> valShape = {1};
    std::vector<int64_t> maxShape = {1};
    std::vector<int64_t> avgRefShape = {1};
    std::vector<int64_t> inputGradRefShape = {2, 3};
    std::vector<int64_t> stepRefShape = {1};
    std::vector<int64_t> resultShape = {1};
    void* valDeviceAddr = nullptr;
    void* maxDeviceAddr = nullptr;
    void* avgRefDeviceAddr = nullptr;
    void* inputGradRefDeviceAddr = nullptr;
    void* stepRefDeviceAddr = nullptr;
    void* resultDeviceAddr = nullptr;
    aclTensor* val = nullptr;
    aclTensor* max = nullptr;
    aclTensor* avgRef = nullptr;
    aclTensor* inputGradRef = nullptr;
    aclTensor* stepRef = nullptr;
    aclTensor* result = nullptr;
    std::vector<float> valHostData = {160.0};
    std::vector<float> maxHostData = {400.0};
    std::vector<float> avgRefHostData = {200.0};
    std::vector<float> inputGradRefHostData = {0, 1, 2, 3, 4, 5};
    std::vector<int64_t> stepRefHostData = {0};
    std::vector<int64_t> dstSizeData = {2, 3};
    std::vector<int64_t> dstStrideData = {3, 1};
    std::vector<int64_t> dstOffsetData = {0};
    std::vector<int32_t> resultHostData = {0};
    aclIntArray* dstSize = aclCreateIntArray(dstSizeData.data(), 2);
    aclIntArray* dstStride = aclCreateIntArray(dstStrideData.data(), 2);
    aclIntArray* dstOffset = aclCreateIntArray(dstOffsetData.data(), 1);
    float cThreshL1 = 1000000;
    float cThreshL2 = 10000;
    float beta1 = 0.99;
    int32_t npuAsdDetect = 3;

    // 创建val aclTensor
    ret = CreateAclTensor(valHostData, valShape, &valDeviceAddr, aclDataType::ACL_FLOAT, &val);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建max aclTensor
    ret = CreateAclTensor(maxHostData, maxShape, &maxDeviceAddr, aclDataType::ACL_FLOAT, &max);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建avgRef aclTensor
    ret = CreateAclTensor(avgRefHostData, avgRefShape, &avgRefDeviceAddr, aclDataType::ACL_FLOAT, &avgRef);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建inputGradRef aclTensor
    ret = CreateAclTensor(inputGradRefHostData, inputGradRefShape, &inputGradRefDeviceAddr , aclDataType::ACL_FLOAT, &inputGradRef);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建stepRef aclTensor
    ret = CreateAclTensor(stepRefHostData, stepRefShape, &stepRefDeviceAddr , aclDataType::ACL_INT64, &stepRef);
    CHECK_RET(ret == ACL_SUCCESS, return ret);
    // 创建result aclTensor
    ret = CreateAclTensor(resultHostData, resultShape, &resultDeviceAddr, aclDataType::ACL_INT32, &result);
    if (result == nullptr) {
        std::cout << "result is nullptr!" << std::endl;
        return 0;
    }
    CHECK_RET(ret == ACL_SUCCESS, return ret);

    // 3.调用CANN算子库API，需要修改为具体的HostApi
    uint64_t workspaceSize = 0;
    aclOpExecutor* executor;
    // 调用aclnnSilentCheckV2第一段接口
    ret = aclnnSilentCheckV2GetWorkspaceSize(val, max, avgRef, inputGradRef, stepRef, dstSize, dstStride, dstOffset, cThreshL1, cThreshL2, beta1, npuAsdDetect, result, &workspaceSize, &executor);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnSilentCheckV2GetWorkspaceSize failed. ERROR: %d\n", ret); return ret);
    // 根据第一段接口计算出的workspaceSize申请device内存
    void* workspaceAddr = nullptr;
    if (workspaceSize > 0) {
        ret = aclrtMalloc(&workspaceAddr, workspaceSize, ACL_MEM_MALLOC_HUGE_FIRST);
        CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret);
    }
    // 调用aclnnSilentCheckV2第二段接口
    ret = aclnnSilentCheckV2(workspaceAddr, workspaceSize, executor, stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclnnSilentCheckV2 failed. ERROR: %d\n", ret); return ret);
    // 4.(固定写法)同步等待任务执行结束
    ret = aclrtSynchronizeStream(stream);
    CHECK_RET(ret == ACL_SUCCESS, LOG_PRINT("aclrtSynchronizeStream failed. ERROR: %d\n", ret); return ret);
    // 5.获取输出的值，将device侧内存上的结果拷贝至host侧，需要根据具体API的接口定义修改
    PrintOutResult(resultShape, &resultDeviceAddr);

    // 6.释放aclTensor和aclScalar，需要根据具体API的接口定义修改
    aclDestroyTensor(val);
    aclDestroyTensor(max);
    aclDestroyTensor(avgRef);
    aclDestroyTensor(inputGradRef);
    aclDestroyTensor(stepRef);
    aclDestroyIntArray(dstSize);
    aclDestroyIntArray(dstStride);
    aclDestroyIntArray(dstOffset);
    aclDestroyTensor(result);

    // 7.释放device资源，需要根据具体API的接口定义修改
    aclrtFree(valDeviceAddr);
    aclrtFree(maxDeviceAddr);
    aclrtFree(avgRefDeviceAddr);
    aclrtFree(inputGradRefDeviceAddr);
    aclrtFree(stepRefDeviceAddr);
    aclrtFree(resultDeviceAddr);
    if (workspaceSize > 0) {
        aclrtFree(workspaceAddr);
    }
    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();
    return 0;
}