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

Representação de um tempo de execução V2 execução primitiva.

Parâmetros

  • backend (Backend) – A instância de backend usada para executar esta tarefa.
  • api_client (RuntimeClient) – Objeto para conexão com o servidor.
  • job_id (str) – ID do trabalho.
  • program_id (str) – ID do programa para o qual este trabalho se destina.
  • creation_date (str | None) – Data de criação do emprego, em UTC.
  • result_decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Uma ResultDecoder subclasse usada para decodificar os resultados de um trabalho, ou uma lista dessas subclasses. Se for especificado mais de um decodificador, eles serão chamados em cadeia, sendo que a saída de cada n-th decodificador servirá como entrada para o n+1-th seguinte. Se não for especificado, será utilizado o valor padrão ResultDecoder .
  • image (str | None) – Imagem de tempo de execução usada para este trabalho: image_name:tag.
  • service (qiskit_runtime_service.QiskitRuntimeService) – Serviço de tempo de execução.
  • session_id (str | None) – ID do trabalho do primeiro trabalho em uma sessão de tempo de execução.
  • tags (list | None) – Tags atribuídas ao trabalho.
  • version (int | None) – Versão primitiva.
  • private (bool | None) – Marca o trabalho como privado.

Inicializa a tarefa primitiva.

Parâmetros

  • job_id (str) – Um identificador único no contexto da primitiva utilizada para executar a tarefa.
  • kwargs – Quaisquer metadados do tipo chave-valor a serem associados a esta tarefa.
  • 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

Erro

Tipo: str | RuntimeJobStatus

Valor Padrão: 'ERROR'

JOB_FINAL_STATES

Tipo: tuple[JobStatus, ...]

Valor Padrão: ('DONE', 'CANCELLED', 'ERROR')

creation_date

Data de criação do trabalho em horário local.

Retorna

A data de criação do trabalho como um objeto de data e hora, em horário local, ou None se a data de criação não estiver disponível.

image

Retorna a imagem de tempo de execução usada para o trabalho.

Retorna

A imagem de tempo de image_name:tag execução ou "" se for utilizada a imagem padrão.

inputs

Parâmetros de entrada do trabalho.

Retorna

Parâmetros de entrada usados nesse trabalho.

instance

Retorna o CRN da instância IBM Cloud.

primitive_id

Nome primitivo.

Retorna

Que trabalho primitivo.

private

Retorna um booleano que indica se o trabalho é privado ou não.

session_id

ID de Sessão.

Retorna

ID de Sessão. Nenhum se o backend for um simulador.

tags

Etiquetas de trabalho.

Retorna

Tags atribuídas ao trabalho que podem ser usadas para filtragem.

usage_estimation

Retorna as informações de estimativa de uso para esse trabalho.

Retorna

quantum_seconds que é o tempo estimado de execução do trabalho no sistema, em segundos. O tempo quântico representa o tempo que o sistema dedica ao processamento de seu trabalho.

Métodos

backend

backend(timeout=None)

GitHub

Retorna o backend em que esse trabalho foi executado. Recuperar dados novamente se o backend for None.

Aumentos

IBMRuntimeError - Se ocorrer um erro de rede.

Parâmetros

timeout (float | None)

Tipo de retorno

Back-end | Nenhum

cancel

cancel()

GitHub

Cancelar a tarefa.

Aumentos

  • RuntimeInvalidStateError - Se o trabalho estiver em um estado que não possa ser cancelado.
  • IBMRuntimeError - Se não for possível cancelar o trabalho.

Tipo de retorno

Nenhum

cancelled

cancelled()

GitHub

Retorna se o trabalho foi cancelado.

Tipo de retorno

bool

done

done()

GitHub

Retorna se o trabalho foi executado com êxito.

Tipo de retorno

bool

error_message

error_message()

GitHub

Retorna o motivo da falha do trabalho.

Retorna

Cadeia de mensagens de erro ou None.

Tipo de retorno

str | Nenhum

errored

errored()

GitHub

Retorna se o trabalho falhou.

Tipo de retorno

bool

in_final_state

in_final_state()

GitHub

Retorna se o trabalho está em um estado de trabalho final, como DONE ou ERROR.

Tipo de retorno

bool

job_id

job_id()

Retorna um ID exclusivo que identifica o trabalho.

Tipo de retorno

str

logs

logs()

GitHub

Retornar os registros de trabalho.

Nota

Os registros de trabalho só ficam disponíveis após a conclusão do trabalho.

Retorna

Registros de trabalho, incluindo saída padrão e erro.

Aumentos

IBMRuntimeError - Se ocorrer um erro de rede.

Tipo de retorno

str

metrics

metrics()

GitHub

Retornar métricas de trabalho.

Retorna

  • timestamps: Registros de data e hora de quando o trabalho foi criado, começou a ser executado e terminou.

  • usage: Detalhes sobre o uso do trabalho, a medição da quantidade de

    tempo em que a QPU está bloqueada para sua carga de trabalho.

Tipo de retorno

Um dicionário com métricas de trabalho, incluindo, entre outros, os seguintes itens

Aumentos

IBMRuntimeError - Se ocorrer um erro de rede.

properties

properties(refresh=False)

GitHub

Retorna as propriedades de backend para esse trabalho.

Parâmetros

refresh (bool) – Se True, consulte novamente o servidor para obter as propriedades de backend. Caso contrário, retorna uma versão em cache.

Retorna

As propriedades de backend usadas para esse trabalho, no momento em que o trabalho começou a ser executado, ou None se as propriedades não estiverem disponíveis.

Tipo de retorno

BackendProperties | Nenhum

result

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

GitHub

Retorna os resultados do trabalho.

Parâmetros

  • timeout (float | None) – Número de segundos para aguardar o trabalho.

  • decoder (type[ResultDecoder] | Sequence[type[ResultDecoder]] | None) – Uma ResultDecoder subclasse usada para decodificar os resultados de um trabalho, ou uma lista dessas subclasses. Se for especificado mais de um decodificador, eles serão chamados em cadeia, sendo que a saída de cada n-th decodificador servirá como entrada para o n+1-th seguinte.

  • poll_interval (float | None) –

    Número de segundos a esperar entre consultas sucessivas ao status da tarefa. do trabalho.

    • Para tarefas fora da sessão, o padrão é 500ms, e o valor mínimo é 100ms.
    • Para tarefas de sessão, o valor padrão e o valor mínimo são 100ms.

Retorna

Resultado da tarefa em tempo de execução (pós-processado, se aplicável).

Aumentos

  • RuntimeJobFailureError - Se o trabalho falhar.
  • RuntimeJobMaxTimeoutError - Se o trabalho não for concluído dentro do tempo limite determinado.
  • RuntimeInvalidStateError - Se o trabalho foi cancelado e estiver tentando recuperar o resultado.

Tipo de retorno

Qualquer

running

running()

GitHub

Retorna se o trabalho está sendo executado ativamente.

Tipo de retorno

bool

status

status()

GitHub

Retorna o status do trabalho.

Retorna

Status deste trabalho.

Tipo de retorno

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

update_tags

update_tags(new_tags)

GitHub

Atualizar as tags associadas a esse trabalho.

Parâmetros

new_tags (list[str]) – Novas etiquetas para atribuir ao trabalho.

Retorna

As novas tags associadas a esse trabalho.

Aumentos

IBMApiError - Se ocorrer um erro inesperado durante a comunicação com o servidor ou a atualização das tags de trabalho.

Tipo de retorno

[liststr]

usage

usage(partial=False)

GitHub

Retorna o uso do trabalho em segundos.

Por padrão, o consumo do trabalho retornado é 0 até que o cálculo do consumo seja concluído. O uso intermediário acumulado pode ser retornado pelo método por meio do partial sinalizador.

Nota

Ao usar partial, observe que não é garantido que o uso final seja retornado assim que o trabalho for concluído. Recomenda-se chamar o método com partial=False para garantir que o uso retornado seja definitivo, ou usar o metrics() método para obter detalhes sobre o status de conclusão.

Parâmetros

Truepartial (bool) – Se, retorne o uso intermediário acumulado até o momento, até que o uso final seja atingido.

Tipo de retorno

valor flutuante

wait_for_final_state

wait_for_final_state(timeout=None, poll_interval=None)

GitHub

Faça a sondagem do status do trabalho na API até que o status esteja em um estado final.

Parâmetros

  • timeout (float | None) – Segundos para aguardar o trabalho. Se None, aguarde indefinidamente.

  • poll_interval (float | None) –

    Número de segundos a esperar entre cada consulta ao serviço para verificar o status da tarefa.

    • Para tarefas fora da sessão, o padrão é 500ms, e o valor mínimo é 100ms.
    • Para tarefas de sessão, o valor padrão e o valor mínimo é 100ms.

Aumentos

RuntimeJobTimeoutError - Se o trabalho não for concluído dentro do tempo limite determinado.

Tipo de retorno

Nenhum

Esta página foi útil?
Relate um bug, erro de digitação ou solicite conteúdo no GitHub.