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

Name	Beschreibung
workspace Erforderlich	Workspace Arbeitsbereichsinstanz zum Öffnen der Sitzung auf
details	Optional[SessionDetails] 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. Standardwert: None
target	Union[str, Target, None] Der Name des Zielobjekts (oder Zielobjekts), an dem die Sitzung geöffnet werden soll. Standardwert: None
provider_id	Optional[str] Die ID des Anbieters, um die Sitzung zu öffnen. Wenn sie nicht übergeben wird, wird sie aus dem Zielnamen extrahiert. Standardwert: None
id	Optional[str] Die ID der Sitzung. Wenn sie nicht übergeben wird, wird eine zufällige uuid verwendet. Standardwert: None
name	Optional[str] Der Name der Sitzung. Wenn er nicht übergeben wird, wird der Name session-{session-id}. Standardwert: None
job_failure_policy	Union[str, SessionJobFailurePolicy, None] Die Richtlinie, die bestimmt, wann eine Sitzung fehlschlägt, geschlossen und keine weiteren Aufträge akzeptiert. Standardwert: None

Methoden

close	Schließt eine Sitzung, sodass keine weiteren Aufträge im Rahmen 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, fehlgeschlagen und Timed_Out).
list_jobs	Listet alle Aufträge auf, die dieser Sitzung zugeordnet sind.
open	Öffnet eine Sitzung, erstellt effektiv eine neue Sitzung im Azure Quantum-Dienst und ermöglicht es, Aufträge zu akzeptieren.
refresh	Ruft die neuesten Sitzungsdetails vom Azure Quantum-Dienst ab.

close

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

close() -> Session

Gibt zurück

Typ	Beschreibung
Session	Das Sitzungsobjekt mit aktualisierten Details nach dem Schließen.

is_in_terminal_state

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

is_in_terminal_state() -> bool

Gibt zurück

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

list_jobs

Listet alle Aufträge auf, die dieser Sitzung zugeordnet sind.

list_jobs() -> List[Job]

Gibt zurück

Typ	Beschreibung
List[Job]	Eine Liste aller Aufträge, die dieser Sitzung zugeordnet sind.

open

Öffnet eine Sitzung, erstellt effektiv eine neue Sitzung im Azure Quantum-Dienst und ermöglicht es, Aufträge zu akzeptieren.

open() -> Session

Gibt zurück

Typ	Beschreibung
Session	Das Sitzungsobjekt mit aktualisierten Details nach dem Öffnen.

refresh

Ruft die neuesten Sitzungsdetails vom Azure Quantum-Dienst ab.

refresh() -> Session

Gibt zurück

Typ	Beschreibung
Session	Das Sitzungsobjekt mit aktualisierten Details.

Attribute

details

Rufen Sie die Sitzungsdetails ab.

Gibt zurück

Typ	Beschreibung
SessionDetails	Die Details zur Sitzung.

target

Ruft das ziel ab, das der Sitzung zugeordnet ist.

Gibt zurück

Typ	Beschreibung
Target	Das ziel, das der Sitzung zugeordnet ist.