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] セッション ID、名前、job_failure_policy、provider_id、ターゲットを含むセッション詳細モデル。すべてのセッション詳細値を含むこのパラメーターを渡すか、同じ値を個々のパラメーターとして渡す必要があります。規定値: None
target	Union[str, Target, None] セッションを開くターゲット (またはターゲットオブジェクト) の名前。規定値: None
provider_id	Optional[str] セッションを開くプロバイダーの ID。渡されない場合は、ターゲット名から抽出されます。規定値: None
id	Optional[str] セッションの ID。渡されない場合は、ランダムな uuid が 1 つ使用されます。規定値: None
name	Optional[str] セッションの名前。渡されない場合、名前は session-{session-id}されます。規定値: None
job_failure_policy	Union[str, SessionJobFailurePolicy, None] セッションが失敗し、閉じられ、それ以上のジョブを受け入れないことを決定するポリシー。規定値: None

メソッド

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

close

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

close() -> Session

戻り値

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

is_in_terminal_state

セッションがいずれかのターミナル状態 (Succeeded、Failed、Timed_Out) の場合は True を返します。

is_in_terminal_state() -> bool

戻り値

型	説明
bool	セッションがいずれかの終了状態にある場合は True。

list_jobs

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

list_jobs() -> List[Job]

戻り値

型	説明
List[Job]	このセッションに関連付けられているすべてのジョブの一覧。

open

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

open() -> Session

戻り値

型	説明
Session	開いた後に更新された詳細を持つセッションオブジェクト。

refresh

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

refresh() -> Session

戻り値

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

属性

details

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

戻り値

型	説明
SessionDetails	セッションに関する詳細。

target

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

戻り値

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

次の方法で共有