已合并
docs: 新增 Host API 参考并按源码生成英文稿 #1130
CheaterAbec创建于 8 天前
docs: 新增 Host API 参考并按源码生成英文稿 #1130
已合并
CheaterAbec创建于 8 天前
CheaterAbec
CheaterAbec成员
8 天前

描述

新增 TLA DSL Host API 中英文参考文档,并按源码英文 docstring(Directory: + Description / Parameters / Constraints / Example)用 AST 生成英文稿;随后多次 rebase 到最新 master,同步上游合入带来的文档与公开 docstring 变更。

主要改动

Host API 文档与生成框架

  • 新增 docs/zh/api/host_api_reference.md(手工维护)与 docs/en/api/host_api_reference.md(自动生成)
  • 将 API 文档生成拆分为 tools/common.py + generate_kernel_api_reference.py + generate_host_api_reference.py(替换原单体 generate_api_reference.py
  • Host 源码 docstring 收口公开面:@tla.kerneltla.compileTlaJitExecutor.launch / KernelLauncher.launchdump_mlirfrom_dlpack / make_fake_tensor、动态 layout 标记、@dataclass 入参约束等
  • 章节按 Compile / Launch / Inspect 组织;同步更新 docs/zh/api/generate_api_docs.md 与中英文索引

与上游对齐 / 文稿修订

  • range_constexpr:补充编译期展开与 DSLOptimizationWarning(≥64 次)说明,并更新语法指南
  • from_dlpack:补充可选参数 element_type(覆盖 DLPack 推导类型,例如 fp8);文案已简化
  • where:对齐 SIMT per-thread 形态(mode="simt" / tla.simt_where
  • mmad:补充 f8e4m3fn / f8e5m2 操作数通路说明
  • 生成器:vec.func 原型统一为 tla.vec.func(小写命名空间加 tla.;Host 的 Class.method 不加)
  • 中文 Kernel API:清理多余 ---、同步源码行号锚点;通过 pre-commit end-of-file-fixer

关联的Issue

原因

补齐 Host 侧公开 API 文档,使参考文档与源码 docstring 同源生成,避免手写漂移;rebase 后与上游 DSL 能力(SIMT / fp8 等)保持文稿一致。

测试

文档更新

  • python/tla_dsl/docs/{zh,en}/api/host_api_reference.md
  • python/tla_dsl/docs/{zh,en}/api/kernel_api_reference.md
  • python/tla_dsl/docs/zh/api/generate_api_docs.mddocs/{zh,en}/index.mddocs/zh/api/index.md
  • python/tla_dsl/docs/zh/kernel_development/core_concepts/syntax_guide.md
  • Host / Kernel 相关源码 docstring(dsl.pyruntime.pycore_api.py 等)

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 CheaterAbec 的贡献)
CheaterAbecCheaterAbec成员
8 天前 创建了 pull request,commit 38128c8c
CheaterAbecCheaterAbec成员
8 天前 virtual merging failed, update merge request[project_id: 7631999, iid: 1130, target_commit_sha: 38128c8ce076b2ec9132d1cc10495e2852906715], message: Conflict detected
CheaterAbecCheaterAbec成员
8 天前 推送  1 个提交:a51dd14b-docs: 从 Host API 中拿掉 jit,并合并 Host Tensor 章节
CheaterAbecCheaterAbec成员
8 天前 virtual merging failed, update merge request[project_id: 7631999, iid: 1130, target_commit_sha: 38128c8ce076b2ec9132d1cc10495e2852906715], message: Conflict detected
CheaterAbecCheaterAbec成员
8 天前 关联了issue:[Requirement|需求建议]: DSL需要提供完善的Host侧API接口文档说明
此处折叠了204条消息 查看更多
CANN-robotCANN-robot成员
17 小时前 合入了pull request
CheaterAbecCheaterAbec成员
17 小时前 修改了pull request 的描述
CheaterAbecCheaterAbec成员
17 小时前 关联了issue:[Requirement|需求建议]: DSL需要提供完善的Host侧API接口文档说明
CheaterAbecCheaterAbec成员
17 小时前 删除了关联的issue:[Requirement|需求建议]: DSL需要提供完善的Host侧API接口文档说明
CheaterAbecCheaterAbec成员
17 小时前 关联了issue:[Requirement|需求建议]: DSL需要提供完善的Host侧API接口文档说明