Skip to main contentIBM Quantum Documentation
Important

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

EnvironmentOptions

class EnvironmentOptions(log_level='WARNING', callback=None, job_tags=None, private=False)

GitHub

Bases: object

Options related to the execution environment.


Attributes

Parameters

  • log_level (Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'])
  • callback (Callable | None)
  • job_tags (List | None)
  • private (bool | None)

callback

Type: Callable | None

Default value: None

Callback function to be invoked for any interim results and final result. The callback function will receive 2 positional parameters:

  1. Job ID
  2. Job result.

Default: None.

job_tags

Type: List | None

Default value: None

Tags to be assigned to the job. The tags can subsequently be used as a filter in the qiskit_ibm_runtime.qiskit_runtime_service.jobs() function call.

Default: None.

log_level

Type: Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']

Default value: 'WARNING'

logging level to set in the execution environment. The valid log levels are: DEBUG, INFO, WARNING, ERROR, and CRITICAL.

Default: WARNING.

private

Type: bool | None

Default value: False

Boolean value for marking jobs as private.


Methods

Was this page helpful?
Report a bug or request content on GitHub.