已合并
docs: add batch consistency and determinism intro #100
docs: add batch consistency and determinism intro #100
已合并
LiuZonggu创建于 11 天前
LiuZonggu成员
11 天前

描述

  1. Add feature introduction documents (Chinese and English)

    • docs/zh/context/determinism_compute.md / docs/en/context/determinism_compute.md: introduce the background, notes, and usage of deterministic computation (for aclnn APIs, enable via aclrtSetSysParamOpt with ACL_OPT_DETERMINISTIC=1; for PyTorch APIs, enable via torch.use_deterministic_algorithms).
    • docs/zh/context/batch_consistency.md / docs/en/context/batch_consistency.md: introduce the background, notes (including version constraints: TorchNPU >= 26.2.0, CANN >= 9.2.0), and usage of Batch consistency (for aclnn APIs, enable via ACL_OPT_DETERMINISTIC=3; for PyTorch APIs, enable via torch_npu.npu.set_deterministic_level).
  2. Update the Basic Operator Concepts index: add "Deterministic Computation" and "Batch Consistency" entries to docs/{zh,en}/context/basic_concept.md.

  3. Simplify the determinism note on the aclnn API list pages: replace the long inline "determinism introduction" block in docs/{zh,en}/op_api_list.md with a [!NOTE] callout that directs readers to the Basic Operator Concepts page to learn about deterministic algorithms, Batch consistency, and common quantization modes.

  4. Add a badge row to the READMEs (Chinese and English): community operator list, project docs, license, contributing guide, and SIG badges.

  5. Update the English quick install guide: replace the outdated WebIDE platform link (org/cann/discussions/54) with the CANNLab guide.

关联的Issue

Related to
https://gitcode.com/cann/ops-ras/issues/33
https://gitcode.com/cann/ops-ras/issues/34

测试

Verified all added/modified Markdown internal links and relative paths; all resolve correctly.

文档更新

  • Added: docs/zh/context/determinism_compute.md, docs/zh/context/batch_consistency.md, docs/en/context/determinism_compute.md, docs/en/context/batch_consistency.md
  • Modified: README.md, README_en.md, docs/zh/context/basic_concept.md, docs/en/context/basic_concept.md, docs/zh/op_api_list.md, docs/en/op_api_list.md, docs/en/install/quick_install.md

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 LiuZonggu 的贡献)
LLiuZonggu成员
11 天前 创建了 pull request,commit f50b086a
LLiuZonggu成员
11 天前 关联了issue:[Documentation|文档反馈]: Add Batch consistency and deterministic computation feature introduction docs
atomgit-bot
atomgit-bot
11 天前 评论:

变更摘要

本 PR 是一次纯文档更新(标题为 "docs: add batch consistency and determinism intro"),围绕确定性计算(Deterministic Computation)与批量一致性(Batch Consistency)两个特性补齐中英文介绍文档,并同步更新相关索引、API 列表页说明、README 徽章以及英文安装指南。具体包括:新增 docs/zh/context/determinism_compute.md、docs/en/context/determinism_compute.md 介绍确定性计算的使用方式(aclnn API 通过 aclrtSetSysParamOpt 设置 ACL_OPT_DETERMINISTIC=1,PyTorch API 通过 torch.use_deterministic_algorithms 开启);新增 docs/zh/context/batch_consistency.md、docs/en/context/batch_consistency.md 介绍批量一致性的背景、注意事项(版本约束:TorchNPU >= 26.2.0、CANN >= 9.2.0)及用法(aclnn API 通过 ACL_OPT_DETERMINISTIC=3,PyTorch API 通过 torch_npu.npu.set_deterministic_level)。同时更新 docs/{zh,en}/context/basic_concept.md 索引、精简 docs/{zh,en}/op_api_list.md 中的说明、为 README.md / README_en.md 增加徽章行,并修正 docs/en/install/quick_install.md 中的过时链接。关联 Issue 为 gitcode.com/cann/ops-ras/issues/33。

主要改动

  • 新增确定性计算文档(中英文):新增 docs/zh/context/determinism_compute.md 与 docs/en/context/determinism_compute.md,介绍确定性计算的背景、注意事项及用法——aclnn API 通过 aclrtSetSysParamOpt 开启 ACL_OPT_DETERMINISTIC=1,PyTorch API 通过 torch.use_deterministic_algorithms 开启。
  • 新增批量一致性文档(中英文):新增 docs/zh/context/batch_consistency.md 与 docs/en/context/batch_consistency.md,介绍批量一致性的背景、注意事项(版本约束 TorchNPU >= 26.2.0、CANN >= 9.2.0)及用法——aclnn API 通过 ACL_OPT_DETERMINISTIC=3,PyTorch API 通过 torch_npu.npu.set_deterministic_level 设置。
  • 更新基础算子概念索引:在 docs/zh/context/basic_concept.md 与 docs/en/context/basic_concept.md 中新增「确定性计算」和「批量一致性」条目,将新文档纳入算子概念索引体系。
  • 精简 aclnn API 列表页说明:将 docs/zh/op_api_list.md 与 docs/en/op_api_list.md 中冗长的内联「确定性介绍」段落替换为 [!NOTE] 提示,引导读者前往基础算子概念页面了解确定性算法、批量一致性及常见量化模式。
  • 更新 README 与英文安装指南:为 README.md 与 README_en.md 增加徽章行(社区算子列表、项目文档、许可证、贡献指南及 SIG 徽章);在 docs/en/install/quick_install.md 中用 CANNLab 使用指南链接替换过时的 WebIDE 平台链接(org/cann/discussions/54)。
likedislike
不准确?
atomgit-bot
atomgit-bot
11 天前 评论:

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

likedislike
不准确?
CANN-robotCANN-robot成员
11 天前 添加了label:cann-cla/yes
此处折叠了98条消息 查看更多
yue-ma成员
10 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
10 天前 添加了label:approved
chenxingyu18成员
10 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
10 天前 添加了label:lgtm
CANN-robotCANN-robot成员
10 天前 合入了pull request