已关闭
[Documentation|文档反馈]: docs/python-api/lib/config.md 未在 API 总索引及 index.rst 中收录,且存在存放路径与命名空间错位 #57
XePWang创建于  9月12日关闭于  9月30日
XePWang
XePWang
9月12日 创建

Thanks for sending an issue! Please fill in the following template to help quickly solve your problem.

Issues Section / 问题文档片段 (Mandatory / 必填)

  1. 文档文件路径与标题声明(docs/python-api/lib/config.md 第 9-11 行):
# asc.runtime.config

Ascend C运行时配置接口,用户通过该模块可配置后端执行模式、SOC版本和设备ID等信息。
  1. 导航索引缺失:docs/python-api/index.md、docs/index.rst 以及 docs/python-api/rst/lib/index.rst 均未列出该文件。

Existing Issues / 存在的问题 (Optional / 选填)

根据华为昇腾软硬件配套规范,PyAsc 支持基于 CAModel 的 Backend.Model(仿真模式)与真实硬件的 Backend.NPU,以及从 Ascend910B1 到 Ascend910C 等主流芯片型号。这些平台参数统一由 python/asc/runtime/config.py 中的 set_platform 进行配置。
针对该模块的文档已在 docs/python-api/lib/config.md 中编写完成,但存在以下严重结构问题:

  1. 文档孤岛:该文件在 docs/python-api/index.md 和 Sphinx 的 docs/index.rst 中均未被引用,在构建输出的 API 站点中无法通过目录导航到达。
  2. 命名空间与物理目录错位:该接口在 Python 中属于 asc.runtime.config(位于 python/asc/runtime/config.py),文档物理路径却被放置在 docs/python-api/lib/ 目录下,混淆了 asc.runtime 与 asc.lib 的层次划分。

改进建议

  1. 将 docs/python-api/lib/config.md 迁移至与命名空间对齐的 docs/python-api/runtime/config.md。
  2. 在 docs/python-api/index.md、docs/index.rst 及对应的 rst 文件中补充导航入口。
likedislike
神里绫华的狗神里绫华的狗成员
9月12日 将 wuzhenqing 设为负责人
kong0808成员
9月12日 评论:

您好!感谢关注和问题反馈。
我们将在docs/python-api/index.md补齐runtime/jit.md、runtime/compiler.md等缺失的内容;在docs/index.rst补齐python-api/rst/runtime/jit、python-api/rst/runtime/compiler等缺失内容;另外将docs/python-api/lib/config.md迁移至与命名空间对齐的位置。

likedislike
神里绫华的狗神里绫华的狗成员
9月12日 关联了pull request:add runtime and profiling API docs
CANN-robotCANN-robot成员
9月30日 关闭了 issue
CANN-robotCANN-robot成员
9月30日 添加了label:resolved