Qiskit Code Assistant
Ang Qiskit Code Assistant ay layuning gawing mas madaling ma-access ang quantum computing para sa mga bagong gumagamit ng Qiskit at mapabuti ang karanasan sa pag-code ng mga kasalukuyang users. Ito ay isang generative AI code assistant na pinapagana ng watsonx. Ito ay sinanay gamit ang milyun-milyong text token mula sa Qiskit SDK, maraming taon ng mga halimbawa ng Qiskit code, at mga feature ng IBM Quantumยฎ. Makakatulong ang Qiskit Code Assistant sa iyong quantum development workflow sa pamamagitan ng pag-aalok ng mga mungkahi na ginawa ng LLM batay sa IBM Granite models na nagsasama ng mga pinakabagong feature at functionality mula sa IBMยฎ.
- Ito ay isang eksperimental na feature na available sa mga IBM Quantum Premium Plan na user na nakarehistrong sa bagong IBM Quantum Platform.
- Ang Qiskit Code Assistant ay nasa preview release status at maaaring magbago.
- Kung mayroon kang feedback o gusto mong makipag-ugnayan sa development team, gamitin ang Qiskit Slack Workspace channel o ang mga kaugnay na pampublikong GitHub repository.
Mga Featureโ
Ang mga sumusunod na feature ay kasama sa mga extension ng Visual Studio Code (VS Code) at mga katugmang editor, gayundin ang JupyterLab:
- Nagpapabilis ng Qiskit code generation sa pamamagitan ng paggamit ng generative AI batay sa mga modelo na espesyalista sa pagbuo ng Qiskit code.
- Nagbibigay-daan sa mga abstract at tiyak na prompt para makabuo ng mga rekomendasyon.
- Nagpapakita ng mga mungkahi na maaari mong suriin, tanggapin, o tanggihan.
- Sinusuportahan ang mga Python code at Jupyter notebook na file.
- Naglalaman ng mga guardrail para maiwasan ang pagsagot sa mga tanong na kumakatawan sa potensyal na panganib para sa mga user, tulad ng mapang-abusong pananalita.
Para sa mga tagubilin para isama ang Qiskit Code Assistant nang direkta sa iyong development environment, sundin ang mga tagubilin sa naaangkop na paksa:
Ang Large Language Model (LLM) sa likod ng Qiskit Code Assistantโ
Para makapagbigay ng mga mungkahi sa code, gumagamit ang Qiskit Code Assistant ng Large Language Model (LLM). Sa kasong ito, kasalukuyang umaasa ang Qiskit Code Assistant sa modelong mistral-small-3.2-24b-qiskit, na itinayo sa Mistral-Small-3.2-24B-Qiskit model. Ang mistral-small-3.2-24b-qiskit na modelo ay nagpapabuti ng kakayahan sa code generation ng modelong Mistral-Small-3.2-24B-Instruct-2506 para sa Qiskit sa pamamagitan ng extended pretraining at fine-tuning nito sa mataas na kalidad na Qiskit data, gayundin ang mga Python commit at chat. Para sa karagdagang impormasyon tungkol sa pamilya ng Mistral AI models, tingnan ang dokumentasyon ng Mistral AI. Para sa karagdagang detalye tungkol sa mga .*-qiskit na modelo, tingnan ang Qiskit Code Assistant: Training LLMs for generating Quantum Computing Code.
2. qiskit/qwen2.5-coder-14b-qiskit - Released June 2025
3. qiskit/granite-3.3-8b-qiskit - Released June 2025
4. qiskit/granite-3.2-8b-qiskit - Released June 2025
Ang aming mga LLM na espesyalista para sa Qiskit ay available din bilang mga open-source na modelo. Tingnan ang lahat ng available na modelo sa https://huggingface.co/Qiskit.
Ang Qiskit HumanEval at Qiskit HumanEval Hard benchmarksโ
Para subukan ang mistral-small-3.2-24b-qiskit at iba pang mga modelo, nakipagtulungan kami sa mga Qiskit Advocate at eksperto para lumikha ng mga execution-based na benchmark na tinatawag na Qiskit HumanEval (QHE) at Qiskit HumanEval Hard (QHE Hard), at pinatakbo ang mga ito sa mga modelo. Ang mga benchmark na ito ay katulad ng HumanEval, na kinabibilangan ng maraming mapaghamong problema sa code na dapat solusyunan, lahat ay batay sa mga opisyal na Qiskit library.
Ang mga benchmark ay binubuo ng humigit-kumulang 150 na pagsubok, bawat isa ay gawa mula sa isang function definition, na sinusundan ng isang docstring na nagdedetalye ng gawain na kailangang solusyunan ng modelo. Bawat halimbawa ay naglalaman din ng isang reference canonical solution, gayundin ang mga unit test, para masuri ang kawastuhan ng mga nabuong solusyon. Mayroong tatlong antas ng kahirapan para sa mga pagsubok: basic, intermediate, at mahirap. Ang Qiskit HumanEval Hard benchmark ay isang variation ng Qiskit HumanEval, ngunit inaalis ang impormasyon na may kaugnayan sa mga code import, kaya kailangang alamin ng LLM ang tamang method o class import. Ang pagbabagong ito ay nagpapahirap ng dataset para sa mga LLM, ayon sa aming mga pagsubok at paunang resulta.
Ang mga dataset para sa Qiskit HumanEval at Qiskit HumanEval Hard ay available sa mga website na ito: Qiskit HumanEval at Qiskit HumanEval. Maaari kang mag-ambag sa pagpapaunlad ng mga benchmark na ito sa GitHub repository.
Karagdagang impormasyon at mga citationโ
Para matuto nang higit pa tungkol sa Qiskit Code Assistant, Qiskit HumanEval, o Qiskit HumanEval Hard benchmarks, at i-cite ang mga ito sa iyong mga siyentipikong publikasyon, suriin ang mga inirerekomendang citation na ito:
@misc{2405.19495,
Author = {Nicolas Dupuis and Luca Buratti and Sanjay Vishwakarma and Aitana Viudes Forrat and David Kremer and Ismael Faro and Ruchir Puri and Juan Cruz-Benito},
Title = {Qiskit Code Assistant: Training LLMs for generating Quantum Computing Code},
Year = {2024},
Eprint = {arXiv:2405.19495},
}
@misc{2406.14712,
Author = {Sanjay Vishwakarma and Francis Harkins and Siddharth Golecha and Vishal Sharathchandra Bajpe and Nicolas Dupuis and Luca Buratti and David Kremer and Ismael Faro and Ruchir Puri and Juan Cruz-Benito},
Title = {Qiskit HumanEval: An Evaluation Benchmark For Quantum Code Generative Models},
Year = {2024},
Eprint = {arXiv:2406.14712},
}
@misc{2508.20907,
Author = {Nicolas Dupuis and Adarsh Tiwari and Youssef Mroueh and David Kremer and Ismael Faro and Juan Cruz-Benito},
Title = {Quantum Verifiable Rewards for Post-Training Qiskit Code Assistant},
Year = {2025},
Eprint = {arXiv:2508.20907},
}
Gamitin ang Qiskit Code Assistant sa lokal na modeโ
Alamin kung paano mag-install, mag-configure, at gumamit ng alinman sa mga modelo ng Qiskit Code Assistant sa iyong lokal na makina.
- Ang Qiskit Code Assistant ay nasa preview release status at maaaring magbago.
- Kung mayroon kang feedback o gusto mong makipag-ugnayan sa development team, gamitin ang Qiskit Slack Workspace channel o ang mga kaugnay na pampublikong GitHub repository.
Mabilis na simula (inirerekomenda)โ
Ang pinakamadaling paraan para makapagsimula sa Qiskit Code Assistant sa lokal na mode ay ang paggamit ng mga automated na setup script para sa VS Code o JupyterLab extension. Awtomatikong ii-install ng mga script na ito ang Ollama para patakbuhin ang mga LLM, i-download ang inirerekomendang modelo, at i-configure ang extension para sa iyo.
Pag-setup ng VS Code extensionโ
Patakbuhin ang sumusunod na command sa iyong terminal:
bash <(curl -fsSL https://raw.githubusercontent.com/Qiskit/qiskit-code-assistant-vscode/main/setup_local.sh)
Ang script na ito ay nagsasagawa ng mga sumusunod na hakbang:
- I-install ang Ollama (kung hindi pa naka-install)
- I-download at i-configure ang inirerekomendang modelo ng Qiskit Code Assistant
- I-set up ang VS Code extension para gumana sa iyong lokal na deployment
Pag-setup ng JupyterLab extensionโ
Patakbuhin ang sumusunod na command sa iyong terminal:
bash <(curl -fsSL https://raw.githubusercontent.com/Qiskit/qiskit-code-assistant-jupyterlab/main/setup_local.sh)
Gagawin ng script na ito ang:
- I-install ang Ollama (kung hindi pa naka-install)
- I-download at i-configure ang inirerekomendang modelo ng Qiskit Code Assistant
- I-set up ang JupyterLab extension para gumana sa iyong lokal na deployment
Mga available na modeloโ
Mga kasalukuyang modeloโ
Ito ang mga pinakabagong inirerekomendang modelo para gamitin sa Qiskit Code Assistant:
- Qiskit/mistral-small-3.2-24b-qiskit - Released October 2025
- qiskit/qwen2.5-coder-14b-qiskit - Released June 2025
- qiskit/granite-3.3-8b-qiskit - Released June 2025
- qiskit/granite-3.2-8b-qiskit - Released June 2025
Mga GGUF na modelo (inirerekomenda para sa mga personal na kapaligiran/laptop)โ
Ang mga modelo sa GGUF na format ay na-optimize para sa lokal na paggamit at nangangailangan ng mas kaunting computational resources:
-
mistral-small-3.2-24b-qiskit-GGUF โ Released October 2025
Trained with Qiskit data up to version 2.1 -
qiskit/qwen2.5-coder-14b-qiskit-GGUF โ Released June 2025
Trained with Qiskit data up to version 2.0 -
qiskit/granite-3.3-8b-qiskit-GGUF โ Released June 2025
Trained with Qiskit data up to version 2.0 -
qiskit/granite-3.2-8b-qiskit-GGUF โ Released June 2025
Trained with Qiskit data up to version 2.0
Ang mga Open Source na modelo ng Qiskit Code Assistant ay available sa safetensors o GGUF file format at maaaring i-download mula sa Hugging Face tulad ng ipinaliwanag sa ibaba.
Mga bersyon ng Qiskit na ginamit para sa trainingโ
| Model | ย | ย | ย | ย | ย | Benchmark Metrics | ย | ย | ย | ย | Release date | Trained on Qiskit version |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ย | QiskitHumanEval-Hard | QiskitHumanEval | HumanEval | ASDiv | MathQA | SciQ | MBPP | IFEval | CrowsPairs (English) | TruthfulQA (MC1 acc) | ย | ย |
| mistral-small-3.2-24b-qiskit | 32.45 | 47.02 | 77.49 | 3.77 | 49.68 | 97.50 | 64.00 | 48.44 | 67.08 | 39.41 | January 2026 | 2.2 |
| qwen2.5-coder-14b-qiskit | 25.17 | 49.01 | 91.46 | 4.21 | 53.90 | 97.00 | 77.60 | 49.64 | 65.18 | 37.82 | June 2025 | 2.0 |
| granite-3.3-8b-qiskit | 14.57 | 27.15 | 62.80 | 0.48 | 38.66 | 93.30 | 52.40 | 59.71 | 59.75 | 39.05 | June 2025 | 2.0 |
| granite-3.2-8b-qiskit | 9.93 | 24.50 | 57.32 | 0.09 | 41.41 | 96.30 | 51.80 | 60.79 | 66.79 | 40.51 | June 2025 | 2.0 |
| granite-8b-qiskit-rc-0.10 | 15.89 | 38.41 | 59.76 | โ | โ | โ | โ | โ | โ | โ | February 2025 | 1.3 |
| granite-8b-qiskit | 17.88 | 44.37 | 53.66 | โ | โ | โ | โ | โ | โ | โ | November 2024 | 1.2 |
Note: All models listed in the benchmark table were evaluated using their respective system prompt, defined in their Hugging Face model.
Mga deprecated na modeloโ
Ang mga modelong ito ay hindi na aktibong pinapanatili ngunit nananatiling available:
- qiskit/granite-8b-qiskit-rc-0.10 - Released February 2025 (deprecated)
- qiskit/granite-8b-qiskit - Released November 2024 (deprecated)
Advanced na pag-setupโ
Kung mas gusto mong manu-manong i-configure ang iyong lokal na setup o kailangan ng mas maraming kontrol sa proseso ng pag-install, palawakin ang mga seksyon sa ibaba.
I-download mula sa website ng Hugging Face
Sundin ang mga hakbang na ito para i-download ang anumang modelong kaugnay ng Qiskit Code Assistant mula sa website ng Hugging Face:
- Pumunta sa nais na pahina ng Qiskit model sa Hugging Face.
- Pumunta sa tab na Files and Versions at i-download ang mga safetensors o GGUF model file.
I-download gamit ang Hugging Face CLI
Para i-download ang alinman sa mga available na modelo ng Qiskit Code Assistant gamit ang Hugging Face CLI, sundin ang mga hakbang na ito:
-
I-install ang Hugging Face CLI
-
Mag-login sa iyong Hugging Face account
huggingface-cli login -
I-download ang modelong gusto mo mula sa nakaraang listahan
huggingface-cli download <HF REPO NAME> <MODEL PATH> --local-dir <LOCAL PATH>
Manu-manong i-deploy ang mga modelo ng Qiskit Code Assistant sa lokal sa pamamagitan ng Ollama
Mayroong maraming paraan para i-deploy at makipag-ugnayan sa na-download na modelo ng Qiskit Code Assistant. Ipinapakita ng gabay na ito ang paggamit ng Ollama tulad ng sumusunod: alinman sa Ollama application sa pamamagitan ng paggamit ng Hugging Face Hub integration o lokal na modelo, o sa llama-cpp-python package.
Paggamit ng Ollama applicationโ
Ang Ollama application ay nagbibigay ng simpleng solusyon para patakbuhin ang mga LLM nang lokal. Madaling gamitin, na may CLI na ginagawang mas diretso ang buong proseso ng setup, pamamahala ng modelo, at pakikipag-ugnayan. Ito ay perpekto para sa mabilis na eksperimento at para sa mga user na gustong mas kaunting teknikal na detalye ang hawakan.
I-install ang Ollamaโ
-
I-download ang Ollama application
-
I-install ang na-download na file
-
Ilunsad ang na-install na Ollama application
impormasyonMatagumpay na tumatakbo ang application kapag lumitaw ang Ollama icon sa desktop menu bar. Maaari mo ring i-verify na tumatakbo ang serbisyo sa pamamagitan ng pagpunta sa
http://localhost:11434/. -
Subukan ang Ollama sa iyong terminal at simulang magpatakbo ng mga modelo. Halimbawa:
ollama run hf.co/Qiskit/Qwen2.5-Coder-14B-Qiskit
I-set up ang Ollama gamit ang Hugging Face Hub integrationโ
Ang Ollama/Hugging Face Hub integration ay nagbibigay ng paraan para makipag-ugnayan sa mga modelong naka-host sa Hugging Face Hub nang hindi na kailangang lumikha ng bagong modelfile o manu-manong i-download ang mga GGUF o safetensors file. Ang mga default na template at params file ay kasama na para sa modelo sa Hugging Face Hub.
-
Siguraduhing tumatakbo ang Ollama application.
-
Pumunta sa nais na pahina ng modelo, at kopyahin ang URL. Halimbawa, https://huggingface.co/Qiskit/Qwen2.5-Coder-14B-Qiskit-GGUF.
-
Mula sa iyong terminal, patakbuhin ang command:
ollama run hf.co/Qiskit/Qwen2.5-Coder-14B-Qiskit
Maaari mong gamitin ang modelong hf.co/Qiskit/Qwen2.5-Coder-14B-Qiskit o alinman sa iba pang kasalukuyang inirerekomendang opisyal na GGUF model na hf.co/Qiskit/mistral-small-3.2-24b-qiskit-GGUF o hf.co/Qiskit/granite-3.3-8b-qiskit-GGUF.
I-set up ang Ollama gamit ang manu-manong na-download na GGUF model ng Qiskit Code Assistantโ
Kung manu-mano kang nag-download ng GGUF model tulad ng https://huggingface.co/Qiskit/Qwen2.5-Coder-14B-Qiskit-GGUF at gusto mong mag-eksperimento sa iba't ibang template at parameter, maaari kang sundin ang mga hakbang na ito para i-load ito sa iyong lokal na Ollama application.
-
Lumikha ng
Modelfilena may sumusunod na nilalaman at tiyaking i-update ang<PATH-TO-GGUF-FILE>sa aktwal na path ng iyong na-download na modelo.FROM <PATH-TO-GGUF-FILE>
TEMPLATE """{{ if .System }}
System:
{{ .System }}
{{ end }}{{ if .Prompt }}Question:
{{ .Prompt }}
{{ end }}Answer:
```python{{ .Response }}
"""
PARAMETER stop "Question:"
PARAMETER stop "Answer:"
PARAMETER stop "System:"
PARAMETER stop "```"
PARAMETER temperature 0
PARAMETER top_k 1 -
Run the following command to create a custom model instance based on the
Modelfile.ollama create Qwen2.5-Coder-14B-Qiskit -f ./path-to-model-filetalaThis process may take some time for Ollama to read the model file, initialize the model instance, and configure it according to the specifications provided.
Run the Qiskit Code Assistant model manually downloaded in Ollamaโ
After the Qwen2.5-Coder-14B-Qiskit model has been set up in Ollama, run the following command to launch the model and interact with it in the terminal (in chat mode).
ollama run Qwen2.5-Coder-14B-Qiskit
Some useful commands:
ollama list- List models on your computerollama rm Qwen2.5-Coder-14B-Qiskit- Delete the modelollama show Qwen2.5-Coder-14B-Qiskit- Show model informationollama stop Qwen2.5-Coder-14B-Qiskit- Stop a model that is currently runningollama ps- List which models are currently loaded
Manually deploy the Qiskit Code Assistant models in local through the llama-cpp-python package
An alternative to the Ollama application is the llama-cpp-python package, which is a Python binding for llama.cpp. It gives you more control and flexibility to run the GGUF model locally, and is ideal for users who wish to integrate the local model in their workflows and Python applications.
- Install
llama-cpp-python - Interact with the model from within your application using
llama_cpp. For example:
from llama_cpp import Llama
model_path = <PATH-TO-GGUF-FILE>
model = Llama(
model_path,
seed=17,
n_ctx=10000,
n_gpu_layers=37, # to offload in gpu, but put 0 if all in cpu
)
input = 'Generate a quantum circuit with 2 qubits'
raw_pred = model(input)["choices"][0]["text"]
You can also add text generation parameters to the model to customize the inference:
generation_kwargs = {
"max_tokens": 512,
"echo": False, # Echo the prompt in the output
"top_k": 1
}
raw_pred = model(input, **generation_kwargs)["choices"][0]["text"]
Manually deploy the Qiskit Code Assistant models in local through llama.cpp
Use the llama.cpp libraryโ
Another alternative is to use llama.cpp, an open-source library for performing LLM inference on a CPU with minimal setup.
It provides low-level control over the model execution and is typically run from the command line, pointing to a local GGUF model file.
There are several ways to install llama.cpp on your machine:
- Install llama.cpp using brew, nix, or winget
- Run with Docker: See out the Docker documentation by
llama.cppteam - Download pre-built binaries from the releases page
- Build from source by cloning this repository
Once installed, you can use llama.cpp to interact with GGUF models in conversation mode as follows:
# Use a local model file
llama-cli -m my_model.gguf -cnv
# Or download and run a model directly from Hugging Face
llama-cli -hf Qiskit/Qwen2.5-Coder-14B-Qiskit-GGUF -cnv
You can also launch an OpenAI-compatible API server for the model in the following way:
llama-server -hf Qiskit/Qwen2.5-Coder-14B-Qiskit-GGUF
Advanced parametersโ
With the llama-cli program, you can control the model generation using command-line options. For example, you can provide an initial โsystemโ prompt using the -p/--prompt flag. In conversation mode (-cnv), this initial prompt acts as the system message. Otherwise, you can simply prepend any desired instruction to your prompt text. You can also adjust sampling parameters - for instance: temperature (--temp), top-k (--top-k), top-p (--top-p), repetition penalty (--repeat-penalty), and the seed to use (--seed). The following is an example invocation using these options:
llama-cli -hf Qiskit/Qwen2.5-Coder-14B-Qiskit-GGUF \
-p "You are a friendly assistant." -cnv \
--temp 0.7 \
--top-k 50 \
--top-p 0.95 \
--repeat-penalty 1.1 \
--seed 42
Para matiyak ang wastong functionality ng aming mga Qiskit model, inirerekomenda naming gamitin ang system prompt na ibinigay sa aming mga HF GGUF repository: system prompt para sa mistral-small-3.2-24b-qiskit-GGUF, Qwen2.5-Coder-14B-Qiskit-GGUF, granite-3.3-8b-qiskit-GGUF, at granite-3.2-8b-qiskit-GGUF.
Manu-manong ikonekta ang mga extension sa lokal na deployment
Gamitin ang VS Code extension at JupyterLab extension para sa Qiskit Code Assistant para i-prompt ang lokal na na-deploy na modelo ng Qiskit Code Assistant. Kapag nai-set up mo na ang Ollama application kasama ang modelo, maaari mong i-configure ang mga extension para kumonekta sa lokal na serbisyo.
Kumonekta gamit ang Qiskit Code Assistant VS Code extensionโ
Gamit ang Qiskit Code Assistant VS Code extension, maaari kang makipag-ugnayan sa modelo at magsagawa ng code completion habang nagsusulat ng code. Maaari itong gumana nang maayos para sa mga user na naghahanap ng tulong sa pagsulat ng Qiskit code para sa kanilang mga Python application.
- I-install ang Qiskit Code Assistant VS Code extension.
- Sa VS Code, pumunta sa User Settings at itakda ang Qiskit Code Assistant: Url sa URL ng iyong lokal na Ollama deployment (halimbawa,
http://localhost:11434). - I-reload ang VS Code sa pamamagitan ng pagpunta sa View > Command Palette... at pagpili ng Developer: Reload Window.
Ang modelo ng Qiskit Code Assistant na na-configure sa Ollama ay dapat lumabas sa status bar at handa nang gamitin.
Kumonekta gamit ang Qiskit Code Assistant JupyterLab extensionโ
Gamit ang Qiskit Code Assistant JupyterLab extension, maaari kang makipag-ugnayan sa modelo at magsagawa ng code completion nang direkta sa iyong Jupyter Notebook. Ang mga user na pangunahing nagtatrabaho sa mga Jupyter Notebook ay maaaring samantalahin ang extension na ito para higit pang mapahusay ang kanilang karanasan sa pagsulat ng Qiskit code.
- I-install ang Qiskit Code Assistant JupyterLab extension.
- Sa JupyterLab, pumunta sa Settings Editor at itakda ang Qiskit Code Assistant Service API sa URL ng iyong lokal na Ollama deployment (halimbawa,
http://localhost:11434).
Ang modelo ng Qiskit Code Assistant na na-configure sa Ollama ay dapat lumabas sa status bar at handa nang gamitin.
Mga susunod na hakbangโ
- I-install at gamitin ang opisyal na extension ng JupyterLab o VS Code.
- Tingnan ang mga halimbawa para gamitin ang Qiskit Code Assistant para sa mga circuit, pag-configure ng error suppression, at pag-transpile gamit ang mga pass manager.