cirq_google.engine.EngineJob

A job created via the Quantum Engine API.

Inherits From: AbstractJob

cirq_google.engine.EngineJob(
    project_id: str,
    program_id: str,
    job_id: str,
    context: engine_base.EngineContext,
    _job: (quantum.QuantumJob | None) = None,
    job_result_future: (duet.AwaitableFuture[quantum.QuantumResult | quantum.QuantumJob] | None) = None
) -> None

This job may be in a variety of states. It may be scheduling, it may be executing on a machine, or it may have entered a terminal state (either succeeding or failing).

EngineJobs can be iterated over, returning Results. These Results can also be accessed by index. Note that this will block until the results are returned from the Engine service.

project_id A project_id of the parent Google Cloud Project.
program_id Unique ID of the program within the parent project.
job_id Unique ID of the job within the parent program.
context Engine configuration and context to use.
_job The optional current job state.
job_result_future A future to be completed when the job result is available. If set, EngineJob will await this future when a caller asks for the job result. If the future is completed with a QuantumJob, it is assumed that the job has failed.

project_id A project_id of the parent Google Cloud Project.
program_id Unique ID of the program within the parent project.
job_id Unique ID of the job within the parent program.

Methods

add_labels

View source

add_labels(
    labels: dict[str, str]
) -> EngineJob

Adds new labels to a previously created quantum job.

Params
labels New labels to add to the existing job labels.

Returns
This EngineJob.

cancel

View source

cancel() -> None

Cancel the job.

create_time

View source

create_time() -> datetime.datetime

Returns when the job was created.

delete

View source

delete() -> None

Deletes the job and result, if any.

description

View source

description() -> str

Returns the description of the job.

engine

View source

engine() -> engine_base.Engine

Returns the parent Engine object.

execution_status

View source

execution_status() -> quantum.ExecutionStatus.State

Return the execution status of the job.

failure

View source

failure() -> (tuple[str, str] | None)

Return failure code and message of the job if present.

get_calibration

View source

get_calibration() -> (calibration.Calibration | None)

Returns the recorded calibration at the time when the job was run, if one was captured, else None.

get_processor

View source

get_processor() -> (engine_processor.EngineProcessor | None)

Returns the EngineProcessor for the processor the job is/was run on, if available, else None.

get_repetitions_and_sweeps

View source

get_repetitions_and_sweeps() -> tuple[int, list[cirq.Sweep]]

Returns the repetitions and sweeps for the Quantum Engine job.

Returns
A tuple of the repetition count and list of sweeps.

id

View source

id() -> str

Returns the job id.

labels

View source

labels() -> dict[str, str]

Returns the labels of the job.

processor_ids

View source

processor_ids() -> list[str]

Returns the processor ids provided when the job was created.

program

View source

program() -> engine_program.EngineProgram

Returns the parent EngineProgram object.

remove_labels

View source

remove_labels(
    keys: list[str]
) -> EngineJob

Removes labels with given keys from the labels of a previously created quantum job.

Params
label_keys Label keys to remove from the existing job labels.

Returns
This EngineJob.

results

View source

results()

Returns the job results, blocking until the job is complete.

results_async

View source

results_async()

Returns the job results, blocking until the job is complete.

set_description

View source

set_description(
    description: str
) -> EngineJob

Sets the description of the job.

Params
description The new description for the job.

Returns
This EngineJob.

set_labels

View source

set_labels(
    labels: dict[str, str]
) -> EngineJob

Sets (overwriting) the labels for a previously created quantum job.

Params
labels The entire set of new job labels.

Returns
This EngineJob.

status

View source

status() -> str

Return the execution status of the job.

update_time

View source

update_time() -> datetime.datetime

Returns when the job was last updated.

__getitem__

View source

__getitem__(
    item
)

__iter__

View source

__iter__() -> Iterator[cirq.Result]

__len__

View source

__len__() -> int