| Name | qiskit-code-assistant-jupyterlab JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | AI Autocomplete JupyterLab extension for Qiskit Code Assistant (Beta) |
| upload_time | 2025-11-04 14:24:22 |
| maintainer | None |
| docs_url | None |
| author | IBM |
| requires_python | >=3.8 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2024 IBM
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Qiskit Code Assistant (Beta)
> The Qiskit Code Assistant is a beta release, subject to change.
Write and optimize Qiskit code with a generative AI code assistant.
---
Increase quantum computing developer productivity and learn best practices for Qiskit and IBM Quantum Platform services with Qiskit Code Assistant!
---
Make programming quantum computers even easier with Qiskit Code Assistant, a generative AI code assistant. Trained with approximately 370 million text tokens from Qiskit SDK v1.x, years of Qiskit code examples, and IBM Quantum features, Qiskit Code Assistant accelerates your quantum development workflow by offering LLM-generated suggestions based on [Mistral-Small-3.2-24B-Instruct-2506](https://huggingface.co/mistralai/Mistral-Small-3.2-24B-Instruct-2506) that incorporate the latest features and functionalities from IBM. And soon, Qiskit Code Assistant will be able to be used alongside Qiskit patterns building blocks for reusable code and workflow simplification.
Qiskit is the open-source quantum SDK preferred by 69% of respondents to the Unitary Fund's Open Source Software Survey, with nearly 600,000 registered users to date. Now you can get the performance and stability of the Qiskit SDK with the added efficiency of Qiskit Code Assistant to streamline your workflow and optimize your quantum computing programs.
## Features
- Accelerate Qiskit code generation by leveraging generative AI based on the `mistral-small-3.2-24b-qiskit` model
- Use abstract and specific prompts to generate recommendations
- Manage code changes by reviewing, accepting, and rejecting suggestions
- Supports Python code files
## Learn the best ways to use Qiskit and IBM Quantum Platform services
Improve your Qiskit code by reviewing, browsing, and accepting model-generated code suggestions.
### Use abstract prompts to get started
Provide abstract prompts to Qiskit Code Assistant using `#comments`. Type `Alt .`, `Alt \` or `Tab` following a `#comment` to obtain syntactically correct and contextually relevant content (up to 60 tokens) suited to your desired task.
### Use specific prompts for streamlined code completion
Use `Alt .`, `Alt \` or `Tab` with code to obtain specific model-generated suggestions for code completion based on semantic analysis of source code. Review code recommendations before accepting.
## Get started
You can use Qiskit Code Assistant in two ways:
### Option 1: IBM Quantum Cloud (Recommended)
Requires an IBM Quantum Premium Plan account for the best experience.
#### Obtain your IBM Quantum Platform API token
Open the [IBM Quantum Platform](https://quantum.cloud.ibm.com/) in your browser and log in with your IBM Quantum Cloud account. After logging in, an IBM Quantum API token is displayed on the upper right side of the web page.
#### Set the API token in the JupyterLab extension
When you first open Jupyterlab in a new window or tab you may see that the status bar
is highlighted orange, this shows that the service is not reachable.
If you click the status bar or try to run the completer a dialog will display asking
for your API token, paste the token copied above here.
You can also search for "Qiskit" in the command palette (`Alt Shift C`) to enter or
update your API token.
In addition if the enviroment variable `QISKIT_IBM_TOKEN` is set or the Qiskit
configuration file `~/.qiskit/qiskit-ibm.json` exists then the API token will be
populated at application start. If an API token is entered via the extension it will be
stored in `~/.qiskit/qiskit-ibm.json` under a new config named `qiskit-code-assistant`
#### Accept the model disclaimer/EULA
By default, the model you will use is `mistral-small-3.2-24b-qiskit`. It will appear in the Model Picker in the bottom of the status bar.
The first time you use the `mistral-small-3.2-24b-qiskit` model, a model disclaimer/EULA will appear with information about the model and links to documentation and the model's license. It will also list some restrictions that you should be aware of when using the model, including a restriction against using proprietary code. Clicking `Accept` will enable the new model during code generation.
### Option 2: Local Setup (For Non-Premium Users)
If you don't have an IBM Quantum Premium Plan account, you can run the Qiskit Code Assistant entirely on your local machine using open-source models.
#### Quick Setup (One Command)
```bash
bash <(curl -fsSL https://raw.githubusercontent.com/Qiskit/qiskit-code-assistant-jupyterlab/main/setup_local.sh)
```
Or if you cloned the repository:
```bash
bash setup_local.sh
```
For automated/CI setups, use non-interactive mode:
```bash
bash setup_local.sh --non-interactive
# Or: bash setup_local.sh -y
```
#### What the script does
- Detects and uses `uv` for faster installations (if available)
- Checks and optionally installs JupyterLab (if needed)
- Always upgrades the extension to the latest version
- Installs and configures Ollama (local LLM server)
- Downloads the Qwen2.5-Coder 14B model optimized for Qiskit (~9GB)
- Configures optimal model parameters
- Sets up JupyterLab extension automatically
#### Requirements
- **Operating System**: macOS, Linux, or Windows (via Git Bash or WSL)
- **Python**: 3.8+ with pip installed
- **RAM**: 16GB+ recommended (8GB+ for lighter models)
- **Disk Space**: ~5-20GB depending on model size
#### Available Models
The setup script supports multiple models. By default, it uses **Qwen2.5-Coder 14B** which offers the best quality for code generation.
| Model | Size | Quality | RAM Required |
| ------------------------------- | ----- | ------------- | ------------ |
| **Qwen2.5-Coder 14B** (Default) | ~9GB | Best for code | 16GB+ |
| Mistral Small 24B | ~15GB | Most recent | 24GB+ |
| Granite 3.3 8B | ~5GB | Lightweight | 8GB+ |
All models are trained on **Qiskit 2.0+** and optimized for quantum computing code assistance.
For detailed instructions, see the [Local Setup Guide](https://github.com/Qiskit/qiskit-code-assistant-jupyterlab#local-setup).
## Using the Extension
### Generate code suggestions
Once you've accepted the model disclaimer/EULA, you can open a new file and start typing. If you type `Alt .`, some faded text should appear with model-generated suggestions.
### Review and accept/reject code suggestions
Type `Alt Tab` or `Alt END` to accept the model-generated suggestion, or type `Esc` to cancel/reject the model-generated suggestion.
### Using the Inline Completer
The inline completer can be triggered using the following key strokes.
- `Alt .` or `Alt \` will run the completer at the current cursor location
- `Alt [` and `Alt ]` can be used to cycle through the list of suggestions if there are
more than one
- `Alt Tab` or `Alt END` will "accept" the suggested code and insert it at the current
cursor location
In addition, once the completer runs you can use the buttons on the inline completer
widget to cycle or accept
### Using the Code Completer
Jupyterlab also includes a traditional completer than displays suggestion in a context
menu rather than inline. This completer can be triggered using `Tab` to run and display
the context menu.
The context menu will include suggestions from the default completer in addition to the
Qiskit Code Assistant suggestions. The context menu also sanitizes and trims the
suggestions, making it less useful for see the code suggestion before inserting it.
### Jupyterlab Settings
There are a few settings we recommend to edit in your user settings.
1. Inline Completer `showWidget` can be set to `always` in order to always show the
inline completer widget to cycle through and select a completion item
2. Code Completion `providerTimeout` can be increased, our suggested value is `15000` or
15 seconds. This is 1 second by default and the Qiskit Code Assistant API rarely returns
within 1 second. This setting only apply the the standard completer that is invoked with
`Tab`, the inline completer has a default of 15 seconds.
3. If you want to change the instance of the Qiskit Code Assistant Service that the
extension should use you can edit the Qiskit Code Assistant setting `serviceUrl`.
This can also be set to any service exposing LLMs using OpenAI-compatible API endpoints.
4. Keyboard shortcuts can be changed by searching for `completer` in the Keyboard Shortcuts
settings and adding new shortcuts for the relevant commands.
5. Telemetry can be disabled by unchecking the `enableTelemetry` setting.
> **NOTE**: The telemetry does not collect your code nor the suggested code completions.
> What is collected is whether a code suggestion was accepted or dismissed.
6. Response streaming can be enabled by checking the `enableStreaming` setting.
## Terms of use
- [End User License Agreement (EULA)](https://github.com/Qiskit/qiskit-code-assistant-jupyterlab/blob/main/docs/EULA.md) acceptance required before starting to use the model acceptance required before starting to use the model
- Terms of use: [https://quantum.ibm.com/terms](https://quantum.ibm.com/terms)
- Privacy policy: [https://quantum.ibm.com/terms/privacy](https://quantum.ibm.com/terms/privacy)
- Cloud Services Agreement [https://www.ibm.com/support/customer/csol/terms/?id=Z126-6304&cc=us&lc=en](https://www.ibm.com/support/customer/csol/terms/?id=Z126-6304&cc=us&lc=en)
- IBM Cloud Service Description [https://www.ibm.com/support/customer/csol/terms/?id=i126-6605&lc=en](https://www.ibm.com/support/customer/csol/terms/?id=i126-6605&lc=en)
Raw data
{
"_id": null,
"home_page": null,
"name": "qiskit-code-assistant-jupyterlab",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "IBM",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/36/88/413bce4db69952d0b68e61746d99fcd796f6d78e83b1e6ab357e7d913646/qiskit_code_assistant_jupyterlab-0.8.0.tar.gz",
"platform": null,
"description": "# Qiskit Code Assistant (Beta)\n\n> The Qiskit Code Assistant is a beta release, subject to change.\n\nWrite and optimize Qiskit code with a generative AI code assistant.\n\n---\n\nIncrease quantum computing developer productivity and learn best practices for Qiskit and IBM Quantum Platform services with Qiskit Code Assistant!\n\n---\n\nMake programming quantum computers even easier with Qiskit Code Assistant, a generative AI code assistant. Trained with approximately 370 million text tokens from Qiskit SDK v1.x, years of Qiskit code examples, and IBM Quantum features, Qiskit Code Assistant accelerates your quantum development workflow by offering LLM-generated suggestions based on [Mistral-Small-3.2-24B-Instruct-2506](https://huggingface.co/mistralai/Mistral-Small-3.2-24B-Instruct-2506) that incorporate the latest features and functionalities from IBM. And soon, Qiskit Code Assistant will be able to be used alongside Qiskit patterns building blocks for reusable code and workflow simplification.\n\nQiskit is the open-source quantum SDK preferred by 69% of respondents to the Unitary Fund's Open Source Software Survey, with nearly 600,000 registered users to date. Now you can get the performance and stability of the Qiskit SDK with the added efficiency of Qiskit Code Assistant to streamline your workflow and optimize your quantum computing programs.\n\n## Features\n\n- Accelerate Qiskit code generation by leveraging generative AI based on the `mistral-small-3.2-24b-qiskit` model\n- Use abstract and specific prompts to generate recommendations\n- Manage code changes by reviewing, accepting, and rejecting suggestions\n- Supports Python code files\n\n## Learn the best ways to use Qiskit and IBM Quantum Platform services\n\nImprove your Qiskit code by reviewing, browsing, and accepting model-generated code suggestions.\n\n### Use abstract prompts to get started\n\nProvide abstract prompts to Qiskit Code Assistant using `#comments`. Type `Alt .`, `Alt \\` or `Tab` following a `#comment` to obtain syntactically correct and contextually relevant content (up to 60 tokens) suited to your desired task.\n\n\n\n### Use specific prompts for streamlined code completion\n\nUse `Alt .`, `Alt \\` or `Tab` with code to obtain specific model-generated suggestions for code completion based on semantic analysis of source code. Review code recommendations before accepting.\n\n## Get started\n\nYou can use Qiskit Code Assistant in two ways:\n\n### Option 1: IBM Quantum Cloud (Recommended)\n\nRequires an IBM Quantum Premium Plan account for the best experience.\n\n#### Obtain your IBM Quantum Platform API token\n\nOpen the [IBM Quantum Platform](https://quantum.cloud.ibm.com/) in your browser and log in with your IBM Quantum Cloud account. After logging in, an IBM Quantum API token is displayed on the upper right side of the web page.\n\n#### Set the API token in the JupyterLab extension\n\nWhen you first open Jupyterlab in a new window or tab you may see that the status bar\nis highlighted orange, this shows that the service is not reachable.\n\n\n\nIf you click the status bar or try to run the completer a dialog will display asking\nfor your API token, paste the token copied above here.\n\n\n\nYou can also search for \"Qiskit\" in the command palette (`Alt Shift C`) to enter or\nupdate your API token.\n\nIn addition if the enviroment variable `QISKIT_IBM_TOKEN` is set or the Qiskit\nconfiguration file `~/.qiskit/qiskit-ibm.json` exists then the API token will be\npopulated at application start. If an API token is entered via the extension it will be\nstored in `~/.qiskit/qiskit-ibm.json` under a new config named `qiskit-code-assistant`\n\n#### Accept the model disclaimer/EULA\n\nBy default, the model you will use is `mistral-small-3.2-24b-qiskit`. It will appear in the Model Picker in the bottom of the status bar.\n\nThe first time you use the `mistral-small-3.2-24b-qiskit` model, a model disclaimer/EULA will appear with information about the model and links to documentation and the model's license. It will also list some restrictions that you should be aware of when using the model, including a restriction against using proprietary code. Clicking `Accept` will enable the new model during code generation.\n\n### Option 2: Local Setup (For Non-Premium Users)\n\nIf you don't have an IBM Quantum Premium Plan account, you can run the Qiskit Code Assistant entirely on your local machine using open-source models.\n\n#### Quick Setup (One Command)\n\n```bash\nbash <(curl -fsSL https://raw.githubusercontent.com/Qiskit/qiskit-code-assistant-jupyterlab/main/setup_local.sh)\n```\n\nOr if you cloned the repository:\n\n```bash\nbash setup_local.sh\n```\n\nFor automated/CI setups, use non-interactive mode:\n\n```bash\nbash setup_local.sh --non-interactive\n# Or: bash setup_local.sh -y\n```\n\n#### What the script does\n\n- Detects and uses `uv` for faster installations (if available)\n- Checks and optionally installs JupyterLab (if needed)\n- Always upgrades the extension to the latest version\n- Installs and configures Ollama (local LLM server)\n- Downloads the Qwen2.5-Coder 14B model optimized for Qiskit (~9GB)\n- Configures optimal model parameters\n- Sets up JupyterLab extension automatically\n\n#### Requirements\n\n- **Operating System**: macOS, Linux, or Windows (via Git Bash or WSL)\n- **Python**: 3.8+ with pip installed\n- **RAM**: 16GB+ recommended (8GB+ for lighter models)\n- **Disk Space**: ~5-20GB depending on model size\n\n#### Available Models\n\nThe setup script supports multiple models. By default, it uses **Qwen2.5-Coder 14B** which offers the best quality for code generation.\n\n| Model | Size | Quality | RAM Required |\n| ------------------------------- | ----- | ------------- | ------------ |\n| **Qwen2.5-Coder 14B** (Default) | ~9GB | Best for code | 16GB+ |\n| Mistral Small 24B | ~15GB | Most recent | 24GB+ |\n| Granite 3.3 8B | ~5GB | Lightweight | 8GB+ |\n\nAll models are trained on **Qiskit 2.0+** and optimized for quantum computing code assistance.\n\nFor detailed instructions, see the [Local Setup Guide](https://github.com/Qiskit/qiskit-code-assistant-jupyterlab#local-setup).\n\n## Using the Extension\n\n### Generate code suggestions\n\nOnce you've accepted the model disclaimer/EULA, you can open a new file and start typing. If you type `Alt .`, some faded text should appear with model-generated suggestions.\n\n### Review and accept/reject code suggestions\n\nType `Alt Tab` or `Alt END` to accept the model-generated suggestion, or type `Esc` to cancel/reject the model-generated suggestion.\n\n### Using the Inline Completer\n\nThe inline completer can be triggered using the following key strokes.\n\n- `Alt .` or `Alt \\` will run the completer at the current cursor location\n- `Alt [` and `Alt ]` can be used to cycle through the list of suggestions if there are\n more than one\n- `Alt Tab` or `Alt END` will \"accept\" the suggested code and insert it at the current\n cursor location\n\nIn addition, once the completer runs you can use the buttons on the inline completer\nwidget to cycle or accept\n\n\n\n### Using the Code Completer\n\nJupyterlab also includes a traditional completer than displays suggestion in a context\nmenu rather than inline. This completer can be triggered using `Tab` to run and display\nthe context menu.\n\nThe context menu will include suggestions from the default completer in addition to the\nQiskit Code Assistant suggestions. The context menu also sanitizes and trims the\nsuggestions, making it less useful for see the code suggestion before inserting it.\n\n\n\n### Jupyterlab Settings\n\nThere are a few settings we recommend to edit in your user settings.\n\n1. Inline Completer `showWidget` can be set to `always` in order to always show the\n inline completer widget to cycle through and select a completion item\n\n2. Code Completion `providerTimeout` can be increased, our suggested value is `15000` or\n 15 seconds. This is 1 second by default and the Qiskit Code Assistant API rarely returns\n within 1 second. This setting only apply the the standard completer that is invoked with\n `Tab`, the inline completer has a default of 15 seconds.\n\n3. If you want to change the instance of the Qiskit Code Assistant Service that the\n extension should use you can edit the Qiskit Code Assistant setting `serviceUrl`.\n This can also be set to any service exposing LLMs using OpenAI-compatible API endpoints.\n\n4. Keyboard shortcuts can be changed by searching for `completer` in the Keyboard Shortcuts\n settings and adding new shortcuts for the relevant commands.\n\n5. Telemetry can be disabled by unchecking the `enableTelemetry` setting.\n\n > **NOTE**: The telemetry does not collect your code nor the suggested code completions.\n > What is collected is whether a code suggestion was accepted or dismissed.\n\n6. Response streaming can be enabled by checking the `enableStreaming` setting.\n\n## Terms of use\n\n- [End User License Agreement (EULA)](https://github.com/Qiskit/qiskit-code-assistant-jupyterlab/blob/main/docs/EULA.md) acceptance required before starting to use the model acceptance required before starting to use the model\n- Terms of use: [https://quantum.ibm.com/terms](https://quantum.ibm.com/terms)\n- Privacy policy: [https://quantum.ibm.com/terms/privacy](https://quantum.ibm.com/terms/privacy)\n- Cloud Services Agreement [https://www.ibm.com/support/customer/csol/terms/?id=Z126-6304&cc=us&lc=en](https://www.ibm.com/support/customer/csol/terms/?id=Z126-6304&cc=us&lc=en)\n- IBM Cloud Service Description [https://www.ibm.com/support/customer/csol/terms/?id=i126-6605&lc=en](https://www.ibm.com/support/customer/csol/terms/?id=i126-6605&lc=en)\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright 2024 IBM\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.",
"summary": "AI Autocomplete JupyterLab extension for Qiskit Code Assistant (Beta)",
"version": "0.8.0",
"project_urls": {
"Bug Tracker": "https://github.com/Qiskit/qiskit-code-assistant-jupyterlab/issues",
"Homepage": "https://github.com/Qiskit/qiskit-code-assistant-jupyterlab",
"Repository": "https://github.com/Qiskit/qiskit-code-assistant-jupyterlab.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e3b42a371844d2c225b52adcedba2f12d68e267f6b4ec80f0d9b36d3e24a0f49",
"md5": "2dfa393f9fd315866b123d95faa8c5c2",
"sha256": "4e6438fe5a44ccf8967aeac9e2155c262f2a00f30fbd6e9a1f16fa2b209529f3"
},
"downloads": -1,
"filename": "qiskit_code_assistant_jupyterlab-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2dfa393f9fd315866b123d95faa8c5c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 41137,
"upload_time": "2025-11-04T14:24:21",
"upload_time_iso_8601": "2025-11-04T14:24:21.053954Z",
"url": "https://files.pythonhosted.org/packages/e3/b4/2a371844d2c225b52adcedba2f12d68e267f6b4ec80f0d9b36d3e24a0f49/qiskit_code_assistant_jupyterlab-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3688413bce4db69952d0b68e61746d99fcd796f6d78e83b1e6ab357e7d913646",
"md5": "b2d8905db5a08bc0d109cdb8f9252cff",
"sha256": "69794da1c83621c5f0a28b5b406c52c7076eba56d768579d4cbdde5550b427d4"
},
"downloads": -1,
"filename": "qiskit_code_assistant_jupyterlab-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "b2d8905db5a08bc0d109cdb8f9252cff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 626390,
"upload_time": "2025-11-04T14:24:22",
"upload_time_iso_8601": "2025-11-04T14:24:22.121862Z",
"url": "https://files.pythonhosted.org/packages/36/88/413bce4db69952d0b68e61746d99fcd796f6d78e83b1e6ab357e7d913646/qiskit_code_assistant_jupyterlab-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-04 14:24:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Qiskit",
"github_project": "qiskit-code-assistant-jupyterlab",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qiskit-code-assistant-jupyterlab"
}
