Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Regenerate Runtime for fix to stub module #1280

Merged
merged 1 commit into from
May 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/qiskit-ibm-runtime/dev/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ description: API documentation for qiskit-ibm-runtime
* [Qiskit Runtime (`qiskit_ibm_runtime`)](runtime_service)
* [Primitive options (`qiskit_ibm_runtime.options`)](options)
* [Transpiler passes (`qiskit_ibm_runtime.transpiler.passes`)](transpiler)
* [Transpiler scheduling passes (`qiskit_ibm_runtime.transpiler.passes.scheduling`)](qiskit_ibm_runtime.transpiler.passes.scheduling)
* [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider)

Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ python_api_type: module
python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling
---

<span id="module-qiskit_ibm_runtime.transpiler.passes.scheduling" />

# scheduling
<span id="transpiler-scheduling-passes-qiskit-ibm-runtime-transpiler-passes-scheduling" />

<span id="scheduling-qiskit-ibm-runtime-transpiler-passes-scheduling" />
<span id="module-qiskit_ibm_runtime.transpiler.passes.scheduling" />

## Scheduling
# Transpiler scheduling passes

<span id="module-qiskit_ibm_runtime.transpiler.passes.scheduling" />

Expand All @@ -24,7 +22,7 @@ A collection of scheduling passes for working with IBM Quantum’s next-generati
You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in `transpile()` or `generate_preset_pass_manager()`.
</Admonition>

### Classes
## Classes

| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
Expand All @@ -35,7 +33,7 @@ A collection of scheduling passes for working with IBM Quantum’s next-generati
| [`PadDelay`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay")(durations\[, fill\_very\_end, ...]) | Padding idle time with Delay instructions. |
| [`PadDynamicalDecoupling`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling")(durations, dd\_sequences) | Dynamical decoupling insertion pass for IBM dynamic circuit backends. |

### Example usage
## Example usage

Below we demonstrate how to schedule and pad a teleportation circuit with delays for a dynamic circuit backend’s execution model:

Expand Down Expand Up @@ -119,7 +117,7 @@ When compiling a circuit with Qiskit, it is more efficient and more robust to pe

<span id="scheduling-old-format-c-if-conditioned-gates" />

### Scheduling old format `c_if` conditioned gates
## Scheduling old format c\_if conditioned gates

Scheduling with old format `c_if` conditioned gates is not supported.

Expand Down Expand Up @@ -173,7 +171,7 @@ qc_if_dd.draw(output="mpl", style="iqp")

<span id="exploiting-ibm-backend-s-local-parallel-fast-path" />

### Exploiting IBM backend’s local parallel “fast-path”
## Exploiting IBM backend’s local parallel “fast-path”

IBM quantum hardware supports a localized “fast-path” which enables a block of gates applied to a *single qubit* that are conditional on an immediately predecessor measurement *of the same qubit* to be completed with lower latency. The hardware is also able to do this in *parallel* on disjoint qubits that satisfy this condition.

Expand Down
9 changes: 5 additions & 4 deletions docs/api/qiskit-ibm-runtime/dev/transpiler.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes

A collection of transpiler passes for IBM backends. Refer to [transpile](/transpile) to learn more about transpilation and passes.

| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
| [`ConvertIdToDelay`](qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay "qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay")(durations\[, gate]) | Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. |
| [`scheduling`](qiskit_ibm_runtime.transpiler.passes.scheduling#module-qiskit_ibm_runtime.transpiler.passes.scheduling "qiskit_ibm_runtime.transpiler.passes.scheduling") | Scheduling (qiskit\_ibm\_runtime.transpiler.passes.scheduling) |
| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| [`ConvertIdToDelay`](qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay "qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay")(durations\[, gate]) | Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. |

See [`qiskit_ibm_runtime.transpiler.passes.scheduling`](qiskit_ibm_runtime.transpiler.passes.scheduling#module-qiskit_ibm_runtime.transpiler.passes.scheduling "qiskit_ibm_runtime.transpiler.passes.scheduling") for a collection of scheduling passes.

1 change: 1 addition & 0 deletions docs/api/qiskit-ibm-runtime/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ description: API documentation for qiskit-ibm-runtime
* [Qiskit Runtime (`qiskit_ibm_runtime`)](runtime_service)
* [Primitive options (`qiskit_ibm_runtime.options`)](options)
* [Transpiler passes (`qiskit_ibm_runtime.transpiler.passes`)](transpiler)
* [Transpiler scheduling passes (`qiskit_ibm_runtime.transpiler.passes.scheduling`)](qiskit_ibm_runtime.transpiler.passes.scheduling)
* [Fake Provider (`qiskit_ibm_runtime.fake_provider`)](fake_provider)

Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ python_api_type: module
python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling
---

<span id="module-qiskit_ibm_runtime.transpiler.passes.scheduling" />

# scheduling
<span id="transpiler-scheduling-passes-qiskit-ibm-runtime-transpiler-passes-scheduling" />

<span id="scheduling-qiskit-ibm-runtime-transpiler-passes-scheduling" />
<span id="module-qiskit_ibm_runtime.transpiler.passes.scheduling" />

## Scheduling
# Transpiler scheduling passes

<span id="module-qiskit_ibm_runtime.transpiler.passes.scheduling" />

Expand All @@ -24,7 +22,7 @@ A collection of scheduling passes for working with IBM Quantum’s next-generati
You should not mix these scheduling passes with Qiskit’s builtin scheduling passes as they will negatively interact with the scheduling routines for dynamic circuits. This includes setting `scheduling_method` in `transpile()` or `generate_preset_pass_manager()`.
</Admonition>

### Classes
## Classes

| | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
Expand All @@ -35,7 +33,7 @@ A collection of scheduling passes for working with IBM Quantum’s next-generati
| [`PadDelay`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDelay")(durations\[, fill\_very\_end, ...]) | Padding idle time with Delay instructions. |
| [`PadDynamicalDecoupling`](qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling "qiskit_ibm_runtime.transpiler.passes.scheduling.PadDynamicalDecoupling")(durations, dd\_sequences) | Dynamical decoupling insertion pass for IBM dynamic circuit backends. |

### Example usage
## Example usage

Below we demonstrate how to schedule and pad a teleportation circuit with delays for a dynamic circuit backend’s execution model:

Expand Down Expand Up @@ -119,7 +117,7 @@ When compiling a circuit with Qiskit, it is more efficient and more robust to pe

<span id="scheduling-old-format-c-if-conditioned-gates" />

### Scheduling old format `c_if` conditioned gates
## Scheduling old format c\_if conditioned gates

Scheduling with old format `c_if` conditioned gates is not supported.

Expand Down Expand Up @@ -173,7 +171,7 @@ qc_if_dd.draw(output="mpl", style="iqp")

<span id="exploiting-ibm-backend-s-local-parallel-fast-path" />

### Exploiting IBM backend’s local parallel “fast-path”
## Exploiting IBM backend’s local parallel “fast-path”

IBM quantum hardware supports a localized “fast-path” which enables a block of gates applied to a *single qubit* that are conditional on an immediately predecessor measurement *of the same qubit* to be completed with lower latency. The hardware is also able to do this in *parallel* on disjoint qubits that satisfy this condition.

Expand Down
9 changes: 5 additions & 4 deletions docs/api/qiskit-ibm-runtime/transpiler.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ python_api_name: qiskit_ibm_runtime.transpiler.passes

A collection of transpiler passes for IBM backends. Refer to [transpile](/transpile) to learn more about transpilation and passes.

| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- |
| [`ConvertIdToDelay`](qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay "qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay")(durations\[, gate]) | Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. |
| [`scheduling`](qiskit_ibm_runtime.transpiler.passes.scheduling#module-qiskit_ibm_runtime.transpiler.passes.scheduling "qiskit_ibm_runtime.transpiler.passes.scheduling") | Scheduling (qiskit\_ibm\_runtime.transpiler.passes.scheduling) |
| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| [`ConvertIdToDelay`](qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay "qiskit_ibm_runtime.transpiler.passes.ConvertIdToDelay")(durations\[, gate]) | Convert `qiskit.circuit.library.standard_gates.IGate` to a delay of the corresponding length. |

See [`qiskit_ibm_runtime.transpiler.passes.scheduling`](qiskit_ibm_runtime.transpiler.passes.scheduling#module-qiskit_ibm_runtime.transpiler.passes.scheduling "qiskit_ibm_runtime.transpiler.passes.scheduling") for a collection of scheduling passes.

Binary file modified public/api/qiskit-ibm-runtime/dev/objects.inv
Binary file not shown.
Binary file modified public/api/qiskit-ibm-runtime/objects.inv
Binary file not shown.
Binary file modified public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion scripts/lib/api/specialCaseResults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,11 @@ export function specialCaseResults(results: HtmlToMdResultWithUrl[]): void {
};
}

if (result.url.endsWith("/ibm-runtime")) {
if (
result.url.endsWith("/ibm-runtime") ||
(result.url.endsWith("/index") &&
result.url.includes("qiskit-ibm-runtime/"))
) {
result.meta = {
hardcodedFrontmatter: RUNTIME_INDEX_META,
};
Expand Down
Loading