Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit Runtime client Go to the latest version
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=<factory>)

GitHub

Options related to the execution environment.

Parameters

  • log_level (str) – logging level to set in the execution environment. The valid log levels are: DEBUG, INFO, WARNING, ERROR, and CRITICAL. The default level is WARNING.

  • callback (Optional[Callable]) –

    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.
  • job_tags (Optional[List]) – 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.


Attributes

callback

Type: Callable | None

Default value: None

log_level

Type: str

Default value: 'WARNING'

job_tags

Type: List | None


Methods

validate_environment_options

static validate_environment_options(environment_options)

GitHub

Validate that environment options are legal. :raises ValueError: if log_level is not in LogLevelType.

Return type

None

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