Pull Request已成功合入, 合并人@ascend-robot
(感谢 yucaopanmu 的贡献)变更摘要
这是一个纯文档类(docs)PR,主要对 docs/zh/api/environment_variable/ 目录下 API 模块相关的环境变量文档进行系统梳理和规范化:新增 4 个缺失的环境变量文档、为 11 个文档统一补齐 > [!NOTE] 告警块(说明"此功能为 torch_npu 特有,PyTorch 社区无直接对应变量")、补充使用约束、修复标题/正文中的 Markdown 转义与缩进问题,并同步更新菜单与列表文件。
主要改动
- 新增 4 个环境变量文档:新增
ACL_OP_INIT_MODE.md(算子编译初始化模式,覆盖 0/1/2 三种模式、默认值规则与使用约束)、ACLNN_EXTENSION_SWITCH.md(ACLNN 扩展代码路径开关)、ACLNN_EXTENSION_PATH.md(ACLNN 扩展代码搜索路径)、PYTORCH_CUSTOM_DERIVATIVES_PATH.md(自定义算子自动微分定义文件路径) - 统一补齐 NOTE 告警块:为
ACL_OP_COMPILER_CACHE_DIR.md、ACL_OP_COMPILER_CACHE_MODE.md、ASCEND_LAUNCH_BLOCKING.md(含与 PyTorch 社区CUDA_LAUNCH_BLOCKING的差异对比)、COMBINED_ENABLE.md、FORCE_OVERFLOW_CHECK.md、INF_NAN_MODE_ENABLE.md、INF_NAN_MODE_FORCE_DISABLE.md、TASK_QUEUE_ENABLE.md、TORCH_NPU_FALLBACK_CPU_DISABLE.md、TORCH_NPU_LEGACY_IMPL_LIST.md、TORCH_NPU_USE_COMPATIBLE_IMPL.md共 11 个文档补充 torch_npu 特有功能的说明 - 补充与重写使用约束:将
COMBINED_ENABLE.md、INF_NAN_MODE_ENABLE.md、INF_NAN_MODE_FORCE_DISABLE.md中"使用约束"为"无"的内容补充为具体约束条款,并重写COMBINED_ENABLE.md的功能描述(由"可设置 combined 标志"改为完整描述) - 修复格式与内容问题:修复
TORCH_NPU_FALLBACK_CPU_DISABLE.md、TORCH_NPU_LEGACY_IMPL_LIST.md、TORCH_NPU_USE_COMPATIBLE_IMPL.md标题中下划线未转义(TORCH_NPU_X→TORCH\_NPU\_X)以及INF_NAN_MODE_ENABLE.md、FORCE_OVERFLOW_CHECK.md中INF_NAN的转义;修复TASK_QUEUE_ENABLE.md默认值描述缩进;将ACL_OP_COMPILER_CACHE_DIR.md中的ACL_OP_COMPILER_CACHE_MODE由纯文本改为超链接;更新env_variable_list.md中COMBINED_ENABLE的简述 - 同步菜单与列表:在
_menu_op_compilation.md和env_variable_list.md中新增 4 个环境变量条目,保证文档导航与索引与新增内容一致


🤖 本次改动均为数据 / 生成 / 二进制文件(如测试用例、锁文件、媒体资源),没有可审查的代码逻辑,已跳过 AI 代码审查。


Thanks for your pull-request.
The full list of commands accepted by me can be found at here.
You can get sig-info at here.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
PR Approval Progress
✅ Congratulations! All modules have met the lgtm and approve requirements.
Module Approval Details
| module | lgtm status | approve status |
|---|---|---|
| **/*.md | ✅ chenrayray, LEE JIHAE (2/2) | ✅ chenrayray (1/1) |
💡 Tip:
- Committer can comment
/approveor/lgtm- Commenting
/approveimplies both code review (lgtm) and intent to merge (approve)
CLA Signature Pass
yucaopanmu, thanks for your pull request. All authors of the commits have signed the CLA. 👍


当前仓库存在以下 保护分支 :
| Protected Branch | Version | Release |
|---|---|---|
| master | ||
| v2.7.1 | ||
| v2.11.0 | ||
| v2.12.0 | ||
| v2.10.0 | ||
| v2.9.0 | ||
| v2.7.1-26.1.0 | ||
| v2.10.0-26.1.0 | ||
| v2.11.0-26.1.0 | ||
| v2.12.0-26.1.0 | ||
| v2.9.0-26.1.0 | ||
| ci-test |
评论 /sync <branch1> <branch2> ... 可将当前 PR 修改同步到其它分支(创建同步 PR):
a) 如果当前 PR 是 Open 状态,同步操作将延迟到 PR 被合并时执行
b) 如果当前 PR 已经 Merged,将立即执行同步操作
注意:
- /sync 命令可以指定同步到多个分支,仅最后一个 /sync 命令生效
- 如果创建的同步 PR 不正确,可通过向同步 PR 的源分支提交轻量级 PR 完善,或使用 /close 命令关闭


Linking Issue Notice
@yucaopanmu , the pull request must be linked to at least one issue.
If an issue has already been linked, but the needs-issue label remains, you can remove the label by commenting /check-issue .


ascend docs pipeline is running...


✅ 跳过 docs ci 检查,没有需要检查的文档文件


| 阶段 | 任务名 | 状态 | 详情 |
|---|---|---|---|
| 编译构建 | Build_X86 | ⚪ IGNORED | >>> |
| Build_ARM | ⚪ IGNORED | >>> | |
| Build_X86_torchair | ⚪ IGNORED | >>> | |
| Build_ARM_torchair | ⚪ IGNORED | >>> | |
| patch_test | ⚪ IGNORED | >>> | |
| Build_X86_213 | ⚪ IGNORED | >>> | |
| Build_ARM_213 | ⚪ IGNORED | >>> | |
| 恶意代码检查 | Antipoison | ✅ COMPLETED | >>> |
| 编码安全与规范检查 | codecheck_pre-commit | ✅ COMPLETED | >>> |
| check_error | ✅ COMPLETED | >>> | |
| lintrunner | ✅ COMPLETED | >>> | |
| 开源片段检查 | SCA | ✅ COMPLETED | >>> |
| 开发者测试 | UT_ARM_A3_Part_01 | ⚪ IGNORED | >>> |
| UT_ARM_A3_Part_02 | ⚪ IGNORED | >>> | |
| UT_ARM_A2_Part_01 | ⚪ IGNORED | >>> | |
| UT_ARM_A2_Part_02 | ⚪ IGNORED | >>> | |
| UT_ARM_A2_Part_03 | ⚪ IGNORED | >>> | |
| UT_inductor_Part_01 | ⚪ IGNORED | >>> | |
| UT_inductor_Part_02 | ⚪ IGNORED | >>> | |
| UT_inductor_Part_03 | ⚪ IGNORED | >>> | |
| UT_inductor_Part_04 | ⚪ IGNORED | >>> | |
| UT_DIST_ARM_Part_01 | ⚪ IGNORED | >>> | |
| UT_DIST_ARM_Part_02 | ⚪ IGNORED | >>> | |
| UT_DIST_ARM_Part_03 | ⚪ IGNORED | >>> | |
| UT_DIST_ARM_Part_04 | ⚪ IGNORED | >>> | |
| UT_ARM_A2_Select_Part_01 | ⚪ IGNORED | >>> | |
| UT_ARM_A2_Select_Part_02 | ⚪ IGNORED | >>> | |
| UT_inductor_Part_213 | ⚪ IGNORED | >>> | |
| 流水线 | PR-pipeline_pytorch | ✅ COMPLETED | >>> |
- compile、compile_inductor、compile_torchair : 运行流水线
- retry : 重试流水线所有失败子任务
- retry <任务名> : 仅重试指定失败子任务
- stop : 停止流水线


/approve




通过此环境变量可控制是否启用组合连续化优化。开启后,该功能旨在优化由多个 view 操作(如 reshape+slice、permute+select 等,最多支持 2 个组合操作)产生的非连续张量的连续化转换过程,通过推断 view 信息栈避免完整的内存拷贝。
- 配置为“0”:表示关闭此功能。
- 配置为“1”:表示开启。
默认配置为“0”。


这些都不用要,note也不要加,直接写这句话就行,原生的链接找一下加上
该环境变量对应PyTorch的CUDA_LAUNCH_BLOCKING,功能一致,均用于控制算子是否采用同步执行模式。


op-plugin改成OpPlugin


这样优化一下,确认一下还有没有其他配置情况
- 默认不配置:此时torchnpugen使用内置的
third_party/op-plugin/op_plugin/config/目录下对应PyTorch版本的derivatives.yaml作为默认路径。 - 指定路径配置时:.........。


- 必须在启动Python进程前配置该环境变量,进程运行过程中修改不会生效。
- 仅支持配置为“0”、“1”或“2”,其他取值将重置为默认值。


通过此环境变量可控制OpPlugin代码生成(codegen)过程中是否启用ACLNN扩展代码路径。
- 配置为
true或ON时:开启该功能,torchnpugen工具在生成算子代码时使用ACLNN扩展相关的源码路径、模板和注册方式; - 未配置时:不使用该功能,使用内置的默认代码生成逻辑。
该环境变量默认未配置,此时不启用ACLNN扩展代码路径。


约束说明里面的对应内容删掉这里补充完整


通过此环境变量可指定ACLNN扩展代码的搜索路径。在OpPlugin代码生成(codegen)过程中,torchnpugen工具根据此路径查找ACLNN扩展相关的op_plugin源文件、自定义算子YAML配置和exposed_api.py等文件。通常与ACLNN_EXTENSION_SWITCH配合使用,当ACLNN扩展开关开启时,此路径生效。
当ACLNN_EXTENSION_SWITCH启用时:
- 未配置该环境变量:此时torchnpugen使用内置的third_party/op-plugin目录作为默认搜索路径。
- 配置为指定路径:功能对此路径生效。
当ACLNN_EXTENSION_SWITCH未启用时,未配置和配置指定路径,该功能都不生效。


【合入来源】
【修改方案】
本次对 docs/zh/api/environment_variable/ 目录下与API模块有关的环境变量文档进行全面梳理和规范化,主要涉及以下 3 类修改:
新增缺失的环境变量文档(4 个文件)
ACL_OP_INIT_MODE.md:新增算子编译初始化模式环境变量文档,覆盖 0/1/2 三种模式的详细说明、默认值规则、使用约束
ACLNN_EXTENSION_SWITCH.md:新增 ACLNN 扩展代码路径开关文档
ACLNN_EXTENSION_PATH.md:新增 ACLNN 扩展代码搜索路径文档
PYTORCH_CUSTOM_DERIVATIVES_PATH.md:新增自定义算子自动微分定义文件路径文档
补齐统一文档结构(11 个文件)
添加 NOTE 告警块:为 11 个缺失 > [!NOTE] 块的文档统一补充"此功能为torch_npu特有,PyTorch社区无直接对应变量"说明,涉及的文件包括 ACL_OP_COMPILER_CACHE_DIR.md、ACL_OP_COMPILER_CACHE_MODE.md、ASCEND_LAUNCH_BLOCKING.md(含 PyTorch 社区 CUDA_LAUNCH_BLOCKING 差异对比)、COMBINED_ENABLE.md、FORCE_OVERFLOW_CHECK.md、INF_NAN_MODE_ENABLE.md、INF_NAN_MODE_FORCE_DISABLE.md、TASK_QUEUE_ENABLE.md、TORCH_NPU_FALLBACK_CPU_DISABLE.md、TORCH_NPU_LEGACY_IMPL_LIST.md、TORCH_NPU_USE_COMPATIBLE_IMPL.md
补充使用约束:将 COMBINED_ENABLE.md、INF_NAN_MODE_ENABLE.md、INF_NAN_MODE_FORCE_DISABLE.md 中"使用约束"为"无"的文档补充为具体的约束条款
修正格式和内容问题(多个文件)
标题转义修复:TORCH_NPU_FALLBACK_CPU_DISABLE.md、TORCH_NPU_LEGACY_IMPL_LIST.md、TORCH_NPU_USE_COMPATIBLE_IMPL.md 标题中下划线未转义(TORCH_NPU_X → TORCH_NPU_X)
正文转义修复:INF_NAN_MODE_ENABLE.md、FORCE_OVERFLOW_CHECK.md 中 INF_NAN 未转义为 INF_NAN
交叉链接补充:ACL_OP_COMPILER_CACHE_DIR.md 中 ACL_OP_COMPILER_CACHE_MODE 由纯文本改为超链接
缩进修复:TASK_QUEUE_ENABLE.md 中默认值描述缩进修正
内容完善:COMBINED_ENABLE.md 功能描述由"通过此环境变量可设置combined标志"重写为完整描述
简述更新:env_variable_list.md 中 COMBINED_ENABLE 简述更新
菜单和列表同步:_menu_op_compilation.md 和 env_variable_list.md 添加 4 个新增环境变量条目
【资料变更】
涉及资料变更,修改内容如下:
新增文档(4 个):
docs/zh/api/environment_variable/op_compilation/ACL_OP_INIT_MODE.md
docs/zh/api/environment_variable/op_compilation/ACLNN_EXTENSION_SWITCH.md
docs/zh/api/environment_variable/op_compilation/ACLNN_EXTENSION_PATH.md
docs/zh/api/environment_variable/op_compilation/PYTORCH_CUSTOM_DERIVATIVES_PATH.md
修改文档(13 个):
docs/zh/api/environment_variable/op_compilation/ACL_OP_COMPILER_CACHE_DIR.md:添加 NOTE 告警块,补充交叉链接
docs/zh/api/environment_variable/op_compilation/ACL_OP_COMPILER_CACHE_MODE.md:添加 NOTE 告警块
docs/zh/api/environment_variable/op_execution/ASCEND_LAUNCH_BLOCKING.md:添加 NOTE 告警块(含 PyTorch 社区差异对比),删除多余空行
docs/zh/api/environment_variable/op_execution/COMBINED_ENABLE.md:重写功能描述,添加 NOTE 告警块,补充使用约束
docs/zh/api/environment_variable/op_execution/FORCE_OVERFLOW_CHECK.md:修复 INF_NAN 转义,添加 NOTE 告警块
docs/zh/api/environment_variable/op_execution/INF_NAN_MODE_ENABLE.md:修复 INF_NAN 转义,添加 NOTE 告警块,补充使用约束
docs/zh/api/environment_variable/op_execution/INF_NAN_MODE_FORCE_DISABLE.md:添加 NOTE 告警块,补充使用约束
docs/zh/api/environment_variable/op_execution/TASK_QUEUE_ENABLE.md:修复默认值描述缩进,添加 NOTE 告警块
docs/zh/api/environment_variable/op_execution/TORCH_NPU_FALLBACK_CPU_DISABLE.md:修复标题转义,添加 NOTE 告警块
docs/zh/api/environment_variable/op_execution/TORCH_NPU_LEGACY_IMPL_LIST.md:修复标题转义,添加 NOTE 告警块
docs/zh/api/environment_variable/op_execution/TORCH_NPU_USE_COMPATIBLE_IMPL.md:修复标题转义,添加 NOTE 告警块
docs/zh/api/environment_variable/op_compilation/_menu_op_compilation.md:添加 4 个新增环境变量菜单条目
docs/zh/api/environment_variable/env_variable_list.md:更新 COMBINED_ENABLE 简述,添加 4 个新增环境变量列表条目
【接口变更】
不涉及
【功能验证】
不涉及
【CheckList】