Поделиться через

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

Модель сведений о сеансе, содержащая идентификатор сеанса, имя, job_failure_policy, provider_id и целевой объект. Этот параметр должен быть передан, содержащий все значения сведений о сеансе, или те же значения должны передаваться в качестве отдельных параметров.

target
Union[str, Target, None]
значение по умолчанию: None

Имя целевого объекта (или целевого объекта), на который открывается сеанс.

provider_id
Optional[str]
значение по умолчанию: None

Идентификатор поставщика для открытия сеанса. Если он не передан, он будет извлечен из целевого имени.

id
Optional[str]
значение по умолчанию: None

Идентификатор сеанса. Если значение не передано, будет использоваться один случайный uuid.

name
Optional[str]
значение по умолчанию: None

Имя сеанса. Если этот параметр не передан, имя будет session-{session-id}.

job_failure_policy
Union[str, SessionJobFailurePolicy, None]
значение по умолчанию: 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

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

Значение true, если сеанс находится в одном из состояний терминала.

Возвращаемый тип

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