Skip to content

ran gen-api for qiskit-ibm-transpiler v 0.18.0 (latest) #5429

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.

Sign up for GitHub

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

Draft
eharvey328 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

ran gen-api for qiskit-ibm-transpiler v 0.18.0 (latest) #5429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions docs/api/qiskit-ibm-transpiler/ai.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ python_api_name: qiskit_ibm_transpiler.ai

## Classes

| | |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| [`AIRouting`](ai-ai-routing "qiskit_ibm_transpiler.ai.AIRouting")(\[coupling\_map, backend, ...]) | The AIRouting pass acts both as a layout stage and a routing stage. |
| [`AICliffordSynthesis`](ai-ai-clifford-synthesis "qiskit_ibm_transpiler.ai.AICliffordSynthesis")(\[coupling\_map, backend, ...]) | Synthesis for Clifford circuits (blocks of H, S and CX gates). |
| [`AILinearFunctionSynthesis`](ai-ai-linear-function-synthesis "qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis")(\[coupling\_map, ...]) | Synthesis for Linear Function circuits (blocks of CX and SWAP gates). |
| [`AIPermutationSynthesis`](ai-ai-permutation-synthesis "qiskit_ibm_transpiler.ai.AIPermutationSynthesis")(\[coupling\_map, ...]) | Synthesis for Permutation circuits (blocks of SWAP gates). |
| [`CollectCliffords`](ai-collect-cliffords "qiskit_ibm_transpiler.ai.CollectCliffords")(\[do\_commutative\_analysis, ...]) | Collects Clifford blocks as Instruction objects and stores the original sub-circuit to compare against it after synthesis. |
| [`CollectLinearFunctions`](ai-collect-linear-functions "qiskit_ibm_transpiler.ai.CollectLinearFunctions")(\[...]) | Collects blocks of SWAP and CX as LinearFunction objects and stores the original sub-circuit to compare against it after synthesis. |
| [`CollectPermutations`](ai-collect-permutations "qiskit_ibm_transpiler.ai.CollectPermutations")(\[...]) | Collects blocks of SWAP circuits as Permutations. |
| | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| [`AIRouting`](/docs/api/qiskit-ibm-transpiler/ai-ai-routing "qiskit_ibm_transpiler.ai.AIRouting")(\[coupling\_map, backend, ...]) | The AIRouting pass acts both as a layout stage and a routing stage. |

@axelhzf axelhzf Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 why the change from relative to absolute links?

@eharvey328 eharvey328 Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a change introduced during the addons pipeline to resolve cross-package links. It does this by passing allObjectInvs. When a link matches it's own package's object.inv, they get rewritten to absolute paths by resolveStubUrl.

The relative-to-absolute change is intentional behavior from that pipeline refactor, and both formats work (normalizeUrl handled paths that starts with /docs/api). So functionally it's fine, it's just a side effect of now resolving cross-package links through object.inv.

| [`AICliffordSynthesis`](/docs/api/qiskit-ibm-transpiler/ai-ai-clifford-synthesis "qiskit_ibm_transpiler.ai.AICliffordSynthesis")(\[coupling\_map, backend, ...]) | Synthesis for Clifford circuits (blocks of H, S and CX gates). |
| [`AILinearFunctionSynthesis`](/docs/api/qiskit-ibm-transpiler/ai-ai-linear-function-synthesis "qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis")(\[coupling\_map, ...]) | Synthesis for Linear Function circuits (blocks of CX and SWAP gates). |
| [`AIPermutationSynthesis`](/docs/api/qiskit-ibm-transpiler/ai-ai-permutation-synthesis "qiskit_ibm_transpiler.ai.AIPermutationSynthesis")(\[coupling\_map, ...]) | Synthesis for Permutation circuits (blocks of SWAP gates). |
| [`CollectCliffords`](/docs/api/qiskit-ibm-transpiler/ai-collect-cliffords "qiskit_ibm_transpiler.ai.CollectCliffords")(\[do\_commutative\_analysis, ...]) | Collects Clifford blocks as Instruction objects and stores the original sub-circuit to compare against it after synthesis. |
| [`CollectLinearFunctions`](/docs/api/qiskit-ibm-transpiler/ai-collect-linear-functions "qiskit_ibm_transpiler.ai.CollectLinearFunctions")(\[...]) | Collects blocks of SWAP and CX as LinearFunction objects and stores the original sub-circuit to compare against it after synthesis. |
| [`CollectPermutations`](/docs/api/qiskit-ibm-transpiler/ai-collect-permutations "qiskit_ibm_transpiler.ai.CollectPermutations")(\[...]) | Collects blocks of SWAP circuits as Permutations. |

2 changes: 1 addition & 1 deletion docs/api/qiskit-ibm-transpiler/release-notes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,7 @@ in_page_toc_max_heading_level: 2

### New features

* Add optimization\_preferences optional input to [`TranspilerService`](transpiler-service-transpiler-service "qiskit_ibm_transpiler.transpiler_service.TranspilerService") constructor.
* Add optimization\_preferences optional input to [`TranspilerService`](/docs/api/qiskit-ibm-transpiler/transpiler-service-transpiler-service "qiskit_ibm_transpiler.transpiler_service.TranspilerService") constructor.

With this new feature, users could specify by which properties they want to optimize on the transpiler process. Allowed options are: “n\_cnots”, “n\_gates”, “cnot\_layers”, “layers”, “noise”, and these options can be provided in two ways: - Only an option, as a string value: Transpilation will be done priorizating this element and then the rest of the options - Several options, as a list: Transpilation will be done only with the specified elements ([67](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/67))

Expand Down
6 changes: 3 additions & 3 deletions docs/api/qiskit-ibm-transpiler/transpiler-service.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service

## Classes

| | |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| [`TranspilerService`](transpiler-service-transpiler-service "qiskit_ibm_transpiler.transpiler_service.TranspilerService")(optimization\_level\[, ai, ...]) | Class for using the transpiler service. |
| | |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------- |
| [`TranspilerService`](/docs/api/qiskit-ibm-transpiler/transpiler-service-transpiler-service "qiskit_ibm_transpiler.transpiler_service.TranspilerService")(optimization\_level\[, ai, ...]) | Class for using the transpiler service. |

Loading