45 lines
2.1 KiB
Plaintext
45 lines
2.1 KiB
Plaintext
---
|
||
title: Options (v0.26)
|
||
description: API reference for qiskit.providers.Options in qiskit v0.26
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.providers.Options
|
||
---
|
||
|
||
<span id="qiskit-providers-options" />
|
||
|
||
# qiskit.providers.Options
|
||
|
||
<Class id="qiskit.providers.Options" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/providers/options.py" signature="Options" modifiers="class">
|
||
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.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.providers.Options.__init__" signature="__init__(*args, **kwargs)">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------ |
|
||
| [`__init__`](#qiskit.providers.Options.__init__ "qiskit.providers.Options.__init__")(\*args, \*\*kwargs) | Initialize self. |
|
||
| [`get`](#qiskit.providers.Options.get "qiskit.providers.Options.get")(field\[, default]) | Get an option value for a given key. |
|
||
| [`update_options`](#qiskit.providers.Options.update_options "qiskit.providers.Options.update_options")(\*\*fields) | Update options with kwargs |
|
||
|
||
### get
|
||
|
||
<Function id="qiskit.providers.Options.get" signature="get(field, default=None)">
|
||
Get an option value for a given key.
|
||
</Function>
|
||
|
||
### update\_options
|
||
|
||
<Function id="qiskit.providers.Options.update_options" signature="update_options(**fields)">
|
||
Update options with kwargs
|
||
</Function>
|
||
</Class>
|
||
|