33 lines
1.1 KiB
Plaintext
33 lines
1.1 KiB
Plaintext
---
|
|
title: Options
|
|
description: API reference for qiskit.providers.Options
|
|
in_page_toc_min_heading_level: 1
|
|
python_api_type: class
|
|
python_api_name: qiskit.providers.Options
|
|
---
|
|
|
|
# Options
|
|
|
|
<Class id="qiskit.providers.Options" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py" signature="Options" modifiers="class">
|
|
Bases: `types.SimpleNamespace`
|
|
|
|
Base options object
|
|
|
|
This class is the abstract class that all backend options are based on. The properties of the class are intended to be all dynamically adjustable so that a user can reconfigure the backend on demand. If a property is immutable to the user (eg something like number of qubits) that should be a configuration of the backend class itself instead of the options.
|
|
|
|
## Methods
|
|
|
|
### get
|
|
|
|
<Function id="qiskit.providers.Options.get" signature="Options.get(field, default=None)">
|
|
Get an option value for a given key.
|
|
</Function>
|
|
|
|
### update\_options
|
|
|
|
<Function id="qiskit.providers.Options.update_options" signature="Options.update_options(**fields)">
|
|
Update options with kwargs
|
|
</Function>
|
|
</Class>
|
|
|