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)
Basi: BasePrimitiveJob[PrimitiveResult, Literal['INIZIALIZZAZIONE', 'IN CODA', 'IN ESECUZIONE', 'ANNULLATO', 'FATTO', 'ERRORE']], BaseRuntimeJob
Rappresentazione dell'esecuzione di una primitiva " IBM Quantum Compute " (precedentemente denominata " Qiskit Runtime ") V2.
Parametri
- backend (Backend) – L'istanza di backend utilizzata per l'esecuzione di questo processo.
- api_client (RuntimeClient) – Oggetto per la connessione al server.
- job_id (str) – ID lavoro.
- program_id (str) – ID del programma per il quale si lavora.
- creation_date (str | None) – Data di creazione del lavoro, in UTC.
- result_decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Una
ResultDecodersottoclasse utilizzata per decodificare i risultati dei lavori, oppure un elenco di tali sottoclassi. Se vengono specificati più decodificatori, questi verranno chiamati in catena, in modo che l'uscita di unn-thdecodificatore costituisca l'entrata deln+1-thdecodificatore successivo. Se non specificato, viene utilizzato il valore predefinitoResultDecoder. - image (str | None) – IBM Quantum Compute immagine utilizzata per questo lavoro: nome_immagine:tag.
- service (QiskitRuntimeService) – IBM Quantum Compute servizio.
- session_id (str | None) – ID del primo processo in una sessione IBM Quantum Compute.
- tags (list | None) – Tag assegnati al lavoro.
- version (int | None) – Versione primitiva.
- private (bool | None) – Segna il lavoro come privato.
Inizializza il processo primitivo.
Parametri
- job_id (str) – Un identificativo univoco nel contesto della primitiva utilizzata per l'esecuzione del processo.
- kwargs – Eventuali metadati chiave-valore da associare a questo processo.
- 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)
Attributi
ERRORE
Tipo: str | RuntimeJobStatus
Valore predefinito: 'ERROR'
JOB_FINAL_STATES
Tipo: tuple[JobStatus,...]
Valore predefinito: ('DONE', 'CANCELLED', 'ERROR')
creation_date
Data di creazione del lavoro in ora locale.
Risultati
La data di creazione del lavoro come oggetto datetime, in ora locale, o None se la data di creazione non è disponibile.
image
Restituisce l'immagine " IBM Quantum Compute " utilizzata per il lavoro.
Risultati
L'immagine " IBM Quantum Compute " oppure image_name:tag "" se viene utilizzata l'immagine predefinita.
inputs
Parametri di input del lavoro.
Risultati
Parametri di ingresso utilizzati in questo lavoro.
instance
Restituisce l'istanza CRN di IBM Cloud.
primitive_id
Nome primitivo.
Risultati
Questo lavoro è davvero faticoso.
private
Restituisce un booleano che indica se il lavoro è privato o meno.
session_id
ID sessione.
Risultati
ID sessione. Nessuno se il backend è un simulatore.
tags
Tag lavoro.
Risultati
Tag assegnati al lavoro che possono essere utilizzati per il filtraggio.
usage_estimation
Restituisce le informazioni sulla stima dell'utilizzo per questo lavoro.
Risultati
quantum_seconds che è il tempo di esecuzione del lavoro stimato dal sistema in secondi. Il tempo quantico rappresenta il tempo che il sistema dedica all'elaborazione del lavoro.
Metodi
backend
backend(timeout=None)
Restituisce il backend in cui è stato eseguito questo lavoro. Recupera nuovamente i dati se il backend è None.
Aumenti
IBMRuntimeError - Se si è verificato un errore di rete.
Parametri
timeout (float | None)
Tipo di restituzione
Backend | Nessuno
cancel
cancel()
Annullare il lavoro.
Aumenti
- RuntimeInvalidStateError - Se il lavoro è in uno stato che non può essere annullato.
- IBMRuntimeError - Se non è possibile annullare il lavoro.
Tipo di restituzione
Nessuna
cancelled
done
error_message
error_message()
Restituisce il motivo del fallimento del lavoro.
Risultati
Stringa del messaggio di errore o None.
Tipo di restituzione
str | Nessuno
errored
in_final_state
in_final_state()
Restituisce se il lavoro è in uno stato finale, come DONE o ERROR.
Tipo di restituzione
bool
job_id
job_id()
Restituisce un id univoco che identifica il lavoro.
Tipo di restituzione
STR
logs
logs()
Restituzione dei registri di lavoro.
I registri dei lavori sono disponibili solo al termine del lavoro.
Risultati
Registri del lavoro, compresi output standard ed errori.
Aumenti
IBMRuntimeError - Se si è verificato un errore di rete.
Tipo di restituzione
STR
metrics
metrics()
Restituire le metriche del lavoro.
Risultati
-
timestamps: Timestamp di quando il lavoro è stato creato, avviato e terminato. -
usage: Dettagli sull'utilizzo del lavoro, la misurazione della quantità ditempo in cui la QPU è bloccata per il carico di lavoro.
Tipo di restituzione
Un dizionario con le metriche del lavoro, tra cui, ma non solo, le seguenti
Aumenti
IBMRuntimeError - Se si è verificato un errore di rete.
properties
properties(refresh=False)
Restituisce le proprietà del backend per questo lavoro.
Parametri
refresh (bool) – Se True, interrogare nuovamente il server per le proprietà del backend. Altrimenti, restituisce una versione memorizzata nella cache.
Risultati
Le proprietà del backend utilizzate per questo lavoro, al momento dell'avvio dell'esecuzione del lavoro, oppure None se le proprietà non sono disponibili.
Tipo di restituzione
BackendProperties | Nessuno
result
result(timeout=None, decoder=None, poll_interval=None)
Restituisce i risultati del lavoro.
Parametri
-
timeout (float | None) – Numero di secondi di attesa per il lavoro.
-
decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Una
ResultDecodersottoclasse utilizzata per decodificare i risultati dei lavori, oppure un elenco di tali sottoclassi. Se vengono specificati più decodificatori, questi verranno chiamati in catena, in modo che l'uscita di unn-thdecodificatore costituisca l'entrata deln+1-thdecodificatore successivo. -
poll_interval (float | None) –
Numero di secondi da attendere tra una richiesta e l'altra dello stato del processo. del lavoro.
- Per i lavori non in sessione, il valore predefinito è
500ms, mentre il valore minimo è100ms. - Per i lavori in sessione, il valore predefinito e il valore minimo sono
100ms.
- Per i lavori non in sessione, il valore predefinito è
Risultati
IBM Quantum Compute risultato del lavoro (eventualmente sottoposto a post-elaborazione).
Aumenti
- RuntimeJobFailureError - Se il lavoro non è riuscito.
- RuntimeJobMaxTimeoutError - Se il lavoro non viene completato entro il timeout stabilito.
- RuntimeInvalidStateError - Se il lavoro è stato annullato e si tenta di recuperare i risultati.
Tipo di restituzione
Qualsiasi
running
status
status()
Restituisce lo stato del lavoro.
Risultati
Stato di questo lavoro.
Tipo di restituzione
Letterale[ 'INIZIALIZZAZIONE', 'QUEUED', 'IN CORSA', 'ANNULLATO', 'FATTO', 'ERRORE']
update_tags
update_tags(new_tags)
Aggiornare i tag associati a questo lavoro.
Parametri
new_tags (list[str]) – Nuovi tag da assegnare al lavoro.
Risultati
I nuovi tag associati a questo lavoro.
Aumenti
IBMApiError - Se si è verificato un errore imprevisto durante la comunicazione con il server o l'aggiornamento dei tag del lavoro.
Tipo di restituzione
[liststr]
usage
usage(partial=False)
Restituisce l'utilizzo del lavoro in secondi.
Per impostazione predefinita, l'utilizzo del processo restituito è 0 fino al completamento del calcolo dell'utilizzo. Il metodo consente di restituire i dati di utilizzo intermedi accumulati utilizzando il partial flag.
Quando si utilizza partial, si tenga presente che non è garantito che l'utilizzo finale venga restituito non appena il processo è completato. Si consiglia di richiamare il metodo con partial=False per assicurarsi che l'utilizzo restituito sia definitivo, oppure di utilizzare il metrics() metodo per ottenere dettagli sullo stato di completamento.
Parametri
partial (bool) – se True, restituisce l'utilizzo intermedio accumulato fino a quel momento, fino al raggiungimento dell'utilizzo finale.
Tipo di restituzione
mobile
wait_for_final_state
wait_for_final_state(timeout=None, poll_interval=None)
Eseguire il polling per lo stato del lavoro dall'API fino a quando lo stato è in uno stato finale.
Parametri
-
timeout (float | None) – Secondi di attesa per il lavoro. Se
None, attendere a tempo indeterminato. -
poll_interval (float | None) –
Numero di secondi di attesa tra una richiesta e l'altra al servizio per verificare lo stato del processo.
- Per i lavori non in sessione, il valore predefinito è
500ms, mentre il valore minimo è100ms. - Per i lavori in sessione, il valore predefinito e il valore minimo è
100ms.
- Per i lavori non in sessione, il valore predefinito è
Aumenti
RuntimeJobTimeoutError - Se il lavoro non viene completato entro il timeout stabilito.
Tipo di restituzione
Nessuna