ログイン認証情報を保存する
信頼できるPython環境(個人用ノートパソコンやワークステーションなど)で作業している場合は、save_account() メソッドを使用して認証情報をローカルに保存し、それを使用してサービスを初期化することができます。
- 公共のコンピューターやその他の信頼できない環境を使用している場合は、代わりに信頼できない環境でのサービスの初期化の手順に従ってください。
- QiskitではなくREST APIを使用して接続する場合は、こちらの手順に従ってください。
- 必要に応じて、この情報を参照してファイアウォールを設定し、IBM Quantum APIエンドポイントへのアクセスを有効にしてください。
始める前に
-
qiskitおよびqiskit-ibm-runtimeパッケージがインストールされたアクティブなPython環境で作業していることを確認してください。 -
Python仮想環境をアクティブにして、仮想環境内でPythonを実行してください。
-
IBM Quantum Platformにログインしてください。
アクセス認証情報を確認する
-
ヘッダーのアカウント切り替えで、正しいアカウントとリージョンが選択されていることを確認してください。
-
APIキーを確認してください。ダッシュボードでAPIキーを作成し、認証に使用できるよう安全な場所にコピーしてください。なお、同じAPIキーを使用してどのリージョンにも接続できます。
-
任意:使用するインスタンスをインスタンスページから確認してください。そのCRNにカーソルを合わせ、コピーアイコンをクリックして、インスタンスを識別するために使用できるよう安全な場所に保存してください。
アクセス認証情報を保存する
保存したいアカウントごとに1回、適切なコードを実行して認証情報を保存してください。認証情報を保存した後は、IBM Quantum Compute Serviceの初期化の手順に従って認証情報を読み込んでください。
特定のインスタンスにアクセスする認証情報を保存する:
複数のインスタンスがあり、Quantum Computeに使用するインスタンスを簡単に指定したい場合は、インスタンスCRNを含む認証情報を保存してください。
from qiskit_ibm_runtime import QiskitRuntimeService
QiskitRuntimeService.save_account(
# For `token`, use the 44-character API_KEY you created
# and saved from the IBM Quantum Platform Home dashboard:
token="<your-api-key>",
name="<account-name>", # Optional
instance="<IBM Cloud CRN or instance name>", # Optional
set_as_default=True, # Optional
overwrite=True, # Optional
)
自動インスタンス選択のための認証情報を保存する:
インスタンスCRNを指定せずにこれらの認証情報をQuantum Computeに渡すと、指定されたオプションに基づいて適切なインスタンスが自動的に選択されます。
from qiskit_ibm_runtime import QiskitRuntimeService
QiskitRuntimeService.save_account(
# For `token`, use the 44-character API_KEY you created
# and saved from the IBM Quantum Platform Home dashboard:
token="<your=api-key>",
name="<account-name>", # Optional
instance="<instance-to-use>", # Optional
plans_preference="<plan_types>", # Optional
region="<region>", # Optional
tags="<instance-tags>", # Optional
set_as_default=True, # Optional
overwrite=True, # Optional
)
Available options
token: IBM Cloud API key. Your token is confidential. Do not share your token in public code.instance: Optionally specify the instance to use through its IBM Cloud CRN or instance name.plans_preference: Optionally set the types of plans to prioritize. This is ignored if the instance is specified. Available options areopen,pay-as-you-go,flex,premium, andon-prem. Instances of a certain plan type are excluded if the plan name is not specified. For example, if [open] is passed in, only Open Plan instances are available. This is ignored ifinstanceis specified.region: Optionally set the region to use. Accepted values areus-eastandeu-de. This is ignored ifinstanceis specified.tags: Optionally specify the instance's tags. Accepts a list of tag name strings. This is ignored ifinstanceis specified.name: Optionally name this set of account credentials.set_as_default: Set the value toTrueto save these as your default credentials. If you save only one account, it is automatically set as the default.overwrite: Set this value toTrueto update your default credentials.
Examples
Example 1
This example saves credentials for specific instances, which allow open and premium access. The open credentials are set as the default.
from qiskit_ibm_runtime import QiskitRuntimeService
QiskitRuntimeService.save_account(token="<API_TOKEN>",
instance="<CRN_for_premium_instance>",
name="premium")
QiskitRuntimeService.save_account(token="<API_TOKEN>",
instance="<CRN_for_open_instance>",
name="open", set_as_default=True)
例2
この例では、自動インスタンス選択のための認証情報を保存します。Quantum Computeは、アカウントで利用可能なEUリージョンのプレミアムインスタンスのみを検索します。この認証情報が新しいデフォルトになります。
QiskitRuntimeService.save_account(
token="your-api-key",
set_as_default=True,
overwrite = True,
# Set instance "filters" instead of specifying the instance:
region="eu-de",
plans_preference=["premium"]
)
保存された認証情報を確認する
保存したすべての認証情報を表示するには、service.saved_accounts() を実行してください。デフォルトの認証情報を保存して名前を付けなかった場合は、default-ibm-quantum-platform という名前が付きます。デフォルトの認証情報に名前を付けた場合は、出力に "is_default_account": true が表示されます。
注意事項
-
複数のアカウントを保存する場合は、
nameパラメーターを使用して区別してください。 -
認証情報は
$HOME/.qiskit/qiskit-ibm.jsonに保存されます。このファイルを手動で編集しないでください。 -
認証情報を保存しない場合は、新しいセッションを開始するたびに(IBM Quantum Compute Serviceをインスタンス化するたびに)認証情報を指定する必要があります。
-
認証情報を手動で指定した場合、保存されたアカウントは使用されません。
次のステップ
- 信頼できるPython環境でIBM Quantum Compute Serviceを初期化する。
- 信頼できない環境でIBM Quantum Compute Serviceを初期化する。
- 利用可能なQPUを確認する。
- Qiskit SDKをローカルで設定する。
- ハードウェアで最初の回路を実行するガイドの手順に従って、量子プログラムを作成して実行する。
- REST APIでIBM Quantum Platformを使用するためのセットアップ。
- チュートリアルを試してみる。