Share via

Session Kelas

  • Referensi

Sesi Pekerjaan Azure Quantum: pengelompokan pekerjaan yang logis.

Warisan
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
Diperlukan

Instans ruang kerja untuk membuka sesi pada

details
Optional[SessionDetails]
nilai default: None

Model detail sesi, berisi id sesi, nama, job_failure_policy, provider_id dan target. Parameter ini harus diteruskan yang berisi semua nilai detail sesi, atau nilai yang sama harus diteruskan sebagai parameter individual.

target
Union[str, Target, None]
nilai default: None

Nama target (atau objek Target) untuk membuka sesi.

provider_id
Optional[str]
nilai default: None

Id penyedia untuk membuka sesi. Jika tidak diteruskan, itu akan diekstraksi dari nama target.

id
Optional[str]
nilai default: None

Id sesi. Jika tidak diteruskan, satu uuid acak akan digunakan.

name
Optional[str]
nilai default: None

Nama sesi. Jika tidak diteruskan, nama akan menjadi session-{session-id}.

job_failure_policy
Union[str, SessionJobFailurePolicy, None]
nilai default: None

Kebijakan yang menentukan kapan sesi akan gagal, menutup, dan tidak menerima pekerjaan lebih lanjut.

Metode

close

Menutup sesi, tidak mengizinkan pekerjaan lebih lanjut dikirimkan di bawah sesi.
is_in_terminal_state

Mengembalikan True jika sesi berada di salah satu status terminal yang mungkin (Berhasil, Gagal, dan Timed_Out).
list_jobs

Lists semua pekerjaan yang terkait dengan sesi ini.
open

Membuka sesi, secara efektif membuat sesi baru di layanan Azure Quantum, dan memungkinkannya untuk menerima pekerjaan di bawahnya.
refresh

Mengambil detail sesi terbaru dari layanan Azure Quantum.

close

Menutup sesi, tidak mengizinkan pekerjaan lebih lanjut dikirimkan di bawah sesi.

close() -> Session

Mengembalikan

Objek sesi dengan detail yang diperbarui setelah ditutup.

Tipe hasil

Session

is_in_terminal_state

Mengembalikan True jika sesi berada di salah satu status terminal yang mungkin (Berhasil, Gagal, dan Timed_Out).

is_in_terminal_state() -> bool

Mengembalikan

True jika sesi berada di salah satu status terminal.

Tipe hasil

bool

list_jobs

Lists semua pekerjaan yang terkait dengan sesi ini.

list_jobs() -> List[Job]

Mengembalikan

Daftar semua pekerjaan yang terkait dengan sesi ini.

Tipe hasil

List[Job]

open

Membuka sesi, secara efektif membuat sesi baru di layanan Azure Quantum, dan memungkinkannya untuk menerima pekerjaan di bawahnya.

open() -> Session

Mengembalikan

Objek sesi dengan detail yang diperbarui setelah dibuka.

Tipe hasil

Session

refresh

Mengambil detail sesi terbaru dari layanan Azure Quantum.

refresh() -> Session

Mengembalikan

Objek sesi dengan detail yang diperbarui.

Tipe hasil

Session

Atribut

details

Dapatkan detail sesi.

Mengembalikan

Detail tentang sesi.

Tipe hasil

SessionDetails

target

Dapatkan target yang terkait dengan sesi.

Mengembalikan

Target yang terkait dengan sesi.

Tipe hasil

Target