Skip to main content
IBM Quantum Platform

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

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

Représentation d'une exécution primitive de type « IBM Quantum Compute » (anciennement « Qiskit Runtime ») V2.

Paramètres

  • backend (Backend) – L'instance backend utilisée pour exécuter cette tâche.
  • api_client (RuntimeClient) – Objet permettant de se connecter au serveur.
  • job_id (str) – Job ID.
  • program_id (str) – ID du programme pour lequel ce travail est effectué.
  • creation_date (str | None) – Date de création de l'emploi, en UTC.
  • result_decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Une ResultDecoder sous-classe servant à décoder les résultats d'un travail, ou une liste de ces sous-classes. Si plusieurs décodeurs sont spécifiés, ils seront appelés en chaîne, la sortie de chaque n-th décodeur servant d'entrée au n+1-th suivant. Si aucune valeur n'est spécifiée, la valeur par défaut ResultDecoder est utilisée.
  • image (str | None) – IBM Quantum Compute image utilisée pour cette mission : nom_de_l'image:balise.
  • service (QiskitRuntimeService) – IBM Quantum Compute service.
  • session_id (str | None) – Identifiant de la première tâche d'une session « IBM Quantum Compute ».
  • tags (list | None) – Balises attribuées à la tâche.
  • version (int | None) – Version primitive.
  • private (bool | None) – Marque le travail comme privé.

Initialise la tâche primitive.

Paramètres

  • job_id (str) – Un identifiant unique dans le contexte de la primitive utilisée pour exécuter la tâche.
  • kwargs – Toute métadonnée de type clé-valeur à associer à cette tâche.
  • 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)

Attributs

ERREUR

Type : str | RuntimeJobStatus

Valeur par défaut : 'ERROR'

EMPLOI_ÉTATS FINALS

Type : tuple[JobStatus,...]

Valeur par défaut : ('DONE', 'CANCELLED', 'ERROR')

creation_date

Date de création de l'emploi en heure locale.

Retours

La date de création du travail sous forme d'objet datetime, en heure locale, ou None si la date de création n'est pas disponible.

image

Renvoie l'image « IBM Quantum Compute » utilisée pour la tâche.

Retours

L'image IBM Quantum Compute ou image_name:tag "" si l'image par défaut est utilisée.

inputs

Paramètres d'entrée du travail.

Retours

Paramètres d'entrée utilisés dans ce travail.

instance

Renvoyer l'instance CRN de IBM Cloud.

primitive_id

Nom de la primitive.

Retours

Ce boulot est vraiment ingrat.

private

Renvoie un booléen indiquant si le travail est privé ou non.

session_id

ID de session.

Retours

ID de session. Aucune si le backend est un simulateur.

tags

Étiquettes d'emploi.

Retours

Étiquettes attribuées au travail qui peuvent être utilisées pour le filtrage.

usage_estimation

Renvoyer les informations relatives à l'estimation de l'utilisation pour ce travail.

Retours

quantum_seconds qui est le temps d'exécution estimé de la tâche par le système en secondes. Le temps quantique représente le temps que le système consacre au traitement de votre travail.

Méthodes

backend

backend(timeout=None)

GitHub

Retourne le backend où ce travail a été exécuté. Récupérer à nouveau les données si le backend est None.

Augmentations

IBMRuntimeError - Si une erreur de réseau s'est produite.

Paramètres

timeout (float | None)

Type de retour

Backend | Aucun

cancel

cancel()

GitHub

Annuler le travail.

Augmentations

  • RuntimeInvalidStateError - Si le travail est dans un état qui ne peut être annulé.
  • IBMRuntimeError - S'il n'est pas possible d'annuler le travail.

Type de retour

Aucun

cancelled

cancelled()

GitHub

Indique si le travail a été annulé.

Type de retour

booléen

done

done()

GitHub

Indique si le travail a été exécuté avec succès.

Type de retour

booléen

error_message

error_message()

GitHub

Renvoie la raison de l'échec du travail.

Retours

Chaîne de messages d'erreur ou None.

Type de retour

str | Aucun

errored

errored()

GitHub

Indique si le travail a échoué.

Type de retour

booléen

in_final_state

in_final_state()

GitHub

Indique si le travail est dans un état final tel que DONE ou ERROR.

Type de retour

booléen

job_id

job_id()

Renvoi d'un identifiant unique permettant d'identifier le travail.

Type de retour

str

logs

logs()

GitHub

Renvoyer les journaux de travail.

Remarque

Les journaux de travail ne sont disponibles qu'une fois le travail terminé.

Retours

Journaux des travaux, y compris la sortie standard et les erreurs.

Augmentations

IBMRuntimeError - Si une erreur de réseau s'est produite.

Type de retour

str

metrics

metrics()

GitHub

Renvoyer les métriques de l'emploi.

Retours

  • timestamps: Horodatage de la création, de l'exécution et de la fin du travail.

  • usage: Détails concernant l'utilisation de l'emploi, la mesure de la quantité de

    la durée pendant laquelle le QPU est verrouillé pour votre charge de travail.

Type de retour

Un dictionnaire avec les paramètres de l'emploi, y compris, mais sans s'y limiter, les éléments suivants

Augmentations

IBMRuntimeError - Si une erreur de réseau s'est produite.

properties

properties(refresh=False)

GitHub

Renvoie les propriétés du backend pour ce travail.

Paramètres

refresh (bool) – Si True, demander à nouveau au serveur les propriétés du backend. Sinon, il renvoie une version mise en cache.

Retours

Les propriétés du backend utilisées pour ce travail, au moment où le travail a commencé à s'exécuter, ou None si les propriétés ne sont pas disponibles.

Type de retour

BackendProperties | Aucun

result

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

GitHub

Renvoyer les résultats du travail.

Paramètres

  • timeout (float | None) – Nombre de secondes d'attente pour le travail.

  • decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Une ResultDecoder sous-classe servant à décoder les résultats d'un travail, ou une liste de ces sous-classes. Si plusieurs décodeurs sont spécifiés, ils seront appelés en chaîne, la sortie de chaque n-th décodeur servant d'entrée au n+1-th suivant.

  • poll_interval (float | None) –

    Nombre de secondes à respecter entre deux requêtes successives concernant l'état de la tâche. du poste.

    • Pour les tâches hors session, la valeur par défaut est 500ms, et la valeur minimale est 100ms.
    • Pour les tâches de session, la valeur par défaut et la valeur minimale sont 100ms.

Retours

IBM Quantum Compute résultat du traitement (post-traité le cas échéant).

Augmentations

  • RuntimeJobFailureError - Si le travail a échoué.
  • RuntimeJobMaxTimeoutError - Si le travail n'est pas terminé dans le délai imparti.
  • RuntimeInvalidStateError - Si le travail a été annulé et que l'on tente de récupérer le résultat.

Type de retour

Tous

running

running()

GitHub

Indique si le travail est en cours d'exécution.

Type de retour

booléen

status

status()

GitHub

Renvoie le statut du travail.

Retours

Statut de cet emploi.

Type de retour

Littéral[ "INITIALISATION", "QUEUED", "RUNNING", "CANCELLED", "DONE", "ERROR"]

update_tags

update_tags(new_tags)

GitHub

Mettre à jour les balises associées à ce travail.

Paramètres

new_tags (list[str]) – Nouvelles balises à attribuer à la tâche.

Retours

Les nouvelles étiquettes associées à ce travail.

Augmentations

IBMApiError - Si une erreur inattendue s'est produite lors de la communication avec le serveur ou de la mise à jour des étiquettes de travail.

Type de retour

[liststr]

usage

usage(partial=False)

GitHub

Renvoyer l'utilisation du travail en secondes.

Par défaut, l'utilisation du job indiquée est 0 jusqu'à ce que le calcul de l'utilisation soit terminé. La méthode permet de récupérer l'utilisation intermédiaire cumulée à l'aide de partial l'indicateur.

Remarque

Lorsque vous utilisez partial, notez qu'il n'est pas garanti que le résultat final soit renvoyé dès que la tâche est terminée. Il est recommandé d'appeler la méthode avec partial=False pour s'assurer que l'utilisation renvoyée est définitive, ou d'utiliser la metrics() méthode pour obtenir des détails sur l'état d'achèvement.

Paramètres

partial (bool) – si True, renvoie l'utilisation intermédiaire cumulée jusqu'à présent, jusqu'à ce que l'utilisation finale soit atteinte.

Type de retour

séparer

wait_for_final_state

wait_for_final_state(timeout=None, poll_interval=None)

GitHub

Interroger l'API pour connaître l'état du travail jusqu'à ce que l'état soit définitif.

Paramètres

  • timeout (float | None) – Secondes d'attente pour le travail. Si None, attendre indéfiniment.

  • poll_interval (float | None) –

    Nombre de secondes à respecter entre chaque requête adressée au service pour connaître l'état de la tâche.

    • Pour les tâches hors session, la valeur par défaut est 500ms, et la valeur minimale est 100ms.
    • Pour les tâches de session, la valeur par défaut et la valeur minimale sont 100ms.

Augmentations

RuntimeJobTimeoutError - Si le travail n'est pas terminé dans le délai imparti.

Type de retour

Aucun

Cette page a-t-elle été utile ?
Signaler un bogue, une coquille ou proposer du contenu sur GitHub.