hc-skadi/ascendc/ascendc-docs-search

Ascend C 开发资源

概述

本技能提供"本地优先，在线兜底"的文档搜索能力：

• 本地资源：1022 个 API 文档、587 个示例代码、实现参考
• 在线搜索：华为昇腾社区文档搜索（仅在本地资源不足时使用）

官方资源路径

资料查找优先级

1. asc-devkit/docs/api/context/ (本地 API 文档 - 1022 个)
         ↓ 找不到
2. asc-devkit/examples/ (示例代码 - 587 个)
         ↓ 找不到
3. asc-devkit/impl/ (实现代码)
         ↓ 找不到
4. 在线搜索（华为昇腾社区）
   使用 scripts/ 中的 Python 脚本
   推荐版本：8.5.0（与当前环境一致）

⚠️ API 变体搜索指南（重要）

问题：Ascend C 存在 240+ 个带数字后缀的 API 变体（如 Add-25.md），同名 API 的不同变体功能可能完全不同。

典型案例：

• Add.md - 基础版本
• Add-25.md - 变体版本（支持更多功能）

强制搜索步骤

1. 列出所有变体：

```bash # 搜索某个 API 的所有变体（将 APIName 替换为实际 API 名称） ls asc-devkit/docs/api/context/ | grep -iE "^APIName"

# 示例： # APIName.md ← 基础版本 # APIName-25.md ← 变体版本 # APIName-91.md ← 变体版本 ```

1. 逐一确认功能：每个变体的函数签名、参数、功能可能完全不同

变体命名规律

变体检测命令

# 查找某个 API 的所有变体（强制，将 APIName 替换为实际名称）
ls asc-devkit/docs/api/context/ | grep -iE "^APIName"
 
# 在所有变体中搜索特定关键词
grep -l "关键词" asc-devkit/docs/api/context/APIName*.md

环境兼容性

当前环境：A3 服务器，CANN 8.5.0

查阅资料时必须确认 API/方法适用于当前环境。

Explore Agent 使用

何时使用：

1. 查找 API 文档或实现示例
2. 了解某个技术点的实现方式
3. 搜索类似算子的参考实现
4. 遇到错误时查找相关解决方案
5. 方案走通后探索更优实现

使用方式：

使用 Task 工具，subagent_type=Explore
提供明确的搜索目标和范围

示例提示词：

• "搜索 asc-devkit 中 Exp API 的使用示例"
• "查找双缓冲的实现参考"
• "搜索类似的三角函数算子实现"

示例代码索引

在线搜索

适用情况：

• 本地 context 目录检索不到相关 API
• 需要更详细的官方说明或最新版本信息
• 本地文档版本过旧或不完整

快速搜索：

# 基础搜索（推荐使用中文关键词）
python skills/ascendc-docs-search/scripts/ascend_search_client.py "Ascend C 临时内存申请" --max_results 5
 
# 搜索 API 文档
python skills/ascendc-docs-search/scripts/ascend_search_client.py "AscendC::Add 接口原型" --max_results 8
 
# 带版本过滤（推荐使用 8.5.0）
python skills/ascendc-docs-search/scripts/ascend_search_client.py "Ascend C API" --version "8.5.0"

获取详细内容：

python skills/ascendc-docs-search/scripts/ascend_content_fetcher.py <URL>

参数说明：

• keyword：搜索关键词（必需），建议使用中文
• --max_results：返回结果数量（1-10，默认 10）
• --lang：语言设置（zh/en，默认 zh）
• --version：版本过滤字符串（如 "8.5.0"）
• --doc_type：文档类型（DOC/API，默认 DOC）

依赖安装：

pip install -r skills/ascendc-docs-search/requirements.txt

参考资料

• API 文档索引
• 示例代码目录
• 环境兼容性表