cannbot-knowledge使用完全指南:直接读卡、通用检索、API查询3种用法实战
【免费下载链接】cannbot-knowledgecannbot算子开发知识库插件依赖的知识库本体仓,给cannbot提供统一的知识底座。项目地址: https://gitcode.com/cann/cannbot-knowledge
cannbot-knowledge 是 CANN 社区智能体 CANNBot 背后的知识库本体仓,它为 AI 提供统一、可追溯的知识底座。本指南带你快速上手它的 3 种核心用法:直接读卡、通用检索、API 查询,从安装到实战一步到位,帮助新手把 Ascend C 算子开发、模型推理与训练的工程知识真正用起来。
📦 认识 cannbot-knowledge:算子开发知识底座
cannbot-knowledge 把经过整理、可追溯到官方文档或固定版本源码的工程知识保存成 Markdown知识卡,覆盖四类内容:
- 某个 CANN API 的语义和使用限制;
- 某种算子 DSL(Ascend C、Triton-Ascend、PyPTO、TileLang)的编程模型;
- 一个算子的设计、实现或优化方法;
- 编译、运行、精度、性能问题的排查步骤(Runbook)。
所有知识正文集中在 knowledge/ 目录,按“领域 / 技术 / 路径类型”组织,例如 knowledge/ops/ascendc/index.md 收录了 Ascend C 的 API、开发指南、算子与优化知识。仓库同时提供 7 项 Skill,其中 6 项可安装到你的业务项目里使用。
🚀 一键安装步骤:3 条命令接入你的项目
前置条件:Bash、Python 3.10+、Git,以及一个已存在的目标项目目录。
如果网络受限无法直接在线安装,可以用本地方式(推荐新手):
git clone --branch master https://gitcode.com/cann/cannbot-knowledge cd cannbot-knowledge bash install.sh claude /path/to/project consumer其中
claude是客户端标识,可换成codex、cursor、copilot等;consumer表示“只查询”模式。
安装器会自动补齐 Python 依赖、恢复文档资源、构建检索索引,并在你的项目里生成:
| 项目内路径 | 作用 |
|---|---|
.cannbot/knowledge.env | 记录知识仓路径和安装模式 |
.agents/skills/<skill> | 指向知识仓 Skill 的符号链接 |
完整参数、离线安装和高级选项见 docs/installation_and_usage.md。
📖 用法一:直接读卡——已知路径,秒读单张知识卡
当你已经知道答案在哪张卡,直接读卡是最快的方式:
- 在目标项目的终端中展开知识卡绝对路径:
cd /path/to/project source .cannbot/knowledge.env printf '%s\n' "$CANNBOT_KNOWLEDGE_ROOT/knowledge/common/platforms/concepts/ascend_910_95.md"- 把输出路径交给 Agent,例如:“请阅读全文 …/ascend_910_95.md,基于这张卡说明 Ascend 910_95 的基础硬件信息,并注明平台、版本和来源边界。”
这张卡就是 ascend_910_95.md,包含 950 系列的核数、UB/L1/L0C 容量、对齐约束等硬件速查表——单卡即可给出完整答案。
💡 如果一张卡不足以回答,请转入下面的通用检索补充证据。
🔍 用法二:通用检索——knowledge-query 多卡综合
不知道卡片路径、或结论需要多张知识卡综合时(实现方案、调试、优化、测试问题),使用knowledge-query:
“使用
knowledge-query查询 950 平台上实现 Softmax 时可复用的算子设计、API 约束和已知性能问题。请选择相关知识卡,核对来源后综合回答。”
查询时请提供具体问题 + 目标技术 + 目标硬件平台,涉及版本差异时再补充 CANN 版本。理解查询结果的小贴士:
| 看到的信息 | 含义 |
|---|---|
| 候选卡 | Agent 阅读全文的入口,不能直接当最终答案 |
status | 草稿 / 稳定 / 废弃的生命周期标记 |
verified | 真实复核记录,不代表适用于所有平台版本 |
| 零结果 | 当前条件下没找到卡片,不代表技术或 API 不存在 |
🧩 用法三:API 查询——ascendc-api-knowledge-query 核对接口契约
开发 Ascend C 算子时确认 API 签名、参数约束和平台支持,使用专用 Skillascendc-api-knowledge-query。它会复用通用检索的索引和平台过滤能力:
“使用
ascendc-api-knowledge-query查询 950 平台上的DataCopyPad。请选择相关知识卡并阅读全文,说明签名、约束和适用范围,并给出实际读过的卡片链接。”
需要本机头文件证据时,再补充工程实际使用的 CANN 版本和组件包路径,Agent 会按需核验头文件。完整流程与预期产物格式见 recipes/api_search.md。
⚖️ 3 种用法怎么选?一张表看懂
| 你的问题形态 | 推荐入口 |
|---|---|
| 已知准确路径,答案只依赖一张知识卡 | 直接读卡,把路径交给 Agent 阅读全文 |
| 不知道路径,或多张卡才能综合出结论 | knowledge-query通用检索 |
| Ascend C API 的签名、约束、平台支持 | ascendc-api-knowledge-query |
| 新增、更新或检查知识 | 用contributor模式重装,并参考贡献流程 |
🛠 没有结果时怎么办
区分两种情况:
- 索引不可用:先重跑安装器准备索引,此时不能把查询失败解释为“没有知识”;
- 有效零命中:核对平台、技术、版本条件与 API 名,由 Skill 按其流程补搜;仍无结果时应说明已检查的范围和知识缺口,不要用其他平台的卡片替代。
📚 延伸阅读:从查询到算子开发
- docs/installation_and_usage.md:安装、离线配置、更新与常见问题全解
- recipes/answer_with_evidence.md:如何形成可追溯回答
- recipes/operator_development.md:用知识库完成一个 Ascend C 算子开发的完整流程
- knowledge/ops/ascendc/index.md:Ascend C 算子知识总入口
【免费下载链接】cannbot-knowledgecannbot算子开发知识库插件依赖的知识库本体仓,给cannbot提供统一的知识底座。项目地址: https://gitcode.com/cann/cannbot-knowledge
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考