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] Модель сведений о сеансе, содержащая идентификатор сеанса, имя, job_failure_policy, provider_id и целевой объект. Этот параметр должен быть передан со всеми значениями сведений о сеансе, или те же значения должны передаваться в качестве отдельных параметров. Default value: None
target	Union[str, Target, None] Имя целевого объекта (или целевого объекта), для открытия сеанса. Default value: None
provider_id	Optional[str] Идентификатор поставщика для открытия сеанса. Если он не передан, он будет извлечен из целевого имени. Default value: None
id	Optional[str] Идентификатор сеанса. В противном случае будет использоваться один случайный uuid. Default value: None
name	Optional[str] Имя сеанса. Если имя не передано, имя будет сеанс-{session-id}. Default value: None
job_failure_policy	Union[str, SessionJobFailurePolicy, None] Политика, определяющая, когда сеанс завершится сбоем, закройте и не примите дальнейшие задания. Default value: None

Методы

close	Закрывает сеанс, не разрешая отправку дополнительных заданий в рамках сеанса.
is_in_terminal_state	Возвращает значение True, если сеанс находится в одном из возможных состояний терминала (успешно, сбой и Timed_Out).
list_jobs	Выводит список всех заданий, связанных с этим сеансом.
open	Открывает сеанс, эффективно создавая новый сеанс в службе Azure Quantum и позволяя ему принимать задания в нем.
refresh	Извлекает последние сведения о сеансе из службы Azure Quantum.

close

Закрывает сеанс, не разрешая отправку дополнительных заданий в рамках сеанса.

close() -> Session

Возвращаемое значение

Тип	Описание
Session	Объект сеанса с обновленными сведениями после закрытия.

is_in_terminal_state

Возвращает значение True, если сеанс находится в одном из возможных состояний терминала (успешно, сбой и Timed_Out).

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	Целевой объект, связанный с сеансом.