diff --git a/docs/api/qiskit-ibm-runtime/dev/index.mdx b/docs/api/qiskit-ibm-runtime/dev/index.mdx index 05b045f9462..51be9639eb5 100644 --- a/docs/api/qiskit-ibm-runtime/dev/index.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/index.mdx @@ -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) diff --git a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx index f5a3c095d8e..afdcf426dfe 100644 --- a/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx @@ -6,13 +6,11 @@ python_api_type: module python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling --- - - -# scheduling + - + -## Scheduling +# Transpiler scheduling passes @@ -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()`. -### Classes +## Classes | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -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: @@ -119,7 +117,7 @@ When compiling a circuit with Qiskit, it is more efficient and more robust to pe -### 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. @@ -173,7 +171,7 @@ qc_if_dd.draw(output="mpl", style="iqp") -### 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. diff --git a/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx b/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx index 3a6c32a4aef..14ad90f1388 100644 --- a/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx +++ b/docs/api/qiskit-ibm-runtime/dev/transpiler.mdx @@ -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. diff --git a/docs/api/qiskit-ibm-runtime/index.mdx b/docs/api/qiskit-ibm-runtime/index.mdx index 05b045f9462..51be9639eb5 100644 --- a/docs/api/qiskit-ibm-runtime/index.mdx +++ b/docs/api/qiskit-ibm-runtime/index.mdx @@ -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) diff --git a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx index b445d417a2f..a48047ac44f 100644 --- a/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx +++ b/docs/api/qiskit-ibm-runtime/qiskit_ibm_runtime.transpiler.passes.scheduling.mdx @@ -6,13 +6,11 @@ python_api_type: module python_api_name: qiskit_ibm_runtime.transpiler.passes.scheduling --- - - -# scheduling + - + -## Scheduling +# Transpiler scheduling passes @@ -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()`. -### Classes +## Classes | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -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: @@ -119,7 +117,7 @@ When compiling a circuit with Qiskit, it is more efficient and more robust to pe -### 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. @@ -173,7 +171,7 @@ qc_if_dd.draw(output="mpl", style="iqp") -### 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. diff --git a/docs/api/qiskit-ibm-runtime/transpiler.mdx b/docs/api/qiskit-ibm-runtime/transpiler.mdx index 3a6c32a4aef..14ad90f1388 100644 --- a/docs/api/qiskit-ibm-runtime/transpiler.mdx +++ b/docs/api/qiskit-ibm-runtime/transpiler.mdx @@ -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. diff --git a/public/api/qiskit-ibm-runtime/dev/objects.inv b/public/api/qiskit-ibm-runtime/dev/objects.inv index 92762b50d55..89eba5132ee 100644 Binary files a/public/api/qiskit-ibm-runtime/dev/objects.inv and b/public/api/qiskit-ibm-runtime/dev/objects.inv differ diff --git a/public/api/qiskit-ibm-runtime/objects.inv b/public/api/qiskit-ibm-runtime/objects.inv index 57db6437ede..44fb5c8378a 100644 Binary files a/public/api/qiskit-ibm-runtime/objects.inv and b/public/api/qiskit-ibm-runtime/objects.inv differ diff --git a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png index eec04f3bc33..0ad3ecf1108 100644 Binary files a/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png and b/public/images/api/qiskit-ibm-runtime/dev/fake_provider-1_02.png differ diff --git a/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png b/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png index e8b78615a4f..861f77de00a 100644 Binary files a/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png and b/public/images/api/qiskit-ibm-runtime/fake_provider-1_02.png differ diff --git a/scripts/lib/api/specialCaseResults.ts b/scripts/lib/api/specialCaseResults.ts index ca4edb614e3..e273d3eccf8 100644 --- a/scripts/lib/api/specialCaseResults.ts +++ b/scripts/lib/api/specialCaseResults.ts @@ -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, };