Usa Qiskit Code Assistant in JupyterLab

Scopri come installare, usare, configurare e disinstallare l'estensione ufficiale Qiskit Code Assistant in JupyterLab.

Installa l'estensione JupyterLab

Per installare l'estensione JupyterLab, esegui il seguente comando da un terminale:

pip install qiskit-code-assistant-jupyterlab

Dopo aver installato l'estensione, avvia JupyterLab:

jupyter lab

L'estensione si carica automaticamente ed è elencata nella parte inferiore della finestra di JupyterLab. Consulta la documentazione di JupyterLab per assistenza nell'uso di JupyterLab.

Configura le impostazioni dell'estensione

È consigliato modificare le seguenti impostazioni di JupyterLab andando su Impostazioni -> Editor delle impostazioni:

• Clicca su Inline Completer, trova "Show widget" e scegli Always. In questo modo il widget del completamento inline sarà sempre visibile, così potrai scorrere e selezionare un elemento di completamento.

• Clicca su Code Completion e aumenta il valore di "Default timeout for a provider." a 10000 ovvero 10 secondi. Il valore predefinito è 1 secondo, ma l'API di Qiskit Code Assistant potrebbe impiegare più tempo per trovare un suggerimento. Questa impostazione si applica solo al menu contestuale standard richiamato con Tab. Il completamento inline ha un valore predefinito di 10 secondi.

Altre impostazioni che potresti voler cambiare:

• Le scorciatoie da tastiera possono essere modificate da Impostazioni > Editor delle impostazioni > Scorciatoie da tastiera.

• Puoi cambiare il token API di IBM Quantum da usare nella palette dei comandi di JupyterLab. Per farlo, premi Alt + Shift + C, cerca qiskit, seleziona il comando Qiskit Code Assistant: Set IBM Quantum API token e incolla la tua chiave.

• [Avanzato] Per cambiare l'istanza del servizio Qiskit Code Assistant che l'estensione deve usare, modifica l'impostazione serviceUrl di Qiskit Code Assistant.

• [Avanzato] Le scorciatoie da tastiera possono essere modificate cercando completer nelle impostazioni delle Scorciatoie da tastiera (Impostazioni -> Editor delle impostazioni -> Scorciatoie da tastiera) e aggiungendo nuove scorciatoie per i comandi pertinenti.

Inizia a usare l'estensione Qiskit Code Assistant per JupyterLab

Autenticazione e configurazione

Dopo aver installato l'estensione, questa tenta di autenticarti. Per impostazione predefinita, il pacchetto cerca di autenticarsi ai servizi IBM Quantum con la chiave API definita, e utilizza la tua chiave dalla variabile d'ambiente QISKIT_IBM_TOKEN o dal file ~/.qiskit/qiskit-ibm.json (nella sezione default-ibm-quantum). Se hai bisogno di aiuto per configurare il tuo account, segui le istruzioni in Configura il tuo account IBM Cloud.

Per impostazione predefinita, l'estensione usa il modello mistral-small-3.2-24b-qiskit, elencato nel Model Picker nella barra di stato in basso.

La prima volta che usi il modello mistral-small-3.2-24b-qiskit, si apre una finestra che elenca alcune importanti restrizioni di cui dovresti essere a conoscenza quando usi il modello. Clicca su Accept per abilitare il modello per la generazione di codice.

Genera codice

Mentre sviluppi il tuo codice con Qiskit, puoi chiedere a Qiskit Code Assistant di aiutarti. In generale, l'assistente suggerisce codice migliore in risposta a commenti Python o docstring, ma puoi usare l'assistente in qualsiasi punto del file.

Per ottenere un suggerimento di codice, digita un prompt, poi premi Alt + . oppure Alt + \. Ci sono due tipi di prompt che puoi usare:

• Inserisci del codice parziale e ottieni un suggerimento per completarlo. Esempio:

  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.

• Digita il simbolo cancelletto (#), poi scrivi il tuo prompt. Esempio: # Give me a random circuit of 5 qubits and a depth of 4.

Lavora con i suggerimenti di codice

Usa quanto segue per accettare, rifiutare e scorrere i suggerimenti:

• Alt + [ e Alt + ] possono essere usati per scorrere l'elenco dei suggerimenti (se ce n'è più di uno).
• Alt + Tab o Alt + END accetta il codice suggerito e lo inserisce nella posizione corrente del cursore.

Inoltre, dopo l'esecuzione dell'assistente, puoi usare i pulsanti del widget per scorrere o accettare il suggerimento:

nota

Il servizio a volte può impiegare alcuni secondi per restituire un suggerimento; puoi vedere quando il servizio è in elaborazione controllando la barra di stato.

JupyterLab include anche un menu contestuale tradizionale per i suggerimenti. Usa il tasto Tab per aprire e visualizzare il menu contestuale.

Il menu contestuale include suggerimenti da JupyterLab oltre ai suggerimenti di Qiskit Code Assistant. Il menu contestuale inoltre sanitizza e taglia i suggerimenti, rendendolo meno utile per esaminare il suggerimento di codice prima di inserirlo.

Disinstalla l'estensione JupyterLab

Per rimuovere l'estensione Qiskit Code Assistant da JupyterLab, esegui:

pip uninstall qiskit_code_assistant_jupyterlab

Risoluzione dei problemi

Se vedi l'estensione frontend ma non funziona, verifica che l'estensione server sia abilitata:

jupyter server extension list

Se l'estensione server è installata e abilitata, ma non vedi l'estensione frontend, verifica che l'estensione frontend sia installata:

jupyter labextension list

Contribuisci all'estensione JupyterLab

Il codice di questa estensione è pubblicamente disponibile e open source. Scoprilo su GitHub.

Passi successivi

Raccomandazioni

Consulta gli esempi per usare Qiskit Code Assistant per i circuiti, la configurazione della soppressione degli errori e il transpiling con i pass manager.