インストール
前提条件
-
IBM Quantum® Platformのインスタンスでマネージド・ワークフローが有効になっていること。有効にするには、管理者に連絡してください。
-
APIキーとインスタンスのCRN。アクセス認証情報を確認するを参照してください。
-
有効な仮想環境内のPython 3.10以降。環境のセットアップ方法については、Qiskitをインストールするを参照してください。
AIスキルを使ったクイックスタート
Qiskit Functionテンプレート・リポジトリのAIスキルを使用すると、qiskit-ibm-catalogのインストール、既存のローカルコードのパッケージ化、マネージド・ワークフローとしてのデプロイを進めやすくなります。
クライアントパッケージをインストールする
qiskit-ibm-catalogパッケージをインストールします。
pip install qiskit-ibm-catalog
このコマンドは、依存関係としてqiskit-serverless、qiskit、qiskit-ibm-runtimeもインストールします。qiskit-serverlessを別途インストールする必要はありません。これらのガイドの例にはqiskit-ibm-catalog 0.22.0以降が必要で、これによりqiskit-serverless 0.38とqiskit-ibm-runtime 0.51がインストールされます。
これらのパッケージのうち2つを、異なる場所で直接使用します。
-
qiskit-ibm-catalogは、ローカルコンピューターでワークフローのアップロード、実行、結果の取得に使用するクライアントです。 -
qiskit-serverlessはワークフローコード内で実行されます。get_arguments()、update_status()、save_result()などのヘルパーを提供します。
クライアントパッケージを更新する
マネージド・ワークフローはベータ版であるため、クライアントパッケージは頻繁に変更されます。お使いのバージョンを確認するには、次のコマンドを実行します。
pip show qiskit-ibm-catalog
Or, in Python:
import qiskit_ibm_catalog
print(qiskit_ibm_catalog.__version__)
最新バージョンに更新するには、次のコマンドを実行します。
pip install --upgrade qiskit-ibm-catalog
qiskit-ibm-catalogの新しいバージョンがより新しいqiskit-serverlessを必要とする場合、このコマンドはqiskit-serverlessも更新します。
認証する
APIキーを、ワークフローコード、スクリプト、またはノートブックファイルに含めないでください。実行中のワークフローは、run()の呼び出しに使用した認証情報とインスタンスを使用します。
マネージド・ワークフロー・クライアントは、qiskit-ibm-runtimeと同じ認証情報を使用します。すでにQiskitRuntimeService.save_account()でアカウントを保存している場合、クライアントはデフォルトの保存済みアカウントを読み込むため、セットアップを確認するに進んでかまいません。
アカウントを保存していない場合は、信頼できる環境で、APIキーとインスタンスのCRNを一度だけ保存します。
from qiskit_ibm_catalog import ManagedWorkflowClient
ManagedWorkflowClient.save_account(
token="<your-api-key>",
instance="<your-instance-crn>",
)
このメソッドは、認証情報をQiskitRuntimeService.save_account()と同じファイルに書き込みます。クライアントはデフォルトでibm_quantum_platformチャネルを使用するため、channelを設定する必要はありません。複数のアカウントを保存するには、nameを設定し、クライアントを作成するときに同じnameを渡します。
複数のアカウントの保存やインスタンスの自動選択などの詳細なオプションについては、ログイン認証情報を保存するを参照してください。公共のコンピューターやその他の信頼できない環境で作業する場合は、認証情報を保存しないでください。代わりに、信頼できない環境でサービスを初期化するに従ってください。
セットアップを確認する
保存済みアカウントでマネージド・ワークフローに接続し、アップロードしたワークフローを一覧表示します。
from qiskit_ibm_catalog import ManagedWorkflowClient
client = ManagedWorkflowClient()
client.list()
まだワークフローをアップロードしていない場合、出力は空のリスト（[]）になります。認証エラーが表示される場合、クライアントが有効な認証情報を見つけられなかったことを意味します。認証するセクションで保存したアカウントを確認してください。
次のステップ
- 最初のマネージド・ワークフローをデプロイすると、ワークフローをアップロードして実行し、その結果を取得できます。
- 動作するコードから始めるには、Qiskit Functionテンプレートのいずれかをデプロイするか、基本テンプレートを自分のワークフローに合わせて調整してください。