Closed
[Documentation|文档反馈]: softshrink,sparse_apply_ftrl 资料与代码实现不一致,产品支持/约束/调用说明需统一 #8371
小王!Add on 14 days agoClosed at 12 days ago
14 days ago Assign qq_52056150 as responsible person
12 days ago Close issue
12 days ago changed custom state from 待办的 to 已完成
12 days ago Added label: resolved
2 days ago changed custom category from 任务 to 文档
2 days ago Change title to "[Documentation|文档反馈]: softshrink,sparse_apply_ftrl 资料与代码实现不一致,产品支持/约束/调用说明需统一", originally titled "docs(softshrink,sparse_apply_ftrl): 资料与代码实现不一致,产品支持/约束/调用说明需统一".
2 days ago Change title to "[Documentation|文档反馈]: softshrink,sparse_apply_ftrl 资料与代码实现不一致,产品支持/约束/调用说明需统一", originally titled "docs(softshrink,sparse_apply_ftrl): 资料与代码实现不一致,产品支持/约束/调用说明需统一".
2 days ago Added label: documentation
问题现象
SparseApplyFtrl 与 SoftShrink 的 README / aclnn 资料与当前代码实现不一致,主要包括产品支持范围、参数角色与格式、dtype/rank 约束、特殊值语义和调用说明。
SoftShrink
softshrink_def.cpp仅注册 ascend950/ascend350、canndev 无 310b binary_config。x/y,lambd标成“输入”、格式写成1;OpDef 实际为Input(input_x)、Output(output_y)、Attr(lambd).Float(0.5f)。lambd(aclScalar*)填了ND / 0-8 / 非连续√,但标量没有布局、维度和 stride 语义。lambd为 NaN 时会被拒绝、+Inf合法,以及输入x=NaN时本仓 Ascend C 实现输出 0(不做 NaN 透传)。lambd < 0,未覆盖 NaN。SparseApplyFtrl
use_locking未说明为可选属性、默认 false、当前实现不使用。[1],并允许动态-1/-2、拒绝(1,1)。grad与var维数一致、var/accum/linear至少 2 维、本仓未显式校验 rank 上限、A2/A3 canndev 路径允许 1-D var 的兼容性差异。lr>0、l1/l2>=0、lr_power<=0为调用方保证,Host/Tiling 不读取设备侧标量值、不做运行时值域校验。var/accum/linear为独立输出缓冲、非原地;当前 binary_config 仅支持 FLOAT+INT32/INT64、ND。<a>-</a>,未链接已存在的 GEIR 示例;未说明 TF 通路仅注册SparseApplyFtrl,ResourceSparseApplyFtrl由 canndev 承接。A2/A3 兼容性
影响
用户按资料选型或构造输入时可能得到与实现相反的产品支持结论、错误的参数角色/格式、错误的 dtype/rank 约束,或对 NaN/+Inf/非原地输出产生错误预期。
修复
仅修改资料,不修改代码,PR:
修改范围:
activation/softshrink/README.mdactivation/softshrink/README_en.mdactivation/softshrink/docs/aclnnSoftshrink.mdactivation/softshrink/docs/aclnnSoftshrink_en.mdoptim/sparse_apply_ftrl/README.mdoptim/sparse_apply_ftrl/README_en.md验证
git diff --check通过。pre-commit run --files <6 个资料文件>全部通过(trailing-whitespace、end-of-file-fixer、codespell、OAT 等)。