דלג לתוכן הראשי

שימוש ב-Qiskit Code Assistant ב-JupyterLab

למד כיצד להתקין, להשתמש, להגדיר ולהסיר את התוסף הרשמי של Qiskit Code Assistant ב-JupyterLab.

התקנת תוסף JupyterLab​

להתקנת תוסף JupyterLab, הרץ את הפקודה הבאה מהטרמינל:

pip install qiskit-code-assistant-jupyterlab

לאחר התקנת התוסף, הפעל את JupyterLab:

jupyter lab

התוסף נטען אוטומטית ומופיע בתחתית חלון JupyterLab. עיין בתיעוד JupyterLab לעזרה בעבודה עם JupyterLab.

הגדרת הגדרות התוסף​

מומלץ לערוך את הגדרות JupyterLab הבאות על ידי מעבר אל Settings -> Settings Editor:

  • לחץ על Inline Completer, מצא "Show widget" ובחר Always. פירוש הדבר שווידג'ט ה-inline completer תמיד יוצג כדי שתוכל לעבור בין פריטי השלמה ולבחור אחד מהם.

  • לחץ על Code Completion והגדל את הערך עבור "Default timeout for a provider." ל-10000 או 10 שניות. ערך ברירת המחדל הוא שנייה אחת, אך ייתכן שה-API של Qiskit Code Assistant ייקח יותר מזמן זה למצוא הצעה. הגדרה זו חלה רק על תפריט ההקשר הסטנדרטי שמופעל עם Tab. ל-inline completer יש ברירת מחדל של 10 שניות.

הגדרות נוספות שאולי תרצה לשנות:

  • ניתן לשנות קיצורי מקלדת מ-Settings > Settings Editor > Keyboard Shortcuts.

  • ניתן לשנות את אסימון ה-API של IBM Quantum לשימוש בלוח הפקודות של JupyterLab. לשם כך, לחץ Alt + Shift + C, חפש qiskit, בחר את הפקודה Qiskit Code Assistant: Set IBM Quantum API token, והדבק את המפתח שלך.

  • [מתקדם] לשינוי המופע של שירות Qiskit Code Assistant שהתוסף צריך להשתמש בו, ערוך את הגדרת serviceUrl של Qiskit Code Assistant.

  • [מתקדם] ניתן לשנות קיצורי מקלדת על ידי חיפוש completer בהגדרות קיצורי המקלדת (Settings -> Settings Editor -> Keyboard Shortcuts) והוספת קיצורים חדשים לפקודות הרלוונטיות.

תחילת שימוש בתוסף Qiskit Code Assistant ל-JupyterLab​

אימות והגדרה​

לאחר התקנת התוסף, הוא מנסה לאמת אותך. כברירת מחדל, החבילה מנסה לאמת לשירותי IBM Quantum עם מפתח ה-API המוגדר, ומשתמשת במפתח שלך ממשתנה הסביבה QISKIT_IBM_TOKEN או מהקובץ ~/.qiskit/qiskit-ibm.json (תחת הסעיף default-ibm-quantum). אם אתה זקוק לעזרה בהגדרת החשבון שלך, עקוב אחר ההוראות בהגדרת חשבון IBM Cloud שלך.

כברירת מחדל, התוסף משתמש במודל mistral-small-3.2-24b-qiskit, שמופיע ב-Model Picker בשורת הסטטוס בתחתית.

בפעם הראשונה שאתה משתמש במודל mistral-small-3.2-24b-qiskit, נפתח חלון המפרט מספר הגבלות עיקריות שעליך להיות מודע להן בעת השימוש במודל. לחץ Accept כדי לאפשר את המודל ליצירת קוד.

יצירת קוד​

בזמן שאתה מפתח את הקוד שלך באמצעות Qiskit, ניתן לבקש מ-Qiskit Code Assistant לעזור לך. באופן כללי, העוזר מציע קוד טוב יותר בתגובה להערות Python או docstrings, אך ניתן להשתמש בעוזר בכל מקום בקובץ שלך.

כדי לקבל הצעת קוד, הקלד בקשה, ולאחר מכן לחץ Alt + . או Alt + \. ישנם שני סוגים של בקשות שניתן להשתמש בהן:

  • הזן קוד חלקי וקבל הצעה להשלמת הקוד. לדוגמה: 
    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.
  • הקלד סימן פאונד (#), ולאחר מכן הקלד את הבקשה שלך. לדוגמה: # Give me a random circuit of 5 qubits and a depth of 4.

עבודה עם הצעות קוד​

השתמש בפעולות הבאות כדי לקבל, לדחות ולעבור בין הצעות:

  • Alt + [ ו-Alt + ] ניתן להשתמש בהם כדי לעבור ברשימת ההצעות (אם יש יותר מאחת).
  • Alt + Tab או Alt + END מקבלים את קוד ההצעה ומוסיפים אותו במיקום הסמן הנוכחי.

בנוסף, לאחר הרצת העוזר, ניתן להשתמש בכפתורים שבווידג'ט כדי לעבור בין ההצעות או לקבל אותן:

The popup pane with buttons is shown.

הערה

לעיתים השירות עשוי לקחת מספר שניות להחזיר הצעה. ניתן לראות מתי השירות פעיל על ידי בדיקת שורת הסטטוס.

JupyterLab כולל גם תפריט הקשר מסורתי להשלמת קוד. השתמש במקש Tab להפעלה ולהצגת תפריט ההקשר.

תפריט ההקשר כולל הצעות מ-JupyterLab בנוסף להצעות שנוצרו על ידי Qiskit Code Assistant. תפריט ההקשר גם מנקה וקוצץ את ההצעות, מה שהופך אותו לפחות שימושי לבדיקת הצעת הקוד לפני הוספתה.

הסרת תוסף JupyterLab​

להסרת תוסף Qiskit Code Assistant מ-JupyterLab, הרץ:

pip uninstall qiskit_code_assistant_jupyterlab

פתרון בעיות​

אם אתה רואה את תוסף ה-frontend אך הוא אינו עובד, בדוק שתוסף ה-server מופעל:

jupyter server extension list

אם תוסף ה-server מותקן ומופעל, אך אינך רואה את תוסף ה-frontend, בדוק שתוסף ה-frontend מותקן:

jupyter labextension list

תרומה לתוסף JupyterLab​

הקוד של תוסף זה זמין לציבור ובקוד פתוח. עיין בו ב-GitHub.

הצעדים הבאים​

המלצות

ראה דוגמאות לשימוש ב-Qiskit Code Assistant עבור מעגלים, הגדרת דיכוי שגיאות, וTranspiling עם pass managers.