job Package

Defines Azure Quantum job model

Classes

BaseJob

Base job class with methods to create a job from raw blob data, upload blob data and download results.

FilteredJob

Mixin for adding methods to filter jobs

Job

Azure Quantum Job that is submitted to a given Workspace.

JobDetails

Job details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

JobFailedWithResultsError

Error produced when Job completes with status "Failed" and the Job supports producing failure results.

The failure results can be accessed with get_failure_results() method.

Initializes error produced when Job completes with status "Failed" and the Job supports producing failure results.

Session

Azure Quantum Job Session: a logical grouping of jobs.

SessionDetails

Session details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

SessionHost

A protocol to allow other objects to "host" a session. For example, a target object can host an open session and have all jobs that are being submitted through it to be associated with that session.

Example (job 1 to 3 will be associated the session "MySession"):


   with target.open_session(name="MySession") as session:
        job1 = target.submit(input_data=input_data, job_name="Job 1")
        job2 = target.submit(input_data=input_data, job_name="Job 2")
        job3 = target.submit(input_data=input_data, job_name="Job 3")
WorkspaceItem

Workspace item base class.

Enums

ContentType
SessionJobFailurePolicy

Policy controlling the behavior of the Session when a job in the session fails.

SessionStatus

The status of the session.