Skip to main content
IBM Quantum Platform

RuntimeJobV2

class RuntimeJobV2(backend, api_client, job_id, program_id, service, creation_date=None, result_decoder=None, image='', session_id=None, tags=None, version=None, private=False)

GitHub

ベース： BasePrimitiveJob[ PrimitiveResultLiteral['initializing', 'queued', 'running', 'cancelled', 'done', 'error']、] BaseRuntimeJob

実行時の表現 V2 プリミティブの実行。

パラメーター

  • backend (Backend) – このジョブの実行に使用されるバックエンドインスタンス。
  • api_client (RuntimeClient) – サーバーに接続するためのオブジェクト。
  • job_id (str) – 求人ID
  • program_id (str) – この仕事が対象としているプログラムのID
  • creation_date (str | None) – 雇用創出日（UTC）。
  • ResultDecoderresult_decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – ジョブの結果をデコードするために使用されるサブクラス、またはそのようなサブクラスのリスト。 複数のデコーダが指定された場合、それらはチェーン状に呼び出され、各デコーダ n-th の出力が次の n+1-th デコーダの入力となります。 指定がない場合は、デフォルト ResultDecoder 値が使用されます。
  • image (str | None) – このジョブに使用されたランタイムイメージ：image_name:tag。
  • service (qiskit_runtime_service.QiskitRuntimeService) – ランタイムサービス。
  • session_id (str | None) – ランタイムセッションの最初のジョブのジョブID。
  • tags (list | None) – ジョブに割り当てられたタグ。
  • version (int | None) – 原始的なバージョン。
  • private (bool | None) – プライベートの仕事をマークする。

プリミティブジョブを初期化します。

パラメーター

  • job_id (str) – ジョブの実行に使用されたプリミティブのコンテキストにおける一意のID。
  • kwargs – このジョブに関連付けるキーと値のメタデータ。
  • backend (Backend)
  • api_client (RuntimeClient)
  • program_id (str)
  • service (qiskit_runtime_service.QiskitRuntimeService)
  • creation_date (str | None)
  • result_decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None)
  • image (str | None)
  • session_id (str | None)
  • tags (list | None)
  • version (int | None)
  • private (bool | None)

属性

エラー

タイプ: str | RuntimeJobStatus

デフォルト値: 'ERROR'

JOB_FINAL_STATES

タイプ: tuple[JobStatus, ...]

デフォルト値: ('DONE', 'CANCELLED', 'ERROR')

creation_date

現地時間での雇用創出日。

戻り値

ジョブ作成日をdatetimeオブジェクトとして、ローカル時間で指定します。作成日が利用できない場合は、 None 。

image

ジョブに使用されたランタイムイメージを返す。

戻り値

実行時イメージ image_name:tag 、またはデフォルトのイメージ "" が使用される場合。

inputs

ジョブ入力パラメータ。

戻り値

このジョブで使用される入力パラメータ。

instance

IBM Cloud インスタンス CRN を返す。

primitive_id

プリミティブ名。

戻り値

この仕事は実に原始的だ。

private

ジョブがプライベートであるかどうかを示すブール値を返します。

session_id

セッション ID。

戻り値

セッション ID。 バックエンドがシミュレータの場合はなし。

tags

仕事のタグ

戻り値

フィルタリングに使用できるジョブに割り当てられたタグ。

usage_estimation

このジョブの使用見積もり情報を返します。

戻り値

quantum_seconds これはジョブの推定システム実行時間（秒）である。 クオンタムタイムは、システムがジョブの処理に専念している時間を表します。

方法

backend

backend(timeout=None)

GitHub

このジョブが実行されたバックエンドを返します。 バックエンドがNoneの場合、データを再取得する。

レイズ

IBMRuntimeError - ネットワークエラーが発生した場合。

パラメーター

timeout (float | None)

戻りの型

バックエンド | なし

cancel

cancel()

GitHub

ジョブを取り消します。

レイズ

  • RuntimeInvalidStateError - ジョブがキャンセルできない状態にある場合。
  • IBMRuntimeError - ジョブをキャンセルできない場合。

戻りの型

なし

cancelled

cancelled()

GitHub

ジョブがキャンセルされたかどうかを返す。

戻りの型

ブール値

done

done()

GitHub

ジョブが正常に実行されたかどうかを返す。

戻りの型

ブール値

error_message

error_message()

GitHub

ジョブが失敗した場合にその理由を返します。

戻り値

エラーメッセージ文字列または None.

戻りの型

str｜なし

errored

errored()

GitHub

ジョブが失敗したかどうかを返す。

戻りの型

ブール値

in_final_state

in_final_state()

GitHub

ジョブが DONE や ERROR のような最終ジョブ状態にあるかどうかを返す。

戻りの型

ブール値

job_id

job_id()

ジョブを識別する一意の ID を返します。

戻りの型

str

logs

logs()

GitHub

仕事のログを返す。

注

ジョブ・ログは、ジョブが終了した後にのみ見ることができます。

戻り値

標準出力とエラーを含むジョブログ。

レイズ

IBMRuntimeError - ネットワークエラーが発生した場合。

戻りの型

str

metrics

metrics()

GitHub

仕事の指標を返す。

戻り値

  • timestamps:ジョブの作成、実行開始、終了のタイムスタンプ。

  • usage:ジョブの使用に関する詳細、ジョブの使用量の測定

    QPUがワークロードのためにロックされている時間。

戻りの型

以下を含む（ただし必ずしもこれらに限定されない）職務指標を記載した辞書

レイズ

IBMRuntimeError - ネットワークエラーが発生した場合。

properties

properties(refresh=False)

GitHub

このジョブのバックエンドのプロパティを返します。

パラメーター

refresh (bool) – True の場合、バックエンドのプロパティをサーバーに再照会する。 そうでない場合は、キャッシュされたバージョンを返す。

戻り値

ジョブが実行を開始した時点で、このジョブで使用されているバックエンドのプロパティ。プロパティが利用できない場合は、 None 。

戻りの型

BackendProperties | なし

result

result(timeout=None, decoder=None, poll_interval=None)

GitHub

ジョブの結果を返す。

パラメーター

  • timeout (float | None) – ジョブの待機秒数。

  • ResultDecoderdecoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – ジョブの結果をデコードするために使用されるサブクラス、またはそのようなサブクラスのリスト。 複数のデコーダが指定された場合、それらはチェーン状に呼び出され、各デコーダ n-th の出力が次の n+1-th デコーダの入力となります。

  • poll_interval (float | None) –

    ジョブのステータスを連続して照会する際の、各照会間の待機時間（秒単位）。 その仕事について。

    • 100msセッション外ジョブの場合、デフォルト値は 500ms、下限値は です。
    • 100msセッションジョブの場合、デフォルト値および下限値は. です。

戻り値

ランタイムジョブの結果（必要に応じて後処理済み）。

レイズ

  • RuntimeJobFailureError - ジョブが失敗した場合
  • RuntimeJobMaxTimeoutError - 指定されたタイムアウト時間内にジョブが完了しなかった場合。
  • RuntimeInvalidStateError - ジョブがキャンセルされ、結果を取得しようとしている場合。

戻りの型

任意

running

running()

GitHub

ジョブがアクティブに実行されているかどうかを返す。

戻りの型

ブール値

status

status()

GitHub

ジョブのステータスを返す。

戻り値

この仕事の状況

戻りの型

リテラル[ 'INITIALIZING'、'QUEUED'、'RUNNING'、'CANCELLED'、'DONE'、'ERROR']

update_tags

update_tags(new_tags)

GitHub

このジョブに関連付けられているタグを更新する。

パラメーター

new_tags (list[str]) – ジョブに割り当てる新しいタグ。

戻り値

このジョブに関連付けられている新しいタグ。

レイズ

IBMApiError - サーバーとの通信時やジョブタグの更新時に予期せぬエラーが発生した場合。

戻りの型

[リスト文字列]

usage

usage(partial=False)

GitHub

ジョブの使用量を秒単位で返します。

デフォルトでは、使用量の計算が完了するまでは、ジョブの使用量は として 0 返されます。 このメソッドでは、フラグ partial を使用することで、中間使用量の累計値を返すことができます。

注

partialを使用する際は、ジョブが完了した直後に最終的な使用状況が返されるとは限らない点に注意してください。 返される使用状況が最終的なものであることを保証するには、このメソッドを とともに partial=False 呼び出すか、完了ステータスの詳細を確認するには メソッド metrics() を使用することをお勧めします。

パラメーター

partial (bool) – if Trueの場合、最終的な使用量に達するまでの、その時点までの累積中間使用量を返す。

戻りの型

浮動小数点

wait_for_final_state

wait_for_final_state(timeout=None, poll_interval=None)

GitHub

ステータスが最終状態になるまで、APIからジョブステータスをポーリングする。

パラメーター

  • timeout (float | None) – 仕事を待つ数秒。 None の場合、無期限に待つ。

  • poll_interval (float | None) –

    ジョブのステータスをサービスに問い合わせる間隔（秒単位）。

    • 100msセッション外ジョブの場合、デフォルト値は 500ms、下限値は です。
    • 100msセッションジョブの場合、デフォルト値および下限値は. です。

レイズ

RuntimeJobTimeoutError - 指定されたタイムアウト時間内にジョブが完了しなかった場合。

戻りの型

なし

このページは役に立ちましたか？
バグや誤字の報告、またはコンテンツの要求はGitHubで行ってください。