Qiskit代码助手（Beta）

这个实验性功能目前仅向IBM Quantum高级用户开放。如果您不是IBM Quantum高级计划的一部分，您仍然可以安装此扩展；然而，您将无法使用助手。Qiskit代码助手是一个Beta版本，可能会发生变化。

使用生成式AI代码助手编写和优化Qiskit代码。

使用Qiskit代码助手提高量子计算开发者的生产力，并学习Qiskit和IBM Quantum平台服务的最佳实践！

使用Qiskit代码助手，一个生成式AI代码助手，使编程量子计算机变得更加容易。它使用来自Qiskit SDK v1.x的大约3.7亿个文本标记、多年的Qiskit代码示例以及IBM Quantum功能进行训练，通过基于IBM Granite 8B代码生成的建议来加速您的量子开发工作流程，该代码结合了IBM的最新功能和功能。不久，Qiskit代码助手将能够与Qiskit模式构建块一起使用，以实现可重用代码和工作流程简化。

Qiskit 是 Unitary Fund 开源软件调查中 69% 的受访者推荐的开放源代码量子 SDK，迄今为止拥有近 60 万注册用户。现在您可以使用 Qiskit SDK 的性能和稳定性，加上 Qiskit 代码助手的高效性来简化您的 workflow 并优化您的量子计算程序。

功能

• 利用基于 granite-8b-qiskit 模型的生成式 AI 加速 Qiskit 代码生成
• 使用抽象和具体的提示来生成建议
• 通过审查、接受和拒绝建议来管理代码更改
• 支持 Python 代码文件

学习使用 Qiskit 和 IBM 量子平台服务的最佳方式

通过审查、浏览和接受模型生成的代码建议来改进您的 Qiskit 代码。

使用抽象提示开始使用

使用 #comments 提供抽象提示给 Qiskit 代码助手。在 #comment 后面输入 Alt .、Alt \ 或 Tab，以获得适用于您所需任务的语法正确且上下文相关的（最多 60 个标记）内容。

使用具体提示进行代码补全

使用 Alt .、Alt \ 或 Tab 与代码结合，根据源代码的语义分析获得特定模型生成的代码补全建议。在接受之前请审查代码建议。

开始使用

获取您的 IBM 量子平台 API 令牌

在浏览器中打开 IBM 量子平台 并使用您的 IBM 量子账户登录。登录后，IBM 量子 API 令牌将显示在网页右上角。

在 JupyterLab 扩展程序中设置 API 令牌

当您在新窗口或选项卡中首次打开 Jupyterlab 时，您可能会看到状态栏突出显示为橙色，这表示服务不可达。

如果您点击状态栏或尝试运行补全程序，将显示一个对话框，要求您提供 API 令牌，在此处粘贴上面复制的令牌。

您还可以在命令面板中搜索 "Qiskit"（Alt Shift C）以输入或更新您的 API 令牌。

此外，如果环境变量 QISKIT_IBM_TOKEN 已设置或存在 Qiskit 配置文件 ~/.qiskit/qiskit-ibm.json，则 API 令牌将在应用程序启动时填充。如果通过扩展程序输入 API 令牌，则将在 ~/.qiskit/qiskit-ibm.json 下的新配置 qiskit-code-assistant 中存储。

接受模型免责声明/EULA

默认情况下，您将使用的是 granite-8b-qiskit 模型。它将显示在状态栏底部的模型选择器中。

首次使用 granite-8b-qiskit 模型时，将出现有关模型的信息和文档及模型许可证的链接的模型免责声明/EULA。它还将列出一些在使用模型时应注意的限制，包括禁止使用专有代码的限制。点击 接受 将在代码生成期间启用新模型。

生成代码建议

一旦您接受了模型免责声明/EULA，您就可以打开一个新文件并开始输入。如果您输入 Alt .，应该会显示一些带有模型生成建议的淡文本。

审查和接受/拒绝代码建议

输入 Alt Tab 或 Alt END 以接受模型生成的建议，或输入 Esc 以取消/拒绝模型生成的建议。

使用内联补全器

可以使用以下键盘快捷键触发内联补全器。

• Alt . 或 Alt \ 将在当前光标位置运行补全器
• Alt [ 和 Alt ] 可以用来在建议列表之间循环，如果有多于一个建议
• Alt Tab 或 Alt END 将 "接受" 建议的代码并将其插入到当前光标位置

此外，一旦补全器运行，您可以使用内联补全器小部件上的按钮来循环或接受

使用代码补全器

Jupyterlab 还包含一个传统的补全器，该补全器在上下文菜单中显示建议，而不是行内显示。此补全器可以通过使用 Tab 键来触发，以运行并显示上下文菜单。

上下文菜单将包括来自默认补全器的建议以及 Qiskit 代码助手的建议。上下文菜单还会对建议进行清理和修剪，使其在插入之前查看代码建议不那么有用。

Jupyterlab 设置

我们建议在您的用户设置中编辑一些设置。

1. 行内补全器 showWidget 可以设置为 always 以始终显示行内补全器小部件，以便循环选择补全项。

2. 代码补全 providerTimeout 可以增加，我们建议的值是 10000 或 10 秒。默认情况下为 1 秒，而 Qiskit 代码助手 API 很少在 1 秒内返回。此设置仅适用于通过 Tab 触发的标准补全器，行内补全器的默认值为 10 秒。

3. 如果您想更改扩展应使用的 Qiskit 代码助手服务的实例，您可以编辑 Qiskit 代码助手设置 serviceUrl。

4. 可以通过在键盘快捷键设置中搜索 completer 来更改键盘快捷键，并为相关命令添加新的快捷键。

使用条款

• 最终用户许可协议 (EULA) 接受在开始使用模型之前必须接受模型接受
• 使用条款: https://quantum.ibm.com/terms
• 隐私政策: https://quantum.ibm.com/terms/privacy
• 云服务协议 https://www.ibm.com/support/customer/csol/terms/?id=Z126-6304&cc=us&lc=en
• IBM 云服务描述 https://www.ibm.com/support/customer/csol/terms/?id=i126-6605&lc=en