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['INICIALIZANDO', 'EN COLA', 'EN EJECUCIÓN', 'CANCELADO', 'REALIZADO', 'ERROR']], BaseRuntimeJob

Representación de un tiempo de ejecución V2 ejecución primitiva.

Parámetros

  • backend (Backend) – La instancia de backend utilizada para ejecutar esta tarea.
  • api_client (RuntimeClient) – Objeto para conectarse al servidor.
  • job_id (str) – ID de trabajo.
  • program_id (str) – ID del programa para el que es este trabajo.
  • creation_date (str | None) – Fecha de creación del empleo, en UTC.
  • result_decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Una ResultDecoder subclase utilizada para descodificar los resultados de un trabajo, o una lista de dichas subclases. Si se especifica más de un decodificador, se activarán en cadena, de modo que la salida de cada n-th decodificador servirá de entrada al n+1-th siguiente. Si no se especifica, se utiliza el valor por defecto ResultDecoder .
  • image (str | None) – Imagen en tiempo de ejecución utilizada para este trabajo: image_name:tag.
  • service (qiskit_runtime_service.QiskitRuntimeService) – Servicio en tiempo de ejecución.
  • session_id (str | None) – ID de trabajo del primer trabajo de una sesión en tiempo de ejecución.
  • tags (list | None) – Etiquetas asignadas al trabajo.
  • version (int | None) – Versión primitiva.
  • private (bool | None) – Marca el trabajo como privado.

Inicializa el trabajo primitivo.

Parámetros

  • job_id (str) – Un identificador único en el contexto de la primitiva utilizada para ejecutar el trabajo.
  • kwargs : cualquier metadato de tipo «clave-valor» que se desee asociar a esta tarea.
  • backend (Backend)
  • api_client (RuntimeClient)
  • program_id (str)
  • service (qiskit_runtime_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)

Atributos

ERROR

Tipo: str | RuntimeJobStatus

Valor predeterminado: 'ERROR'

JOB_FINAL_STATES

Tipo: tuple[JobStatus, ...]

Valor predeterminado: ('DONE', 'CANCELLED', 'ERROR')

creation_date

Fecha de creación del empleo en hora local.

Devuelve

La fecha de creación del trabajo como objeto datetime, en hora local, o None si la fecha de creación no está disponible.

image

Devuelve la imagen de ejecución utilizada para el trabajo.

Devuelve

La imagen de tiempo de image_name:tag ejecución o "" si se utiliza la imagen predeterminada.

inputs

Parámetros de entrada del trabajo.

Devuelve

Parámetros de entrada utilizados en este trabajo.

instance

Devuelve el CRN de la instancia IBM Cloud.

primitive_id

Nombre primitivo.

Devuelve

Qué trabajo tan primitivo.

private

Devuelve un booleano que indica si el trabajo es privado o no.

session_id

ID de sesión.

Devuelve

ID de sesión. Ninguno si el backend es un simulador.

tags

Etiquetas de trabajo.

Devuelve

Etiquetas asignadas al trabajo que pueden utilizarse para filtrar.

usage_estimation

Devuelve la información de estimación de uso de este trabajo.

Devuelve

quantum_seconds que es el tiempo estimado de ejecución del sistema del trabajo en segundos. El tiempo cuántico representa el tiempo que el sistema dedica a procesar su trabajo.

Métodos

backend

backend(timeout=None)

GitHub

Devuelve el backend donde se ejecutó este trabajo. Recuperar datos de nuevo si backend es None.

Eleva

IBMRuntimeError - Si se ha producido un error de red.

Parámetros

timeout (float | None)

Tipo de retorno

Backend | Ninguno

cancel

cancel()

GitHub

Cancela el trabajo.

Eleva

  • RuntimeInvalidStateError - Si el trabajo se encuentra en un estado que no se puede cancelar.
  • IBMRuntimeError - Si no puede cancelar el trabajo.

Tipo de retorno

Ninguna

cancelled

cancelled()

GitHub

Devuelve si el trabajo ha sido cancelado.

Tipo de retorno

bool

done

done()

GitHub

Devuelve si el trabajo se ha ejecutado correctamente.

Tipo de retorno

bool

error_message

error_message()

GitHub

Devuelve la razón si el trabajo falló.

Devuelve

Cadena de mensaje de error o None.

Tipo de retorno

str | Ninguno

errored

errored()

GitHub

Devuelve si el trabajo ha fallado.

Tipo de retorno

bool

in_final_state

in_final_state()

GitHub

Devuelve si el trabajo está en un estado final de trabajo como DONE o ERROR.

Tipo de retorno

bool

job_id

job_id()

Devuelve un id único que identifica el trabajo.

Tipo de retorno

str

logs

logs()

GitHub

Devuelve los registros de trabajo.

Nota

Los registros de tareas sólo están disponibles una vez finalizada la tarea.

Devuelve

Registros de trabajo, incluida la salida estándar y el error.

Eleva

IBMRuntimeError - Si se ha producido un error de red.

Tipo de retorno

str

metrics

metrics()

GitHub

Devuelve las métricas del trabajo.

Devuelve

  • timestamps: Fechas de creación, inicio y finalización de la tarea.

  • usage: Detalles sobre el uso del trabajo, la medición de la cantidad de

    tiempo que la QPU está bloqueada para su carga de trabajo.

Tipo de retorno

Un diccionario con métricas de trabajo que incluya, entre otras, las siguientes

Eleva

IBMRuntimeError - Si se ha producido un error de red.

properties

properties(refresh=False)

GitHub

Devuelve las propiedades de backend para este trabajo.

Parámetros

refresh (bool) – Si True, vuelva a solicitar al servidor las propiedades del backend. En caso contrario, devuelve una versión en caché.

Devuelve

Las propiedades de backend utilizadas para este trabajo, en el momento en que el trabajo comenzó a ejecutarse, o None si las propiedades no están disponibles.

Tipo de retorno

BackendProperties | Ninguno

result

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

GitHub

Devuelve los resultados del trabajo.

Parámetros

  • timeout (float | None) – Número de segundos de espera para el trabajo.

  • decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Una ResultDecoder subclase utilizada para descodificar los resultados de un trabajo, o una lista de dichas subclases. Si se especifica más de un decodificador, se activarán en cadena, de modo que la salida de cada n-th decodificador servirá de entrada al n+1-th siguiente.

  • poll_interval (float | None) –

    Número de segundos que hay que esperar entre consultas sucesivas del estado del trabajo. del trabajo.

    • En el caso de los trabajos que no son de sesión, el valor predeterminado es 500ms, y el valor mínimo es 100ms.
    • En el caso de los trabajos de sesión, el valor predeterminado y el valor mínimo son 100ms.

Devuelve

Resultado de la tarea de ejecución (posprocesado, si procede).

Eleva

  • RuntimeJobFailureError - Si el trabajo ha fallado.
  • RuntimeJobMaxTimeoutError - Si el trabajo no se completa en el tiempo de espera dado.
  • RuntimeInvalidStateError - Si el trabajo fue cancelado, e intentando recuperar el resultado.

Tipo de retorno

Cualquiera

running

running()

GitHub

Devuelve si el trabajo se está ejecutando activamente.

Tipo de retorno

bool

status

status()

GitHub

Devuelve el estado del trabajo.

Devuelve

Estado de este trabajo.

Tipo de retorno

Literal[ 'INICIALIZANDO', 'QUEUED', 'EN MARCHA', 'CANCELADO', 'HECHO', 'ERROR']

update_tags

update_tags(new_tags)

GitHub

Actualiza las etiquetas asociadas a este trabajo.

Parámetros

new_tags (list[str]) – Nuevas etiquetas para asignar al trabajo.

Devuelve

Las nuevas etiquetas asociadas a este trabajo.

Eleva

IBMApiError - Si se ha producido un error inesperado al comunicarse con el servidor o al actualizar las etiquetas de trabajo.

Tipo de retorno

[liststr]

usage

usage(partial=False)

GitHub

Devuelve el uso del trabajo en segundos.

Por defecto, el consumo del trabajo que se muestra es 0 hasta que finalice el cálculo del consumo. El método permite obtener el uso intermedio acumulado utilizando el partial indicador.

Nota

Al utilizar partial, ten en cuenta que no se garantiza que el resultado final se devuelva tan pronto como finalice el trabajo. Se recomienda invocar el método con partial=False para garantizar que el uso devuelto sea definitivo, o utilizar el metrics() método para obtener detalles sobre el estado de finalización.

Parámetros

Truepartial (bool) – Si es así, devuelve el consumo intermedio acumulado hasta ese momento, hasta que se alcance el consumo final.

Tipo de retorno

flotante

wait_for_final_state

wait_for_final_state(timeout=None, poll_interval=None)

GitHub

Sondea el estado del trabajo desde la API hasta que el estado se encuentre en un estado final.

Parámetros

  • timeout (float | None) – Segundos de espera para el trabajo. Si None, espere indefinidamente.

  • poll_interval (float | None) –

    Número de segundos que hay que esperar entre cada consulta al servicio para conocer el estado del trabajo.

    • En el caso de los trabajos que no son de sesión, el valor predeterminado es 500ms, y el valor mínimo es 100ms.
    • En el caso de los trabajos de sesión, el valor predeterminado y el valor mínimo es 100ms.

Eleva

RuntimeJobTimeoutError - Si el trabajo no se completa en el tiempo de espera dado.

Tipo de retorno

Ninguna

¿Le ha resultado útil esta página?
Informe de un error, de una errata o solicite contenido en GitHub.