Session Klasse

Azure Quantum Job Session: eine logische Gruppierung von Aufträgen.

Vererbung

azure.quantum.job.workspace_item.WorkspaceItem

Session

Konstruktor

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)

Parameter

workspace

Workspace

Erforderlich

Arbeitsbereich instance zum Öffnen der Sitzung

details

Optional[SessionDetails]

Standardwert: None

Sitzungsdetailsmodell mit sitzungs-ID, Name, job_failure_policy, provider_id und Ziel. Entweder sollte dieser Parameter übergeben werden, der alle Sitzungsdetailwerte enthält, oder die gleichen Werte sollten als einzelne Parameter übergeben werden.

target

Union[str, Target, None]

Standardwert: None

Der Name des Ziels (oder Zielobjekts), für das die Sitzung geöffnet werden soll.

provider_id

Optional[str]

Standardwert: None

Die ID des Anbieters, für den die Sitzung geöffnet werden soll. Wenn sie nicht übergeben wird, wird sie aus dem Zielnamen extrahiert.

id

Optional[str]

Standardwert: None

Die ID der Sitzung. Wenn sie nicht übergeben wird, wird eine zufällige uuid verwendet.

name

Optional[str]

Standardwert: None

Der Name der Sitzung. Wenn sie nicht übergeben wird, lautet der Name session-{session-id}.

job_failure_policy

Union[str, SessionJobFailurePolicy, None]

Standardwert: None

Die Richtlinie, die bestimmt, wann eine Sitzung fehlschlägt, geschlossen und keine weiteren Aufträge akzeptiert.

Methoden

close	Schließt eine Sitzung, sodass keine weiteren Aufträge unter der Sitzung übermittelt werden können.
is_in_terminal_state	Gibt True zurück, wenn sich die Sitzung in einem der möglichen Terminalzustände befindet (Erfolgreich, Fehler und Timed_Out).
list_jobs	Listen alle Aufträge, die dieser Sitzung zugeordnet sind.
open	Öffnet eine Sitzung, erstellt effektiv eine neue Sitzung im Azure Quantum-Dienst, und ermöglicht es diesem, aufträge darin anzunehmen.
refresh	Ruft die neuesten Sitzungsdetails aus dem Azure Quantum-Dienst ab.

close

Schließt eine Sitzung, sodass keine weiteren Aufträge unter der Sitzung übermittelt werden können.

close() -> Session

Gibt zurück

Das Sitzungsobjekt mit aktualisierten Details nach dem Schließen.

Rückgabetyp

Session

is_in_terminal_state

Gibt True zurück, wenn sich die Sitzung in einem der möglichen Terminalzustände befindet (Erfolgreich, Fehler und Timed_Out).

is_in_terminal_state() -> bool

Gibt zurück

True, wenn sich die Sitzung in einem der Terminalzustände befindet.

Rückgabetyp

bool

list_jobs

Listen alle Aufträge, die dieser Sitzung zugeordnet sind.

list_jobs() -> List[Job]

Gibt zurück

Eine Liste aller Aufträge, die dieser Sitzung zugeordnet sind.

Rückgabetyp

List[Job]

open

Öffnet eine Sitzung, erstellt effektiv eine neue Sitzung im Azure Quantum-Dienst, und ermöglicht es diesem, aufträge darin anzunehmen.

open() -> Session

Gibt zurück

Das Sitzungsobjekt mit aktualisierten Details nach dem Öffnen.

Rückgabetyp

Session

refresh

Ruft die neuesten Sitzungsdetails aus dem Azure Quantum-Dienst ab.

refresh() -> Session

Gibt zurück

Das Sitzungsobjekt mit aktualisierten Details.

Rückgabetyp

Session

Attribute

details

Rufen Sie die Sitzungsdetails ab.

Gibt zurück

Die Details zur Sitzung.

Rückgabetyp

SessionDetails

target

Rufen Sie das ziel ab, das der Sitzung zugeordnet ist.

Gibt zurück

Das der Sitzung zugeordnete Ziel.

Rückgabetyp

Target