131 lines
4.2 KiB
Plaintext
131 lines
4.2 KiB
Plaintext
---
|
||
title: RunConfig
|
||
description: API reference for qiskit.assembler.RunConfig
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.assembler.RunConfig
|
||
---
|
||
|
||
# qiskit.assembler.RunConfig
|
||
|
||
<Class id="qiskit.assembler.RunConfig" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/assembler/run_config.py" signature="RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)" modifiers="class">
|
||
Class for Run Configuration.
|
||
|
||
### shots
|
||
|
||
<Attribute id="qiskit.assembler.RunConfig.shots">
|
||
the number of shots
|
||
|
||
**Type**
|
||
|
||
int
|
||
</Attribute>
|
||
|
||
### max\_credits
|
||
|
||
<Attribute id="qiskit.assembler.RunConfig.max_credits">
|
||
the max\_credits to use on the IBM Q public devices
|
||
|
||
**Type**
|
||
|
||
int
|
||
</Attribute>
|
||
|
||
### seed\_simulator
|
||
|
||
<Attribute id="qiskit.assembler.RunConfig.seed_simulator">
|
||
the seed to use in the simulator
|
||
|
||
**Type**
|
||
|
||
int
|
||
</Attribute>
|
||
|
||
### memory
|
||
|
||
<Attribute id="qiskit.assembler.RunConfig.memory">
|
||
whether to request memory from backend (per-shot readouts)
|
||
|
||
**Type**
|
||
|
||
bool
|
||
</Attribute>
|
||
|
||
### parameter\_binds
|
||
|
||
<Attribute id="qiskit.assembler.RunConfig.parameter_binds">
|
||
List of parameter bindings
|
||
|
||
**Type**
|
||
|
||
list\[dict]
|
||
</Attribute>
|
||
|
||
Initialize a RunConfig object
|
||
|
||
**Parameters**
|
||
|
||
* **shots** (*int*) – the number of shots
|
||
* **max\_credits** (*int*) – the max\_credits to use on the IBM Q public devices
|
||
* **seed\_simulator** (*int*) – the seed to use in the simulator
|
||
* **memory** (*bool*) – whether to request memory from backend (per-shot readouts)
|
||
* **parameter\_binds** (*list\[dict]*) – List of parameter bindings
|
||
* **\*\*kwargs** – optional fields
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.assembler.RunConfig.__init__" signature="__init__(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)">
|
||
Initialize a RunConfig object
|
||
|
||
**Parameters**
|
||
|
||
* **shots** (*int*) – the number of shots
|
||
* **max\_credits** (*int*) – the max\_credits to use on the IBM Q public devices
|
||
* **seed\_simulator** (*int*) – the seed to use in the simulator
|
||
* **memory** (*bool*) – whether to request memory from backend (per-shot readouts)
|
||
* **parameter\_binds** (*list\[dict]*) – List of parameter bindings
|
||
* **\*\*kwargs** – optional fields
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.assembler.RunConfig.__init__ "qiskit.assembler.RunConfig.__init__")(\[shots, max\_credits, …]) | Initialize a RunConfig object |
|
||
| [`from_dict`](#qiskit.assembler.RunConfig.from_dict "qiskit.assembler.RunConfig.from_dict")(data) | Create a new RunConfig object from a dictionary. |
|
||
| [`to_dict`](#qiskit.assembler.RunConfig.to_dict "qiskit.assembler.RunConfig.to_dict")() | Return a dictionary format representation of the RunConfig |
|
||
|
||
### from\_dict
|
||
|
||
<Function id="qiskit.assembler.RunConfig.from_dict" signature="from_dict(data)" modifiers="classmethod">
|
||
Create a new RunConfig object from a dictionary.
|
||
|
||
**Parameters**
|
||
|
||
**data** (*dict*) – A dictionary representing the RunConfig to create. It will be in the same format as output by [`to_dict()`](#qiskit.assembler.RunConfig.to_dict "qiskit.assembler.RunConfig.to_dict").
|
||
|
||
**Returns**
|
||
|
||
The RunConfig from the input dictionary.
|
||
|
||
**Return type**
|
||
|
||
[RunConfig](#qiskit.assembler.RunConfig "qiskit.assembler.RunConfig")
|
||
</Function>
|
||
|
||
### to\_dict
|
||
|
||
<Function id="qiskit.assembler.RunConfig.to_dict" signature="to_dict()">
|
||
Return a dictionary format representation of the RunConfig
|
||
|
||
**Returns**
|
||
|
||
The dictionary form of the RunConfig.
|
||
|
||
**Return type**
|
||
|
||
dict
|
||
</Function>
|
||
</Class>
|
||
|