已关闭
[Requirement|需求建议]: 补充A2、A3版本API手册中的指令原理与约束说明 #713
bianque创建于  5月21日关闭于  6月16日
bianque成员
5月21日 创建

Background(背景信息)

A2、A3 版本 API 手册当前以接口签名和参数说明为主,缺少以下几个关键维度的内容:

  1. 指令原理说明:API 执行的底层逻辑、计算模式未详细解释
  2. 约束说明不完整:流水类型、同步要求、数据对齐、精度转换规则等约束信息缺失或分散
  3. 缺少高层概述:SIMD 计算模式、矩阵计算分形、数据结构体系等缺乏总览性文档,新手难以建立整体认知
  4. 章节结构分散:工具接口、系统初始化、特殊寄存器访问等文档散落在不同位置,缺乏统一目录组织

Origin(信息来源)

基于开发者反馈和内部文档评审中收集的常见疑问。

Benefit / Necessity(价值/作用)

  • 降低 API 上手成本,减少因理解不足导致的误用
  • 为后续文档规范化提供基线和范例
  • 提升开发者自主排查问题的效率

Design(设计方案)

按模块分批补充,计划覆盖以下方向:

新增概述类文档:

  • SIMD 计算说明(概述 / 连续计算 / 高维计算)
  • 矩阵计算概述与计算分形说明
  • 数据结构体系与精度转换总览

完善 API 参考文档:

  • 同步控制:补充功能说明、约束说明、流水类型
  • 原子操作:补充原理说明与约束
  • Memory 矢量计算(双目/单目/逻辑计算):完善参数约束与行为说明
  • 内置数据类型及标量 API:优化说明内容

调整文档组织结构:

  • 工具接口(Async、InitSocState 等)归入统一目录
  • 工具函数与系统变量访问拆分重组
  • 新增「执行模式」「系统初始化」「特殊寄存器访问」等子目录
likedislike
Bbianque成员
5月21日 添加了label:requirement
Bbianque成员
5月21日 将 bianque 设为负责人
bianque成员
5月21日 评论:

相关问题已确认,随后续修改合入,敬请期待~

likedislike
GRJ_XIDUOGRJ_XIDUO成员
5月21日 关联了pull request:更新同步控制和原子操作两个章节的资料
Chen NingChen Ning成员
5月21日 关联了pull request:【docs】迁移并重组Async和InitSocState文档至工具接口目录
此处折叠了43条消息 查看更多
GRJ_XIDUOGRJ_XIDUO成员
7月2日 关联了pull request:修复数据搬运资料的两个问题:图片缺失和GM地址对齐约束
GRJ_XIDUOGRJ_XIDUO成员
7月2日 关联了pull request:修复数据搬运资料的两个问题:图片缺失和GM地址对齐约束
GRJ_XIDUOGRJ_XIDUO成员
7月6日 关联了pull request:更新数据搬运和缓存控制的资料
GRJ_XIDUOGRJ_XIDUO成员
7月14日 关联了pull request:新增DataCachePreload接口调用样例
Bbianque成员
7月15日 删除了关联的pull request:新增DataCachePreload接口调用样例