Skip to content

Commit ca0aeb8

Browse files
Eric-ArellanoEric-Arellano
committed
Provider and Runtime show modules as top-level in sidebar
1 parent 92b3fa4 commit ca0aeb8

32 files changed

+1118
-1147
lines changed

‎docs/api/qiskit-ibm-provider/_toc.json‎

Lines changed: 125 additions & 124 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"children": [
77
{
88
"title": "Overview",
9-
"url": "/api/qiskit-ibm-provider"
9+
"url": "/api/qiskit-ibm-provider/ibm_provider"
1010
},
1111
{
1212
"title": "IBMBackend",
@@ -52,161 +52,162 @@
5252
"title": "least_busy",
5353
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.least_busy"
5454
},
55-
{
56-
"title": "qiskit_ibm_provider.jupyter",
57-
"url": "/api/qiskit-ibm-provider/ibm_jupyter"
58-
},
5955
{
6056
"title": "Session",
6157
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.Session"
58+
}
59+
]
60+
},
61+
{
62+
"title": "qiskit_ibm_provider.job",
63+
"children": [
64+
{
65+
"title": "Overview",
66+
"url": "/api/qiskit-ibm-provider/ibm_job"
6267
},
6368
{
64-
"title": "qiskit_ibm_provider.job",
65-
"children": [
66-
{
67-
"title": "Overview",
68-
"url": "/api/qiskit-ibm-provider/ibm_job"
69-
},
70-
{
71-
"title": "IBMCircuitJob",
72-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob"
73-
},
74-
{
75-
"title": "IBMCompositeJob",
76-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob"
77-
},
78-
{
79-
"title": "IBMJobApiError",
80-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError"
81-
},
82-
{
83-
"title": "IBMJobError",
84-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError"
85-
},
86-
{
87-
"title": "IBMJobFailureError",
88-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError"
89-
},
90-
{
91-
"title": "IBMJobInvalidStateError",
92-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError"
93-
},
94-
{
95-
"title": "IBMJobTimeoutError",
96-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError"
97-
},
98-
{
99-
"title": "job_monitor",
100-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.job_monitor"
101-
},
102-
{
103-
"title": "QueueInfo",
104-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo"
105-
}
106-
]
69+
"title": "IBMCircuitJob",
70+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCircuitJob"
71+
},
72+
{
73+
"title": "IBMCompositeJob",
74+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMCompositeJob"
75+
},
76+
{
77+
"title": "IBMJobApiError",
78+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobApiError"
79+
},
80+
{
81+
"title": "IBMJobError",
82+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobError"
83+
},
84+
{
85+
"title": "IBMJobFailureError",
86+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobFailureError"
87+
},
88+
{
89+
"title": "IBMJobInvalidStateError",
90+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobInvalidStateError"
10791
},
10892
{
109-
"title": "qiskit_ibm_provider.transpiler",
93+
"title": "IBMJobTimeoutError",
94+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.IBMJobTimeoutError"
95+
},
96+
{
97+
"title": "job_monitor",
98+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.job_monitor"
99+
},
100+
{
101+
"title": "QueueInfo",
102+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.job.QueueInfo"
103+
}
104+
]
105+
},
106+
{
107+
"title": "qiskit_ibm_provider.jupyter",
108+
"url": "/api/qiskit-ibm-provider/ibm_jupyter"
109+
},
110+
{
111+
"title": "qiskit_ibm_provider.transpiler",
112+
"children": [
113+
{
114+
"title": "Overview",
115+
"url": "/api/qiskit-ibm-provider/ibm_transpiler"
116+
},
117+
{
118+
"title": "qiskit_ibm_provider.transpiler.passes",
110119
"children": [
111120
{
112121
"title": "Overview",
113-
"url": "/api/qiskit-ibm-provider/ibm_transpiler"
122+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes"
123+
},
124+
{
125+
"title": "qiskit_ibm_provider.transpiler.passes.basis",
126+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.basis"
114127
},
115128
{
116-
"title": "qiskit_ibm_provider.transpiler.passes",
129+
"title": "qiskit_ibm_provider.transpiler.passes.scheduling",
117130
"children": [
118131
{
119132
"title": "Overview",
120-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes"
133+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling"
134+
},
135+
{
136+
"title": "ALAPScheduleAnalysis",
137+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
138+
},
139+
{
140+
"title": "ASAPScheduleAnalysis",
141+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
121142
},
122143
{
123-
"title": "qiskit_ibm_provider.transpiler.passes.basis",
124-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.basis"
144+
"title": "BlockBasePadder",
145+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
125146
},
126147
{
127-
"title": "qiskit_ibm_provider.transpiler.passes.scheduling",
128-
"children": [
129-
{
130-
"title": "Overview",
131-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling"
132-
},
133-
{
134-
"title": "ALAPScheduleAnalysis",
135-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis"
136-
},
137-
{
138-
"title": "ASAPScheduleAnalysis",
139-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis"
140-
},
141-
{
142-
"title": "BlockBasePadder",
143-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder"
144-
},
145-
{
146-
"title": "DynamicCircuitInstructionDurations",
147-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
148-
},
149-
{
150-
"title": "PadDelay",
151-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
152-
},
153-
{
154-
"title": "PadDynamicalDecoupling",
155-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
156-
}
157-
]
148+
"title": "DynamicCircuitInstructionDurations",
149+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations"
150+
},
151+
{
152+
"title": "PadDelay",
153+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay"
154+
},
155+
{
156+
"title": "PadDynamicalDecoupling",
157+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling"
158158
}
159159
]
160160
}
161161
]
162+
}
163+
]
164+
},
165+
{
166+
"title": "qiskit_ibm_provider.utils",
167+
"children": [
168+
{
169+
"title": "Overview",
170+
"url": "/api/qiskit-ibm-provider/ibm_utils"
162171
},
163172
{
164-
"title": "qiskit_ibm_provider.utils",
165-
"children": [
166-
{
167-
"title": "Overview",
168-
"url": "/api/qiskit-ibm-provider/ibm_utils"
169-
},
170-
{
171-
"title": "seconds_to_duration",
172-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.seconds_to_duration"
173-
},
174-
{
175-
"title": "to_python_identifier",
176-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.to_python_identifier"
177-
},
178-
{
179-
"title": "utc_to_local",
180-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.utc_to_local"
181-
},
182-
{
183-
"title": "validate_job_tags",
184-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.validate_job_tags"
185-
}
186-
]
173+
"title": "seconds_to_duration",
174+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.seconds_to_duration"
187175
},
188176
{
189-
"title": "qiskit_ibm_provider.visualization",
190-
"children": [
191-
{
192-
"title": "Overview",
193-
"url": "/api/qiskit-ibm-provider/ibm_visualization"
194-
},
195-
{
196-
"title": "iplot_error_map",
197-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_error_map"
198-
},
199-
{
200-
"title": "iplot_gate_map",
201-
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_gate_map"
202-
}
203-
]
177+
"title": "to_python_identifier",
178+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.to_python_identifier"
179+
},
180+
{
181+
"title": "utc_to_local",
182+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.utc_to_local"
183+
},
184+
{
185+
"title": "validate_job_tags",
186+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.utils.validate_job_tags"
187+
}
188+
]
189+
},
190+
{
191+
"title": "qiskit_ibm_provider.visualization",
192+
"children": [
193+
{
194+
"title": "Overview",
195+
"url": "/api/qiskit-ibm-provider/ibm_visualization"
196+
},
197+
{
198+
"title": "iplot_error_map",
199+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_error_map"
200+
},
201+
{
202+
"title": "iplot_gate_map",
203+
"url": "/api/qiskit-ibm-provider/qiskit_ibm_provider.visualization.iplot_gate_map"
204204
}
205205
]
206206
},
207207
{
208208
"title": "Release notes",
209209
"url": "/api/qiskit-ibm-provider/release-notes"
210210
}
211-
]
211+
],
212+
"collapsed": true
212213
}

‎docs/api/qiskit-ibm-provider/ibm-provider.md‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/api/qiskit-ibm-provider/ibm_provider.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: qiskit_ibm_provider
3+
description: API reference for qiskit_ibm_provider
4+
in_page_toc_min_heading_level: 1
5+
python_api_type: module
6+
python_api_name: qiskit_ibm_provider
7+
---
8+
9+
<span id="ibm-quantum-provider-qiskit-ibm-provider" />
10+
11+
<span id="module-qiskit_ibm_provider" />
12+
13+
<span id="qiskit-ibm-provider" />
14+
15+
# IBM Quantum Provider
16+
17+
<span id="module-qiskit_ibm_provider" />
18+
19+
`qiskit_ibm_provider`
20+
21+
Modules representing the Qiskit IBM Quantum Provider.
22+
23+
## Logging
24+
25+
The qiskit-ibm-provider uses the `qiskit_ibm_provider` logger.
26+
27+
Two environment variables can be used to control the logging:
28+
29+
> * `QISKIT_IBM_PROVIDER_LOG_LEVEL`: Specifies the log level to use, for the Qiskit IBM provider modules. If an invalid level is set, the log level defaults to `WARNING`. The valid log levels are `DEBUG`, `INFO`, `WARNING`, `ERROR`, and `CRITICAL` (case-insensitive). If the environment variable is not set, then the parent logger’s level is used, which also defaults to `WARNING`.
30+
> * `QISKIT_IBM_PROVIDER_LOG_FILE`: Specifies the name of the log file to use. If specified, messages will be logged to the file only. Otherwise messages will be logged to the standard error (usually the screen).
31+
32+
For more advanced use, you can modify the logger itself. For example, to manually set the level to `WARNING`:
33+
34+
```python
35+
import logging
36+
logging.getLogger('qiskit_ibm_provider').setLevel(logging.WARNING)
37+
```
38+
39+
## Functions
40+
41+
| | |
42+
| ----------------------------------------------------------------------------------------- | ------------------------------------------ |
43+
| [`least_busy`](qiskit_ibm_provider.least_busy "qiskit_ibm_provider.least_busy")(backends) | Return the least busy backend from a list. |
44+
45+
## Classes
46+
47+
| | |
48+
| ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
49+
| [`IBMProvider`](qiskit_ibm_provider.IBMProvider "qiskit_ibm_provider.IBMProvider")(\[token, url, name, instance, ...]) | Provides access to the IBM Quantum services available to an account. |
50+
| [`IBMBackend`](qiskit_ibm_provider.IBMBackend "qiskit_ibm_provider.IBMBackend")(configuration, provider, api\_client) | Backend class interfacing with an IBM Quantum device. |
51+
| [`IBMBackendService`](qiskit_ibm_provider.IBMBackendService "qiskit_ibm_provider.IBMBackendService")(provider, hgp) | Backend namespace for an IBM Quantum account. |
52+
| [`Session`](qiskit_ibm_provider.Session "qiskit_ibm_provider.Session")(\[max\_time]) | Class for creating a flexible Qiskit Runtime session. |
53+
54+
## Exceptions
55+
56+
| | |
57+
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- |
58+
| [`IBMError`](qiskit_ibm_provider.IBMError "qiskit_ibm_provider.IBMError")(\*message) | Base class for errors raised by the provider modules. |
59+
| [`IBMProviderError`](qiskit_ibm_provider.IBMProviderError "qiskit_ibm_provider.IBMProviderError")(\*message) | Base class for errors raise by IBMProvider. |
60+
| [`IBMProviderValueError`](qiskit_ibm_provider.IBMProviderValueError "qiskit_ibm_provider.IBMProviderValueError")(\*message) | Value errors raised by IBMProvider. |
61+
| [`IBMBackendError`](qiskit_ibm_provider.IBMBackendError "qiskit_ibm_provider.IBMBackendError")(\*message) | Base class for errors raised by the backend modules. |
62+
| [`IBMBackendApiError`](qiskit_ibm_provider.IBMBackendApiError "qiskit_ibm_provider.IBMBackendApiError")(\*message) | Errors that occur unexpectedly when querying the server. |
63+
| [`IBMBackendApiProtocolError`](qiskit_ibm_provider.IBMBackendApiProtocolError "qiskit_ibm_provider.IBMBackendApiProtocolError")(\*message) | Errors raised when an unexpected value is received from the server. |
64+
| [`IBMBackendValueError`](qiskit_ibm_provider.IBMBackendValueError "qiskit_ibm_provider.IBMBackendValueError")(\*message) | Value errors raised by the backend modules. |
65+
| [`IBMProviderError`](qiskit_ibm_provider.IBMProviderError "qiskit_ibm_provider.IBMProviderError")(\*message) | Base class for errors raise by IBMProvider. |
66+

0 commit comments

Comments
 (0)