ManagedJobSet

class ManagedJobSet(name=None, short_id=None)[source]

A set of managed jobs.

An instance of this class is returned when you submit experiments using IBMQJobManager.run(). It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using results() and cancel all jobs using cancel().

ManagedJobSet constructor.

Parameters
  • name (Optional[str]) – Name for this set of jobs. If not specified, the current date and time is used.

  • short_id (Optional[str]) – Short ID for this set of jobs.

Methods

ManagedJobSet.cancel()

Cancel all jobs in this job set.

ManagedJobSet.error_messages()

Provide details about job failures.

ManagedJobSet.job(experiment)

Retrieve the job used to submit the specified experiment and its index.

ManagedJobSet.job_set_id()

Return the ID of this job set.

ManagedJobSet.jobs()

Return jobs in this job set.

ManagedJobSet.managed_jobs()

Return the managed jobs in this set.

ManagedJobSet.name()

Return the name of this job set.

ManagedJobSet.qobjs()

Return the Qobjs for the jobs in this set.

ManagedJobSet.report([detailed])

Return a report on current job statuses.

ManagedJobSet.results([timeout, partial])

Return the results of the jobs.

ManagedJobSet.retrieve_jobs(provider[, refresh])

Retrieve previously submitted jobs in this set.

ManagedJobSet.run(experiment_list, backend, …)

Execute a list of circuits or pulse schedules on a backend.

ManagedJobSet.statuses()

Return the status of each job in this set.

ManagedJobSet.tags()

Return the tags assigned to this job set.

ManagedJobSet.update_name(name)

Update the name of this job set.

ManagedJobSet.update_tags([…])

Update the tags assigned to this job set.