Session Classe

  • Referência

Sessão de Trabalho do Azure Quantum: um agrupamento lógico de trabalhos.

Herança
azure.quantum.job.workspace_item.WorkspaceItem
Session

Construtor

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)

Parâmetros

Nome Description
workspace
Obrigatório
Workspace

Instância do workspace para abrir a sessão em
details
Optional[SessionDetails]

Modelo de detalhes da sessão, que contém a ID da sessão, o nome, o job_failure_policy, o provider_id e o destino. Esse parâmetro deve ser passado contendo todos os valores de detalhes da sessão ou os mesmos valores devem ser passados como parâmetros individuais.

Valor padrão: None
target
Union[str, Target, None]

O nome do destino (ou objeto Target) no qual abrir a sessão.

Valor padrão: None
provider_id
Optional[str]

A ID do provedor no qual abrir a sessão. Se não for passado, ele será extraído do nome de destino.

Valor padrão: None
id
Optional[str]

A ID da sessão. Se não for passado, um uuid aleatório será usado.

Valor padrão: None
name
Optional[str]

O nome da sessão. Se não for aprovado, o nome será session-{session-id}.

Valor padrão: None
job_failure_policy
Union[str, SessionJobFailurePolicy, None]

A política que determina quando uma sessão falhará, fechará e não aceitará mais trabalhos.

Valor padrão: None

Métodos

close

Fecha uma sessão, não permitindo que mais trabalhos sejam enviados na sessão.
is_in_terminal_state

Retorna True se a sessão estiver em um dos estados de terminal possíveis (Êxito, Com falha e Timed_Out).
list_jobs

Lista todos os trabalhos associados a esta sessão.
open

Abre uma sessão, criando efetivamente uma nova sessão no serviço do Azure Quantum e permitindo que ela aceite trabalhos sob ela.
refresh

Busca os detalhes mais recentes da sessão do serviço do Azure Quantum.

close

Fecha uma sessão, não permitindo que mais trabalhos sejam enviados na sessão.

close() -> Session

Retornos

Tipo Description
Session

O objeto de sessão com detalhes atualizados após o fechamento.

is_in_terminal_state

Retorna True se a sessão estiver em um dos estados de terminal possíveis (Êxito, Com falha e Timed_Out).

is_in_terminal_state() -> bool

Retornos

Tipo Description
bool

True se a sessão estiver em um dos estados do terminal.

list_jobs

Lista todos os trabalhos associados a esta sessão.

list_jobs() -> List[Job]

Retornos

Tipo Description
List[Job]

Uma lista de todos os trabalhos associados a esta sessão.

open

Abre uma sessão, criando efetivamente uma nova sessão no serviço do Azure Quantum e permitindo que ela aceite trabalhos sob ela.

open() -> Session

Retornos

Tipo Description
Session

O objeto de sessão com detalhes atualizados após sua abertura.

refresh

Busca os detalhes mais recentes da sessão do serviço do Azure Quantum.

refresh() -> Session

Retornos

Tipo Description
Session

O objeto de sessão com detalhes atualizados.

Atributos

details

Obtenha os detalhes da sessão.

Retornos

Tipo Description
SessionDetails

Os detalhes sobre a sessão.

target

Obtenha o destino associado à sessão.

Retornos

Tipo Description
Target

O destino associado à sessão.