From 4c3edf9f9557b3b38f89540a236a1922e5244ec8 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Wed, 13 Nov 2024 14:46:33 -0500 Subject: [PATCH 1/3] Regenerate 0.5, 0.6, 0.7 --- .../qiskit-ibm-transpiler/0.5/_package.json | 2 +- ..._ibm_transpiler.ai.AICliffordSynthesis.mdx | 16 +- ...ranspiler.ai.AILinearFunctionSynthesis.mdx | 16 +- ...m_transpiler.ai.AIPermutationSynthesis.mdx | 16 +- .../qiskit_ibm_transpiler.ai.AIRouting.mdx | 16 +- ...kit_ibm_transpiler.ai.CollectCliffords.mdx | 18 +-- ...m_transpiler.ai.CollectLinearFunctions.mdx | 18 +-- ..._ibm_transpiler.ai.CollectPermutations.mdx | 18 +-- ...r.transpiler_service.TranspilerService.mdx | 16 +- docs/api/qiskit-ibm-transpiler/0.5/utils.mdx | 6 +- .../qiskit-ibm-transpiler/0.6/_package.json | 2 +- ..._ibm_transpiler.ai.AICliffordSynthesis.mdx | 16 +- ...ranspiler.ai.AILinearFunctionSynthesis.mdx | 16 +- ...m_transpiler.ai.AIPermutationSynthesis.mdx | 16 +- .../qiskit_ibm_transpiler.ai.AIRouting.mdx | 16 +- ...kit_ibm_transpiler.ai.CollectCliffords.mdx | 18 +-- ...m_transpiler.ai.CollectLinearFunctions.mdx | 18 +-- ..._ibm_transpiler.ai.CollectPermutations.mdx | 18 +-- ...r.transpiler_service.TranspilerService.mdx | 18 +-- docs/api/qiskit-ibm-transpiler/0.6/utils.mdx | 10 +- docs/api/qiskit-ibm-transpiler/_package.json | 2 +- ..._ibm_transpiler.ai.AICliffordSynthesis.mdx | 16 +- ...ranspiler.ai.AILinearFunctionSynthesis.mdx | 16 +- ...m_transpiler.ai.AIPermutationSynthesis.mdx | 16 +- .../qiskit_ibm_transpiler.ai.AIRouting.mdx | 16 +- ...kit_ibm_transpiler.ai.CollectCliffords.mdx | 18 +-- ...m_transpiler.ai.CollectLinearFunctions.mdx | 18 +-- ..._ibm_transpiler.ai.CollectPermutations.mdx | 18 +-- ...r.transpiler_service.TranspilerService.mdx | 20 +-- .../qiskit-ibm-transpiler/release-notes.mdx | 146 +++++++++++------- docs/api/qiskit-ibm-transpiler/utils.mdx | 10 +- .../api/qiskit-ibm-transpiler/0.5/objects.inv | Bin 932 -> 933 bytes .../api/qiskit-ibm-transpiler/0.6/objects.inv | Bin 932 -> 933 bytes public/api/qiskit-ibm-transpiler/objects.inv | Bin 932 -> 933 bytes 34 files changed, 313 insertions(+), 273 deletions(-) diff --git a/docs/api/qiskit-ibm-transpiler/0.5/_package.json b/docs/api/qiskit-ibm-transpiler/0.5/_package.json index 332213ef66f..bcf7a113b6e 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/_package.json +++ b/docs/api/qiskit-ibm-transpiler/0.5/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit-ibm-transpiler", - "version": "0.5.3" + "version": "0.5.7" } diff --git a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx index 8f8d6e48bfc..87d64150ec4 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name of the backend used for doing the AI Clifford synthesis. - * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. - * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the number of requests to send in parallel. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Clifford synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. ## Methods @@ -28,9 +28,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run @@ -62,7 +62,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.12)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. ### synth\_nodes diff --git a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx index 59cda1e088b..fd2fb3b2a39 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name of the backend used for doing the AI Linear Function synthesis. - * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. - * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the number of requests to send in parallel. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Linear Function synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. ## Methods @@ -28,9 +28,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run @@ -62,7 +62,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.12)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. ### synth\_nodes diff --git a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx index 89b58d69402..ae6c4da005c 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name of the backend used for doing the AI Linear Function synthesis. - * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. - * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the number of requests to send in parallel. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Linear Function synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. ## Methods @@ -28,9 +28,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run @@ -62,7 +62,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.12)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. ### synth\_nodes diff --git a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AIRouting.mdx b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AIRouting.mdx index 8e23e70b2f3..b6414aaa69f 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AIRouting.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.AIRouting.mdx @@ -15,10 +15,10 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Name of the backend used for doing the transpilation. - * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]], optional*) – A list of pairs that represents physical links between qubits. - * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – With a range from 1 to 3, determines the computational effort to spend in the process (higher usually gives better results but takes longer), defaults to 2. - * **layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections), defaults to OPTIMIZE. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Name of the backend used for doing the transpilation. + * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits. + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – With a range from 1 to 3, determines the computational effort to spend in the process (higher usually gives better results but takes longer), defaults to 2. + * **layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections), defaults to OPTIMIZE. ## Methods @@ -29,9 +29,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -39,7 +39,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -49,7 +49,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectCliffords.mdx b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectCliffords.mdx index cdef82dcbe4..feea387b7af 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectCliffords.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectCliffords.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Enable or disable commutative analysis, defaults to True - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the minimum size for blocks generated during the collect Cliffords pass, defaults to 2. - * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the maximum size for blocks generated during the collect Cliffords pass, defaults to 9. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. - * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect Cliffords pass, defaults to 2. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect Cliffords pass, defaults to 9. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx index 7490b865809..f522211c40a 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Enable or disable commutative analysis, defaults to True - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the minimum size for blocks generated during the collect linear functions pass, defaults to 4. - * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the maximum size for blocks generated during the collect linear functions pass, defaults to 9. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. - * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect linear functions pass, defaults to 4. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect linear functions pass, defaults to 9. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectPermutations.mdx b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectPermutations.mdx index 71f27ac4a29..9aeebdf4641 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectPermutations.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.ai.CollectPermutations.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Enable or disable commutative analysis, defaults to True - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the minimum size for blocks generated during the collect permutations pass, defaults to 4. - * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the maximum size for blocks generated during the collect permutations pass, defaults to 12. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. - * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect permutations pass, defaults to 4. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect permutations pass, defaults to 12. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx index c29411373f8..4a986fb1aad 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.5/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx @@ -9,18 +9,18 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService # TranspilerService - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") Class for using the transpiler service. **Parameters** - * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – The optimization level to use during the transpilation. There are 4 optimization levels ranging from 0 to 3, where 0 is intended for not performing any optimizations and 3 spends the most effort to optimize the circuit. - * **ai** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Specifies if the transpilation should use AI or not, defaults to True. - * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]], optional*) – A list of pairs that represents physical links between qubits. - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Name of the backend used for doing the transpilation. - * **qiskit\_transpile\_options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*, optional*) – Other options to transpile with qiskit. - * **ai\_layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections). + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The optimization level to use during the transpilation. There are 4 optimization levels ranging from 0 to 3, where 0 is intended for not performing any optimizations and 3 spends the most effort to optimize the circuit. + * **ai** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Specifies if the transpilation should use AI or not, defaults to True. + * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Name of the backend used for doing the transpilation. + * **qiskit\_transpile\_options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*, optional*) – Other options to transpile with qiskit. + * **ai\_layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections). ## Methods @@ -31,7 +31,7 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService **Parameters** - **circuits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – circuit(s) to transpile. + **circuits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")*] |* [*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – circuit(s) to transpile. **Returns** diff --git a/docs/api/qiskit-ibm-transpiler/0.5/utils.mdx b/docs/api/qiskit-ibm-transpiler/0.5/utils.mdx index 51948e70c08..487da47c3a1 100644 --- a/docs/api/qiskit-ibm-transpiler/0.5/utils.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.5/utils.mdx @@ -21,8 +21,8 @@ python_api_name: qiskit_ibm_transpiler.utils **Parameters** - * **n\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – + * **n\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – **Return type** @@ -40,6 +40,6 @@ python_api_name: qiskit_ibm_transpiler.utils **Return type** - [*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.12)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")] + [*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] diff --git a/docs/api/qiskit-ibm-transpiler/0.6/_package.json b/docs/api/qiskit-ibm-transpiler/0.6/_package.json index a004cd34ff7..d5c6971140d 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/_package.json +++ b/docs/api/qiskit-ibm-transpiler/0.6/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit-ibm-transpiler", - "version": "0.6.1" + "version": "0.6.5" } diff --git a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx index 680a031ded5..b722110f6dd 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name of the backend used for doing the AI Clifford synthesis. - * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. - * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the number of requests to send in parallel. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Clifford synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. ## Methods @@ -28,9 +28,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run @@ -62,7 +62,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.12)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. ### synth\_nodes diff --git a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx index bf00f8c9eef..d6517a2ac52 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name of the backend used for doing the AI Linear Function synthesis. - * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. - * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the number of requests to send in parallel. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Linear Function synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. ## Methods @@ -28,9 +28,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run @@ -62,7 +62,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.12)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. ### synth\_nodes diff --git a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx index c119d40c0cc..530c148182b 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name of the backend used for doing the AI Linear Function synthesis. - * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. - * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the number of requests to send in parallel. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Linear Function synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. ## Methods @@ -28,9 +28,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run @@ -62,7 +62,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.12)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. ### synth\_nodes diff --git a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AIRouting.mdx b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AIRouting.mdx index 6280cfcbce5..39016c932dc 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AIRouting.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.AIRouting.mdx @@ -15,10 +15,10 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Name of the backend used for doing the transpilation. - * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]], optional*) – A list of pairs that represents physical links between qubits. - * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – With a range from 1 to 3, determines the computational effort to spend in the process (higher usually gives better results but takes longer), defaults to 2. - * **layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections), defaults to OPTIMIZE. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Name of the backend used for doing the transpilation. + * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits. + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – With a range from 1 to 3, determines the computational effort to spend in the process (higher usually gives better results but takes longer), defaults to 2. + * **layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections), defaults to OPTIMIZE. ## Methods @@ -29,9 +29,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -39,7 +39,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -49,7 +49,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectCliffords.mdx b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectCliffords.mdx index 68cfe95b6fa..89f261e71ef 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectCliffords.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectCliffords.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Enable or disable commutative analysis, defaults to True - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the minimum size for blocks generated during the collect Cliffords pass, defaults to 2. - * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the maximum size for blocks generated during the collect Cliffords pass, defaults to 9. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. - * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect Cliffords pass, defaults to 2. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect Cliffords pass, defaults to 9. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx index 8c7ae4e0ea8..10f80c8278d 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Enable or disable commutative analysis, defaults to True - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the minimum size for blocks generated during the collect linear functions pass, defaults to 4. - * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the maximum size for blocks generated during the collect linear functions pass, defaults to 9. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. - * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect linear functions pass, defaults to 4. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect linear functions pass, defaults to 9. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectPermutations.mdx b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectPermutations.mdx index d62cada72af..702b2ecaba0 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectPermutations.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.ai.CollectPermutations.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Enable or disable commutative analysis, defaults to True - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the minimum size for blocks generated during the collect permutations pass, defaults to 4. - * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the maximum size for blocks generated during the collect permutations pass, defaults to 12. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. - * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect permutations pass, defaults to 4. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect permutations pass, defaults to 12. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx index af7d399656d..c018bb0b867 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.6/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx @@ -9,19 +9,19 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService # TranspilerService - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") Class for using the transpiler service. **Parameters** - * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – The optimization level to use during the transpilation. There are 4 optimization levels ranging from 0 to 3, where 0 is intended for not performing any optimizations and 3 spends the most effort to optimize the circuit. - * **optimization\_preferences** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*], optional*) – Describe your preferences with a value or a list of values when prioritizing optimization. Allowed options: noise, n\_cnots, n\_gates, cnot\_layers, layers. - * **ai** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Specifies if the transpilation should use AI or not, defaults to True. - * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]], optional*) – A list of pairs that represents physical links between qubits. - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Name of the backend used for doing the transpilation. - * **qiskit\_transpile\_options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*, optional*) – Other options to transpile with qiskit. - * **ai\_layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections). + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The optimization level to use during the transpilation. There are 4 optimization levels ranging from 0 to 3, where 0 is intended for not performing any optimizations and 3 spends the most effort to optimize the circuit. + * **optimization\_preferences** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*], optional*) – Describe your preferences with a value or a list of values when prioritizing optimization. Allowed options: noise, n\_cnots, n\_gates, cnot\_layers, layers. + * **ai** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Specifies if the transpilation should use AI or not, defaults to True. + * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Name of the backend used for doing the transpilation. + * **qiskit\_transpile\_options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*, optional*) – Other options to transpile with qiskit. + * **ai\_layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections). ## Methods @@ -32,7 +32,7 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService **Parameters** - **circuits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – circuit(s) to transpile. + **circuits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")*] |* [*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – circuit(s) to transpile. **Returns** diff --git a/docs/api/qiskit-ibm-transpiler/0.6/utils.mdx b/docs/api/qiskit-ibm-transpiler/0.6/utils.mdx index 18ed53b2a8e..eaa761988cc 100644 --- a/docs/api/qiskit-ibm-transpiler/0.6/utils.mdx +++ b/docs/api/qiskit-ibm-transpiler/0.6/utils.mdx @@ -18,11 +18,11 @@ python_api_name: qiskit_ibm_transpiler.utils ### create\_random\_linear\_function - + **Parameters** - * **n\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – + * **n\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – **Return type** @@ -31,7 +31,7 @@ python_api_name: qiskit_ibm_transpiler.utils ### get\_metrics - + Returns a dict with metrics from a QuantumCircuit **Parameters** @@ -40,6 +40,6 @@ python_api_name: qiskit_ibm_transpiler.utils **Return type** - [*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.12)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")] + [*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] diff --git a/docs/api/qiskit-ibm-transpiler/_package.json b/docs/api/qiskit-ibm-transpiler/_package.json index 53069646e4f..69973f6d590 100644 --- a/docs/api/qiskit-ibm-transpiler/_package.json +++ b/docs/api/qiskit-ibm-transpiler/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit-ibm-transpiler", - "version": "0.7.0" + "version": "0.7.4" } diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx index 6c539bc038a..bb51e0a65c4 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name of the backend used for doing the AI Clifford synthesis. - * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. - * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the number of requests to send in parallel. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Clifford synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. ## Methods @@ -28,9 +28,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run @@ -62,7 +62,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.12)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. ### synth\_nodes diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx index fcc6f14b42c..ae3b11a0dc3 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name of the backend used for doing the AI Linear Function synthesis. - * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. - * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the number of requests to send in parallel. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Linear Function synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. ## Methods @@ -28,9 +28,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run @@ -62,7 +62,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.12)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. ### synth\_nodes diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx index 6cf36dbca7c..d1219bebd55 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx @@ -15,9 +15,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Name of the backend used for doing the AI Linear Function synthesis. - * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. - * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the number of requests to send in parallel. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Linear Function synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. ## Methods @@ -28,9 +28,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -38,7 +38,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -48,7 +48,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run @@ -62,7 +62,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Raises** - [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.12)") – when this is left unimplemented for a pass. + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. ### synth\_nodes diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx index 57510430aed..0206a06458e 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx @@ -15,10 +15,10 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Parameters** - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Name of the backend used for doing the transpilation. - * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]], optional*) – A list of pairs that represents physical links between qubits. - * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – With a range from 1 to 3, determines the computational effort to spend in the process (higher usually gives better results but takes longer), defaults to 2. - * **layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections), defaults to OPTIMIZE. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Name of the backend used for doing the transpilation. + * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits. + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – With a range from 1 to 3, determines the computational effort to spend in the process (higher usually gives better results but takes longer), defaults to 2. + * **layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections), defaults to OPTIMIZE. ## Methods @@ -29,9 +29,9 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -39,7 +39,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -49,7 +49,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx index cc99bb1d63b..d01660c8cea 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Enable or disable commutative analysis, defaults to True - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the minimum size for blocks generated during the collect Cliffords pass, defaults to 2. - * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the maximum size for blocks generated during the collect Cliffords pass, defaults to 9. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. - * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect Cliffords pass, defaults to 2. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect Cliffords pass, defaults to 9. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx index 9874030638c..dc5d935200e 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Enable or disable commutative analysis, defaults to True - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the minimum size for blocks generated during the collect linear functions pass, defaults to 4. - * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the maximum size for blocks generated during the collect linear functions pass, defaults to 9. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. - * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect linear functions pass, defaults to 4. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect linear functions pass, defaults to 9. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx index ae428042f9f..090ddd33df9 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx @@ -15,11 +15,11 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Parameters** - * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Enable or disable commutative analysis, defaults to True - * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the minimum size for blocks generated during the collect permutations pass, defaults to 4. - * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Set the maximum size for blocks generated during the collect permutations pass, defaults to 12. - * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. - * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect permutations pass, defaults to 4. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect permutations pass, defaults to 12. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. ## Methods @@ -30,9 +30,9 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Parameters** - * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)")) – Qiskit IR to optimize. + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. - * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.12)")) – A callback function which is caller per execution of optimization task. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. **Returns** @@ -40,7 +40,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Return type** - [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.12)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] ### name @@ -50,7 +50,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations **Return type** - [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") ### run diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx index 3ac8d9ae7d8..ff406b907f9 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx @@ -9,20 +9,20 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService # TranspilerService - Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)") + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") Class for using the transpiler service. **Parameters** - * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – The optimization level to use during the transpilation. There are 4 optimization levels ranging from 0 to 3, where 0 is intended for not performing any optimizations and 3 spends the most effort to optimize the circuit. - * **optimization\_preferences** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*], optional*) – Describe your preferences with a value or a list of values when prioritizing optimization. Allowed options: noise, n\_cnots, n\_gates, cnot\_layers, layers. - * **ai** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Specifies if the transpilation should use AI or not, defaults to True. - * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")*]], optional*) – A list of pairs that represents physical links between qubits. - * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Name of the backend used for doing the transpilation. - * **qiskit\_transpile\_options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")*, optional*) – Other options to transpile with qiskit. - * **ai\_layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")*, optional*) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections). - * **use\_fractional\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The optimization level to use during the transpilation. There are 4 optimization levels ranging from 0 to 3, where 0 is intended for not performing any optimizations and 3 spends the most effort to optimize the circuit. + * **optimization\_preferences** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*], optional*) – Describe your preferences with a value or a list of values when prioritizing optimization. Allowed options: noise, n\_cnots, n\_gates, cnot\_layers, layers. + * **ai** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Specifies if the transpilation should use AI or not, defaults to True. + * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Name of the backend used for doing the transpilation. + * **qiskit\_transpile\_options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*, optional*) – Other options to transpile with qiskit. + * **ai\_layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections). + * **use\_fractional\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – ## Methods @@ -33,7 +33,7 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService **Parameters** - **circuits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.12)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")*] |* [*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *|*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – circuit(s) to transpile. + **circuits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")*] |* [*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – circuit(s) to transpile. **Returns** diff --git a/docs/api/qiskit-ibm-transpiler/release-notes.mdx b/docs/api/qiskit-ibm-transpiler/release-notes.mdx index 77bf64b7a29..8d56f1fcf80 100644 --- a/docs/api/qiskit-ibm-transpiler/release-notes.mdx +++ b/docs/api/qiskit-ibm-transpiler/release-notes.mdx @@ -10,8 +10,46 @@ in_page_toc_max_heading_level: 2 +## 0.7.4 (2024-11-11) + +### New features + +* Use QPY as exchange format with service ([104](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/104)) + + + +## 0.7.3 (2024-11-06) + + + +### New features + +* Retry http requests after any RequestException ([111](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/111)) + + + +## 0.7.2 (2024-10-31) + +### Bug fixes + +* Added fix to avoid random test errors. Check that result exists when result is success. ([105](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/105)) + + + +## 0.7.1 (2024-10-30) + + + +### New features + +* In case of failure, always retry the GET request to retrieve a result unitl the timeout is reached. Increase the delay between requests to 5 seconds when we are over 1 minute. Retry transpilation POST request three times in case of failure. ([97](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/97)) + + + ## 0.7.0 (2024-09-18) + + ### New features * Adds support for sending the use\_fractional\_gates option to the transpile service ([83](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/83)) @@ -22,19 +60,21 @@ in_page_toc_max_heading_level: 2 * Removes unneeded benchmark method ([81](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/81)) * Adds test to verify that a circuit with a barrier will be transpiled ([84](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/84)) - + ## 0.6.1 (2024-09-17) + + ### Bug fixes * Fixes a bug with ECR gates coming from Qiskit when parsing using OpenQASM2 ([74](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/74)) - + ## 0.6.0 (2024-09-16) - + ### New features @@ -44,44 +84,44 @@ in_page_toc_max_heading_level: 2 * Enabling coupling\_map as options to the AI Synthesis passes ([70](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/70)) - + ### Bug fixes * Keep trying to get results even in case of HTTPError exception with status 520 ([52](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/52)) * Fixing the type of ECR gates when loading circuits from the Qiskit Transpiler Service ([63](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/63)) - + ## 0.5.3 (2024-09-17) - + ### Bug fixes * Fixes a bug with ECR gates coming from Qiskit when parsing using OpenQASM2 ([74](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/74)) - + ## 0.5.2 (2024-09-12) - + ### Bug fixes * Fixing the type of ECR gates when loading circuits from the qiskit transpiler service ([63](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/63)) - + ## 0.5.1 (2024-08-29) - + ### Bug fixes * Keep trying getting result even in case of HTTPError exception with status 520 ([52](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/52)) - + ## 0.5.0 (2024-08-27) @@ -89,47 +129,47 @@ in_page_toc_max_heading_level: 2 * Rename package to `qiskit-ibm-transpiler` ([43](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/43)) - + ## 0.4.10 (2024-09-17) - + ### Bug fixes * Fixes a bug with ECR gates coming from Qiskit when parsing using OpenQASM2 ([77](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/77)) - + ## 0.4.9 (2024-09-12) - + ### Bug fixes * Fixing the type of ECR gates when loading circuits from the qiskit transpiler service ([64](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/64)) - + ## 0.4.8 (2024-08-29) - + ### Bug fixes * Keep trying getting result even in case of HTTPError exception with status 520 ([54](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/54)) - + ## 0.4.7 (2024-08-27) - + ### Bug fixes * Add stacklevel to DeprecationWarning so it appears in Jupyter notebooks ([49](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/49)) - + ## 0.4.6 (2024-08-23) @@ -137,179 +177,179 @@ in_page_toc_max_heading_level: 2 * Add deprecation notice in preparation for project rename to `qiskit-ibm-transpiler` ([40](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/40)) - + ### Bug fixes * Forward incoming error when decoding fails ([36](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/36)) - + ## 0.4.5 (2024-08-01) - + ### New features * Enable programmatic config of polling timeout ([28](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/28)) - + ### Bug fixes * Using the declared `ai_layout_mode` in the TranspilerService’s run method ([25](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/25)) - + ## 0.4.4 (2024-07-25) - + ### Upgrade notes * Increasing timeout to 600s instead of 120s ([21](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/21)) - + ### New features * Expose service errors to users ([8](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/8)) * Configure logging for a library ([10](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/10)) - + ### Bug fixes * Correctly parse string boolean for ai param ([7](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/7)) - + ## 0.4.3 (2024-06-07) - + ### Upgrade notes * Check existence of credentials and raise related exceptions instead of breaking - + ## 0.4.2 (2024-06-07) - + ### Bug fixes * Python 3.8 support. Back to specify types with typing * Fixing some import errors for local modules - + ### Other notes * Relaxing pin of local dependencies - + ## 0.4.1 (2024-06-06) - + ### Upgrade notes * Updating logs levels - + ### Bug fixes * Rebuild layout in transpiled circuit * Avoid barrier nodes in collection - + ### Other notes * Refactoring the extension code - + ## 0.4.0 (2024-05-28) - + ### Upgrade notes * Updating Clifford service URL * Replace `use_ai` by `ai` param in requests - + ### New features * Request the synthesis of a list of circuits to the service. * Adding docstrings for public documentation - + ### Bug fixes * Adjust dependencies to be less strict and support minor version updates for qiskit & patch updates for qiskit-qasm3-import - + ### Other notes * Move type hints in documentation. * Set name to logger - + ## 0.3.0 (2024-02-29) - + ### Upgrade notes * Updating the plugin to use Qiskit 1.0 by default - + ### Bug fixes * Supporting measurements in circuits when transpiling using `ai=true` option - + ## 0.2.1 (2024-02-22) - + ### New features * Add multithreading to synth requests. The requests to the service for transpile and transpile now are done in parallel. - + ### Upgrade notes * Updated collection passes. Now the passes could work up to N of qubits or with any block size of qubits. - + ## 0.2.0 (2024-02-12) - + ### New features * Added support for synthesis and transpilation of Clifford, Permutation and Linear Function circuits. Using new URLs for the service. - + ## 0.1.3 (2023-12-11) - + ### Bug fixes @@ -317,7 +357,7 @@ in_page_toc_max_heading_level: 2 * Fixing hardcoded input to routing * Fix bug in input and refactor - + ## 0.1.2 (2023-12-04) diff --git a/docs/api/qiskit-ibm-transpiler/utils.mdx b/docs/api/qiskit-ibm-transpiler/utils.mdx index e52593e487e..fec4039064c 100644 --- a/docs/api/qiskit-ibm-transpiler/utils.mdx +++ b/docs/api/qiskit-ibm-transpiler/utils.mdx @@ -18,11 +18,11 @@ python_api_name: qiskit_ibm_transpiler.utils ### create\_random\_linear\_function - + **Parameters** - * **n\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – - * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – + * **n\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – **Return type** @@ -31,7 +31,7 @@ python_api_name: qiskit_ibm_transpiler.utils ### get\_metrics - + Returns a dict with metrics from a QuantumCircuit **Parameters** @@ -40,6 +40,6 @@ python_api_name: qiskit_ibm_transpiler.utils **Return type** - [*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.12)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")] + [*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] diff --git a/public/api/qiskit-ibm-transpiler/0.5/objects.inv b/public/api/qiskit-ibm-transpiler/0.5/objects.inv index 01755b33acf8ce4a5d5081331f28da216ebd958d..2e1e557936017df6bee683662876f610879db7fb 100644 GIT binary patch delta 798 zcmV+(1L6Fn2c-v)lz)e5Qg2k>d3t+P z$hHEV&K(ya^1DsN4HVjN)1Azt8s&$|YPVP_-6vaag z#6=I$3A%^iQRzeM1ocBbpeI16m!xSB>V_~GR-l^B@RXV0jgn#1IpC{-n*d%q#eOe3 zuD+K`@ZO7!N`LRACK&IfqjmRok>t9!4}$2w+Rh01gminj8dH*L@IHoeDpl;X6dU0}d{xg2O@^;h-X7 zIHUwW941v0`^8C;Wf~>JlEj(RAm}rtlO>v>kt$8ORDYqSSe#ZN`-+4(+|jfv6E8riwOYmDjh|0A>W{gFH#78=y6 zD8c%a>3^P%f7*02`R~Kf!x1vSgrlmQ(gJeP!<3p`0y`sWZQayK;rM1>I9BlqOwoW*qSV1W--xO$^%WOPo9eb|%dK==u)8Ju7;^9O z5EHV3w{dbeunT75vB{1>cDGtG1#3_sOE{G9h<`b%=Q;bcFV2=~*f<`d)N7={BwT?zP6=iD+R9t{w=iW9`zMzSsMXKInP)e zA6ngTO@z|HGx3JJYaXr}Z`3~=?_+qa;n2g?hocz4*@j>^PG~xSq)vAt1okxQA4c|J c?H5f5O;|b4*eo9PI*K-fs^X0N2V(HuT!x*FF8}}l delta 797 zcmV+&1LFLp2c!p(lz)?U>8vl#iytLN9q_*kWZ$E{E1Y;Y&=j4VA|Mz== zpN+$d(0_#~#A8z!#iibe8dS~&+q~a4ZPnGlt{E2>yW{Kw%N8$zNPf4xuf=-Zs_Nlg znrF~LZ_AW5*P7ihQjUhn;SI{pK;Jc(=e8p9E`|a`uH?-L(0@KnB&trP1Gix!Pj8P3 z*;b&_x#J>4ez&Q(fkGQ@x)VCE%gpxhT}a^STPI5+T1izolukiXwGNcQ$sOu}qIjr* zxac7|LH7_mDt(BZpnj+a^aKd?k~9rM-4G_j3RKe>o-z}>Q8J7=2YfYf6TnNS*zZNh z)%S7<-g~i8>3_Y{1mnGQwC>(6l3e%pK@j~{+ZiFBkZuoGV@gsD-p6p#4h)K?10b&E zP@Q1oP&_K&P&?^q4;1tRzHjRqN;7N>aBG+oA^>PleVWERe20j4z`?~-a9C&~98^RM zhm_!l!=!3rzc@*aKO_yuRrz$pjUy=N> zax_emS>pl(tt>9tDGQ1e$|6#2vVb_1EMB@t78xy3xeJR{&b-;OGriheSa5yJ&bmOl zVE?Si&Npq;eplkz5N4hgSf9mhR*S6GbrQlV-zlAp4qrM_7Ya<{j=NXIR zL#rFEiBLLtCf<;D&BJx$jrxbl&&drL{_pn! zKO2V^q5ld~h{vWdic7r_HK?2mwt2s8+N!I8T{A8&cE{NVmMvZak^F9XUyJp+Rn^10 zG|!-g-j*qAt~I-1q#O;C!yA;Hfxc@n&uvBIT?_??T*;dgpnrXuNK~Cn2X4bep57i6 zvaLX;bH_!9{BBcm1BEu+bSHFRmznM1yO6-uw@#Kuw34cFD4l|&Y8@zplRMM{Me$Gr zanVC`g6<)BRQeD*LH$q<=m`+&C21Ojx*<%46{w~&JY^<$qhuI$4)|)|CV-btvEPf1 ztMBC!y!T?G(tmrY3C4TrXx+VCB)RVGgCP2^wlhLLA>AIX#+0NQypQ3e9T*f(2S8lS zp*q3Fp?Fllp?1>K9w_JseBahJlxEl%;MOoFL;%p9`ZSGs_zn^8fP;&v;IPm}IH-si z4k^J8he_4MesPjynMTR5BylD+2>MLvWQnF|q)JmRRez`{7N^yenl9IrPgQL6z9RW$ zb+;ixL7w18anFr{Xfz|M$TTQ{{IiQmWmvbs& zRofJGuT`<$d$lclIKJ5zj#YdDQ#4?dD0MK;H==4weZ>XSrn;@#aw{Dd>~6_EhTOY6 z#DuKiZJgW9ng-gW*t|J2`suWhN>O2Mmue+zB8M}0+F)TC*EQ%F!@6yhGU;=(`5<(pE&?#ZZ9AmAp9t+JC2sMAgZ3;5JO;>FrS= z+X{3#cU*+X?=}@TP-w$VcR~ktnb{t`3kh6(>tty}E2%1n(kV!))`2oOxkEir6c05J z7d=EL=pKScr4O+a)DQK5o&cdS0ulz z91W9X*0=ycD~n5Z%7P+=vWQfhEFexLi z*gtEs^GzGI-<5bagxRS(LVeib&VDJ&&iAQoOpJck$j<#;V@#j_ADNx+kL2;N(4gK# z3D&1f_kVQ!)25rre;!$W2@%z|cmX`{)Ynj}f&n0(7Wmf7#_C@Z0_EUFTo&>;4Yhx20we3f=_#TWHfg=_}H*HUg4zp0PMS zw7TJ%2&IE(;thG%JX|;4sDC)#$M9Oip@*vvM=^l24Z(1n&~yMvo$f>k>}k|LjO@eO bn-&n7uyUTUSv=}>6m14o#ToezN-W)0GL4b3 diff --git a/public/api/qiskit-ibm-transpiler/objects.inv b/public/api/qiskit-ibm-transpiler/objects.inv index 3a83090f39c1c012e1d653549e6617215e555ca9..172046e4303e8051f4a60d312a06a69a382fbba7 100644 GIT binary patch delta 436 zcmV;l0Zaa*2c-v)lnc_NNxgNQCPmt$Y>}QHe-ZkxFok$*3ZuBx8&QMGxnP_3+or9$ z8rU`C;$nB4ePG$*B@oH)miM(-uUl0;yi4;8TIg+=vgTT|8%D~}Fgd(I*%|1&2J_rj zMBc?vfXJ1+IRVc3NUGL>GB~+IJx~-6H4qm)L?`GTf=8tfu@lq}^?;rLpld-uc8F&Q>J@5{%Ow5lE|`hOCOZb%-D=4ctU-Y+;ZVXO=BS?M?9aY9TYmY$jt?l*teZbJ zzk6UK*lysD5w$P^bf{*3+2tbe+x_ib=b!UW{T=w)mYS^;ybAcY(58FTSEOZa1SI7= zV{v?Fb;C6gN(axx8}hDsxNf{VQU7qfkKwh3Ll0LUj$#038-n3Dq3HmUI^Bs7*wd(g e7}ISg6Lb&3qtb`i3F?P>Ku>^BFG7MizRcTop0ZBQ}SR5Z(-Ed8W(!n$FhP-PYt{ZREKOFC4c&*{k!_|kQ x7{J+vU^q@_I)J23cOnG#H0mEl_F?T!2u)Zy&)6&;^*V|+gR0_;{0B}?-B)0 From 990fb486a7f4957610aefe2da500cd580fd86f13 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Wed, 13 Nov 2024 14:48:56 -0500 Subject: [PATCH 2/3] Generate 0.7 as historical --- .../qiskit-ibm-transpiler/0.7/_package.json | 4 + docs/api/qiskit-ibm-transpiler/0.7/_toc.json | 68 ++++++++++++ docs/api/qiskit-ibm-transpiler/0.7/ai.mdx | 28 +++++ docs/api/qiskit-ibm-transpiler/0.7/index.mdx | 11 ++ ..._ibm_transpiler.ai.AICliffordSynthesis.mdx | 91 ++++++++++++++++ ...ranspiler.ai.AILinearFunctionSynthesis.mdx | 91 ++++++++++++++++ ...m_transpiler.ai.AIPermutationSynthesis.mdx | 91 ++++++++++++++++ .../qiskit_ibm_transpiler.ai.AIRouting.mdx | 97 ++++++++++++++++++ ...kit_ibm_transpiler.ai.CollectCliffords.mdx | 89 ++++++++++++++++ ...m_transpiler.ai.CollectLinearFunctions.mdx | 89 ++++++++++++++++ ..._ibm_transpiler.ai.CollectPermutations.mdx | 89 ++++++++++++++++ ...r.transpiler_service.TranspilerService.mdx | 43 ++++++++ .../0.7/transpiler_service.mdx | 22 ++++ docs/api/qiskit-ibm-transpiler/0.7/utils.mdx | 45 ++++++++ .../api/qiskit-ibm-transpiler/0.7/objects.inv | Bin 0 -> 933 bytes .../config/historical-pages-to-latest.json | 3 +- 16 files changed, 860 insertions(+), 1 deletion(-) create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/_package.json create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/_toc.json create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/ai.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/index.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIRouting.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectCliffords.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectPermutations.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/transpiler_service.mdx create mode 100644 docs/api/qiskit-ibm-transpiler/0.7/utils.mdx create mode 100644 public/api/qiskit-ibm-transpiler/0.7/objects.inv diff --git a/docs/api/qiskit-ibm-transpiler/0.7/_package.json b/docs/api/qiskit-ibm-transpiler/0.7/_package.json new file mode 100644 index 00000000000..69973f6d590 --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/_package.json @@ -0,0 +1,4 @@ +{ + "name": "qiskit-ibm-transpiler", + "version": "0.7.4" +} diff --git a/docs/api/qiskit-ibm-transpiler/0.7/_toc.json b/docs/api/qiskit-ibm-transpiler/0.7/_toc.json new file mode 100644 index 00000000000..6abd8d0923f --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/_toc.json @@ -0,0 +1,68 @@ +{ + "title": "Qiskit Transpiler Service client", + "children": [ + { + "title": "API index", + "url": "/api/qiskit-ibm-transpiler/0.7" + }, + { + "title": "qiskit_ibm_transpiler.ai", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-transpiler/0.7/ai" + }, + { + "title": "AICliffordSynthesis", + "url": "/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AICliffordSynthesis" + }, + { + "title": "AILinearFunctionSynthesis", + "url": "/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis" + }, + { + "title": "AIPermutationSynthesis", + "url": "/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIPermutationSynthesis" + }, + { + "title": "AIRouting", + "url": "/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIRouting" + }, + { + "title": "CollectCliffords", + "url": "/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectCliffords" + }, + { + "title": "CollectLinearFunctions", + "url": "/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectLinearFunctions" + }, + { + "title": "CollectPermutations", + "url": "/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectPermutations" + } + ] + }, + { + "title": "qiskit_ibm_transpiler.transpiler_service", + "children": [ + { + "title": "Module overview", + "url": "/api/qiskit-ibm-transpiler/0.7/transpiler_service" + }, + { + "title": "TranspilerService", + "url": "/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.transpiler_service.TranspilerService" + } + ] + }, + { + "title": "qiskit_ibm_transpiler.utils", + "url": "/api/qiskit-ibm-transpiler/0.7/utils" + }, + { + "title": "Release notes", + "url": "/api/qiskit-ibm-transpiler/release-notes" + } + ], + "collapsed": true +} diff --git a/docs/api/qiskit-ibm-transpiler/0.7/ai.mdx b/docs/api/qiskit-ibm-transpiler/0.7/ai.mdx new file mode 100644 index 00000000000..44e35e831eb --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/ai.mdx @@ -0,0 +1,28 @@ +--- +title: ai (v0.7) +description: API reference for qiskit_ibm_transpiler.ai in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_transpiler.ai +--- + + + + + +# AI + +`qiskit_ibm_transpiler.ai` + +## Classes + +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| [`AIRouting`](qiskit_ibm_transpiler.ai.AIRouting "qiskit_ibm_transpiler.ai.AIRouting")(\[backend\_name, coupling\_map, ...]) | The AIRouting pass acts both as a layout stage and a routing stage. | +| [`AICliffordSynthesis`](qiskit_ibm_transpiler.ai.AICliffordSynthesis "qiskit_ibm_transpiler.ai.AICliffordSynthesis")(backend\_name\[, ...]) | Synthesis for Clifford circuits (blocks of H, S and CX gates). | +| [`AILinearFunctionSynthesis`](qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis "qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis")(backend\_name\[, ...]) | Synthesis for Linear Function circuits (blocks of CX and SWAP gates). | +| [`AIPermutationSynthesis`](qiskit_ibm_transpiler.ai.AIPermutationSynthesis "qiskit_ibm_transpiler.ai.AIPermutationSynthesis")(backend\_name\[, ...]) | Synthesis for Permutation circuits (blocks of SWAP gates). | +| [`CollectCliffords`](qiskit_ibm_transpiler.ai.CollectCliffords "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`](qiskit_ibm_transpiler.ai.CollectLinearFunctions "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`](qiskit_ibm_transpiler.ai.CollectPermutations "qiskit_ibm_transpiler.ai.CollectPermutations")(\[...]) | Collects blocks of SWAP circuits as Permutations. | + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/index.mdx b/docs/api/qiskit-ibm-transpiler/0.7/index.mdx new file mode 100644 index 00000000000..9ae9a4f778a --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/index.mdx @@ -0,0 +1,11 @@ +--- +title: Qiskit Transpiler Service client API documentation (v0.7) +description: Index of all the modules in qiskit-ibm-transpiler v0.7. +--- + +# qiskit-ibm-transpiler API reference + +* [AI (`qiskit_ibm_transpiler.ai`)](ai) +* [Qiskit IBM Transpiler (`qiskit_ibm_transpiler.transpiler_service`)](transpiler_service) +* [Utilities (`qiskit_ibm_transpiler.utils`)](utils) + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx new file mode 100644 index 00000000000..27b2cf99b08 --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx @@ -0,0 +1,91 @@ +--- +title: AICliffordSynthesis (v0.7) +description: API reference for qiskit_ibm_transpiler.ai.AICliffordSynthesis in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis +--- + +# AICliffordSynthesis + + + Bases: `AISynthesis` + + Synthesis for Clifford circuits (blocks of H, S and CX gates). Currently up to 9 qubit blocks. + + **Parameters** + + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Clifford synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. + + ## Methods + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + **Return type** + + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + + ### name + + + Name of the pass. + + **Return type** + + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + + + ### run + + + Run a pass on the DAGCircuit. This is implemented by the pass developer. + + **Parameters** + + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run. + + **Raises** + + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + + + ### synth\_nodes + + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (*RunState*) – Completion status of current task. + + **Returns** + + Updated pass manager state. + + **Return type** + + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx new file mode 100644 index 00000000000..b94693052a5 --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx @@ -0,0 +1,91 @@ +--- +title: AILinearFunctionSynthesis (v0.7) +description: API reference for qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis +--- + +# AILinearFunctionSynthesis + + + Bases: `AISynthesis` + + Synthesis for Linear Function circuits (blocks of CX and SWAP gates). Currently up to 9 qubit blocks. + + **Parameters** + + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Linear Function synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. + + ## Methods + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + **Return type** + + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + + ### name + + + Name of the pass. + + **Return type** + + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + + + ### run + + + Run a pass on the DAGCircuit. This is implemented by the pass developer. + + **Parameters** + + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run. + + **Raises** + + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + + + ### synth\_nodes + + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (*RunState*) – Completion status of current task. + + **Returns** + + Updated pass manager state. + + **Return type** + + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx new file mode 100644 index 00000000000..17ac576ae75 --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx @@ -0,0 +1,91 @@ +--- +title: AIPermutationSynthesis (v0.7) +description: API reference for qiskit_ibm_transpiler.ai.AIPermutationSynthesis in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis +--- + +# AIPermutationSynthesis + + + Bases: `AISynthesis` + + Synthesis for Permutation circuits (blocks of SWAP gates). Currently available for 65, 33, and 27 qubit blocks. + + **Parameters** + + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Name of the backend used for doing the AI Linear Function synthesis. + * **replace\_only\_if\_better** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Determine if replace the original circuit with the synthesized one if it’s better, defaults to True. + * **max\_threads** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the number of requests to send in parallel. + + ## Methods + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + **Return type** + + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + + ### name + + + Name of the pass. + + **Return type** + + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + + + ### run + + + Run a pass on the DAGCircuit. This is implemented by the pass developer. + + **Parameters** + + **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.2)")) – the dag on which the pass is run. + + **Raises** + + [**NotImplementedError**](https://docs.python.org/3/library/exceptions.html#NotImplementedError "(in Python v3.13)") – when this is left unimplemented for a pass. + + + ### synth\_nodes + + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (*RunState*) – Completion status of current task. + + **Returns** + + Updated pass manager state. + + **Return type** + + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIRouting.mdx b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIRouting.mdx new file mode 100644 index 00000000000..7643303c6ca --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.AIRouting.mdx @@ -0,0 +1,97 @@ +--- +title: AIRouting (v0.7) +description: API reference for qiskit_ibm_transpiler.ai.AIRouting in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_transpiler.ai.AIRouting +--- + +# AIRouting + + + Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.2)") + + The AIRouting pass acts both as a layout stage and a routing stage. + + **Parameters** + + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Name of the backend used for doing the transpilation. + * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits. + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – With a range from 1 to 3, determines the computational effort to spend in the process (higher usually gives better results but takes longer), defaults to 2. + * **layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections), defaults to OPTIMIZE. + + ## Methods + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + **Return type** + + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + + ### name + + + Name of the pass. + + **Return type** + + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + + + ### run + + + Run the AIRouting pass on dag. + + **Parameters** + + **dag** (*DAGCircuit*) – the directed acyclic graph to be mapped. + + **Returns** + + A dag mapped to be compatible with the coupling\_map. + + **Return type** + + DAGCircuit + + **Raises** + + * **TranspilerError** – if the coupling map or the layout are not + * **compatible with the DAG**\*\*, or \*\***if the coupling\_map=None** – + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (*RunState*) – Completion status of current task. + + **Returns** + + Updated pass manager state. + + **Return type** + + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectCliffords.mdx b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectCliffords.mdx new file mode 100644 index 00000000000..d2b797e8dc2 --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectCliffords.mdx @@ -0,0 +1,89 @@ +--- +title: CollectCliffords (v0.7) +description: API reference for qiskit_ibm_transpiler.ai.CollectCliffords in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords +--- + +# CollectCliffords + + + Bases: `RepeatedCollectAndCollapse` + + Collects Clifford blocks as Instruction objects and stores the original sub-circuit to compare against it after synthesis. + + **Parameters** + + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect Cliffords pass, defaults to 2. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect Cliffords pass, defaults to 9. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + + ## Methods + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + **Return type** + + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + + ### name + + + Name of the pass. + + **Return type** + + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + + + ### run + + + Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit + + **Returns** + + the optimized DAG. + + **Return type** + + DAGCircuit + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (*RunState*) – Completion status of current task. + + **Returns** + + Updated pass manager state. + + **Return type** + + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx new file mode 100644 index 00000000000..9ba1667dd03 --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx @@ -0,0 +1,89 @@ +--- +title: CollectLinearFunctions (v0.7) +description: API reference for qiskit_ibm_transpiler.ai.CollectLinearFunctions in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions +--- + +# CollectLinearFunctions + + + Bases: `RepeatedCollectAndCollapse` + + Collects blocks of SWAP and CX as LinearFunction objects and stores the original sub-circuit to compare against it after synthesis. + + **Parameters** + + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect linear functions pass, defaults to 4. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect linear functions pass, defaults to 9. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + + ## Methods + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + **Return type** + + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + + ### name + + + Name of the pass. + + **Return type** + + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + + + ### run + + + Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit + + **Returns** + + the optimized DAG. + + **Return type** + + DAGCircuit + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (*RunState*) – Completion status of current task. + + **Returns** + + Updated pass manager state. + + **Return type** + + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectPermutations.mdx b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectPermutations.mdx new file mode 100644 index 00000000000..4b48a0a26b0 --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.ai.CollectPermutations.mdx @@ -0,0 +1,89 @@ +--- +title: CollectPermutations (v0.7) +description: API reference for qiskit_ibm_transpiler.ai.CollectPermutations in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations +--- + +# CollectPermutations + + + Bases: `RepeatedCollectAndCollapse` + + Collects blocks of SWAP circuits as Permutations. + + **Parameters** + + * **do\_commutative\_analysis** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Enable or disable commutative analysis, defaults to True + * **min\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the minimum size for blocks generated during the collect permutations pass, defaults to 4. + * **max\_block\_size** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Set the maximum size for blocks generated during the collect permutations pass, defaults to 12. + * **collect\_from\_back** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")*, optional*) – Specify if collect blocks in reverse order or not, defaults to False. + * **num\_reps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*, optional*) – Specify how many times to repeat the optimization process, defaults to 10. + + ## Methods + + ### execute + + + Execute optimization task for input Qiskit IR. + + **Parameters** + + * **passmanager\_ir** ([*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)")) – Qiskit IR to optimize. + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – State associated with workflow execution by the pass manager itself. + * **callback** ([*Callable*](https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable "(in Python v3.13)")) – A callback function which is caller per execution of optimization task. + + **Returns** + + Optimized Qiskit IR and state of the workflow. + + **Return type** + + [tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.13)")\[[*Any*](https://docs.python.org/3/library/typing.html#typing.Any "(in Python v3.13)"), [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")] + + + ### name + + + Name of the pass. + + **Return type** + + [str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") + + + ### run + + + Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit + + **Returns** + + the optimized DAG. + + **Return type** + + DAGCircuit + + + ### update\_status + + + Update workflow status. + + **Parameters** + + * **state** ([*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)")) – Pass manager state to update. + * **run\_state** (*RunState*) – Completion status of current task. + + **Returns** + + Updated pass manager state. + + **Return type** + + [*PassManagerState*](/api/qiskit/qiskit.passmanager.PassManagerState "(in Qiskit v1.2)") + + + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx new file mode 100644 index 00000000000..0ff0bbcb631 --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx @@ -0,0 +1,43 @@ +--- +title: TranspilerService (v0.7) +description: API reference for qiskit_ibm_transpiler.transpiler_service.TranspilerService in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService +--- + +# TranspilerService + + + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") + + Class for using the transpiler service. + + **Parameters** + + * **optimization\_level** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The optimization level to use during the transpilation. There are 4 optimization levels ranging from 0 to 3, where 0 is intended for not performing any optimizations and 3 spends the most effort to optimize the circuit. + * **optimization\_preferences** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)") *|*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*], optional*) – Describe your preferences with a value or a list of values when prioritizing optimization. Allowed options: noise, n\_cnots, n\_gates, cnot\_layers, layers. + * **ai** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Specifies if the transpilation should use AI or not, defaults to True. + * **coupling\_map** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*]], optional*) – A list of pairs that represents physical links between qubits. + * **backend\_name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Name of the backend used for doing the transpilation. + * **qiskit\_transpile\_options** ([*dict*](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.13)")*, optional*) – Other options to transpile with qiskit. + * **ai\_layout\_mode** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)")*, optional*) – Specifies how to handle the layout selection. There are 3 layout modes: keep (respects the layout set by the previous transpiler passes), improve (uses the layout set by the previous transpiler passes as a starting point) and optimize (ignores previous layout selections). + * **use\_fractional\_gates** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – + + ## Methods + + ### run + + + Transpile the circuit(s) by calling the service /transpile endpoint. + + **Parameters** + + **circuits** ([*List*](https://docs.python.org/3/library/typing.html#typing.List "(in Python v3.13)")*\[*[*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")*] |* [*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – circuit(s) to transpile. + + **Returns** + + The transpiled circuit(s) + + + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/transpiler_service.mdx b/docs/api/qiskit-ibm-transpiler/0.7/transpiler_service.mdx new file mode 100644 index 00000000000..3192dde69ec --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/transpiler_service.mdx @@ -0,0 +1,22 @@ +--- +title: transpiler_service (v0.7) +description: API reference for qiskit_ibm_transpiler.transpiler_service in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_transpiler.transpiler_service +--- + + + + + +# Qiskit IBM Transpiler + +`qiskit_ibm_transpiler.transpiler_service` + +## Classes + +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | +| [`TranspilerService`](qiskit_ibm_transpiler.transpiler_service.TranspilerService "qiskit_ibm_transpiler.transpiler_service.TranspilerService")(optimization\_level\[, ai, ...]) | Class for using the transpiler service. | + diff --git a/docs/api/qiskit-ibm-transpiler/0.7/utils.mdx b/docs/api/qiskit-ibm-transpiler/0.7/utils.mdx new file mode 100644 index 00000000000..5cfab561ac6 --- /dev/null +++ b/docs/api/qiskit-ibm-transpiler/0.7/utils.mdx @@ -0,0 +1,45 @@ +--- +title: utils (v0.7) +description: API reference for qiskit_ibm_transpiler.utils in qiskit-ibm-transpiler v0.7 +in_page_toc_min_heading_level: 2 +python_api_type: module +python_api_name: qiskit_ibm_transpiler.utils +--- + + + + + +# Utilities + +`qiskit_ibm_transpiler.utils` + +## Functions + +### create\_random\_linear\_function + + + **Parameters** + + * **n\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + * **seed** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – + + **Return type** + + [*LinearFunction*](/api/qiskit/qiskit.circuit.library.LinearFunction "(in Qiskit v1.2)") + + +### get\_metrics + + + Returns a dict with metrics from a QuantumCircuit + + **Parameters** + + **qc** ([*QuantumCircuit*](/api/qiskit/qiskit.circuit.QuantumCircuit "(in Qiskit v1.2)")) – + + **Return type** + + [*Dict*](https://docs.python.org/3/library/typing.html#typing.Dict "(in Python v3.13)")\[[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.13)"), [int](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")] + + diff --git a/public/api/qiskit-ibm-transpiler/0.7/objects.inv b/public/api/qiskit-ibm-transpiler/0.7/objects.inv new file mode 100644 index 0000000000000000000000000000000000000000..172046e4303e8051f4a60d312a06a69a382fbba7 GIT binary patch literal 933 zcmV;W16uqeAX9K?X>NERX>N99Zgg*Qc_4OWa&u{KZXhxWBOp+6Z)#;@bUGkWX>)67 zbRbDWO(0ZqVQzD9X>4V33L_v^WpZ8b#rNMXCQiPX<{x4c-pO)L2sKd6vyxR6qdTfdVsdl zq)EMXohC)vq-@>J$c2~I8kp2JUHk2)kdR<(er@Ukp1=}@FaapxZQTJLE>%CXovWMfFec@Qe zCon|=Mu}1f^L!(!w$xW#Fm0;asx7zDal!7E>|@Bi%R@}a3f{)a-M}uGiN_{82HD+e z$rP+Xfh^%r!XxIWp6Be(zBpTc`N574DAcT*KQ_O6U?bRW;ExftFamU_W`Eh`BJkV& z?Oo@e^H2R9_}Z45trWZp__xred(>B?Wo-l`fmAC6)GXB&dyIHBnPk~-aq5ZKeGe;C<^wKpL&VdXqyvv}0&DB29FiZk*b HUen!M&tb%U literal 0 HcmV?d00001 diff --git a/scripts/config/historical-pages-to-latest.json b/scripts/config/historical-pages-to-latest.json index 5b6cefad308..e07f17b2816 100644 --- a/scripts/config/historical-pages-to-latest.json +++ b/scripts/config/historical-pages-to-latest.json @@ -19284,7 +19284,8 @@ "qiskit_transpiler_service.transpiler_service.TranspilerService": "/qiskit_ibm_transpiler.transpiler_service.TranspilerService" }, "0.5": {}, - "0.6": {} + "0.6": {}, + "0.7": {} }, "qiskit-addon-aqc-tensor": {}, "qiskit-addon-obp": {}, From 209c0037a126bf3760c70260f2c4a19940f5a24f Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Wed, 13 Nov 2024 14:55:07 -0500 Subject: [PATCH 3/3] Generate 0.8 --- docs/api/qiskit-ibm-transpiler/_package.json | 2 +- ..._ibm_transpiler.ai.AICliffordSynthesis.mdx | 6 +- ...ranspiler.ai.AILinearFunctionSynthesis.mdx | 6 +- ...m_transpiler.ai.AIPermutationSynthesis.mdx | 6 +- .../qiskit_ibm_transpiler.ai.AIRouting.mdx | 4 +- ...kit_ibm_transpiler.ai.CollectCliffords.mdx | 4 +- ...m_transpiler.ai.CollectLinearFunctions.mdx | 4 +- ..._ibm_transpiler.ai.CollectPermutations.mdx | 4 +- ...r.transpiler_service.TranspilerService.mdx | 4 +- .../qiskit-ibm-transpiler/release-notes.mdx | 143 +++++++----------- docs/api/qiskit-ibm-transpiler/utils.mdx | 4 +- public/api/qiskit-ibm-transpiler/objects.inv | Bin 933 -> 931 bytes scripts/config/api-html-artifacts.json | 1 + 13 files changed, 81 insertions(+), 107 deletions(-) diff --git a/docs/api/qiskit-ibm-transpiler/_package.json b/docs/api/qiskit-ibm-transpiler/_package.json index 69973f6d590..fbe95439333 100644 --- a/docs/api/qiskit-ibm-transpiler/_package.json +++ b/docs/api/qiskit-ibm-transpiler/_package.json @@ -1,4 +1,4 @@ { "name": "qiskit-ibm-transpiler", - "version": "0.7.4" + "version": "0.8.1" } diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx index bb51e0a65c4..b29bdf101b9 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AICliffordSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis # AICliffordSynthesis - + Bases: `AISynthesis` Synthesis for Clifford circuits (blocks of H, S and CX gates). Currently up to 9 qubit blocks. @@ -53,7 +53,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis ### synth\_nodes - + ### update\_status diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx index ae3b11a0dc3..33f3fe06cf2 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis # AILinearFunctionSynthesis - + Bases: `AISynthesis` Synthesis for Linear Function circuits (blocks of CX and SWAP gates). Currently up to 9 qubit blocks. @@ -53,7 +53,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis ### synth\_nodes - + ### update\_status diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx index d1219bebd55..3bab0343692 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIPermutationSynthesis.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis # AIPermutationSynthesis - + Bases: `AISynthesis` Synthesis for Permutation circuits (blocks of SWAP gates). Currently available for 65, 33, and 27 qubit blocks. @@ -53,7 +53,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis ### run - + Run a pass on the DAGCircuit. This is implemented by the pass developer. **Parameters** @@ -67,7 +67,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis ### synth\_nodes - + ### update\_status diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx index 0206a06458e..d182f1715b6 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.AIRouting.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting # AIRouting - + Bases: [`TransformationPass`](/api/qiskit/qiskit.transpiler.TransformationPass "(in Qiskit v1.2)") The AIRouting pass acts both as a layout stage and a routing stage. @@ -54,7 +54,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIRouting ### run - + Run the AIRouting pass on dag. **Parameters** diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx index d01660c8cea..9b48de75af8 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectCliffords.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords # CollectCliffords - + Bases: `RepeatedCollectAndCollapse` Collects Clifford blocks as Instruction objects and stores the original sub-circuit to compare against it after synthesis. @@ -55,7 +55,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectCliffords ### run - + Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit **Returns** diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx index dc5d935200e..75469f9bd92 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectLinearFunctions.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions # CollectLinearFunctions - + Bases: `RepeatedCollectAndCollapse` Collects blocks of SWAP and CX as LinearFunction objects and stores the original sub-circuit to compare against it after synthesis. @@ -55,7 +55,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectLinearFunctions ### run - + Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit **Returns** diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx index 090ddd33df9..88801989b8d 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.ai.CollectPermutations.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations # CollectPermutations - + Bases: `RepeatedCollectAndCollapse` Collects blocks of SWAP circuits as Permutations. @@ -55,7 +55,7 @@ python_api_name: qiskit_ibm_transpiler.ai.CollectPermutations ### run - + Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit **Returns** diff --git a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx index ff406b907f9..ef11a9fadce 100644 --- a/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx +++ b/docs/api/qiskit-ibm-transpiler/qiskit_ibm_transpiler.transpiler_service.TranspilerService.mdx @@ -8,7 +8,7 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService # TranspilerService - + Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)") Class for using the transpiler service. @@ -28,7 +28,7 @@ python_api_name: qiskit_ibm_transpiler.transpiler_service.TranspilerService ### run - + Transpile the circuit(s) by calling the service /transpile endpoint. **Parameters** diff --git a/docs/api/qiskit-ibm-transpiler/release-notes.mdx b/docs/api/qiskit-ibm-transpiler/release-notes.mdx index 8d56f1fcf80..6c8fda0a057 100644 --- a/docs/api/qiskit-ibm-transpiler/release-notes.mdx +++ b/docs/api/qiskit-ibm-transpiler/release-notes.mdx @@ -10,45 +10,20 @@ in_page_toc_max_heading_level: 2 -## 0.7.4 (2024-11-11) +## 0.8.0 (2024-11-13) ### New features +* In case of failure, always retry the GET request to retrieve a result unitl the timeout is reached. Increase the delay between requests to 5 seconds when we are over 1 minute. Retry transpilation POST request three times in case of failure. ([97](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/97)) * Use QPY as exchange format with service ([104](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/104)) - - - -## 0.7.3 (2024-11-06) - - - -### New features - * Retry http requests after any RequestException ([111](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/111)) +* Add Pauli Network synthesis pass. ([112](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/112)) - - -## 0.7.2 (2024-10-31) - -### Bug fixes - -* Added fix to avoid random test errors. Check that result exists when result is success. ([105](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/105)) - - - -## 0.7.1 (2024-10-30) - - - -### New features - -* In case of failure, always retry the GET request to retrieve a result unitl the timeout is reached. Increase the delay between requests to 5 seconds when we are over 1 minute. Retry transpilation POST request three times in case of failure. ([97](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/97)) - - + ## 0.7.0 (2024-09-18) - + ### New features @@ -60,21 +35,19 @@ in_page_toc_max_heading_level: 2 * Removes unneeded benchmark method ([81](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/81)) * Adds test to verify that a circuit with a barrier will be transpiled ([84](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/84)) - + ## 0.6.1 (2024-09-17) - - ### Bug fixes * Fixes a bug with ECR gates coming from Qiskit when parsing using OpenQASM2 ([74](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/74)) - + ## 0.6.0 (2024-09-16) - + ### New features @@ -84,44 +57,44 @@ in_page_toc_max_heading_level: 2 * Enabling coupling\_map as options to the AI Synthesis passes ([70](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/70)) - + ### Bug fixes * Keep trying to get results even in case of HTTPError exception with status 520 ([52](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/52)) * Fixing the type of ECR gates when loading circuits from the Qiskit Transpiler Service ([63](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/63)) - + ## 0.5.3 (2024-09-17) - + ### Bug fixes * Fixes a bug with ECR gates coming from Qiskit when parsing using OpenQASM2 ([74](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/74)) - + ## 0.5.2 (2024-09-12) - + ### Bug fixes * Fixing the type of ECR gates when loading circuits from the qiskit transpiler service ([63](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/63)) - + ## 0.5.1 (2024-08-29) - + ### Bug fixes * Keep trying getting result even in case of HTTPError exception with status 520 ([52](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/52)) - + ## 0.5.0 (2024-08-27) @@ -129,47 +102,47 @@ in_page_toc_max_heading_level: 2 * Rename package to `qiskit-ibm-transpiler` ([43](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/43)) - + ## 0.4.10 (2024-09-17) - + ### Bug fixes * Fixes a bug with ECR gates coming from Qiskit when parsing using OpenQASM2 ([77](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/77)) - + ## 0.4.9 (2024-09-12) - + ### Bug fixes * Fixing the type of ECR gates when loading circuits from the qiskit transpiler service ([64](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/64)) - + ## 0.4.8 (2024-08-29) - + ### Bug fixes * Keep trying getting result even in case of HTTPError exception with status 520 ([54](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/54)) - + ## 0.4.7 (2024-08-27) - + ### Bug fixes * Add stacklevel to DeprecationWarning so it appears in Jupyter notebooks ([49](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/49)) - + ## 0.4.6 (2024-08-23) @@ -177,179 +150,179 @@ in_page_toc_max_heading_level: 2 * Add deprecation notice in preparation for project rename to `qiskit-ibm-transpiler` ([40](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/40)) - + ### Bug fixes * Forward incoming error when decoding fails ([36](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/36)) - + ## 0.4.5 (2024-08-01) - + ### New features * Enable programmatic config of polling timeout ([28](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/28)) - + ### Bug fixes * Using the declared `ai_layout_mode` in the TranspilerService’s run method ([25](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/25)) - + ## 0.4.4 (2024-07-25) - + ### Upgrade notes * Increasing timeout to 600s instead of 120s ([21](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/21)) - + ### New features * Expose service errors to users ([8](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/8)) * Configure logging for a library ([10](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/10)) - + ### Bug fixes * Correctly parse string boolean for ai param ([7](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/7)) - + ## 0.4.3 (2024-06-07) - + ### Upgrade notes * Check existence of credentials and raise related exceptions instead of breaking - + ## 0.4.2 (2024-06-07) - + ### Bug fixes * Python 3.8 support. Back to specify types with typing * Fixing some import errors for local modules - + ### Other notes * Relaxing pin of local dependencies - + ## 0.4.1 (2024-06-06) - + ### Upgrade notes * Updating logs levels - + ### Bug fixes * Rebuild layout in transpiled circuit * Avoid barrier nodes in collection - + ### Other notes * Refactoring the extension code - + ## 0.4.0 (2024-05-28) - + ### Upgrade notes * Updating Clifford service URL * Replace `use_ai` by `ai` param in requests - + ### New features * Request the synthesis of a list of circuits to the service. * Adding docstrings for public documentation - + ### Bug fixes * Adjust dependencies to be less strict and support minor version updates for qiskit & patch updates for qiskit-qasm3-import - + ### Other notes * Move type hints in documentation. * Set name to logger - + ## 0.3.0 (2024-02-29) - + ### Upgrade notes * Updating the plugin to use Qiskit 1.0 by default - + ### Bug fixes * Supporting measurements in circuits when transpiling using `ai=true` option - + ## 0.2.1 (2024-02-22) - + ### New features * Add multithreading to synth requests. The requests to the service for transpile and transpile now are done in parallel. - + ### Upgrade notes * Updated collection passes. Now the passes could work up to N of qubits or with any block size of qubits. - + ## 0.2.0 (2024-02-12) - + ### New features * Added support for synthesis and transpilation of Clifford, Permutation and Linear Function circuits. Using new URLs for the service. - + ## 0.1.3 (2023-12-11) - + ### Bug fixes @@ -357,7 +330,7 @@ in_page_toc_max_heading_level: 2 * Fixing hardcoded input to routing * Fix bug in input and refactor - + ## 0.1.2 (2023-12-04) diff --git a/docs/api/qiskit-ibm-transpiler/utils.mdx b/docs/api/qiskit-ibm-transpiler/utils.mdx index fec4039064c..8ba185e71fb 100644 --- a/docs/api/qiskit-ibm-transpiler/utils.mdx +++ b/docs/api/qiskit-ibm-transpiler/utils.mdx @@ -18,7 +18,7 @@ python_api_name: qiskit_ibm_transpiler.utils ### create\_random\_linear\_function - + **Parameters** * **n\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – @@ -31,7 +31,7 @@ python_api_name: qiskit_ibm_transpiler.utils ### get\_metrics - + Returns a dict with metrics from a QuantumCircuit **Parameters** diff --git a/public/api/qiskit-ibm-transpiler/objects.inv b/public/api/qiskit-ibm-transpiler/objects.inv index 172046e4303e8051f4a60d312a06a69a382fbba7..fd777ad16e6bc1928cb9608e408917dfa2e88ff5 100644 GIT binary patch delta 796 zcmV+%1LORq2crj&lz+FWx2)BqNSoBH+Znm=(pm$P+NNv2{S*=sjBWg$lN&Pp-|q!} zHV&^s{}rYXPfcMImwF>=P&pTD^Ksj>RaXPMW?WqCj$(s|PeSexrRGmx*Zo@>L-X0aQ ztw5)9$3=+zZc}jsg*M!DCv;$!neE}bkigZqPL@WrlB#kjor0ul9Vmm7JJbV3@lXSC z(L;2C?jd+o`Vc!o{ZJ3+2@vWfX&QvOAxwq`P)%oe%1rP^$uR01@YTRg056?lzZV@> z-^(R<@5M%?_kU6ojQ7&fx_i4wa^2epLG)j3XM}u4x;YWAHzvIFesi5fVi4N zb%KpU@u+}9?WCtYP|y$fuB~e*&9E`Rtzk}x0H8hfX&UqJ9U|TV2NzSpVWEw1P!Ta4 zQi2~2ld6gR;v~s3jgnzW;!J7~^qJDh5>3%am8M*(P=8Y_POB+3U9Ksgs@Uj#Me@ta z(J)D7jSCR8vbbcYEGSYai%7M}0^(G%cjLS5 z{j(-J-?UNtU5RHyn4P*K)Q27J?3c3ae4on3#OP;@?A+fq#`O9Bk=gnFNFEOh4eCvl zV13GTPk+ZhZMvEK_hIPq2$^5PQB_W90lDa5O3f~Toe{ORZfZXgzmNT8d8uH##wjkV zwkhgft75(PYFqYje6uectN0A2Xuv2@>R_I4MAer1iVLPqbz8ONRyr=&a>YJ}+`Bx) zgsk9woZJoUf|+<~vSW}fA687k8WhM94kbKdj(_TT&i?F+v(?uh?D&8}&ARzx^ScK& zg6#(W7*Pu&K!F>aOTWa>8;7!24g*M%jz9KDaBOoc~8H?jX zs~fI~P&#-f-jH|A!*%10`iJ9v46ijDdbs*<6azTh5Ddo&O$U(F=}v^eo<{w{$UdyS a2^FCUE9V)T#iL$F(PmIpoRR-lligX20gf;L delta 798 zcmV+(1L6Fm2c-v)lz-BsNxgNQCPmt$Y~9Ytg_qVEnAA31`|YQYkYH@%_nh32;s1Uw z@UwAv5&Ew%g?MZVqqx)?QG?34V4L^brmeaf*frzgVt1T=!3VmT8m>OA=>NgP_lpPL^njMyfRBQh$Y-VsTncsp)b}`BcS5?<sCt}&+1|BuYh_eb)0SZGkM zq6F(xrhj`n{%O+ci#c zS+z}3_gWR}y;s|^hvS=l;aJ5dFhv7KiBbpid?Tv1)K^?EZK~UB?Wo-l`fmAC6)GXB&dyIHBnPk~-aq5ZKeGe;C<^ cwHG%bG-2gDW3zbF>nPd`s){r6A70blTSSAB>i_@% diff --git a/scripts/config/api-html-artifacts.json b/scripts/config/api-html-artifacts.json index cb8223f3dbc..32bd6d4b3be 100644 --- a/scripts/config/api-html-artifacts.json +++ b/scripts/config/api-html-artifacts.json @@ -52,6 +52,7 @@ "0.14": "https://ibm.box.com/shared/static/t37e7jjsi0hii4j3xoorwpwso5m03jqn.zip" }, "qiskit-ibm-transpiler": { + "0.8": "https://ibm.box.com/shared/static/saqoas2nqzp460lzo9lon8ia79w6dkax.zip", "0.7": "https://ibm.box.com/shared/static/6gl56swiujb79zlwjsrnqozjhw8bp3un.zip", "0.6": "https://ibm.box.com/shared/static/oaon22ismcdep31qbw7zz2f04b9ej2fw.zip", "0.5": "https://ibm.box.com/shared/static/kg4rp8mkkw7ydruz8fvemvfu7aqomy83.zip",