Skip to content

docs: sync operator register contracts - #26

Open
TruNcat3 wants to merge 2 commits into
mainfrom
docs/ops-register-contract-maintenance
Open

TruNcat3 wants to merge 2 commits into
mainfrom
docs/ops-register-contract-maintenance

Conversation

@TruNcat3

Copy link
Copy Markdown
Collaborator

自查

  • 核心八件齐全: README / REPORT / __init__.py(包化入口) / reference / register / example / kernel/ / test/(不新增算子;同步既有文档)
  • 三层测试绿: test/{kernel,op,framework}_level.py(纯文档更新;本 PR 复跑 pytest tests/unit)
  • 性能对照: script/bench_perf.py(native 参照)+ reports/ 更新(无性能路径变化)
  • 黄金绿: goldendata/ + script/check_accuracy.py(无数值语义变化)
  • 包化回归绿: ops 包入口扫描 16/16
  • 多平台变更时: PLATFORM.md / MERGE.md 已同步(无新平台;仅同步现有 MLU 注册契约)
  • 署名一致: wt-YYYY-MM-DD-fix + # wt <邮箱>,commit 作者相同(文档索引更新,无新实现署名块)

说明

PR #25 已把 13 个 MLU 算子的 register_a1 升级为 counter + platform 契约,并完成包态执行修复;但对应 README / REPORT / development / test-report 仍停留在旧口径。本 PR 补齐这层文档维护:

  • ops/README.md 修复索引表断裂,统一 13 个 MLU 算子状态为定稿
  • 增加 13 个 MLU 算子的注册契约说明:
    • canonical key = AutogradPrivateUse1
    • compatibility key = PrivateUse1
    • 10 个可注册算子支持 counter["n"] 与 platform
    • empty / detach_ / result_type 保持 NotImplementedError
    • 10 个可注册算子实现导入为包态优先、脚本态 fallback
    • clone 保留包态实际执行代表用例说明
  • 13 个算子各自补齐:
    • README 注册契约
    • REPORT 维护日期与契约同步
    • development 维护记录
    • test-report 注册契约复验行
  • 明确 ops-packaging CI 与 ops/test_packaging.py 的不同口径:前者 CPU 包入口扫描,后者 NPU 真机 E2E
  • 修正 empty 的路线描述为自用/实验
  • 修正 sdpa_math 索引中“三平台黄金”的表述为“四实现黄金”

验证

pytest tests/unit -q        24 passed
ops package import scan     16/16
Markdown link check         0 errors
intake validation           0 errors
git diff --check            PASS

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant