Skip to content

Your AI assistant for CANN

CANN-ASSIST

介绍

CANN-ASSIST代码助手基于开源项目Continue进行二次开发，是一款专为CANN社区开发人员打造的AI辅助工具，旨在显著提升开发效率与代码质量。

开发者在日常开发中，CANN-ASSIST能快速辅助完成代码续写、对话问答等功能，提高工作效率与代码质量。

软件架构

软件由前端交互层，与后端服务层组成。
前端交互层嵌入主流代码编辑器，如 Visual Studio Code 等，以插件形式存在，用户可在熟悉的编码环境中使用助手功能。通过展示代码续写建议、以及侧边栏的对话文本框，旨在方便用户使用并探索助手提供的各种功能。
后端服务层采用基于神经网络的代码生成模型，提供代码补全、对话问答等代码辅助开发功能。通过后端服务的持续能力提升，不断提高前端交互层的用户体验。

插件登录与配置

1. 插件登录

插件登陆后才提供完整问答、续写等模型服务，使用GitCode账户进行登陆。

点击右上⻆小齿轮，点击登录按键，允许使用GitCode登录并打开外部网站。
跳转至外部网站进行GitCode账户授权，并重定向回VSCode完成登录。

2. 插件配置

点击右上⻆⼩⻮轮后，选中打开 CANN-ASSIST 的配置⽂件。
不同VsCode版本打开配置文件的小齿轮位置不同，若无法找到，可直接在VsCode顶端搜索框中搜索“config.json”。

使用说明

1. 模型选择、快捷键

上述配置完成后，一般可自动识别模型类型。如未自动识别，可在 CANN-ASSIST 中选择指定的模型。
另外，用户也可自主选择续写、行内编辑（优化）模型。
快捷键查看。

2. 智能问答

在CANN-ASSIST的聊天框中，发送任意测试命令(如“hello”)，如果返回回答，则说明已经成功与后端服务器连接。
问答是一个连续的过程，模型会根据对话上文进行回答。
用户可在任意对话节点带上历史消息发送给模型。

3. 行级续写

打开编码⽂件，回⻋/空格/停顿自动触发行集续写（首次可能需要等待1-3秒）。
若模型建议的代码符合预期，可按 Tab键全接纳，代码由灰色变为正常颜色(如下图)；若不符合预期，可按Esc键拒绝。
如只想接纳部分，则可以选择按词（ctrl + →）或者按行接纳。

4. 代码优化

除问答、续写等功能外，可以基于问答使用代码优化能力。可将代码段通过鼠标右键，或快捷键ctrl+I或ctrl+L发送至聊天框，并输入个性化需求，实现多样功能。

示例1：代码解释，将红色高亮代码片段发送至聊天框，输入蓝色高亮个性化需求，模型输出绿色高亮回答。
示例2：代码注释，将红色高亮代码片段发送至聊天框，输入蓝色高亮个性化需求，模型输出绿色高亮回答(也可直接使用右键添加注释)。
示例3：C++转Python，将红色高亮代码片段发送至聊天框，输入蓝色高亮个性化需求，模型输出绿色高亮回答。
更多示例：代码生成、代码检查与优化、对话问答等……

5. 多文件引用

代码优化中可将单文件的部分代码加入对话框中，插件也支持多文件加入对话框中。多次选中目标代码，并ctrl+I即可加入对话中。

多文件加入对话框

6. Codebase检索能力

@Codebase能力以当前工程目录下所有文件作为索引库，提升问答效率和质量。

注意：在使用此功能之前需要检查本地代码索引库是否完成，以保证索引效果。
使用时，在聊天框输入@Codebase即可。
用户可以使用其他@功能，自由引入各种内容至对话框中。

7. 代码检视

代码检视入口：右侧打开的文件任意位置、左侧资源管理列表的文件或文件。
点击：右键菜单-CANN_ASSIST-代码检视，即可创建代码检视任务。
等待检视结果生成后，可查看代码检视意见。

8. 文档生成

仅有效支持算子文件夹，点击：右键菜单-CANN_ASSIST-文档生成，即可创建文档生成任务。
终端显示自动扫描出的算子列表。
IDE顶部可选择不同功能。
- 生成指定算子文档。
- 生成算子文档结果。
- 批量生成算子文档。
- 重新扫描算子，即可对所选文件夹进行算子扫描。
- 配置管理：单击选项可手动配置模型参数、排除目录、文件扫描深度及提示词内容。
  
  当前配置内容显示：
- 退出：单击选项即可退出文档生成功能。

9. 文档检查

创建文档检查（左侧文件区操作创建文档流程，如果放在文件夹下面，则文件夹下面的内容开始创建文档检查）。
上一步点击后，右侧会展示结果面板,在这里可以查看刚才文档检查的结果。

10. utWorkFlow

创建utWorkFlow（在相应的算子名称上面按照图示点击）。
右侧会弹出相应的创建请求页面。
点击创建，即开始启动生成utWorkFlow任务，点击右侧查看ut任务，即可看到任务执行情况。

License

Apache 2.0 © 2025 CANN-ASSIST Dev, Inc.