已合并
docs: 新增 Host API 参考并按源码生成英文稿 #1130
CheaterAbec创建于 8 天前
docs: 新增 Host API 参考并按源码生成英文稿 #1130
已合并
Pull Request已成功合入, 合并人@CANN-robot
(感谢 CheaterAbec 的贡献)8 天前 创建了 pull request,commit 38128c8c
8 天前 virtual merging failed, update merge request[project_id: 7631999, iid: 1130, target_commit_sha: 38128c8ce076b2ec9132d1cc10495e2852906715], message: Conflict detected
8 天前 virtual merging failed, update merge request[project_id: 7631999, iid: 1130, target_commit_sha: 38128c8ce076b2ec9132d1cc10495e2852906715], message: Conflict detected
8 天前 推送 1 个提交:a51dd14b-docs: 从 Host API 中拿掉 jit,并合并 Host Tensor 章节
8 天前 virtual merging failed, update merge request[project_id: 7631999, iid: 1130, target_commit_sha: 38128c8ce076b2ec9132d1cc10495e2852906715], message: Conflict detected
8 天前 virtual merging failed, update merge request[project_id: 7631999, iid: 1130, target_commit_sha: 38128c8ce076b2ec9132d1cc10495e2852906715], message: Conflict detected
8 天前 关联了issue:[Requirement|需求建议]: DSL需要提供完善的Host侧API接口文档说明
此处折叠了204条消息 查看更多
17 小时前 合入了pull request
17 小时前 修改了pull request 的描述
17 小时前 关联了issue:[Requirement|需求建议]: DSL需要提供完善的Host侧API接口文档说明
17 小时前 删除了关联的issue:[Requirement|需求建议]: DSL需要提供完善的Host侧API接口文档说明
17 小时前 关联了issue:[Requirement|需求建议]: DSL需要提供完善的Host侧API接口文档说明
描述
新增 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(自动生成)tools/common.py+generate_kernel_api_reference.py+generate_host_api_reference.py(替换原单体generate_api_reference.py)@tla.kernel、tla.compile、TlaJitExecutor.launch/KernelLauncher.launch、dump_mlir、from_dlpack/make_fake_tensor、动态 layout 标记、@dataclass入参约束等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不加)---、同步源码行号锚点;通过 pre-commitend-of-file-fixer关联的Issue
无
原因
补齐 Host 侧公开 API 文档,使参考文档与源码 docstring 同源生成,避免手写漂移;rebase 后与上游 DSL 能力(SIMT / fp8 等)保持文稿一致。
测试
文档更新
python/tla_dsl/docs/{zh,en}/api/host_api_reference.mdpython/tla_dsl/docs/{zh,en}/api/kernel_api_reference.mdpython/tla_dsl/docs/zh/api/generate_api_docs.md、docs/{zh,en}/index.md、docs/zh/api/index.mdpython/tla_dsl/docs/zh/kernel_development/core_concepts/syntax_guide.mddsl.py、runtime.py、core_api.py等)类型标签