Gunakan Qiskit Code Assistant di JupyterLab

Pelajari cara menginstal, menggunakan, mengonfigurasi, dan menghapus ekstensi resmi Qiskit Code Assistant di JupyterLab.

Instal ekstensi JupyterLab

Untuk menginstal ekstensi JupyterLab, jalankan perintah berikut dari terminal:

pip install qiskit-code-assistant-jupyterlab

Setelah ekstensi terinstal, mulai JupyterLab:

jupyter lab

Ekstensi akan dimuat otomatis dan muncul di bagian bawah jendela JupyterLab. Lihat dokumentasi JupyterLab untuk bantuan menggunakan JupyterLab.

Konfigurasi pengaturan ekstensi

Disarankan untuk mengedit pengaturan JupyterLab berikut melalui Settings -> Settings Editor:

• Klik Inline Completer, cari "Show widget" dan pilih Always. Ini berarti widget inline completer akan selalu ditampilkan sehingga kamu bisa menelusuri dan memilih item pelengkap.

• Klik Code Completion dan tingkatkan nilai "Default timeout for a provider." menjadi 10000 atau 10 detik. Nilai default-nya adalah 1 detik, tapi API Qiskit Code Assistant mungkin butuh waktu lebih lama untuk menemukan saran. Pengaturan ini hanya berlaku untuk context menu standar yang dipanggil dengan Tab. Inline completer punya default 10 detik.

Pengaturan lain yang mungkin ingin kamu ubah:

• Pintasan keyboard bisa diubah dari Settings > Settings Editor > Keyboard Shortcuts.

• Kamu bisa mengubah token API IBM Quantum di command palette JupyterLab. Caranya, tekan Alt + Shift + C, cari qiskit, pilih perintah Qiskit Code Assistant: Set IBM Quantum API token, lalu tempel kunci kamu.

• [Lanjutan] Untuk mengubah instance layanan Qiskit Code Assistant yang digunakan ekstensi, edit pengaturan serviceUrl di Qiskit Code Assistant.

• [Lanjutan] Pintasan keyboard bisa diubah dengan mencari completer di pengaturan Keyboard Shortcuts (Settings -> Settings Editor -> Keyboard Shortcuts) dan menambahkan pintasan baru untuk perintah yang relevan.

Mulai menggunakan ekstensi Qiskit Code Assistant untuk JupyterLab

Autentikasi dan pengaturan

Setelah ekstensi terinstal, ekstensi akan mencoba mengautentikasimu. Secara default, paket ini mencoba mengautentikasi ke layanan IBM Quantum menggunakan kunci API yang sudah dikonfigurasi, dan menggunakan kunci dari variabel lingkungan QISKIT_IBM_TOKEN atau dari file ~/.qiskit/qiskit-ibm.json (di bagian default-ibm-quantum). Jika butuh bantuan mengonfigurasi akun, ikuti instruksi di Siapkan akun IBM Cloud kamu.

Secara default, ekstensi menggunakan model mistral-small-3.2-24b-qiskit, yang tercantum di Model Picker pada status bar bagian bawah.

Pertama kali kamu menggunakan model mistral-small-3.2-24b-qiskit, sebuah jendela akan terbuka yang menampilkan beberapa batasan utama yang perlu kamu ketahui saat menggunakan model ini. Klik Accept untuk mengaktifkan model untuk pembuatan kode.

Buat kode

Saat kamu mengembangkan kode menggunakan Qiskit, kamu bisa meminta bantuan dari Qiskit Code Assistant. Secara umum, asisten memberikan saran kode yang lebih baik sebagai respons terhadap komentar Python atau docstring, tapi kamu bisa menggunakan asisten di mana saja dalam file kamu.

Untuk mendapatkan saran kode, ketik prompt, lalu tekan Alt + . atau Alt + \. Ada dua jenis prompt yang bisa kamu gunakan:

• Masukkan kode sebagian dan dapatkan saran untuk melengkapinya. Contoh:

  from qiskit.circuit import QuantumCircuit
  from qiskit.transpiler import generate_preset_pass_manager
  from qiskit_ibm_runtime import SamplerV2 as Sampler
  from qiskit_ibm_runtime.fake_provider import FakeManilaV2
  
  # Bell Circuit
  qc = QuantumCircuit(2)
  qc.h(0)
  qc.cx(0, 1)
  
  qc.mea # Type Ctrl + . for a code suggestion.

• Ketik tanda pagar (#), lalu ketik promptmu. Contoh: # Give me a random circuit of 5 qubits and a depth of 4.

Bekerja dengan saran kode

Gunakan hal berikut untuk menerima, menolak, dan menelusuri saran:

• Alt + [ dan Alt + ] digunakan untuk menelusuri daftar saran (jika ada lebih dari satu).
• Alt + Tab atau Alt + END menerima kode yang disarankan dan menyisipkannya di posisi kursor saat ini.

Selain itu, setelah asisten selesai berjalan, kamu bisa menggunakan tombol pada widget untuk menelusuri atau menerima saran:

catatan

Layanan kadang butuh beberapa detik untuk mengembalikan saran. Kamu bisa melihat kapan layanan sedang bekerja dengan memeriksa status bar.

JupyterLab juga menyertakan context menu saran tradisional. Gunakan tombol Tab untuk menjalankan dan menampilkan context menu.

Context menu menyertakan saran dari JupyterLab selain saran dari Qiskit Code Assistant. Context menu juga membersihkan dan memangkas saran, sehingga kurang berguna untuk meninjau saran kode sebelum menyisipkannya.

Hapus ekstensi JupyterLab

Untuk menghapus ekstensi Qiskit Code Assistant dari JupyterLab, jalankan:

pip uninstall qiskit_code_assistant_jupyterlab

Pemecahan masalah

Jika kamu melihat ekstensi frontend tapi tidak berfungsi, periksa apakah ekstensi server sudah diaktifkan:

jupyter server extension list

Jika ekstensi server sudah terinstal dan diaktifkan, tapi kamu tidak melihat ekstensi frontend, periksa apakah ekstensi frontend sudah terinstal:

jupyter labextension list

Berkontribusi pada ekstensi JupyterLab

Kode untuk ekstensi ini tersedia secara publik dan open source. Lihat di GitHub.

Langkah selanjutnya

Rekomendasi

Lihat contoh penggunaan Qiskit Code Assistant untuk Circuit, mengonfigurasi error suppression, dan transpiling dengan pass managers.