RuntimeJobV2

class RuntimeJobV2(backend, api_client, job_id, program_id, service, creation_date=None, result_decoder=None, image='', session_id=None, tags=None, version=None, private=False)

GitHub

Basen: BasePrimitiveJob[PrimitiveResult, Literal['INITIALIZING', 'QUEUED', 'RUNNING', 'CANCELLED', 'DONE', 'ERROR']], BaseRuntimeJob

Darstellung der Ausführung einer „ IBM Quantum Compute “-Primitive (früher „ Qiskit Runtime “) V2.

Parameter

backend (Backend) – Die Backend-Instanz, auf der dieser Job ausgeführt wird.
api_client (RuntimeClient) – Objekt zur Verbindung mit dem Server.
job_id (str) – Job-ID.
program_id (str) – ID des Programms, für das diese Stelle vorgesehen ist.
creation_date (str | None) – Datum der Arbeitsplatzschaffung, in UTC.
result_decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Eine ResultDecoder Unterklasse, die zum Dekodieren von Auftragsergebnissen verwendet wird, oder eine Liste solcher Unterklassen. Wenn mehr als ein Decoder angegeben wird, werden diese nacheinander aufgerufen, wobei die Ausgabe des jeweiligen n-th Decoders als Eingabe für den n+1-th nächsten Decoder dient. Sofern nicht anders angegeben, wird der Standardwert ResultDecoder verwendet.
image (str | None) – IBM Quantum Compute Für diesen Auftrag verwendetes Bild: Bildname:Tag.
service (QiskitRuntimeService) – IBM Quantum Compute Dienstleistung.
session_id (str | None) – Auftrags-ID des ersten Auftrags in einer „ IBM Quantum Compute “-Sitzung.
tags (list | None) – Dem Auftrag zugewiesene Tags.
version (int | None) – Primitive Version.
private (bool | None) – Markiert Job als privat.

Initialisiert den einfachen Auftrag.

Parameter

job_id (str) – Eine eindeutige ID im Kontext der Primitive, mit der der Job ausgeführt wird.
kwargs – Alle Schlüssel-Wert-Metadaten, die diesem Auftrag zugeordnet werden sollen.
backend (Backend)
api_client (RuntimeClient)
program_id (str)
service (QiskitRuntimeService)
creation_date (str | None)
result_decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None)
image (str | None)
session_id (str | None)
tags (list | None)
version (int | None)
private (bool | None)

Attribute

FEHLER

Typ: str | RuntimeJobStatus

Standardwert: 'ERROR'

JOB_ENDSTÄNDE

Typ: tuple[JobStatus,...]

Standardwert: ('DONE', 'CANCELLED', 'ERROR')

creation_date

Erstellungsdatum der Stelle in Ortszeit.

Rückgabe

Das Erstellungsdatum des Auftrags als Datetime-Objekt in Ortszeit oder None , wenn das Erstellungsdatum nicht verfügbar ist.

image

Gibt das für den Auftrag verwendete „ IBM Quantum Compute “-Bild zurück.

Rückgabe

Das Bild „ IBM Quantum Compute “ "" oder image_name:tag das Standardbild.

inputs

Job-Eingabeparameter.

Rückgabe

In diesem Auftrag verwendete Eingabeparameter.

instance

Rückgabe der IBM Cloud Instanz CRN.

primitive_id

Einfacher Name.

Rückgabe

Was für eine primitive Arbeit.

private

Gibt einen booleschen Wert zurück, der angibt, ob der Auftrag privat ist oder nicht.

session_id

Die Sitzungs-ID.

Rückgabe

Die Sitzungs-ID. Keine, wenn das Backend ein Simulator ist.

usage_estimation

Gibt die Informationen zur Nutzungsabschätzung für diesen Auftrag zurück.

Rückgabe

quantum_seconds ist die geschätzte Systemausführungszeit des Auftrags in Sekunden. Die Quantenzeit stellt die Zeit dar, die das System für die Bearbeitung Ihres Auftrags aufwendet.

Methoden

backend

backend(timeout=None)

GitHub

Gibt das Backend zurück, in dem dieser Auftrag ausgeführt wurde. Erneutes Abrufen von Daten, wenn das Backend keines ist.

Erhöht

IBMRuntimeError - Wenn ein Netzwerkfehler aufgetreten ist.

Parameter

timeout (float | None)

Rückgabetyp

Backend | Keine

cancel

cancel()

GitHub

Stornieren Sie den Job.

Erhöht

RuntimeInvalidStateError - Wenn sich der Auftrag in einem Zustand befindet, der nicht abgebrochen werden kann.
IBMRuntimeError - Wenn der Auftrag nicht abgebrochen werden kann.

Rückgabetyp

Keine

cancelled

cancelled()

GitHub

Gibt zurück, ob der Auftrag abgebrochen wurde.

Rückgabetyp

Bool

done

done()

GitHub

Gibt zurück, ob der Auftrag erfolgreich ausgeführt wurde.

Rückgabetyp

Bool

error_message

error_message()

GitHub

Gibt den Grund zurück, wenn der Auftrag fehlgeschlagen ist.

Rückgabe

Fehlermeldungsstring oder None.

Rückgabetyp

str | Keine

errored

errored()

GitHub

Gibt zurück, ob der Auftrag fehlgeschlagen ist.

Rückgabetyp

Bool

in_final_state

in_final_state()

GitHub

Gibt zurück, ob sich der Auftrag in einem endgültigen Auftragsstatus wie DONE oder ERROR befindet.

Rückgabetyp

Bool

job_id

job_id()

Gibt eine eindeutige ID zurück, die den Auftrag identifiziert.

Rückgabetyp

str

logs

logs()

GitHub

Auftragsprotokolle zurücksenden.

Anmerkung

Auftragsprotokolle sind erst nach Beendigung des Auftrags verfügbar.

Rückgabe

Auftragsprotokolle, einschließlich Standardausgabe und Fehler.

Erhöht

IBMRuntimeError - Wenn ein Netzwerkfehler aufgetreten ist.

Rückgabetyp

str

metrics

metrics()

GitHub

Job-Metriken zurückgeben.

Rückgabe

timestamps: Zeitstempel, wann der Auftrag erstellt, gestartet und beendet wurde.
usage: Details zur Auftragsverwendung, die Messung des Umfangs der

zeit, in der die QPU für Ihre Arbeitslast gesperrt ist.

Rückgabetyp

Ein Wörterbuch mit Job-Metriken, einschließlich, aber nicht beschränkt auf die folgenden

Erhöht

IBMRuntimeError - Wenn ein Netzwerkfehler aufgetreten ist.

properties

properties(refresh=False)

GitHub

Gibt die Backend-Eigenschaften für diesen Auftrag zurück.

Parameter

refresh (bool) – Wenn True, fragen Sie den Server erneut nach den Backend-Eigenschaften ab. Andernfalls wird eine gecachte Version zurückgegeben.

Rückgabe

Die für diesen Auftrag verwendeten Backend-Eigenschaften zum Zeitpunkt der Auftragsausführung oder None , wenn keine Eigenschaften verfügbar sind.

Rückgabetyp

BackendProperties | Keine

result

result(timeout=None, decoder=None, poll_interval=None)

GitHub

Geben Sie die Ergebnisse des Auftrags zurück.

Parameter

timeout (float | None) – Anzahl der Sekunden, die auf den Auftrag gewartet wird.
decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Eine ResultDecoder Unterklasse, die zum Dekodieren von Auftragsergebnissen verwendet wird, oder eine Liste solcher Unterklassen. Wenn mehr als ein Decoder angegeben wird, werden diese nacheinander aufgerufen, wobei die Ausgabe des jeweiligen n-th Decoders als Eingabe für den n+1-th nächsten Decoder dient.
poll_interval (float | None) –

Anzahl der Sekunden, die zwischen aufeinanderfolgenden Abfragen des Jobstatus gewartet werden soll. der Arbeit.
- 500msBei nicht sitzungsgebundenen Aufträgen ist der Standardwert, und der Mindestwert ist 100ms.
- 100msBei Sitzungsaufträgen sind der Standardwert und der Mindestwert.

Rückgabe

IBM Quantum Compute Auftragsergebnis (ggf. nachbearbeitet).

Erhöht

RuntimeJobFailureError - Wenn der Auftrag fehlgeschlagen ist.
RuntimeJobMaxTimeoutError - Wenn der Auftrag nicht innerhalb der angegebenen Zeitspanne abgeschlossen wird.
RuntimeInvalidStateError - Wenn der Auftrag abgebrochen wurde und versucht wird, das Ergebnis abzurufen.

Rückgabetyp

Beliebig

running

running()

GitHub

Gibt zurück, ob der Auftrag aktiv ausgeführt wird.

Rückgabetyp

Bool

status

status()

GitHub

Gibt den Status des Auftrags zurück.

Rückgabe

Status dieser Stelle.

Rückgabetyp

Literal[ 'INITIALIZING', 'QUEUED', 'RUNNING', 'CANCELLED', 'DONE', 'ERROR']

update_tags

update_tags(new_tags)

GitHub

Aktualisieren Sie die mit diesem Auftrag verbundenen Tags.

Parameter

new_tags (list[str]) – Neue Tags, die dem Auftrag zugewiesen werden sollen.

Rückgabe

Die neuen Tags, die mit diesem Auftrag verbunden sind.

Erhöht

IBMApiError - Wenn bei der Kommunikation mit dem Server oder bei der Aktualisierung der Job-Tags ein unerwarteter Fehler aufgetreten ist.

Rückgabetyp

[liststr]

usage

usage(partial=False)

GitHub

Rückgabe der Auftragsnutzung in Sekunden.

Standardmäßig wird 0 die zurückgegebenen Jobnutzung so lange angezeigt, bis die Berechnung der Nutzung abgeschlossen ist. Die kumulierte Zwischennutzung kann von der Methode mithilfe des partial Flags zurückgegeben werden.

Anmerkung

Beachten Sie bei der Verwendung partialvon, dass nicht garantiert ist, dass der endgültige Verbrauch sofort nach Abschluss des Auftrags zurückgegeben wird. Es wird empfohlen, die Methode mit partial=False aufzurufen, um sicherzustellen, dass die zurückgegebene Nutzung endgültig ist, oder die metrics() Methode zu verwenden, um Einzelheiten zum Abschlussstatus zu erhalten.

Parameter

partial (bool) – Wenn True, gib die bisher kumulierte Zwischennutzung zurück, bis die endgültige Nutzung erreicht ist.

Rückgabetyp

Gleitkommazahl

wait_for_final_state

wait_for_final_state(timeout=None, poll_interval=None)

GitHub

Abfrage des Auftragsstatus über die API, bis der Status einen endgültigen Zustand erreicht hat.

Parameter

timeout (float | None) – Sekunden, um auf den Auftrag zu warten. Wenn None, warten Sie auf unbestimmte Zeit.
poll_interval (float | None) –

Anzahl der Sekunden, die zwischen den Abfragen des Dienstes zum Status des Auftrags gewartet werden soll.
- 500msBei nicht sitzungsgebundenen Aufträgen ist der Standardwert, und der Mindestwert ist 100ms.
- 100msBei Sitzungsaufträgen ist der Standardwert und der Mindestwert.

Erhöht

RuntimeJobTimeoutError - Wenn der Auftrag nicht innerhalb der angegebenen Zeitspanne abgeschlossen wird.

Rückgabetyp

Keine

War diese Seite hilfreich?

Melden Sie auf GitHub einen Fehler, einen Tippfehler oder fordern Sie Inhalte an.