文件最后提交记录最后更新时间
13 天前
30 天前
30 天前
30 天前
30 天前
2 个月前
2 个月前
README

Sigmoid

产品支持情况

产品 是否支持
Ascend 950PR/Ascend 950DT
Atlas A3 训练系列产品/Atlas A3 推理系列产品
Atlas A2 训练系列产品/Atlas A2 推理系列产品
Atlas 200I/500 A2 推理产品 ×
Atlas 推理系列产品
Atlas 训练系列产品

功能说明

  • 算子功能:对输入 Tensor 完成 Sigmoid 运算。

计算公式:

out=11+e−inputout = \frac{1}{1 + e^{-input}}

  • 目录 experimental/activation/sigmoid_v2 对外导出 aclnnSigmoidaclnnInplaceSigmoid 两段式 ACLNN 接口。
  • op_host/op_api/aclnn_sigmoid.cpp 是对外 ACLNN 接口入口。
  • op_host/op_api/sigmoid.hop_host/op_api/sigmoid.cpp 提供内部 l0op::Sigmoid 封装,当前由 ACLNN 接口直接调用。

调用方式

调用方式 是否支持
ACLNN 调用
ACLNN 原地调用

ACLNN 接口

函数原型

当前 experimental Sigmoid 提供两段式 ACLNN 接口:

aclnnStatus aclnnSigmoidGetWorkspaceSize(
    const aclTensor *self,
    aclTensor *out,
    uint64_t *workspaceSize,
    aclOpExecutor **executor);

aclnnStatus aclnnSigmoid(
    void *workspace,
    uint64_t workspaceSize,
    aclOpExecutor *executor,
    const aclrtStream stream);

原地版本接口如下:

aclnnStatus aclnnInplaceSigmoidGetWorkspaceSize(
    aclTensor *selfRef,
    uint64_t *workspaceSize,
    aclOpExecutor **executor);

aclnnStatus aclnnInplaceSigmoid(
    void *workspace,
    uint64_t workspaceSize,
    aclOpExecutor *executor,
    const aclrtStream stream);

详细参数和返回值说明见 docs/aclnnSigmoid&aclnnInplaceSigmoid.md

参数说明

参数名 输入/输出 描述 数据类型 数据格式
self 输入 待进行 Sigmoid 计算的入参,公式中的 input。 FLOAT、FLOAT16、BFLOAT16 ND
out 输出 非原地接口的计算出参。 FLOAT、FLOAT16、BFLOAT16 ND
selfRef 输入/输出 原地接口的输入输出张量。 FLOAT、FLOAT16、BFLOAT16 ND

约束说明

  • 输入仅支持 FLOATFLOAT16BFLOAT16
  • 输入和输出的 dtype 必须一致。
  • 输入和输出的 shape 必须完全一致。
  • 支持 0 到 8 维 Tensor。
  • 支持空 Tensor。
  • 支持非连续 Tensor,接口内部会在需要时做 ContiguousViewCopy
  • FLOAT16BFLOAT16 路径在 kernel 中采用升精度计算,再回写到原 dtype。

目录说明

路径 说明
examples/test_aclnn_sigmoid.cpp aclnnSigmoid 两段式调用示例。
examples/test_aclnn_inplace_sigmoid.cpp aclnnInplaceSigmoid 两段式调用示例。
examples/run.sh 编译并运行 example 的脚本。
docs/aclnnSigmoid&aclnnInplaceSigmoid.md aclnnSigmoid / aclnnInplaceSigmoid 接口文档。
tests/ut/op_api/test_aclnn_sigmoid.cpp op_api 单元测试。
tests/st/aclnnSigmoid/all_aclnnSigmoid.json 适用于 ATK 的小规模标准化测试集。
tests/st/aclnnSigmoid/executor_aclnnSigmoid.py ATK CPU benchmark 执行器。

Example 运行

先确保 custom run 包已经安装,并加载 CANN 环境:

source /usr/local/Ascend/cann-8.5.0-beta.1/set_env.sh
export LD_LIBRARY_PATH=/usr/local/Ascend/cann-8.5.0-beta.1/opp/vendors/customize_nn/op_api/lib:${LD_LIBRARY_PATH}
cd /root/src/cann/ops-nn/experimental/activation/sigmoid_v2/examples
bash run.sh

示例会编译 test_aclnn_sigmoid.cpptest_aclnn_inplace_sigmoid.cpp 并直接运行,默认检查输入 [[0, 1], [2, 3]] 的输出是否与 CPU 参考值一致。

Tests 运行

1. op_api 单元测试

source /usr/local/Ascend/cann/set_env.sh
cd /root/src/cann/ops-nn
bash build.sh --experimental --ops=sigmoid -u --opapi -j8 -O2

2. ATK 小规模标准化测试

export ATK_BIND_CPU_TYPE=2
source /usr/local/Ascend/cann/set_env.sh
source /root/src/kernel/ascend-kernel/.venv/bin/activate
cd /root/src/testcase
atk node --backend npu --devices 2 \
  node --backend cpu task --task accuracy \
  -c /root/src/cann/ops-nn/experimental/activation/sigmoid_v2/tests/st/aclnnSigmoid/all_aclnnSigmoid.json \
  -p /root/src/cann/ops-nn/experimental/activation/sigmoid_v2/tests/st/aclnnSigmoid/executor_aclnnSigmoid.py