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] 要打开会话的目标（或 Target 对象）的名称。默认值: None
provider_id	Optional[str] 要打开会话的提供程序的 ID。如果未传递，将从目标名称中提取它。默认值: None
id	Optional[str] 会话的 ID。如果未传递，将使用一个随机 uuid。默认值: 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	如此如果会话处于某个终端状态。

list_jobs

列出与此会话关联的所有作业。

list_jobs() -> List[Job]

类型	说明
List[Job]	与此会话关联的所有作业的列表。

open

打开会话，有效地在 Azure Quantum 服务中创建新会话，并允许它接受其下的作业。

open() -> Session

类型	说明
Session	打开会话对象后具有更新的详细信息。

refresh

从 Azure Quantum 服务中提取最新的会话详细信息。

refresh() -> Session

类型	说明
Session	具有更新详细信息的会话对象。

属性

details

获取会话详细信息。

类型	说明
SessionDetails	有关会话的详细信息。

target

获取与会话关联的目标。

类型	说明
Target	与会话关联的目标。

通过