qiskit-documentation/docs/api/qiskit/0.26/ibmq_experiment.mdx

47 lines
2.3 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: experiment
description: API reference for qiskit.providers.ibmq.experiment
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit.providers.ibmq.experiment
---
<span id="module-qiskit.providers.ibmq.experiment" />
<span id="qiskit-providers-ibmq-experiment" />
# Experiment
<span id="module-qiskit.providers.ibmq.experiment" />
`qiskit.providers.ibmq.experiment`
Modules representing IBM Quantum Experience experiments.
<Admonition title="Caution" type="note">
This package is currently provided in beta form and heavy modifications to both functionality and API are likely to occur.
</Admonition>
<Admonition title="Note" type="note">
This service is not available to all accounts.
</Admonition>
You can use the experiment service to query, upload, and retrieve experiments, experiment plots, and analysis results. For example:
```python
from qiskit import IBMQ
provider = IBMQ.load_account()
experiments = provider.experiment.experiments()
```
All the available functions can be invoked using the provider.experiment attribute, which is an instance of the [`ExperimentService`](qiskit.providers.ibmq.experiment.ExperimentService "qiskit.providers.ibmq.experiment.ExperimentService") class.
## Classes
| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| [`ExperimentService`](qiskit.providers.ibmq.experiment.ExperimentService "qiskit.providers.ibmq.experiment.ExperimentService")(provider) | Provides experiment related services. |
| [`Experiment`](qiskit.providers.ibmq.experiment.Experiment "qiskit.providers.ibmq.experiment.Experiment")(provider, backend\_name, …\[, …]) | Class representing an experiment. |
| [`AnalysisResult`](qiskit.providers.ibmq.experiment.AnalysisResult "qiskit.providers.ibmq.experiment.AnalysisResult")(experiment\_uuid, …\[, fit, …]) | Class representing an analysis result for an experiment. |