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)

參數

名稱	Description
workspace 必要	Workspace 開啟工作工作區實例
details	Optional[SessionDetails] 會話詳細數據模型，包含會話標識碼、名稱、job_failure_policy、provider_id和目標。這個參數應該傳遞包含所有會話詳細數據值，或者應該以個別參數的形式傳遞相同的值。預設值: None
target	Union[str, Target, None] 要開啟會話的目標名稱（或 Target 物件）。預設值: None
provider_id	Optional[str] 要開啟會話之提供者的標識碼。如果未傳遞，則會從目標名稱擷取它。預設值: None
id	Optional[str] 會話的標識碼。如果未傳遞，則會使用一個隨機 uuid。預設值: None
name	Optional[str] 工作階段的名稱。如果未傳遞，名稱將會 session-{session-id}。預設值: None
job_failure_policy	Union[str, SessionJobFailurePolicy, None] 決定會話何時會失敗、關閉且不接受進一步作業的原則。預設值: None

方法

close	關閉工作階段，不允許在工作階段下提交進一步的工作。
is_in_terminal_state	如果會話處於其中一個可能的終端狀態，則傳回 True（Succeeded、Failed 和 Timed_Out）。
list_jobs	列出與此會話相關聯的所有作業。
open	開啟會話，有效地在 Azure Quantum 服務中建立新的工作階段，並允許它接受其下的工作。
refresh	從 Azure Quantum 服務擷取最新的會話詳細數據。

close

關閉工作階段，不允許在工作階段下提交進一步的工作。

close() -> Session

傳回

類型	Description
Session	會話物件，其關閉之後會更新詳細數據。

is_in_terminal_state

如果會話處於其中一個可能的終端狀態，則傳回 True（Succeeded、Failed 和 Timed_Out）。

is_in_terminal_state() -> bool

傳回

類型	Description
bool	如果會話處於其中一個終端狀態，則為 True。

list_jobs

列出與此會話相關聯的所有作業。

list_jobs() -> List[Job]

傳回

類型	Description
List[Job]	與此工作階段相關聯的所有作業清單。

open

開啟會話，有效地在 Azure Quantum 服務中建立新的工作階段，並允許它接受其下的工作。

open() -> Session

傳回

類型	Description
Session	會話物件，其開啟後會更新詳細數據。

refresh

從 Azure Quantum 服務擷取最新的會話詳細數據。

refresh() -> Session

傳回

類型	Description
Session	具有更新詳細數據的會話物件。

屬性

details

取得工作階段詳細數據。

傳回

類型	Description
SessionDetails	會話的詳細數據。

target

取得與會話相關聯的目標。

傳回

類型	Description
Target	與會話相關聯的目標。

共用方式為