Aller au contenu principal

Utiliser Qiskit Code Assistant dans JupyterLab

Apprends à installer, utiliser, configurer et désinstaller l'extension officielle Qiskit Code Assistant dans JupyterLab.

Installer l'extension JupyterLab​

Pour installer l'extension JupyterLab, exécute la commande suivante depuis un terminal :

pip install qiskit-code-assistant-jupyterlab

Après avoir installé l'extension, démarre JupyterLab :

jupyter lab

L'extension se charge automatiquement et apparaît en bas de la fenêtre JupyterLab. Consulte la documentation JupyterLab pour obtenir de l'aide sur l'utilisation de JupyterLab.

Configurer les paramètres de l'extension​

Il est recommandé de modifier les paramètres JupyterLab suivants en allant dans Settings -> Settings Editor :

  • Clique sur Inline Completer, trouve « Show widget » et choisis Always. Cela signifie que le widget de complétion en ligne sera toujours affiché pour que tu puisses parcourir et sélectionner un élément de complétion.

  • Clique sur Code Completion et augmente la valeur de « Default timeout for a provider. » à 10000 ou 10 secondes. La valeur par défaut est de 1 seconde, mais l'API Qiskit Code Assistant peut prendre plus de temps pour trouver une suggestion. Ce paramètre s'applique uniquement au menu contextuel standard invoqué avec Tab. Le compléteur en ligne a une valeur par défaut de 10 secondes.

Autres paramètres que tu pourrais vouloir modifier :

  • Les raccourcis clavier peuvent être modifiés depuis Settings > Settings Editor > Keyboard Shortcuts.

  • Tu peux changer le token d'API IBM Quantum à utiliser dans la palette de commandes JupyterLab. Pour ce faire, tape Alt + Shift + C, recherche qiskit, sélectionne la commande Qiskit Code Assistant: Set IBM Quantum API token et colle ta clé.

  • [Avancé] Pour changer l'instance du service Qiskit Code Assistant que l'extension doit utiliser, modifie le paramètre serviceUrl de Qiskit Code Assistant.

  • [Avancé] Les raccourcis clavier peuvent être modifiés en recherchant completer dans les paramètres de raccourcis clavier (Settings -> Settings Editor -> Keyboard Shortcuts) et en ajoutant de nouveaux raccourcis pour les commandes concernées.

Commencer à utiliser l'extension Qiskit Code Assistant pour JupyterLab​

Authentification et configuration​

Après l'installation de l'extension, celle-ci tente de t'authentifier. Par défaut, le package essaie de s'authentifier aux services IBM Quantum avec la clé API définie, et utilise ta clé depuis la variable d'environnement QISKIT_IBM_TOKEN ou depuis le fichier ~/.qiskit/qiskit-ibm.json (sous la section default-ibm-quantum). Si tu as besoin d'aide pour configurer ton compte, suis les instructions dans Configurer ton compte IBM Cloud.

Par défaut, l'extension utilise le modèle mistral-small-3.2-24b-qiskit, qui est répertorié dans le sélecteur de modèle dans la barre d'état en bas.

La première fois que tu utilises le modèle mistral-small-3.2-24b-qiskit, une fenêtre s'ouvre listant certaines restrictions importantes dont tu dois être conscient lors de l'utilisation du modèle. Clique sur Accept pour activer le modèle pour la génération de code.

Générer du code​

Pendant que tu développes ton code avec Qiskit, tu peux demander à Qiskit Code Assistant de t'aider. En général, l'assistant suggère un meilleur code en réponse à des commentaires Python ou des docstrings, mais tu peux utiliser l'assistant n'importe où dans ton fichier.

Pour obtenir une suggestion de code, tape une invite, puis tape Alt + . ou Alt + \. Il existe deux types d'invites que tu peux utiliser :

  • Saisis du code partiel et obtiens une suggestion pour le compléter. Exemple : 
    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.
  • Tape un signe dièse (#), puis tape ton invite. Exemple : # Give me a random circuit of 5 qubits and a depth of 4.

Travailler avec les suggestions de code​

Utilise les éléments suivants pour accepter, rejeter et naviguer parmi les suggestions :

  • Alt + [ et Alt + ] peuvent être utilisés pour parcourir la liste des suggestions (s'il y en a plus d'une).
  • Alt + Tab ou Alt + END accepte le code suggéré et l'insère à l'emplacement actuel du curseur.

De plus, après l'exécution de l'assistant, tu peux utiliser les boutons du widget pour naviguer parmi les suggestions ou en accepter une :

The popup pane with buttons is shown.

remarque

Le service peut parfois prendre quelques secondes pour retourner une suggestion. Tu peux voir quand le service est en cours de traitement en vérifiant la barre d'état.

JupyterLab inclut également un menu contextuel de suggestion traditionnel. Utilise la touche Tab pour exécuter et afficher le menu contextuel.

Le menu contextuel inclut des suggestions de JupyterLab en plus des suggestions faites par Qiskit Code Assistant. Le menu contextuel assainit et tronque également les suggestions, ce qui le rend moins utile pour examiner la suggestion de code avant de l'insérer.

Désinstaller l'extension JupyterLab​

Pour supprimer l'extension Qiskit Code Assistant de JupyterLab, exécute :

pip uninstall qiskit_code_assistant_jupyterlab

Dépannage​

Si tu vois l'extension frontend mais qu'elle ne fonctionne pas, vérifie que l'extension serveur est activée :

jupyter server extension list

Si l'extension serveur est installée et activée, mais que tu ne vois pas l'extension frontend, vérifie que l'extension frontend est installée :

jupyter labextension list

Contribuer à l'extension JupyterLab​

Le code de cette extension est publiquement disponible et open source. Découvre-le sur GitHub.

Prochaines étapes​

Recommandations

Consulte des exemples pour utiliser Qiskit Code Assistant pour les circuits, la configuration de la suppression d'erreurs et la transpilation avec des pass managers.