Session クラス

Azure Quantum ジョブ セッション: ジョブの論理グループ。

継承

azure.quantum.job.workspace_item.WorkspaceItem

Session

コンストラクター

Session(workspace: Workspace, details: SessionDetails | None = None, target: str | Target | None = None, provider_id: str | None = None, id: str | None = None, name: str | None = None, job_failure_policy: str | SessionJobFailurePolicy | None = None, **kwargs)

パラメーター

workspace

Workspace

必須

セッションを開くワークスペース インスタンス

details

Optional[SessionDetails]

既定値: None

セッション ID、名前、job_failure_policy、provider_id、ターゲットを含むセッション詳細モデル。 すべてのセッション詳細値を含むこのパラメーターを渡すか、同じ値を個々のパラメーターとして渡す必要があります。

target

Union[str, Target, None]

既定値: None

セッションを開くターゲット (または Target オブジェクト) の名前。

provider_id

Optional[str]

既定値: None

セッションを開くプロバイダーの ID。 渡されない場合は、ターゲット名から抽出されます。

id

Optional[str]

既定値: None

セッションの ID。 渡されない場合は、ランダムな uuid が 1 つ使用されます。

name

Optional[str]

既定値: None

セッションの名前。 渡されない場合、名前は session-{session-id} になります。

job_failure_policy

Union[str, SessionJobFailurePolicy, None]

既定値: None

セッションが失敗するタイミングを決定するポリシー。閉じて、それ以上のジョブを受け入れません。

メソッド

close	セッションを閉じ、セッションの下でそれ以上のジョブを送信することはできません。
is_in_terminal_state	セッションが可能なターミナル状態 (Succeeded、Failed、Timed_Out) の 1 つにある場合は True を返します。
list_jobs	このセッションに関連付けられているすべてのジョブをListsします。
open	セッションを開き、Azure Quantum サービスで新しいセッションを効果的に作成し、その下のジョブを受け入れることができるようにします。
refresh	Azure Quantum サービスから最新のセッションの詳細をフェッチします。

close

セッションを閉じ、セッションの下でそれ以上のジョブを送信することはできません。

close() -> Session

戻り値

閉じた後に更新された詳細を含むセッション オブジェクト。

の戻り値の型 :

Session

is_in_terminal_state

セッションが可能なターミナル状態 (Succeeded、Failed、Timed_Out) の 1 つにある場合は True を返します。

is_in_terminal_state() -> bool

戻り値

True を指定すると、セッションがいずれかのターミナル状態になります。

の戻り値の型 :

bool

list_jobs

このセッションに関連付けられているすべてのジョブをListsします。

list_jobs() -> List[Job]

戻り値

このセッションに関連付けられているすべてのジョブの一覧。

の戻り値の型 :

List[Job]

open

セッションを開き、Azure Quantum サービスで新しいセッションを効果的に作成し、その下のジョブを受け入れることができるようにします。

open() -> Session

戻り値

開いた後に更新された詳細を含むセッション オブジェクト。

の戻り値の型 :

Session

refresh

Azure Quantum サービスから最新のセッションの詳細をフェッチします。

refresh() -> Session

戻り値

更新された詳細を含むセッション オブジェクト。

の戻り値の型 :

Session

属性

details

セッションの詳細を取得します。

戻り値

セッションに関する詳細。

の戻り値の型 :

SessionDetails

target

セッションに関連付けられているターゲットを取得します。

戻り値

セッションに関連付けられているターゲット。

の戻り値の型 :

Target