From 1d37e9f097e42ab63db6537d3add2f27411df9fe Mon Sep 17 00:00:00 2001 From: Arnau Casau <47946624+arnaucasau@users.noreply.github.com> Date: Wed, 18 Dec 2024 16:45:44 +0100 Subject: [PATCH] Generate qiskit-ibm-transpiler 0.9.3 API docs (#2503) This PR generates the docs for qiskit-ibm-transpiler v0.9.3 ```bash npm run gen-api -- -p qiskit-ibm-transpiler -v 0.9.3 ``` --- docs/api/qiskit-ibm-transpiler/_package.json | 2 +- ..._ibm_transpiler.ai.AICliffordSynthesis.mdx | 2 +- ...ranspiler.ai.AILinearFunctionSynthesis.mdx | 2 +- ...m_transpiler.ai.AIPermutationSynthesis.mdx | 2 +- .../qiskit-ibm-transpiler/release-notes.mdx | 188 +++++++++--------- public/api/qiskit-ibm-transpiler/objects.inv | Bin 1087 -> 1087 bytes 6 files changed, 103 insertions(+), 93 deletions(-) diff --git a/docs/api/qiskit-ibm-transpiler/_package.json b/docs/api/qiskit-ibm-transpiler/_package.json index 53ee715f552..f79bfd4372d 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.9.2" + "version": "0.9.3" } 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 893f8bb8c7d..46b2cd97d38 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 @@ -76,7 +76,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AICliffordSynthesis **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – the dag on which the pass is run. + **dag** (*DAGCircuit*) – the dag on which the pass is run. **Raises** 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 268ff2cba8a..719470e7f30 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 @@ -76,7 +76,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AILinearFunctionSynthesis **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – the dag on which the pass is run. + **dag** (*DAGCircuit*) – the dag on which the pass is run. **Raises** 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 eacf9500540..d0087e68ced 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 @@ -76,7 +76,7 @@ python_api_name: qiskit_ibm_transpiler.ai.AIPermutationSynthesis **Parameters** - **dag** ([*DAGCircuit*](/api/qiskit/qiskit.dagcircuit.DAGCircuit "(in Qiskit v1.3)")) – the dag on which the pass is run. + **dag** (*DAGCircuit*) – the dag on which the pass is run. **Raises** diff --git a/docs/api/qiskit-ibm-transpiler/release-notes.mdx b/docs/api/qiskit-ibm-transpiler/release-notes.mdx index 3d34746d113..f01af64111d 100644 --- a/docs/api/qiskit-ibm-transpiler/release-notes.mdx +++ b/docs/api/qiskit-ibm-transpiler/release-notes.mdx @@ -10,23 +10,31 @@ in_page_toc_max_heading_level: 2 +## 0.9.3 (2024-12-18) + +### Other notes + +* Pin qiskit\_ibm\_ai\_local\_transpiler version to 0.1.4 and Qiskit to \<1.3 ([149](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/149)) + + + ## 0.9.2 (2024-12-12) ### Bug fixes * Pin qiskit\_ibm\_ai\_local\_transpiler version to 0.1.3 ([145](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/145)) - + ## 0.9.1 (2024-11-15) - + ### Bug fixes * Fix optimization\_preferences\` used in generate\_ai\_pass\_manager method. Adding related tests ([130](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/130)) - + ## 0.9.0 (2024-11-14) @@ -34,32 +42,32 @@ in_page_toc_max_heading_level: 2 * Adding local mode for routing, permutations, linear functions and cliffords. ([125](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/125)) - + ## 0.8.2 (2024-11-13) - + ### 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)) * Fix pauli better circuit replacement. ([122](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/122)) - + ## 0.8.1 (2024-11-13) - + ### New features * Updating the README to reflect the availability of the AIPauliNetworkSynthesis feature. ([121](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/121)) - + ## 0.8.0 (2024-11-13) - + ### New features @@ -68,117 +76,119 @@ in_page_toc_max_heading_level: 2 * 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.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)) * Adds iterative decomposition to Qasm3 export. ([85](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/85)) + + ### Other notes * 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.5 (2024-11-11) - + ### New features * Use QPY as exchange format with service ([104](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/104)) - + ## 0.6.4 (2024-11-07) - + ### New features * Retry http requests after any RequestException ([111](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/111)) - + ## 0.6.3 (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.6.2 (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.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 @@ -188,84 +198,84 @@ 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.7 (2024-11-11) - + ### New features * Use QPY as exchange format with service ([104](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/104)) - + ## 0.5.6 (2024-11-07) - + ### New features * Retry http requests after any RequestException ([111](https://github.com/Qiskit/qiskit-ibm-transpiler/pull/111)) - + ## 0.5.5 (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.5.4 (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.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) @@ -273,47 +283,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) @@ -321,179 +331,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 @@ -501,7 +511,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/public/api/qiskit-ibm-transpiler/objects.inv b/public/api/qiskit-ibm-transpiler/objects.inv index 6bd1d0071af3b5cb9e84fb8a62ee51103e0d430c..6e7ff2abe0157a018f4bc15fd64fa8e37581c4df 100644 GIT binary patch delta 968 zcmV;(12_D?2)_uBg@3_sn=ll{@BJ%~y2E-PZMD;S>pD$}v`O8%oskPpYmGo^o38!u z2P7oee#Y+^E|u%>-tQyv_hH~gsJ}vI;&Gd4$ttxIC6_BElHL2wwl12ICszp*=lgN` zAxY0(JSD5!^<618n_3nR@0EV$N~o?)UNWVU>x5KC!>srl&wm@ud(~V&*9DPxJ~SY5 zh00jP%J+7h?Yh%!1u(6pc;M zT``fTx=~iu1y}LhaT6lH*%eIlOlhW@84AoclN!E@iZl7Gsq$`FPz~>^jzLn*?`eaJ z0H1~#LEzIvi+_U&Ve>*^LLNC9d?G0U;nNe22_Kyh7Cv||GJNca;P7cc$A?c#REYT0 z5TfLs%Wb1sOpbu1WEeF;pdPsR0O>Qb15`o_4xglXso@hwjto#9B`-iF;jjR?groqm z!I%K45g7r}(E$Ofh)M@g2O%1M)r}U_6EY2kqcJV1o_{}-;cPxIW;lD`(abyo&-3pH zPqyqJg5uJF7dGb5o#4fxdC-1C@2IstP|(Z!t}aWS>tP#?yXHAX1ORQ#+trw*?+~LM z;Ls^XfMm?^10;rM3r7;(9S%KY5{HHMih~MR#vw&G$6-2vL6D}RYF86ar^s{z8|3}?$D+s;;kG@s3-TF}PgjA&Ei?P&9XqYH3 zjvEk+XmIDc(9jTJL0ilM{<9^;na>bLcAlXDX*+{R^_&638P4FvyUie@t(NbL+oFlR zWV+C1(uH}iyXm4AUKb2!OS)XR$isaAa08moy?+B$$2;oD_hspFFU-co;A8uA>F4%i z`t*~&bh$@;r(veJd=)u2UTC@>hhK2IHLKspsfQC}`a*~5GDiY3^f0X^Bd}fPr82(M zekS}q_J^%<$-9her;B=qZMV+flCK9EK zn}2rPExPu<+ja8MxArcMWuhwh+qiN+u`f*9!t_*_+}^Jf$v0f`D(A-*z``8$13vxP zH&51Iek7+K$S2mVKZ)P}U?bRm;!pcmXu*}QXMfnmndjVLc~`5?t55wm@U=xJ_maN~ z{_jlb=22aeVr>K@)d6#1yf58wB7D`}PeHfWA4eg8vkk#; qoFaPyNws$(1h!oYPa}00dlP~PqYjvx#G@`pK{2Q<&dh(w|NcM77v>%S delta 968 zcmV;(12_D?2)_uBg@0dfn=ll`-}@;nbr0(UX}h=et?M)?(k6B5_KX~GT5DiZ+jPyh zpCBQ@|M0zrH{@{d?*x2~4ZL#om+PEw>Rd}I)Q(q7t|%wF{axLZZNcUH8T^?$0FerZZ1?{a8>A)qxmoIUVxW*&j(`FDgz zTXqnEap}N|8*}K6@Z!)sYQLd((p(=X;OYI)R23`qunmW;c}@`mfSdDnHDu~L#AF9J zbc_*vGUoWfCkAN?M-to}4n1ZPhXwYEgNj(jAtgA+VPXwrZb4BtvP;phBuiO65XQ3U zbM0j-Nq;bzN74dT^9V~boGlM+J6j3Rd^Q(rK^qG*qD@V=qs_;faj{?F=H;a|RG*ID?n&HiHbdT5%}mjhNU= zW(#d5U0874%@$pFU9dk}vgN`>9-jj|51`rHCx1|NdZM2EUY0HQ!E8*7zP8Vnes4df zPrvEQmV4EAKFk%9Z@gf}2Tk|q_yfJcu47o%VCdoO(@_lIY(pR% qr^p@vQth1xf^C=jhk-hby$M2uQRf+(#DkWjs2ETeXXHP{-u^x@2GH{W