From f99b2794205fb3ebe66e41881214259f3b822c41 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 31 Jan 2024 13:17:58 -0500 Subject: [PATCH 01/20] fix formatting and consolidate notes --- .../0.5/experiment_data_fixes-f69c3569a8ba1342.yaml | 10 +++++----- .../notes/0.5_deprecations-4188ada026cb682b.yaml | 3 --- ...cess_figure_without_extension-5b7438c19e223d6b.yaml | 4 ++-- ...lses-amp-angle-representation-f5c40007416cf938.yaml | 2 +- .../notes/broadcasting-option-8a3b72bfc1df9668.yaml | 2 +- .../notes/circuit-count-method-a095bd74aaa1d2fb.yaml | 6 ++---- .../drop_python_3_7_support-0529a7122e94b004.yaml | 2 +- .../notes/dump-terra-0_24-47c5d4fb92f1d97b.yaml | 6 ------ .../notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml | 2 +- 9 files changed, 13 insertions(+), 24 deletions(-) delete mode 100644 releasenotes/notes/dump-terra-0_24-47c5d4fb92f1d97b.yaml diff --git a/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml b/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml index 8d876e9ef6..44df56dd33 100644 --- a/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml +++ b/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml @@ -8,19 +8,19 @@ features: :meth:`.ExperimentData.get_service_from_provider` enabling the automatic setting of the experiment database service via passing the provider. - | - The `start_datetime`property of :class:`.ExperimentData`is now being + The ``start_datetime`` property of :class:`.ExperimentData` is now being set to the time the experiment data was created. - | - The `end_datetime` property of :class:`.ExperimentData` is now being + The ``end_datetime`` property of :class:`.ExperimentData` is now being set to the latest time a successful job terminated. - | - The `creation_datetime` and `updated_datetime` properties of :class:`.ExperimentData` + The ``creation_datetime`` and ``updated_datetime`` properties of :class:`.ExperimentData` are now being read from the server when saving the experiment. - | - All the datetime properties are stored in UTC and converted to local when using getters. + All the datetime properties are now stored in UTC and converted to local time when using getters. - | :meth:`.ExperimentData.save` can now raise exceptions when saving - fails, unless the `suppress_errors` flag is set (on by default) + fails, unless the ``suppress_errors`` flag is set (on by default). fixes: diff --git a/releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml b/releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml index 085add3d87..12e3da55df 100644 --- a/releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml +++ b/releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml @@ -12,9 +12,6 @@ upgrade: * Curve fit solvers ``curve_fit()`` and ``multi_curve_fit()`` as well as fit functions ``bloch_oscillation_x()``, ``bloch_oscillation_y()``, and ``bloch_oscillation_z()`` have been removed. Use the LMFIT library instead. - * The scipy lstsq tomography fitters ``scipy_linear_lstsq`` and ``scipy_gaussian_lstsq`` have - been removed. Use the `linear_lstsq`, `cvxpy_linear_lstsq`, or `cvxpy_gaussian_lstsq` fitter - instead. * The ``flat_top_widths`` argument and experiment option of the :class:`.CrossResonanceHamiltonian` experiment and its subclass have been removed. Use ``durations`` instead. diff --git a/releasenotes/notes/access_figure_without_extension-5b7438c19e223d6b.yaml b/releasenotes/notes/access_figure_without_extension-5b7438c19e223d6b.yaml index bb7d34a29d..545c8ac0c3 100644 --- a/releasenotes/notes/access_figure_without_extension-5b7438c19e223d6b.yaml +++ b/releasenotes/notes/access_figure_without_extension-5b7438c19e223d6b.yaml @@ -1,4 +1,4 @@ --- -upgrade: +feature: - | - Figures in `ExperimentData` objects can now be accessed without '.svg' extension. \ No newline at end of file + Figures in :class:`.ExperimentData` objects can now be accessed without the ``.svg`` extension. \ No newline at end of file diff --git a/releasenotes/notes/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml b/releasenotes/notes/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml index c131f3f9df..2393331895 100644 --- a/releasenotes/notes/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml +++ b/releasenotes/notes/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml @@ -18,7 +18,7 @@ other: upgrade: - | The representation of pulses in the :class:`.FixedFrequencyTransmon` library - was changed from complex amplitude to (``amp``,``angle``) representation. All pulses + was changed from complex amplitude to (``amp``, ``angle``) representation. All pulses now include an ``angle`` parameter, and the default values of ``amp`` are set as type ``float`` instead of ``complex``. - | diff --git a/releasenotes/notes/broadcasting-option-8a3b72bfc1df9668.yaml b/releasenotes/notes/broadcasting-option-8a3b72bfc1df9668.yaml index e99e7a1b8e..d6deb84dd4 100644 --- a/releasenotes/notes/broadcasting-option-8a3b72bfc1df9668.yaml +++ b/releasenotes/notes/broadcasting-option-8a3b72bfc1df9668.yaml @@ -1,7 +1,7 @@ --- features: - | - Added a `broadcast` option to the :class:`.CompositeAnalysis`. When `broadcast=True` is passed, + Added a ``broadcast`` option to :class:`.CompositeAnalysis`. When ``broadcast=True`` is passed, this option will be applied to child experiment analyses within the class. This means it will iterate through the child analysis classes and apply the given option to each of them. diff --git a/releasenotes/notes/circuit-count-method-a095bd74aaa1d2fb.yaml b/releasenotes/notes/circuit-count-method-a095bd74aaa1d2fb.yaml index d8080ae02b..72ce129e04 100644 --- a/releasenotes/notes/circuit-count-method-a095bd74aaa1d2fb.yaml +++ b/releasenotes/notes/circuit-count-method-a095bd74aaa1d2fb.yaml @@ -3,9 +3,7 @@ features: - | A new method :meth:`BaseExperiment.job_info` has been added that will output the number of jobs the experiment is expected to be split into - based on the provided backend. - - | - Refer to issue - `#1247 https://github.com/Qiskit-Extensions/qiskit-experiments/issues/1247` + based on the provided backend. Refer to issue + `#1247 `_ for more details. \ No newline at end of file diff --git a/releasenotes/notes/drop_python_3_7_support-0529a7122e94b004.yaml b/releasenotes/notes/drop_python_3_7_support-0529a7122e94b004.yaml index 26b6c1bf82..6af8ef7962 100644 --- a/releasenotes/notes/drop_python_3_7_support-0529a7122e94b004.yaml +++ b/releasenotes/notes/drop_python_3_7_support-0529a7122e94b004.yaml @@ -1,4 +1,4 @@ --- upgrade: - | - Dropped support for Python 3.7. + Dropped support for Python 3.7 and added support for Python 3.12. diff --git a/releasenotes/notes/dump-terra-0_24-47c5d4fb92f1d97b.yaml b/releasenotes/notes/dump-terra-0_24-47c5d4fb92f1d97b.yaml deleted file mode 100644 index ae281833b2..0000000000 --- a/releasenotes/notes/dump-terra-0_24-47c5d4fb92f1d97b.yaml +++ /dev/null @@ -1,6 +0,0 @@ ---- -upgrade: - - | - The minimal required Qiskit-Terra version was bumped to 0.24. This version enables - new pulse amplitude representation of (``amp``, ``angle``) pair - and improved user-communication for deprecated functionalities. diff --git a/releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml b/releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml index f2b29811b4..9f8a4b59e5 100644 --- a/releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml +++ b/releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml @@ -5,7 +5,7 @@ upgrade: ``qiskit``. This change follows the move in upstream Qiskit to rename ``qiskit-terra`` to ``qiskit``. The minimum required version was increased from 0.24 for ``qiskit-terra`` to 0.44 for ``qiskit`` (equivalent to - `qiskit-terra`` 0.25). The maximum ``qiskit`` version was set to ``<1.0`` + ``qiskit-terra`` 0.25). The maximum ``qiskit`` version was set to ``<1.0`` in anticipation of breaking changes in Qiskit 1.0. Closer to the Qiskit 1.0 release, a patch release of ``qiskit-experiments`` will remove this constraint and address any compatibility issues. For more information see From 12f9d25a9238e258ad35005daf6fe442e5276167 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Thu, 1 Feb 2024 01:14:32 -0500 Subject: [PATCH 02/20] more formatting fixes --- releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml | 4 ++-- .../add_warning_analysis_without_data-bfc802da52591f13.yaml | 2 +- releasenotes/notes/attach-other-cals-2f539e7799ceb6c8.yaml | 4 ++-- releasenotes/notes/bugfix_expdata_copy-2c73a21ad720858d.yaml | 2 +- .../experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml | 4 ++-- releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml | 4 ++-- releasenotes/notes/rabi-and-qv-bugfix-34636baee6651af1.yaml | 4 ++-- releasenotes/notes/remove-tomo-reset-3f21ec4d0dacba91.yaml | 4 ++-- .../notes/runtime-provider-support-5358b72ec0035419.yaml | 5 ++++- 9 files changed, 18 insertions(+), 15 deletions(-) diff --git a/releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml b/releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml index 12e3da55df..1288938541 100644 --- a/releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml +++ b/releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml @@ -7,8 +7,8 @@ upgrade: allowed. Use ``physical_qubits`` keyword argument with a sequence type input. * The ``scipy_linear_lstsq`` and ``scipy_gaussian_lstsq`` fitters for the :class:`.StateTomographyAnalysis` and :class:`.ProcessTomographyAnalysis` - classes have been removed. Use the :func:`.linear_lstsq`, :func:`.cvxpy_linear_lstsq`, - or :func:`.cvxpy_gaussian_lstsq` fitters instead. + classes have been removed. Use the :func:`.cvxpy_linear_lstsq` + and :func:`.cvxpy_gaussian_lstsq` fitters instead. * Curve fit solvers ``curve_fit()`` and ``multi_curve_fit()`` as well as fit functions ``bloch_oscillation_x()``, ``bloch_oscillation_y()``, and ``bloch_oscillation_z()`` have been removed. Use the LMFIT library instead. diff --git a/releasenotes/notes/add_warning_analysis_without_data-bfc802da52591f13.yaml b/releasenotes/notes/add_warning_analysis_without_data-bfc802da52591f13.yaml index 986eb7a39e..98d8b8f060 100644 --- a/releasenotes/notes/add_warning_analysis_without_data-bfc802da52591f13.yaml +++ b/releasenotes/notes/add_warning_analysis_without_data-bfc802da52591f13.yaml @@ -1,4 +1,4 @@ --- other: - | - Display a warning when running an analysis on `ExperimentData` objects which do not contain data. \ No newline at end of file + Display a warning when running an analysis on :class:`.ExperimentData` objects which do not contain data. \ No newline at end of file diff --git a/releasenotes/notes/attach-other-cals-2f539e7799ceb6c8.yaml b/releasenotes/notes/attach-other-cals-2f539e7799ceb6c8.yaml index 4eb054ffc1..80b3f73b70 100644 --- a/releasenotes/notes/attach-other-cals-2f539e7799ceb6c8.yaml +++ b/releasenotes/notes/attach-other-cals-2f539e7799ceb6c8.yaml @@ -8,6 +8,6 @@ fixes: - | :class:`.qiskit_experiments.library.FineXDragCal` and :class:`.qiskit_experiments.library.EFRoughXSXAmplitudeCal` were updated to - attach `"sx"` and `"x"` calibrations to their circuits, respectively. - Previously, they only attached the `"x"` and `"x12"` calibrations that they + attach ``"sx"`` and ``"x"`` calibrations to their circuits, respectively. + Previously, they only attached the ``"x"`` and ``"x12"`` calibrations that they were calibrating. See issue `#1158 `_. diff --git a/releasenotes/notes/bugfix_expdata_copy-2c73a21ad720858d.yaml b/releasenotes/notes/bugfix_expdata_copy-2c73a21ad720858d.yaml index cec8f54e99..fd7c9b91d2 100644 --- a/releasenotes/notes/bugfix_expdata_copy-2c73a21ad720858d.yaml +++ b/releasenotes/notes/bugfix_expdata_copy-2c73a21ad720858d.yaml @@ -1,5 +1,5 @@ --- fixes: - | - 'copy' method under ExperimentData class now copies the provider. + The :meth:`.ExperimentData.copy` method under ExperimentData class now copies the provider. \ No newline at end of file diff --git a/releasenotes/notes/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml b/releasenotes/notes/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml index b60fb3e531..9d5586cbaa 100644 --- a/releasenotes/notes/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml +++ b/releasenotes/notes/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml @@ -1,6 +1,6 @@ --- fixes: - | - :meth:`ExperimentData.auto_save` setter no longer saves sub-experiments twice. + The :attr:`ExperimentData.auto_save` setter no longer saves sub-experiments twice. - | - :meth:`ExperimentData.save` now handles correctly figures in sub-experiments when `flatten_results=True` + :meth:`ExperimentData.save` now handles correctly figures in sub-experiments when ``flatten_results=True``. diff --git a/releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml b/releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml index 9f8a4b59e5..30f69c94b0 100644 --- a/releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml +++ b/releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml @@ -11,5 +11,5 @@ upgrade: constraint and address any compatibility issues. For more information see the `Qiskit repository renaming plan `__ - and the `Qiskit issue `__ - for the renaming of the package. + and the `Qiskit 1.0 migration guide `__ + for information on renaming of the package. diff --git a/releasenotes/notes/rabi-and-qv-bugfix-34636baee6651af1.yaml b/releasenotes/notes/rabi-and-qv-bugfix-34636baee6651af1.yaml index b6119d299c..9f5a61d3eb 100644 --- a/releasenotes/notes/rabi-and-qv-bugfix-34636baee6651af1.yaml +++ b/releasenotes/notes/rabi-and-qv-bugfix-34636baee6651af1.yaml @@ -2,9 +2,9 @@ fixes: - | Resolved a serialization issue that affected Rabi experiments when running it through - `qiskit-ibm-provider` using custom amplitudes provided as a numpy array. + the backend provider using custom amplitudes provided as a numpy array. - | - Resolved an issue that caused QV experiments to fail when executed via `qiskit-ibm-provider` using + Resolved an issue that caused QV experiments to fail when executed via the backend provider using Qiskit Terra for calculating ideal probabilities, instead of Aer. - | Resolved a serialization issue that affected DRAG experiments with integral beta values specified. \ No newline at end of file diff --git a/releasenotes/notes/remove-tomo-reset-3f21ec4d0dacba91.yaml b/releasenotes/notes/remove-tomo-reset-3f21ec4d0dacba91.yaml index 702da2cc1b..20786d4dc3 100644 --- a/releasenotes/notes/remove-tomo-reset-3f21ec4d0dacba91.yaml +++ b/releasenotes/notes/remove-tomo-reset-3f21ec4d0dacba91.yaml @@ -4,5 +4,5 @@ other: Removed the reset instruction from the beginning of tomography experiments. Since qubits are usually reset between circuits, this change should have no impact on tomography experiments, but it should allow backends that do not - provide a reset instruction to run tomography experiments. `#1250 - ` + provide a reset instruction to run tomography experiments. See `#1250 + `_. diff --git a/releasenotes/notes/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/runtime-provider-support-5358b72ec0035419.yaml index 8a879f49d7..ac21050a50 100644 --- a/releasenotes/notes/runtime-provider-support-5358b72ec0035419.yaml +++ b/releasenotes/notes/runtime-provider-support-5358b72ec0035419.yaml @@ -8,4 +8,7 @@ upgrade: With the impending deprecation of the ``qiskit-ibm-provider`` package, support for ``qiskit-ibm-provider`` is now deprecated and will be removed in the next release. Users should migrate to ``qiskit-ibm-runtime`` following the - `migration guide `. + `migration guide + `_. + ``qiskit-ibm-runtime`` is not listed as a dependency for compatibility reasons, but users + will need it to run experiments on IBM backends. From 8de4e04e1662b0adf1455565371f7969c2833498 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Thu, 1 Feb 2024 12:01:57 -0500 Subject: [PATCH 03/20] move notes --- .../{ => 0.6}/0.5_deprecations-4188ada026cb682b.yaml | 0 releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml | 9 +++++++++ ...access_figure_without_extension-5b7438c19e223d6b.yaml | 0 .../add-dataframe-analysis-results-ec8863e826a70621.yaml | 0 .../add-dataframe-curve-data-a8905c450748b281.yaml | 0 ...isualization-with-unshared-axis-9f7bfe272353086b.yaml | 0 .../add-test-equality-checker-dbe5762d2b6a967f.yaml | 0 ...d_warning_analysis_without_data-bfc802da52591f13.yaml | 0 ...pulses-amp-angle-representation-f5c40007416cf938.yaml | 0 .../{ => 0.6}/attach-other-cals-2f539e7799ceb6c8.yaml | 0 .../backend-in-rough-frequency-cal-8582610249e2327b.yaml | 0 .../{ => 0.6}/broadcasting-option-8a3b72bfc1df9668.yaml | 0 .../{ => 0.6}/bugfix_expdata_copy-2c73a21ad720858d.yaml | 0 .../{ => 0.6}/cals-no-coupling-map-5114ae9faa2f9e69.yaml | 0 .../{ => 0.6}/circuit-count-method-a095bd74aaa1d2fb.yaml | 0 .../deprecate-flatten-result-false-026a89c09cc7a004.yaml | 0 .../{ => 0.6}/device-component-c9ec9011c529425c.yaml | 0 .../drop_python_3_7_support-0529a7122e94b004.yaml | 0 .../{ => 0.6}/dynamics-requirement-6109a8846c0f88c2.yaml | 0 .../{ => 0.6}/exp-data-pickle-61511b6e926e3198.yaml | 0 ...periment_data_metadata_save_fix-912b7180a28cfb03.yaml | 0 .../experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml | 0 ...-support-calibrations-roundtrip-47f09bd9ff803479.yaml | 0 .../{ => 0.6}/figure_return_SVG-4ad72fc8a3bee3cb.yaml | 0 .../fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml | 0 .../{ => 0.6}/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml | 0 .../notes/{ => 0.6}/half-angle-x-600debac368ce2c6.yaml | 0 .../{ => 0.6}/irb-circuit-order-619845a707519c44.yaml | 0 .../notes/{ => 0.6}/matplotlib-fix-58d938b49771cf17.yaml | 0 .../notes/{ => 0.6}/mod-stark-1f1afb538a94fe9a.yaml | 0 .../params_without_schedule-20555d98875a626b.yaml | 4 ++-- .../plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml | 0 .../{ => 0.6}/qiskit-dependency-3f6b8d71cc4d2c31.yaml | 0 .../notes/{ => 0.6}/qvplotter-04efe280aaa9d555.yaml | 0 .../{ => 0.6}/rabi-and-qv-bugfix-34636baee6651af1.yaml | 0 .../{ => 0.6}/rb-v2-none-coupling-fda2b22afdef507b.yaml | 0 .../{ => 0.6}/remove-tomo-reset-3f21ec4d0dacba91.yaml | 0 .../{ => 0.6}/requirements-extras-d5768794acbce467.yaml | 0 .../runtime-provider-support-5358b72ec0035419.yaml | 0 .../notes/{ => 0.6}/scale_options-745ee6f8e560043f.yaml | 0 .../selective-figure-generation-0864216f34d3486f.yaml | 0 .../setter-methods-for-experiment-099074e59faffb49.yaml | 0 .../{ => 0.6}/update-figure-name-2db258c30ffe9912.yaml | 0 ...upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml | 0 44 files changed, 11 insertions(+), 2 deletions(-) rename releasenotes/notes/{ => 0.6}/0.5_deprecations-4188ada026cb682b.yaml (100%) create mode 100644 releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml rename releasenotes/notes/{ => 0.6}/access_figure_without_extension-5b7438c19e223d6b.yaml (100%) rename releasenotes/notes/{ => 0.6}/add-dataframe-analysis-results-ec8863e826a70621.yaml (100%) rename releasenotes/notes/{ => 0.6}/add-dataframe-curve-data-a8905c450748b281.yaml (100%) rename releasenotes/notes/{ => 0.6}/add-support-for-visualization-with-unshared-axis-9f7bfe272353086b.yaml (100%) rename releasenotes/notes/{ => 0.6}/add-test-equality-checker-dbe5762d2b6a967f.yaml (100%) rename releasenotes/notes/{ => 0.6}/add_warning_analysis_without_data-bfc802da52591f13.yaml (100%) rename releasenotes/notes/{ => 0.6}/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml (100%) rename releasenotes/notes/{ => 0.6}/attach-other-cals-2f539e7799ceb6c8.yaml (100%) rename releasenotes/notes/{ => 0.6}/backend-in-rough-frequency-cal-8582610249e2327b.yaml (100%) rename releasenotes/notes/{ => 0.6}/broadcasting-option-8a3b72bfc1df9668.yaml (100%) rename releasenotes/notes/{ => 0.6}/bugfix_expdata_copy-2c73a21ad720858d.yaml (100%) rename releasenotes/notes/{ => 0.6}/cals-no-coupling-map-5114ae9faa2f9e69.yaml (100%) rename releasenotes/notes/{ => 0.6}/circuit-count-method-a095bd74aaa1d2fb.yaml (100%) rename releasenotes/notes/{ => 0.6}/deprecate-flatten-result-false-026a89c09cc7a004.yaml (100%) rename releasenotes/notes/{ => 0.6}/device-component-c9ec9011c529425c.yaml (100%) rename releasenotes/notes/{ => 0.6}/drop_python_3_7_support-0529a7122e94b004.yaml (100%) rename releasenotes/notes/{ => 0.6}/dynamics-requirement-6109a8846c0f88c2.yaml (100%) rename releasenotes/notes/{ => 0.6}/exp-data-pickle-61511b6e926e3198.yaml (100%) rename releasenotes/notes/{ => 0.6}/experiment_data_metadata_save_fix-912b7180a28cfb03.yaml (100%) rename releasenotes/notes/{ => 0.6}/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml (100%) rename releasenotes/notes/{ => 0.6}/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml (100%) rename releasenotes/notes/{ => 0.6}/figure_return_SVG-4ad72fc8a3bee3cb.yaml (100%) rename releasenotes/notes/{ => 0.6}/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml (100%) rename releasenotes/notes/{ => 0.6}/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml (100%) rename releasenotes/notes/{ => 0.6}/half-angle-x-600debac368ce2c6.yaml (100%) rename releasenotes/notes/{ => 0.6}/irb-circuit-order-619845a707519c44.yaml (100%) rename releasenotes/notes/{ => 0.6}/matplotlib-fix-58d938b49771cf17.yaml (100%) rename releasenotes/notes/{ => 0.6}/mod-stark-1f1afb538a94fe9a.yaml (100%) rename releasenotes/notes/{ => 0.6}/params_without_schedule-20555d98875a626b.yaml (73%) rename releasenotes/notes/{ => 0.6}/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml (100%) rename releasenotes/notes/{ => 0.6}/qiskit-dependency-3f6b8d71cc4d2c31.yaml (100%) rename releasenotes/notes/{ => 0.6}/qvplotter-04efe280aaa9d555.yaml (100%) rename releasenotes/notes/{ => 0.6}/rabi-and-qv-bugfix-34636baee6651af1.yaml (100%) rename releasenotes/notes/{ => 0.6}/rb-v2-none-coupling-fda2b22afdef507b.yaml (100%) rename releasenotes/notes/{ => 0.6}/remove-tomo-reset-3f21ec4d0dacba91.yaml (100%) rename releasenotes/notes/{ => 0.6}/requirements-extras-d5768794acbce467.yaml (100%) rename releasenotes/notes/{ => 0.6}/runtime-provider-support-5358b72ec0035419.yaml (100%) rename releasenotes/notes/{ => 0.6}/scale_options-745ee6f8e560043f.yaml (100%) rename releasenotes/notes/{ => 0.6}/selective-figure-generation-0864216f34d3486f.yaml (100%) rename releasenotes/notes/{ => 0.6}/setter-methods-for-experiment-099074e59faffb49.yaml (100%) rename releasenotes/notes/{ => 0.6}/update-figure-name-2db258c30ffe9912.yaml (100%) rename releasenotes/notes/{ => 0.6}/upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml (100%) diff --git a/releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml b/releasenotes/notes/0.6/0.5_deprecations-4188ada026cb682b.yaml similarity index 100% rename from releasenotes/notes/0.5_deprecations-4188ada026cb682b.yaml rename to releasenotes/notes/0.6/0.5_deprecations-4188ada026cb682b.yaml diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml new file mode 100644 index 0000000000..4814fae75f --- /dev/null +++ b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml @@ -0,0 +1,9 @@ +--- +prelude: > + Qiskit Experiments 0.6 adds numerous features and improvements. It is compatible with Qiskit 1.0. + Notable changes include refactoring the analysis results to a Pandas dataframe, and refactoring + curve fit data into a new :class:`ScatterTable` container based on dataframes that is stored + by default as an artifact in :class:`ExperimentData` along with the summary of fit results. + New experiments include :class:`StarkP1Spectroscopy`, :class:`StarkRamseyXY`, + :class:`StarkRamseyXYScan`. The supported provider for running jobs on IBM backends has + switched from ``qiskit-ibm-provider`` to ``qiskit-ibm-experiment``. diff --git a/releasenotes/notes/access_figure_without_extension-5b7438c19e223d6b.yaml b/releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml similarity index 100% rename from releasenotes/notes/access_figure_without_extension-5b7438c19e223d6b.yaml rename to releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml diff --git a/releasenotes/notes/add-dataframe-analysis-results-ec8863e826a70621.yaml b/releasenotes/notes/0.6/add-dataframe-analysis-results-ec8863e826a70621.yaml similarity index 100% rename from releasenotes/notes/add-dataframe-analysis-results-ec8863e826a70621.yaml rename to releasenotes/notes/0.6/add-dataframe-analysis-results-ec8863e826a70621.yaml diff --git a/releasenotes/notes/add-dataframe-curve-data-a8905c450748b281.yaml b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml similarity index 100% rename from releasenotes/notes/add-dataframe-curve-data-a8905c450748b281.yaml rename to releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml diff --git a/releasenotes/notes/add-support-for-visualization-with-unshared-axis-9f7bfe272353086b.yaml b/releasenotes/notes/0.6/add-support-for-visualization-with-unshared-axis-9f7bfe272353086b.yaml similarity index 100% rename from releasenotes/notes/add-support-for-visualization-with-unshared-axis-9f7bfe272353086b.yaml rename to releasenotes/notes/0.6/add-support-for-visualization-with-unshared-axis-9f7bfe272353086b.yaml diff --git a/releasenotes/notes/add-test-equality-checker-dbe5762d2b6a967f.yaml b/releasenotes/notes/0.6/add-test-equality-checker-dbe5762d2b6a967f.yaml similarity index 100% rename from releasenotes/notes/add-test-equality-checker-dbe5762d2b6a967f.yaml rename to releasenotes/notes/0.6/add-test-equality-checker-dbe5762d2b6a967f.yaml diff --git a/releasenotes/notes/add_warning_analysis_without_data-bfc802da52591f13.yaml b/releasenotes/notes/0.6/add_warning_analysis_without_data-bfc802da52591f13.yaml similarity index 100% rename from releasenotes/notes/add_warning_analysis_without_data-bfc802da52591f13.yaml rename to releasenotes/notes/0.6/add_warning_analysis_without_data-bfc802da52591f13.yaml diff --git a/releasenotes/notes/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml b/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml similarity index 100% rename from releasenotes/notes/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml rename to releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml diff --git a/releasenotes/notes/attach-other-cals-2f539e7799ceb6c8.yaml b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml similarity index 100% rename from releasenotes/notes/attach-other-cals-2f539e7799ceb6c8.yaml rename to releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml diff --git a/releasenotes/notes/backend-in-rough-frequency-cal-8582610249e2327b.yaml b/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml similarity index 100% rename from releasenotes/notes/backend-in-rough-frequency-cal-8582610249e2327b.yaml rename to releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml diff --git a/releasenotes/notes/broadcasting-option-8a3b72bfc1df9668.yaml b/releasenotes/notes/0.6/broadcasting-option-8a3b72bfc1df9668.yaml similarity index 100% rename from releasenotes/notes/broadcasting-option-8a3b72bfc1df9668.yaml rename to releasenotes/notes/0.6/broadcasting-option-8a3b72bfc1df9668.yaml diff --git a/releasenotes/notes/bugfix_expdata_copy-2c73a21ad720858d.yaml b/releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml similarity index 100% rename from releasenotes/notes/bugfix_expdata_copy-2c73a21ad720858d.yaml rename to releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml diff --git a/releasenotes/notes/cals-no-coupling-map-5114ae9faa2f9e69.yaml b/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml similarity index 100% rename from releasenotes/notes/cals-no-coupling-map-5114ae9faa2f9e69.yaml rename to releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml diff --git a/releasenotes/notes/circuit-count-method-a095bd74aaa1d2fb.yaml b/releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml similarity index 100% rename from releasenotes/notes/circuit-count-method-a095bd74aaa1d2fb.yaml rename to releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml diff --git a/releasenotes/notes/deprecate-flatten-result-false-026a89c09cc7a004.yaml b/releasenotes/notes/0.6/deprecate-flatten-result-false-026a89c09cc7a004.yaml similarity index 100% rename from releasenotes/notes/deprecate-flatten-result-false-026a89c09cc7a004.yaml rename to releasenotes/notes/0.6/deprecate-flatten-result-false-026a89c09cc7a004.yaml diff --git a/releasenotes/notes/device-component-c9ec9011c529425c.yaml b/releasenotes/notes/0.6/device-component-c9ec9011c529425c.yaml similarity index 100% rename from releasenotes/notes/device-component-c9ec9011c529425c.yaml rename to releasenotes/notes/0.6/device-component-c9ec9011c529425c.yaml diff --git a/releasenotes/notes/drop_python_3_7_support-0529a7122e94b004.yaml b/releasenotes/notes/0.6/drop_python_3_7_support-0529a7122e94b004.yaml similarity index 100% rename from releasenotes/notes/drop_python_3_7_support-0529a7122e94b004.yaml rename to releasenotes/notes/0.6/drop_python_3_7_support-0529a7122e94b004.yaml diff --git a/releasenotes/notes/dynamics-requirement-6109a8846c0f88c2.yaml b/releasenotes/notes/0.6/dynamics-requirement-6109a8846c0f88c2.yaml similarity index 100% rename from releasenotes/notes/dynamics-requirement-6109a8846c0f88c2.yaml rename to releasenotes/notes/0.6/dynamics-requirement-6109a8846c0f88c2.yaml diff --git a/releasenotes/notes/exp-data-pickle-61511b6e926e3198.yaml b/releasenotes/notes/0.6/exp-data-pickle-61511b6e926e3198.yaml similarity index 100% rename from releasenotes/notes/exp-data-pickle-61511b6e926e3198.yaml rename to releasenotes/notes/0.6/exp-data-pickle-61511b6e926e3198.yaml diff --git a/releasenotes/notes/experiment_data_metadata_save_fix-912b7180a28cfb03.yaml b/releasenotes/notes/0.6/experiment_data_metadata_save_fix-912b7180a28cfb03.yaml similarity index 100% rename from releasenotes/notes/experiment_data_metadata_save_fix-912b7180a28cfb03.yaml rename to releasenotes/notes/0.6/experiment_data_metadata_save_fix-912b7180a28cfb03.yaml diff --git a/releasenotes/notes/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml b/releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml similarity index 100% rename from releasenotes/notes/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml rename to releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml diff --git a/releasenotes/notes/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml similarity index 100% rename from releasenotes/notes/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml rename to releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml diff --git a/releasenotes/notes/figure_return_SVG-4ad72fc8a3bee3cb.yaml b/releasenotes/notes/0.6/figure_return_SVG-4ad72fc8a3bee3cb.yaml similarity index 100% rename from releasenotes/notes/figure_return_SVG-4ad72fc8a3bee3cb.yaml rename to releasenotes/notes/0.6/figure_return_SVG-4ad72fc8a3bee3cb.yaml diff --git a/releasenotes/notes/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml b/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml similarity index 100% rename from releasenotes/notes/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml rename to releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml diff --git a/releasenotes/notes/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml b/releasenotes/notes/0.6/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml similarity index 100% rename from releasenotes/notes/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml rename to releasenotes/notes/0.6/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml diff --git a/releasenotes/notes/half-angle-x-600debac368ce2c6.yaml b/releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml similarity index 100% rename from releasenotes/notes/half-angle-x-600debac368ce2c6.yaml rename to releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml diff --git a/releasenotes/notes/irb-circuit-order-619845a707519c44.yaml b/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml similarity index 100% rename from releasenotes/notes/irb-circuit-order-619845a707519c44.yaml rename to releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml diff --git a/releasenotes/notes/matplotlib-fix-58d938b49771cf17.yaml b/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml similarity index 100% rename from releasenotes/notes/matplotlib-fix-58d938b49771cf17.yaml rename to releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml diff --git a/releasenotes/notes/mod-stark-1f1afb538a94fe9a.yaml b/releasenotes/notes/0.6/mod-stark-1f1afb538a94fe9a.yaml similarity index 100% rename from releasenotes/notes/mod-stark-1f1afb538a94fe9a.yaml rename to releasenotes/notes/0.6/mod-stark-1f1afb538a94fe9a.yaml diff --git a/releasenotes/notes/params_without_schedule-20555d98875a626b.yaml b/releasenotes/notes/0.6/params_without_schedule-20555d98875a626b.yaml similarity index 73% rename from releasenotes/notes/params_without_schedule-20555d98875a626b.yaml rename to releasenotes/notes/0.6/params_without_schedule-20555d98875a626b.yaml index 5c1c019ac8..3893c17229 100644 --- a/releasenotes/notes/params_without_schedule-20555d98875a626b.yaml +++ b/releasenotes/notes/0.6/params_without_schedule-20555d98875a626b.yaml @@ -1,8 +1,8 @@ --- upgrade: - | - The variables `__drive_freq_parameter__` and `__readout_freq_parameter__` - have been removed from `Calibrations`. These variables were given special + The variables ``__drive_freq_parameter__`` and ``__readout_freq_parameter__`` + have been removed from :class:`.Calibrations`. These variables were given special treatment which is inconsistent with the framework. To replace them a mechanism to define and add parameters without a schedule has been added to the basis gate library. This has the added benefit of making the API of diff --git a/releasenotes/notes/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml b/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml similarity index 100% rename from releasenotes/notes/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml rename to releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml diff --git a/releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml b/releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml similarity index 100% rename from releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml rename to releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml diff --git a/releasenotes/notes/qvplotter-04efe280aaa9d555.yaml b/releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml similarity index 100% rename from releasenotes/notes/qvplotter-04efe280aaa9d555.yaml rename to releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml diff --git a/releasenotes/notes/rabi-and-qv-bugfix-34636baee6651af1.yaml b/releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml similarity index 100% rename from releasenotes/notes/rabi-and-qv-bugfix-34636baee6651af1.yaml rename to releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml diff --git a/releasenotes/notes/rb-v2-none-coupling-fda2b22afdef507b.yaml b/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml similarity index 100% rename from releasenotes/notes/rb-v2-none-coupling-fda2b22afdef507b.yaml rename to releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml diff --git a/releasenotes/notes/remove-tomo-reset-3f21ec4d0dacba91.yaml b/releasenotes/notes/0.6/remove-tomo-reset-3f21ec4d0dacba91.yaml similarity index 100% rename from releasenotes/notes/remove-tomo-reset-3f21ec4d0dacba91.yaml rename to releasenotes/notes/0.6/remove-tomo-reset-3f21ec4d0dacba91.yaml diff --git a/releasenotes/notes/requirements-extras-d5768794acbce467.yaml b/releasenotes/notes/0.6/requirements-extras-d5768794acbce467.yaml similarity index 100% rename from releasenotes/notes/requirements-extras-d5768794acbce467.yaml rename to releasenotes/notes/0.6/requirements-extras-d5768794acbce467.yaml diff --git a/releasenotes/notes/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml similarity index 100% rename from releasenotes/notes/runtime-provider-support-5358b72ec0035419.yaml rename to releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml diff --git a/releasenotes/notes/scale_options-745ee6f8e560043f.yaml b/releasenotes/notes/0.6/scale_options-745ee6f8e560043f.yaml similarity index 100% rename from releasenotes/notes/scale_options-745ee6f8e560043f.yaml rename to releasenotes/notes/0.6/scale_options-745ee6f8e560043f.yaml diff --git a/releasenotes/notes/selective-figure-generation-0864216f34d3486f.yaml b/releasenotes/notes/0.6/selective-figure-generation-0864216f34d3486f.yaml similarity index 100% rename from releasenotes/notes/selective-figure-generation-0864216f34d3486f.yaml rename to releasenotes/notes/0.6/selective-figure-generation-0864216f34d3486f.yaml diff --git a/releasenotes/notes/setter-methods-for-experiment-099074e59faffb49.yaml b/releasenotes/notes/0.6/setter-methods-for-experiment-099074e59faffb49.yaml similarity index 100% rename from releasenotes/notes/setter-methods-for-experiment-099074e59faffb49.yaml rename to releasenotes/notes/0.6/setter-methods-for-experiment-099074e59faffb49.yaml diff --git a/releasenotes/notes/update-figure-name-2db258c30ffe9912.yaml b/releasenotes/notes/0.6/update-figure-name-2db258c30ffe9912.yaml similarity index 100% rename from releasenotes/notes/update-figure-name-2db258c30ffe9912.yaml rename to releasenotes/notes/0.6/update-figure-name-2db258c30ffe9912.yaml diff --git a/releasenotes/notes/upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml b/releasenotes/notes/0.6/upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml similarity index 100% rename from releasenotes/notes/upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml rename to releasenotes/notes/0.6/upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml From f12c50c07737f1d7494890cce23fa94fce7fda2b Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Thu, 1 Feb 2024 19:13:34 -0500 Subject: [PATCH 04/20] update deprecation policy --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf33b8ffa7..73423b88bc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,7 @@ Contents: - [Pull request checklist](#pull-request-checklist) - [Testing your code](#testing-your-code) - [STDOUT/STDERR and logging capture](#stdoutstderr-and-logging-capture) + - [Other testing related settings](#other-testing-related-settings) - [Code style](#code-style) - [Changelog generation](#changelog-generation) - [Release notes](#release-notes) @@ -360,16 +361,26 @@ There are a few other build options available: ### Deprecation policy -Qiskit Experiments is part of Qiskit and, therefore, the [Qiskit Deprecation -Policy](https://qiskit.org/documentation/deprecation_policy.html) fully applies here. -Public-facing changes must come with a deprecation warning for at least three months or -two version cycles before the old feature is removed. Deprecations can only happen on -minor releases and not on patch releases. +Qiskit Experiments's deprecation policy is based on Qiskit's [Deprecation +Policy](https://github.com/Qiskit/qiskit/blob/45e42525224e9e1857300e7e5529273fe619c9e4/DEPRECATION.md) +prior to its 1.0 release. Public-facing changes must come with a deprecation warning +for at least three months or two version cycles before the old feature is removed. +Deprecations can only happen on minor releases and not on patch releases. + +The timeline for deprecating an existing feature is as follows: + +* Minor release 1: An alternative path is provided. A `PendingDeprecationWarning` should be issued + when the old path is used, indicating to users how to switch to the new path and the release + in which the old path will no longer be available. +* Minor release 2: The `PendingDeprecationWarning` becomes a `DeprecationWarning`. The release note + should indicate the feature has been deprecated and how to switch to the new path. +* Minor release 3: The old feature is removed. The release note should indicate that the feature has + been removed and how to switch to the new path. #### Adding deprecation warnings We use the deprecation wrappers in [Qiskit -Utilities](https://qiskit.org/documentation/apidoc/utils.html) to add warnings: +Utilities](https://docs.quantum.ibm.com/api/qiskit/utils) to add warnings: ```python @@ -388,6 +399,15 @@ Utilities](https://qiskit.org/documentation/apidoc/utils.html) to add warnings: pass ``` +Note that these pre-deprecation and deprecation warnings will cause the CI to fail, but features up +for deprecation should continue to be tested until their removal. All such expected warnings +should be caught in tests: + +```python + with self.assertWarns(DeprecationWarning): + # Test something deprecated here +``` + ### Development cycle The development cycle for Qiskit Experiments is all handled in the open using project From 112f1e9d4672d6c38af8539e622b71f87fcb5872 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Mon, 5 Feb 2024 16:21:09 -0500 Subject: [PATCH 05/20] update notes --- CONTRIBUTING.md | 2 +- .../notes/0.4/0_3_1_release-43f09573952ce3ee.yaml | 4 ++-- .../0.6/add-dataframe-curve-data-a8905c450748b281.yaml | 2 +- ...lses-amp-angle-representation-f5c40007416cf938.yaml | 2 +- .../notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml | 4 ++-- .../0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml | 2 +- .../0.6/circuit-count-method-a095bd74aaa1d2fb.yaml | 2 +- ...eprecate-flatten-result-false-026a89c09cc7a004.yaml | 2 +- .../0.6/dynamics-requirement-6109a8846c0f88c2.yaml | 5 ----- ...experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml | 4 ++-- ...upport-calibrations-roundtrip-47f09bd9ff803479.yaml | 10 +++++----- .../notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml | 2 +- .../0.6/requirements-extras-d5768794acbce467.yaml | 3 ++- .../0.6/runtime-provider-support-5358b72ec0035419.yaml | 2 +- requirements-extras.txt | 2 +- 15 files changed, 22 insertions(+), 26 deletions(-) delete mode 100644 releasenotes/notes/0.6/dynamics-requirement-6109a8846c0f88c2.yaml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b2e905152..14f0b9458e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,7 +74,7 @@ When submitting a pull request for review, please ensure that: etc.), you've added or updated a reno release note for that change and tagged the PR for the changelog. 6. If your code requires a change to dependencies, you've updated the corresponding - requirements file: `requirements.txt` contain core dependencies, + requirements file: `requirements.txt` for core dependencies, `requirements-extras.txt` for dependencies for optional features, and `requirements-dev.txt` for dependencies required for running tests and building documentation. diff --git a/releasenotes/notes/0.4/0_3_1_release-43f09573952ce3ee.yaml b/releasenotes/notes/0.4/0_3_1_release-43f09573952ce3ee.yaml index a4d1144602..ce8b923497 100644 --- a/releasenotes/notes/0.4/0_3_1_release-43f09573952ce3ee.yaml +++ b/releasenotes/notes/0.4/0_3_1_release-43f09573952ce3ee.yaml @@ -1,5 +1,5 @@ --- -features: +developer: - | The class :class:`.MockIQBackend` for testing has been updated to support multiple qubits. It now takes lists of IQ cluster centers and widths as input, @@ -16,7 +16,7 @@ fixes: - | Fixes an issue with marginalization of kerneled and discriminated memory in :class:`.CompositeAnalysis` not working correctly. This fixes - :class:`.ParallelExperiments` not working correctly for level-1 measurement + :class:`.ParallelExperiment` not working correctly for level-1 measurement data. - | Fixes a bug with JSON serialization of :class:`.ExperimentData` due to diff --git a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml index cd85dafbb0..9c8ae2b089 100644 --- a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml +++ b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml @@ -23,7 +23,7 @@ upgrade: such as formatting, fitting, and visualization. developer: - | - :meth:`.CurveAnalysis._create_figures` method is added to the curve analysis base class. + Added the :meth:`~.CurveAnalysis._create_figures` method to the :class:`.CurveAnalysis` base class. A curve analysis subclass can overwrite this method to customize the output figures. The method is called with the :class:`.ScatterTable` containing all intermediate data points generated during the curve analysis. diff --git a/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml b/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml index 2393331895..bf12fab777 100644 --- a/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml +++ b/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml @@ -1,7 +1,7 @@ --- other: - | - Qiskit Terra 0.23.0 began phasing out support of complex parameters + Qiskit 0.23.0 began phasing out support of complex parameters in the Pulse module. Mainly, all library symbolic pulses were converted from complex amplitude representation to a duo of real (float) parameters (``amp``, ``angle``). To avoid problems, Qiskit Experiments adopted this convention. diff --git a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml index 80b3f73b70..9da795b40c 100644 --- a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml +++ b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml @@ -1,8 +1,8 @@ --- features: - | - A new method :meth:`.qiskit_experiments.calibration_management.Calibrations.has_template` - has been added to :class:`.qiskit_experiments.calibration_management.Calibrations` + A new method :meth:`~.Calibrations.has_template` + has been added to :class:`.Calibrations` to check if a template schedule exists for a particular set of qubits. fixes: - | diff --git a/releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml b/releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml index fd7c9b91d2..7c7c3864ff 100644 --- a/releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml +++ b/releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml @@ -1,5 +1,5 @@ --- fixes: - | - The :meth:`.ExperimentData.copy` method under ExperimentData class now copies the provider. + The :meth:`.ExperimentData.copy` method now copies the provider. \ No newline at end of file diff --git a/releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml b/releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml index 72ce129e04..550e2f4116 100644 --- a/releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml +++ b/releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml @@ -1,7 +1,7 @@ --- features: - | - A new method :meth:`BaseExperiment.job_info` has been added that will + A new method :meth:`.BaseExperiment.job_info` has been added that will output the number of jobs the experiment is expected to be split into based on the provided backend. Refer to issue `#1247 `_ diff --git a/releasenotes/notes/0.6/deprecate-flatten-result-false-026a89c09cc7a004.yaml b/releasenotes/notes/0.6/deprecate-flatten-result-false-026a89c09cc7a004.yaml index b834d614a2..22a7a8654d 100644 --- a/releasenotes/notes/0.6/deprecate-flatten-result-false-026a89c09cc7a004.yaml +++ b/releasenotes/notes/0.6/deprecate-flatten-result-false-026a89c09cc7a004.yaml @@ -4,4 +4,4 @@ deprecations: Executing composite experiment and composite analysis with ``flatten_results=False`` by default was deprecated. To create child experiment data, please explicitly set ``flatten_results=False``. The default value of ``flatten_results`` will be - turned to True in the future release. + changed to ``True`` in the next release. diff --git a/releasenotes/notes/0.6/dynamics-requirement-6109a8846c0f88c2.yaml b/releasenotes/notes/0.6/dynamics-requirement-6109a8846c0f88c2.yaml deleted file mode 100644 index 311792b9fc..0000000000 --- a/releasenotes/notes/0.6/dynamics-requirement-6109a8846c0f88c2.yaml +++ /dev/null @@ -1,5 +0,0 @@ ---- -other: - - | - Qiskit Dynamics has been removed as a requirement and is now an optional - dependency for running the tutorials and tests. diff --git a/releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml b/releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml index 9d5586cbaa..464138333c 100644 --- a/releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml +++ b/releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml @@ -1,6 +1,6 @@ --- fixes: - | - The :attr:`ExperimentData.auto_save` setter no longer saves sub-experiments twice. + The :attr:`.ExperimentData.auto_save` setter no longer saves sub-experiments twice. - | - :meth:`ExperimentData.save` now handles correctly figures in sub-experiments when ``flatten_results=True``. + :meth:`.ExperimentData.save` now handles correctly figures in sub-experiments when ``flatten_results=True``. diff --git a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml index 99a90f22cf..b2265f9189 100644 --- a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml +++ b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml @@ -1,27 +1,27 @@ --- features: - | - JSON data format is supoorted for saving :class:`.Calibrations` instance. + JSON data format is now supported for saving a :class:`.Calibrations` instance. This leverages a custom JSON encoder and decoder to serialize the entire calibration data including user provided schedule templates. Output JSON data is formatted into the standard data model which is intentionally - agnostic to the calibration data structure, and this allows community + agnostic to the calibration data structure, which this allows community developer to reuse the calibration data in their platform. See :mod:`qiskit_experiments.calibration_management.save_utils` for data models. deprecations: - | Saving :class:`.Calibrations` instance into CSV file was deprecated. - This only provides serialization for limited set of calibraiton data, + This only provides serialization for limited set of calibration data, and loading from the local file is not supported. - | :meth:`.Calibrations.schedule_information` was deprecated. This method returns attached calibration templates in the string format, but this cannot be converted back to the original Qiskit representation. - Now better serialization is provided with :meth:`Calibrations.save` with JSON mode + Now better serialization is provided with :meth:`.Calibrations.save` with JSON mode and it internally dumps these schedule in through QPY format. - | :meth:`.Calibrations.load_parameter_values` was deprecated. - Since saving :.Calibrations: instance into the CSV format was deprecated, + Since saving :class:`.Calibrations` instance into the CSV format was deprecated, the required data file to invoke this method will be no longer generated in future calibrations instance. Full calibration instance roundtrip is now supported with the save and load method. diff --git a/releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml b/releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml index 9f5a61d3eb..81215ed52c 100644 --- a/releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml +++ b/releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml @@ -5,6 +5,6 @@ fixes: the backend provider using custom amplitudes provided as a numpy array. - | Resolved an issue that caused QV experiments to fail when executed via the backend provider using - Qiskit Terra for calculating ideal probabilities, instead of Aer. + Qiskit for calculating ideal probabilities instead of Aer. - | Resolved a serialization issue that affected DRAG experiments with integral beta values specified. \ No newline at end of file diff --git a/releasenotes/notes/0.6/requirements-extras-d5768794acbce467.yaml b/releasenotes/notes/0.6/requirements-extras-d5768794acbce467.yaml index 7b254c1857..cd884d0506 100644 --- a/releasenotes/notes/0.6/requirements-extras-d5768794acbce467.yaml +++ b/releasenotes/notes/0.6/requirements-extras-d5768794acbce467.yaml @@ -3,4 +3,5 @@ other: - | A new set of optional dependencies have been split off from the developer dependencies and can be installed separately as ``qiskit-experiments[extras]``. These are packages that enable - optional experiment features such as ``scikit-learn``-based discriminators. + optional experiment features such as ``scikit-learn``-based discriminators. Qiskit Dynamics and + Qiskit Aer have also been marked as optional in this manner. diff --git a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml index ac21050a50..de962c7802 100644 --- a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml +++ b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml @@ -8,7 +8,7 @@ upgrade: With the impending deprecation of the ``qiskit-ibm-provider`` package, support for ``qiskit-ibm-provider`` is now deprecated and will be removed in the next release. Users should migrate to ``qiskit-ibm-runtime`` following the - `migration guide + `runtime migration guide `_. ``qiskit-ibm-runtime`` is not listed as a dependency for compatibility reasons, but users will need it to run experiments on IBM backends. diff --git a/requirements-extras.txt b/requirements-extras.txt index 707149b52d..b95eeacbc0 100644 --- a/requirements-extras.txt +++ b/requirements-extras.txt @@ -1,4 +1,4 @@ cvxpy>=1.3.2 # for tomography scikit-learn # for discriminators qiskit-aer>=0.13.2 -qiskit_dynamics>=0.4.0 # for the PulseBackend +qiskit-dynamics>=0.4.0 # for the PulseBackend From afeeb81d4cb68a63a14aca6da6e26c3aeb020d11 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Mon, 5 Feb 2024 18:10:14 -0500 Subject: [PATCH 06/20] fix notes in wrong section 0.3.1 release notes were added retroactively, so they must be added to an existing note file created during the correct release --- .../0.4/0_3_1_release-43f09573952ce3ee.yaml | 24 ------------------- .../0.4/0_4_release-5716aa7442b995b2.yaml | 23 ++++++++++++++++++ .../0.6/0.6_release-4d766733941ad57a.yaml | 2 +- ...re_without_extension-5b7438c19e223d6b.yaml | 2 +- 4 files changed, 25 insertions(+), 26 deletions(-) delete mode 100644 releasenotes/notes/0.4/0_3_1_release-43f09573952ce3ee.yaml diff --git a/releasenotes/notes/0.4/0_3_1_release-43f09573952ce3ee.yaml b/releasenotes/notes/0.4/0_3_1_release-43f09573952ce3ee.yaml deleted file mode 100644 index ce8b923497..0000000000 --- a/releasenotes/notes/0.4/0_3_1_release-43f09573952ce3ee.yaml +++ /dev/null @@ -1,24 +0,0 @@ ---- -developer: - - | - The class :class:`.MockIQBackend` for testing has been updated to support - multiple qubits. It now takes lists of IQ cluster centers and widths as input, - and specific backends are now defined as subclasses of - :class:`.MockIQExperimentHelper`. -fixes: - - | - Fixes a bug where instantiating the - :class:`.CrossResonanceHamiltonian` experiment without specifying the - ``cr_gate`` and ``backend`` init kwargs raises an exception. - - | - Fixes a visualization error in the figure produced during analysis of - :class:`.CrossResonanceHamiltonian` when multi-canvas plotting mode is enabled. - - | - Fixes an issue with marginalization of kerneled and discriminated memory in - :class:`.CompositeAnalysis` not working correctly. This fixes - :class:`.ParallelExperiment` not working correctly for level-1 measurement - data. - - | - Fixes a bug with JSON serialization of :class:`.ExperimentData` due to - Qiskit ``backend`` and ``service`` objects not being JSON serializable. These - properties are now set to ``None`` in the serialized experiment data. \ No newline at end of file diff --git a/releasenotes/notes/0.4/0_4_release-5716aa7442b995b2.yaml b/releasenotes/notes/0.4/0_4_release-5716aa7442b995b2.yaml index bab331622c..d013856a5d 100644 --- a/releasenotes/notes/0.4/0_4_release-5716aa7442b995b2.yaml +++ b/releasenotes/notes/0.4/0_4_release-5716aa7442b995b2.yaml @@ -4,3 +4,26 @@ prelude: > class and other bug fixes and improvements. The database service has switched to the `qiskit-ibm-experiment `_ provider. Several new data processing nodes have been added. +developers: + - | + The class :class:`.MockIQBackend` for testing has been updated to support + multiple qubits. It now takes lists of IQ cluster centers and widths as input, + and specific backends are now defined as subclasses of + :class:`.MockIQExperimentHelper`. +fixes: + - | + Fixes a bug where instantiating the + :class:`.CrossResonanceHamiltonian` experiment without specifying the + ``cr_gate`` and ``backend`` init kwargs raises an exception. + - | + Fixes a visualization error in the figure produced during analysis of + :class:`.CrossResonanceHamiltonian` when multi-canvas plotting mode is enabled. + - | + Fixes an issue with marginalization of kerneled and discriminated memory in + :class:`.CompositeAnalysis` not working correctly. This fixes + :class:`.ParallelExperiment` not working correctly for level-1 measurement + data. + - | + Fixes a bug with JSON serialization of :class:`.ExperimentData` due to + Qiskit ``backend`` and ``service`` objects not being JSON serializable. These + properties are now set to ``None`` in the serialized experiment data. \ No newline at end of file diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml index 4814fae75f..ea433324f9 100644 --- a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml +++ b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml @@ -1,6 +1,6 @@ --- prelude: > - Qiskit Experiments 0.6 adds numerous features and improvements. It is compatible with Qiskit 1.0. + Qiskit Experiments 0.6 introduces numerous features and improvements. It is compatible with Qiskit 1.0. Notable changes include refactoring the analysis results to a Pandas dataframe, and refactoring curve fit data into a new :class:`ScatterTable` container based on dataframes that is stored by default as an artifact in :class:`ExperimentData` along with the summary of fit results. diff --git a/releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml b/releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml index 545c8ac0c3..8128036e23 100644 --- a/releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml +++ b/releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml @@ -1,4 +1,4 @@ --- -feature: +features: - | Figures in :class:`.ExperimentData` objects can now be accessed without the ``.svg`` extension. \ No newline at end of file From b817048eebcbbb4f59cdca4ca7e075581de0af27 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Mon, 5 Feb 2024 20:13:08 -0500 Subject: [PATCH 07/20] minor text fixes --- qiskit_experiments/data_processing/nodes.py | 4 ++-- releasenotes/notes/0.4/0_4_release-5716aa7442b995b2.yaml | 2 +- .../notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml | 2 +- releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml | 8 ++++---- .../0.6/add-dataframe-curve-data-a8905c450748b281.yaml | 2 +- .../0.6/add-test-equality-checker-dbe5762d2b6a967f.yaml | 4 ++-- .../notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml | 3 +-- 7 files changed, 12 insertions(+), 13 deletions(-) diff --git a/qiskit_experiments/data_processing/nodes.py b/qiskit_experiments/data_processing/nodes.py index 9bb4ed183b..6b042a7574 100644 --- a/qiskit_experiments/data_processing/nodes.py +++ b/qiskit_experiments/data_processing/nodes.py @@ -740,9 +740,9 @@ def __init__( Args: outcome: The bitstring for which to return the probability and variance. - alpha_prior: A prior Beta distribution parameter ``[`alpha0, alpha1]``. + alpha_prior: A prior Beta distribution parameter ``[alpha0, alpha1]``. If specified as float this will use the same value for - ``alpha0`` and``alpha1`` (Default: 0.5). + ``alpha0`` and ``alpha1`` (Default: 0.5). validate: If set to False the DataAction will not validate its input. Raises: diff --git a/releasenotes/notes/0.4/0_4_release-5716aa7442b995b2.yaml b/releasenotes/notes/0.4/0_4_release-5716aa7442b995b2.yaml index d013856a5d..27646a614e 100644 --- a/releasenotes/notes/0.4/0_4_release-5716aa7442b995b2.yaml +++ b/releasenotes/notes/0.4/0_4_release-5716aa7442b995b2.yaml @@ -4,7 +4,7 @@ prelude: > class and other bug fixes and improvements. The database service has switched to the `qiskit-ibm-experiment `_ provider. Several new data processing nodes have been added. -developers: +developer: - | The class :class:`.MockIQBackend` for testing has been updated to support multiple qubits. It now takes lists of IQ cluster centers and widths as input, diff --git a/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml b/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml index 44df56dd33..08cf6637cb 100644 --- a/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml +++ b/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml @@ -25,6 +25,6 @@ features: fixes: - | - Fixed a bug in :meth:`.ExperimentData._add_job_data` that caused job-id + Fixed a bug in :meth:`.ExperimentData._add_job_data` that caused job id related test fails. diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml index ea433324f9..454dd0f52f 100644 --- a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml +++ b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml @@ -2,8 +2,8 @@ prelude: > Qiskit Experiments 0.6 introduces numerous features and improvements. It is compatible with Qiskit 1.0. Notable changes include refactoring the analysis results to a Pandas dataframe, and refactoring - curve fit data into a new :class:`ScatterTable` container based on dataframes that is stored - by default as an artifact in :class:`ExperimentData` along with the summary of fit results. - New experiments include :class:`StarkP1Spectroscopy`, :class:`StarkRamseyXY`, - :class:`StarkRamseyXYScan`. The supported provider for running jobs on IBM backends has + curve fit data into a new :class:`.ScatterTable` container based on dataframes that is stored + by default as an artifact in :class:`.ExperimentData` along with the summary of fit results. + New experiments include :class:`.StarkP1Spectroscopy`, :class:`.StarkRamseyXY`, + :class:`.StarkRamseyXYAmpScan`. The supported provider for running jobs on IBM backends has switched from ``qiskit-ibm-provider`` to ``qiskit-ibm-experiment``. diff --git a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml index 9c8ae2b089..57f52b9af1 100644 --- a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml +++ b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml @@ -1,7 +1,7 @@ --- features: - | - :class:`.ScatterTable` is introduced as a drop-in replacement of :class:`.CurveData`. + :class:`.ScatterTable` has been introduced as a drop-in replacement of :class:`.CurveData`. This is a data format to store intermediate data in curve analysis, built on top of the pandas DataFrame. Each table row corresponds to a single data point, diff --git a/releasenotes/notes/0.6/add-test-equality-checker-dbe5762d2b6a967f.yaml b/releasenotes/notes/0.6/add-test-equality-checker-dbe5762d2b6a967f.yaml index dd5d26c6a1..c683c39e14 100644 --- a/releasenotes/notes/0.6/add-test-equality-checker-dbe5762d2b6a967f.yaml +++ b/releasenotes/notes/0.6/add-test-equality-checker-dbe5762d2b6a967f.yaml @@ -20,8 +20,8 @@ developer: This function internally dispatches the logic for equality check. - | The default behavior of :meth:`QiskitExperimentsTestCase.assertRoundTripSerializable` and - :meth:`QiskitExperimentsTestCase.assertRoundTripPickle` when `check_func` is not + :meth:`QiskitExperimentsTestCase.assertRoundTripPickle` when ``check_func`` is not provided was upgraded. These methods now compare the decoded instance with :func:`~test.extended_equality.is_equivalent`, rather than - delegating to the native `assertEqual` unittest method. + delegating to the native ``assertEqual`` unittest method. One writing a unittest for serialization no longer need to explicitly set checker function. diff --git a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml index 9da795b40c..62b486e4f2 100644 --- a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml +++ b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml @@ -6,8 +6,7 @@ features: to check if a template schedule exists for a particular set of qubits. fixes: - | - :class:`.qiskit_experiments.library.FineXDragCal` and - :class:`.qiskit_experiments.library.EFRoughXSXAmplitudeCal` were updated to + :class:`.FineXDragCal` and :class:`.EFRoughXSXAmplitudeCal` were updated to attach ``"sx"`` and ``"x"`` calibrations to their circuits, respectively. Previously, they only attached the ``"x"`` and ``"x12"`` calibrations that they were calibrating. See issue `#1158 `_. From d720f6d97898c95c45649a4e711ddefb977800cd Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Tue, 6 Feb 2024 14:13:54 -0800 Subject: [PATCH 08/20] Apply suggestions from code review Co-authored-by: Will Shanks --- releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml | 6 +++--- ...ure-support-calibrations-roundtrip-47f09bd9ff803479.yaml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml index 454dd0f52f..bbbe1caad4 100644 --- a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml +++ b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml @@ -4,6 +4,6 @@ prelude: > Notable changes include refactoring the analysis results to a Pandas dataframe, and refactoring curve fit data into a new :class:`.ScatterTable` container based on dataframes that is stored by default as an artifact in :class:`.ExperimentData` along with the summary of fit results. - New experiments include :class:`.StarkP1Spectroscopy`, :class:`.StarkRamseyXY`, - :class:`.StarkRamseyXYAmpScan`. The supported provider for running jobs on IBM backends has - switched from ``qiskit-ibm-provider`` to ``qiskit-ibm-experiment``. + New experiments include :class:`.StarkP1Spectroscopy`, :class:`.StarkRamseyXY`, and + :class:`.StarkRamseyXYAmpScan`. The supported provider for running jobs on IBM backends is + now ``qiskit-ibm-runtime``. Using ``qiskit-ibm-provider`` is still supported but its use is deprecated. diff --git a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml index b2265f9189..f57a76824c 100644 --- a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml +++ b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml @@ -1,7 +1,7 @@ --- features: - | - JSON data format is now supported for saving a :class:`.Calibrations` instance. + A JSON data format has been added for saving a :class:`.Calibrations` instance. This leverages a custom JSON encoder and decoder to serialize the entire calibration data including user provided schedule templates. Output JSON data is formatted into the standard data model which is intentionally From 6d993f60db502035cf8fc43642f5366276e53076 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Tue, 6 Feb 2024 17:18:25 -0500 Subject: [PATCH 09/20] review comments --- CONTRIBUTING.md | 6 +++--- ...pport-calibrations-roundtrip-47f09bd9ff803479.yaml | 4 ++-- .../notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml | 11 +++-------- .../runtime-provider-support-5358b72ec0035419.yaml | 2 +- 4 files changed, 9 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14f0b9458e..08102d2a2c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -399,9 +399,9 @@ Utilities](https://docs.quantum.ibm.com/api/qiskit/utils) to add warnings: pass ``` -Note that these pre-deprecation and deprecation warnings will cause the CI to fail, but features up -for deprecation should continue to be tested until their removal. All such expected warnings -should be caught in tests: +Note that all warnings emitted by Qiskit Experiments, including pre-deprecation and deprecation +warnings, will cause the CI to fail, but features up for deprecation should continue to be tested +until their removal. All such expected warnings should be caught in tests: ```python with self.assertWarns(DeprecationWarning): diff --git a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml index f57a76824c..3a31509c85 100644 --- a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml +++ b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml @@ -1,11 +1,11 @@ --- features: - | - A JSON data format has been added for saving a :class:`.Calibrations` instance. + A JSON data format has been added for saving a :class:`.Calibrations` instance. This leverages a custom JSON encoder and decoder to serialize the entire calibration data including user provided schedule templates. Output JSON data is formatted into the standard data model which is intentionally - agnostic to the calibration data structure, which this allows community + agnostic to the calibration data structure, and this allows community developer to reuse the calibration data in their platform. See :mod:`qiskit_experiments.calibration_management.save_utils` for data models. deprecations: diff --git a/releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml b/releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml index 30f69c94b0..47ec887c1b 100644 --- a/releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml +++ b/releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml @@ -4,12 +4,7 @@ upgrade: The dependency on ``qiskit-terra`` was replaced with a dependency on ``qiskit``. This change follows the move in upstream Qiskit to rename ``qiskit-terra`` to ``qiskit``. The minimum required version was increased - from 0.24 for ``qiskit-terra`` to 0.44 for ``qiskit`` (equivalent to - ``qiskit-terra`` 0.25). The maximum ``qiskit`` version was set to ``<1.0`` - in anticipation of breaking changes in Qiskit 1.0. Closer to the Qiskit 1.0 - release, a patch release of ``qiskit-experiments`` will remove this - constraint and address any compatibility issues. For more information see - the `Qiskit repository renaming plan + from 0.24 for ``qiskit-terra`` to 0.45 for ``qiskit``. For more information on + the renaming of Qiskit, see the `Qiskit repository renaming plan `__ - and the `Qiskit 1.0 migration guide `__ - for information on renaming of the package. + and the `Qiskit 1.0 migration guide `__. diff --git a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml index de962c7802..26defc52e9 100644 --- a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml +++ b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml @@ -2,7 +2,7 @@ features: - | Experiments run via the ``qiskit-ibm-runtime`` provider can now be saved - to the cloud service. + to and loaded from the cloud service. upgrade: - | With the impending deprecation of the ``qiskit-ibm-provider`` package, support for From 553f502b516addd4bc47e0cd59b55c71cd396b29 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Tue, 6 Feb 2024 18:44:09 -0500 Subject: [PATCH 10/20] update deprecation policy --- CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++---------- 1 file changed, 37 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08102d2a2c..d56728814f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -361,22 +361,49 @@ There are a few other build options available: ### Deprecation policy -Qiskit Experiments's deprecation policy is based on Qiskit's [Deprecation -Policy](https://github.com/Qiskit/qiskit/blob/45e42525224e9e1857300e7e5529273fe619c9e4/DEPRECATION.md) -prior to its 1.0 release. Public-facing changes must come with a deprecation warning -for at least three months or two version cycles before the old feature is removed. -Deprecations can only happen on minor releases and not on patch releases. +Any change to the existing package code that affects how the user interacts with the package +should give the user clear instructions and advanced warning if the change is nontrivial. +Qiskit Experiments's deprecation policy is based on [Qiskit's +policy](https://github.com/Qiskit/qiskit/blob/1.0.0rc1/DEPRECATION.md) prior to its 1.0 release, but +we impose less stringent requirements such that developers can iterate more quickly. +Deprecations and feature removals can only happen on minor releases and not on patch releases. + +The deprecation policy depends on the significance of the user-facing change, which we have divided into +three categories: + +A **core feature change** is one that affects how the framework functions, for example a +change to `BaseExperiment`. The timeline for deprecating an existing core feature is as follows: + +* Minor release 1: An alternative path is provided. A `PendingDeprecationWarning` + should be issued when the old path is used, indicating to users how to switch to + the new path and the release in which the old path will no longer be available. The + developer may choose to directly deprecate the feature and issue a `DeprecationWarning` instead, + in which case the release note should indicate the feature has been deprecated and how to switch + to the new path. +* Minor release 2: The `PendingDeprecationWarning` becomes a `DeprecationWarning`, or the + `DeprecationWarning` remains in place. The release note should indicate the feature has + been deprecated and how to switch to the new path. +* Minor release 3: The old feature is removed. The release note should indicate that the feature has + been removed and how to switch to the new path. + +If the three-release cycle takes fewer than three months, the feature removal must wait for more +releases until three months has elapsed since the first issuing of the `PendingDeprecationWarning` +or `DeprecationWarning`. -The timeline for deprecating an existing feature is as follows: +A **non-core feature change** may be a change to a specific experiment class or modules such as the +plotter. The timeline is shortened for such a change: -* Minor release 1: An alternative path is provided. A `PendingDeprecationWarning` should be issued +* Minor release 1: An alternative path is provided. A `DeprecationWarning` should be issued when the old path is used, indicating to users how to switch to the new path and the release in which the old path will no longer be available. -* Minor release 2: The `PendingDeprecationWarning` becomes a `DeprecationWarning`. The release note - should indicate the feature has been deprecated and how to switch to the new path. -* Minor release 3: The old feature is removed. The release note should indicate that the feature has +* Minor release 2: The old feature is removed. The release note should indicate that the feature has been removed and how to switch to the new path. +Lastly, a **minor, non-core change** would include cosmetic changes such as output file names and +changes to helper functions that isn't directly used in the package code base. These can be made in +one release without a deprecation process as long as the change is clearly described in the +release notes. + #### Adding deprecation warnings We use the deprecation wrappers in [Qiskit From 931d05dfbf7b349dd5a3244c65b47760fea2926c Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Tue, 6 Feb 2024 19:03:26 -0500 Subject: [PATCH 11/20] add pandas intersphinx, expose RB synthesis, more fixes --- docs/conf.py | 1 + .../randomized_benchmarking/__init__.py | 9 +++++++++ .../clifford_synthesis.py | 2 +- .../0.6/0.6_release-4d766733941ad57a.yaml | 18 +++++++++++------- ...-dataframe-curve-data-a8905c450748b281.yaml | 4 ++-- ...-angle-representation-f5c40007416cf938.yaml | 2 +- .../0.6/half-angle-x-600debac368ce2c6.yaml | 6 +++--- ...rb-clifford-synthesis-0e66c62fa3088fba.yaml | 4 ++-- .../notes/0.6/qvplotter-04efe280aaa9d555.yaml | 3 +-- 9 files changed, 31 insertions(+), 18 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 817a15ab67..f9ee74c464 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -171,6 +171,7 @@ "matplotlib": ("https://matplotlib.org/stable/", None), "qiskit": ("https://docs.quantum.ibm.com/api/qiskit/", None), "uncertainties": ("https://pythonhosted.org/uncertainties", None), + "pandas": ("http://pandas.pydata.org/docs/", None), "qiskit_aer": ("https://qiskit.org/ecosystem/aer", None), "qiskit_dynamics": ("https://qiskit.org/ecosystem/dynamics/", None), "qiskit_ibm_runtime": ("https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/", None), diff --git a/qiskit_experiments/library/randomized_benchmarking/__init__.py b/qiskit_experiments/library/randomized_benchmarking/__init__.py index 7f0b555fe5..371f0a3679 100644 --- a/qiskit_experiments/library/randomized_benchmarking/__init__.py +++ b/qiskit_experiments/library/randomized_benchmarking/__init__.py @@ -37,6 +37,14 @@ RBAnalysis InterleavedRBAnalysis +Synthesis +========= + +.. autosummary:: + :toctree: ../stubs/ + + RBDefaultCliffordSynthesis + Utilities ========= @@ -52,3 +60,4 @@ from .interleaved_rb_analysis import InterleavedRBAnalysis from .clifford_utils import CliffordUtils from .rb_utils import RBUtils +from .clifford_synthesis import RBDefaultCliffordSynthesis diff --git a/qiskit_experiments/library/randomized_benchmarking/clifford_synthesis.py b/qiskit_experiments/library/randomized_benchmarking/clifford_synthesis.py index d1a88d7480..e475f76e39 100644 --- a/qiskit_experiments/library/randomized_benchmarking/clifford_synthesis.py +++ b/qiskit_experiments/library/randomized_benchmarking/clifford_synthesis.py @@ -60,7 +60,7 @@ def run( Returns: The quantum circuit representation of the Operation - when successful, and ``None`` otherwise. + when successful, and ``None`` otherwise. Raises: QiskitError: If basis_gates is not supplied. diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml index bbbe1caad4..5badcccc45 100644 --- a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml +++ b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml @@ -1,9 +1,13 @@ --- prelude: > - Qiskit Experiments 0.6 introduces numerous features and improvements. It is compatible with Qiskit 1.0. - Notable changes include refactoring the analysis results to a Pandas dataframe, and refactoring - curve fit data into a new :class:`.ScatterTable` container based on dataframes that is stored - by default as an artifact in :class:`.ExperimentData` along with the summary of fit results. - New experiments include :class:`.StarkP1Spectroscopy`, :class:`.StarkRamseyXY`, and - :class:`.StarkRamseyXYAmpScan`. The supported provider for running jobs on IBM backends is - now ``qiskit-ibm-runtime``. Using ``qiskit-ibm-provider`` is still supported but its use is deprecated. + Qiskit Experiments 0.6 introduces numerous features and improvements. It is compatible with + Qiskit 1.0. Notable changes include: refactoring the analysis results to a pandas + :class:`~pandas:pandas.DataFrame`-based :class:`.AnalysisResultTable`, the ability to add + artifacts of serializable data to :class:`.ExperimentData`, and refactoring curve fit data into + a new :class:`~pandas:pandas.DataFrame`-based :class:`.ScatterTable` container that is + stored by default as an artifact in :class:`.ExperimentData` along with the summary of fit + results. New experiments include :class:`.StarkP1Spectroscopy`, :class:`.StarkRamseyXY`, and + :class:`.StarkRamseyXYAmpScan`, and :class:`.StandardRB` and :class:`.InterleavedRB` were + significantly updated. The supported provider for running jobs on IBM backends is now + ``qiskit-ibm-runtime``. Using ``qiskit-ibm-provider`` is still supported but its use is + deprecated. diff --git a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml index 57f52b9af1..44d8e9b94d 100644 --- a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml +++ b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml @@ -3,8 +3,8 @@ features: - | :class:`.ScatterTable` has been introduced as a drop-in replacement of :class:`.CurveData`. - This is a data format to store intermediate data in curve analysis, built on top of - the pandas DataFrame. Each table row corresponds to a single data point, + This is a data format to store intermediate data in curve analysis built on top of + the pandas :class:`~pandas:pandas.DataFrame`. Each table row corresponds to a single data point, and the table contains all data points generated by the :class:`.CurveAnalysis`. All properties and methods of :class:`.CurveData` are implemented for backward compatibility, but these will be removed in the future release. diff --git a/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml b/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml index bf12fab777..12ce13eeee 100644 --- a/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml +++ b/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml @@ -30,7 +30,7 @@ upgrade: angle parameter) - the experiment will fail. Most reasonable cases will raise a detailed ``CalibrationError`` explaining the change and the way to adjust to it. Some edge cases - like a custom built pulse with an ``angle`` parameter - which doesn't conform to the naming convention of Qiskit Terra's + which doesn't conform to the naming convention of Qiskit's ``ScalableSymbolicPulse`` class, or using a loaded calibration with ``complex`` ``amp`` - will result in updating the wrong parameter. diff --git a/releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml b/releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml index d1af5944f2..a141e3e30c 100644 --- a/releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml +++ b/releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml @@ -3,8 +3,8 @@ fixes: - | The :class:`.HalfAngle` experiment's circuits were changed so that they use combinations of ``rz`` and ``x`` instead of the less standard ``y`` gate. - This change allows :class:`~HalfAngle` to be run on IBM backends directly. - Previously, it could only be run through the :class:`~HalfAngleCal` - subclass in combination with a :class:`~Calibrations` instance containing a + This change allows :class:`.HalfAngle` to be run on IBM backends directly. + Previously, it could only be run through the :class:`.HalfAngleCal` + subclass in combination with a :class:`.Calibrations` instance containing a custom calibration for the ``y`` gate. Fixes issue `#1233 `_. diff --git a/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml b/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml index 1e5b36013d..981dc1af97 100644 --- a/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml +++ b/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml @@ -4,7 +4,7 @@ features: Added a new experiment option ``clifford_synthesis_method`` to RB experiments, e.g. :class:`~.StandardRB` and :class:`~.InterleavedRB` so that users can plug in a custom Clifford synthesis algorithm used for generating RB circuits. - Such a plugin should be implemented as a ``HighLevelSynthesisPlugin`` + Such a plugin should be implemented as a :class:`~.qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin` (see :class:`~.RBDefaultCliffordSynthesis` for example). upgrade: - | @@ -12,7 +12,7 @@ upgrade: consisting only of instructions supported by the backend of interest. fixes: - | - Fixed a bug in circuit generation for three or more qubit RB where + Fixed a bug in circuit generation for three or more qubit Randomized Benchmarking where sampled Cliffords may be changed during their circuits synthesis (in the worst case, the resulting circuits may use qubits not in ``physical_qubits``). See issue diff --git a/releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml b/releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml index e0f6acbd3f..d0c4f68899 100644 --- a/releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml +++ b/releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml @@ -1,8 +1,7 @@ --- features: - | - An :meth:`~qiskit_experiments.visualization.BasePlotter.hline` method was - added to :class:`~qiskit_experiments.visualization.BasePlotter` for + An :meth:`~.BaseDrawer.hline` method was added to :class:`.BaseDrawer` for generating horizontal lines. See `#1348 `__. - | From b57deb0b248b117af50bfc7d1d4c82f1c21cb231 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Tue, 6 Feb 2024 22:40:58 -0500 Subject: [PATCH 12/20] update text --- CONTRIBUTING.md | 4 ++-- ...ature-support-calibrations-roundtrip-47f09bd9ff803479.yaml | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d56728814f..df530f2e12 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -399,8 +399,8 @@ plotter. The timeline is shortened for such a change: * Minor release 2: The old feature is removed. The release note should indicate that the feature has been removed and how to switch to the new path. -Lastly, a **minor, non-core change** would include cosmetic changes such as output file names and -changes to helper functions that isn't directly used in the package code base. These can be made in +Lastly, a **minor, non-core change** could be a cosmetic change such as output file names or a +change to helper functions that isn't directly used in the package codebase. These can be made in one release without a deprecation process as long as the change is clearly described in the release notes. diff --git a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml index 3a31509c85..b20b8d3fb3 100644 --- a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml +++ b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml @@ -7,7 +7,6 @@ features: Output JSON data is formatted into the standard data model which is intentionally agnostic to the calibration data structure, and this allows community developer to reuse the calibration data in their platform. - See :mod:`qiskit_experiments.calibration_management.save_utils` for data models. deprecations: - | Saving :class:`.Calibrations` instance into CSV file was deprecated. From 2cf403c1305a30342704e693c1c9c4fa7c5652fd Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Tue, 6 Feb 2024 23:34:59 -0500 Subject: [PATCH 13/20] review comment --- ...eature-support-calibrations-roundtrip-47f09bd9ff803479.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml index b20b8d3fb3..d1f2fa3673 100644 --- a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml +++ b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml @@ -5,8 +5,7 @@ features: This leverages a custom JSON encoder and decoder to serialize the entire calibration data including user provided schedule templates. Output JSON data is formatted into the standard data model which is intentionally - agnostic to the calibration data structure, and this allows community - developer to reuse the calibration data in their platform. + agnostic to the calibration data structure. deprecations: - | Saving :class:`.Calibrations` instance into CSV file was deprecated. From 280bc1a0effd5c4697ca3343c7da4a792c608f3e Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 7 Feb 2024 01:04:22 -0500 Subject: [PATCH 14/20] add links to old and new providers --- docs/conf.py | 4 ++-- docs/howtos/cloud_service.rst | 4 ++-- docs/howtos/rerun_analysis.rst | 4 ++-- docs/howtos/runtime_sessions.rst | 6 +++--- qiskit_experiments/framework/experiment_data.py | 7 ++++--- .../notes/0.5/0_5_release-89f59845afb19e89.yaml | 2 +- .../0.5/calibration-backendv2-e564f466eb1c9999.yaml | 2 +- .../0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml | 2 +- .../notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml | 2 +- .../notes/0.6/0.6_release-4d766733941ad57a.yaml | 2 +- .../0.6/runtime-provider-support-5358b72ec0035419.yaml | 10 +++++----- 11 files changed, 23 insertions(+), 22 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f9ee74c464..20048be018 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -172,8 +172,8 @@ "qiskit": ("https://docs.quantum.ibm.com/api/qiskit/", None), "uncertainties": ("https://pythonhosted.org/uncertainties", None), "pandas": ("http://pandas.pydata.org/docs/", None), - "qiskit_aer": ("https://qiskit.org/ecosystem/aer", None), - "qiskit_dynamics": ("https://qiskit.org/ecosystem/dynamics/", None), + "qiskit_aer": ("https://qiskit.github.io/qiskit-aer/", None), + "qiskit_dynamics": ("https://qiskit-extensions.github.io/qiskit-dynamics/", None), "qiskit_ibm_runtime": ("https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/", None), } diff --git a/docs/howtos/cloud_service.rst b/docs/howtos/cloud_service.rst index 18c875d3b4..aa14872359 100644 --- a/docs/howtos/cloud_service.rst +++ b/docs/howtos/cloud_service.rst @@ -18,8 +18,8 @@ Saving ~~~~~~ .. note:: - This guide requires :mod:`qiskit-ibm-runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. - For how to migrate from the older :mod:`qiskit-ibm-provider` to :mod:`qiskit-ibm-runtime`, + This guide requires :mod:`qiskit_ibm_runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. + For how to migrate from the older :mod:`qiskit_ibm_provider` to :mod:`qiskit_ibm_runtime`, consult the `migration guide `_.\ You must run the experiment on a real IBM diff --git a/docs/howtos/rerun_analysis.rst b/docs/howtos/rerun_analysis.rst index c5d8653fcf..c4e0e260b1 100644 --- a/docs/howtos/rerun_analysis.rst +++ b/docs/howtos/rerun_analysis.rst @@ -12,8 +12,8 @@ Solution -------- .. note:: - This guide requires :mod:`qiskit-ibm-runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. - For how to migrate from the older :mod:`qiskit-ibm-provider` to :mod:`qiskit-ibm-runtime`, + This guide requires :mod:`qiskit_ibm_runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. + For how to migrate from the older :mod:`qiskit_ibm_provider` to :mod:`qiskit_ibm_runtime`, consult the `migration guide `_.\ Once you recreate the exact experiment you ran and all of its parameters and options, diff --git a/docs/howtos/runtime_sessions.rst b/docs/howtos/runtime_sessions.rst index b7ecc63383..a6b07b29b6 100644 --- a/docs/howtos/runtime_sessions.rst +++ b/docs/howtos/runtime_sessions.rst @@ -11,11 +11,11 @@ Solution -------- .. note:: - This guide requires :mod:`qiskit-ibm-runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. - For how to migrate from the older :mod:`qiskit-ibm-provider` to :mod:`qiskit-ibm-runtime`, + This guide requires :mod:`qiskit_ibm_runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. + For how to migrate from the older :mod:`qiskit_ibm_provider` to :mod:`qiskit_ibm_runtime`, consult the `migration guide `_.\ -Use the :class:`~qiskit_ibm_runtime.IBMBackend` object in :mod:`qiskit-ibm-runtime`, which supports sessions. +Use the :class:`~qiskit_ibm_runtime.IBMBackend` object in :mod:`qiskit_ibm_runtime`, which supports sessions. In this example, we will set the ``max_circuits`` property to an artificially low value so that the experiment will be split into multiple jobs that run sequentially in a single session. When running real experiments with a diff --git a/qiskit_experiments/framework/experiment_data.py b/qiskit_experiments/framework/experiment_data.py index 60396fe309..e4b4241318 100644 --- a/qiskit_experiments/framework/experiment_data.py +++ b/qiskit_experiments/framework/experiment_data.py @@ -2255,9 +2255,10 @@ def load( experiment_id: Experiment ID. service: the database service. provider: an IBMProvider required for loading job data and - can be used to initialize the service. In ``qiskit-ibm-runtime``, - this is the ``QiskitRuntimeService`` and should not be confused with - the experiment database service. + can be used to initialize the service. When using :mod:`qiskit_ibm_runtime`, + this is the :class:`~qiskit_ibm_runtime.QiskitRuntimeService` and should + not be confused with the experiment database service + :meth:`qiskit_ibm_experiment.IBMExperimentService`. Returns: The loaded experiment data. diff --git a/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml b/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml index 731da94a30..9d94a8e92a 100644 --- a/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml +++ b/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml @@ -6,7 +6,7 @@ prelude: > benchmarking experiments has been significantly improved. The ``qubit`` and ``qubits`` input to experiments has been regularized to ``physical_qubits``, and support for ``qiskit-ibmq-provider`` has been deprecated in favor of - ``qiskit-ibm-provider``. New experiments added include + :mod:`qiskit_ibm_provider`. New experiments added include :class:`.MultiStateDiscrimination`, :class:`.ZZRamsey`, :class:`.MitigatedStateTomography`, and :class:`.MitigatedProcessTomography`, along with significant improvements to diff --git a/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml b/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml index 3a89e276b6..8ca5b92784 100644 --- a/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml +++ b/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml @@ -4,7 +4,7 @@ fixes: Updated querying of :class:`~qiskit.providers.Backend` metadata to support the look up of qubit T1 and measurement drive frequency, in order to support :class:`~qiskit.providers.BackendV2` backends. The look up of the - latter is ``qiskit-ibm-provider`` specific. This change fixed errors + latter is :mod:`qiskit_ibm_provider` specific. This change fixed errors failing to find these properties when using :class:`.ResonatorSpectroscopy` (issue `#1099 `_) and when using restless measurements with ``BackendV2`` backends. diff --git a/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml b/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml index 3f589ad464..4e6cffe960 100644 --- a/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml +++ b/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml @@ -2,7 +2,7 @@ upgrade: - | ``qiskit-ibmq-provider`` is deprecated and has been dropped as a requirement. Interactions - with IBM backends should use the ``qiskit-ibm-provider`` package instead (must be installed + with IBM backends should use the :mod:`qiskit_ibm_provider` package instead (must be installed separately; see the `migration guide `_ for more details). diff --git a/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml b/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml index edde8cd844..188ae5b36c 100644 --- a/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml +++ b/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml @@ -4,7 +4,7 @@ fixes: Fixed qpy serialization and deserialization of tomography experiments. The barrier instructions in tomography experiments were created with the wrong Python type which qpy did not support. This issue was most acute when using - ``qiskit-ibm-provider`` which submits circuits to the provider using qpy. + :mod:`qiskit_ibm_provider` which submits circuits to the provider using qpy. There could have been subtler issues with circuit timing using a different provider if the barriers were not separating important circuit instructions. See `#1060 `_. diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml index 5badcccc45..8530ef67ec 100644 --- a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml +++ b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml @@ -9,5 +9,5 @@ prelude: > results. New experiments include :class:`.StarkP1Spectroscopy`, :class:`.StarkRamseyXY`, and :class:`.StarkRamseyXYAmpScan`, and :class:`.StandardRB` and :class:`.InterleavedRB` were significantly updated. The supported provider for running jobs on IBM backends is now - ``qiskit-ibm-runtime``. Using ``qiskit-ibm-provider`` is still supported but its use is + :mod:`qiskit_ibm_runtime`. Using :mod:`qiskit_ibm_provider` is still supported but its use is deprecated. diff --git a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml index 26defc52e9..6ce3650202 100644 --- a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml +++ b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml @@ -1,14 +1,14 @@ --- features: - | - Experiments run via the ``qiskit-ibm-runtime`` provider can now be saved + Experiments run via the :mod:`qiskit_ibm_runtime` provider can now be saved to and loaded from the cloud service. upgrade: - | - With the impending deprecation of the ``qiskit-ibm-provider`` package, support for - ``qiskit-ibm-provider`` is now deprecated and will be removed - in the next release. Users should migrate to ``qiskit-ibm-runtime`` following the + With the impending deprecation of the :mod:`qiskit_ibm_provider` package, support for + :mod:`qiskit_ibm_provider` is now deprecated and will be removed + in the next release. Users should migrate to :mod:`qiskit_ibm_runtime` following the `runtime migration guide `_. - ``qiskit-ibm-runtime`` is not listed as a dependency for compatibility reasons, but users + :mod:`qiskit_ibm_runtime` is not listed as a dependency for compatibility reasons, but users will need it to run experiments on IBM backends. From 6641efa3702df1055b05821c76c9bb0d1f3c54f9 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 7 Feb 2024 01:27:36 -0500 Subject: [PATCH 15/20] add feature subsections --- docs/conf.py | 5 +++-- releasenotes/config.yaml | 10 +++++++++- .../notes/0.6/0.6_release-4d766733941ad57a.yaml | 6 ++++-- ...cess_figure_without_extension-5b7438c19e223d6b.yaml | 2 +- ...dd-dataframe-analysis-results-ec8863e826a70621.yaml | 2 +- .../0.6/add-dataframe-curve-data-a8905c450748b281.yaml | 2 +- ...ualization-with-unshared-axis-9f7bfe272353086b.yaml | 2 +- .../notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml | 2 +- .../0.6/broadcasting-option-8a3b72bfc1df9668.yaml | 2 +- .../0.6/circuit-count-method-a095bd74aaa1d2fb.yaml | 2 +- .../experiment_data_fixes-f69c3569a8ba1342.yaml | 2 +- ...upport-calibrations-roundtrip-47f09bd9ff803479.yaml | 2 +- .../notes/0.6/irb-circuit-order-619845a707519c44.yaml | 2 +- releasenotes/notes/0.6/mod-stark-1f1afb538a94fe9a.yaml | 2 +- ...lugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml | 2 +- releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml | 2 +- .../0.6/runtime-provider-support-5358b72ec0035419.yaml | 2 +- .../notes/0.6/scale_options-745ee6f8e560043f.yaml | 2 +- .../selective-figure-generation-0864216f34d3486f.yaml | 2 +- ...setter-methods-for-experiment-099074e59faffb49.yaml | 2 +- requirements-dev.txt | 2 +- 21 files changed, 34 insertions(+), 23 deletions(-) rename releasenotes/notes/{0.5 => 0.6}/experiment_data_fixes-f69c3569a8ba1342.yaml (98%) diff --git a/docs/conf.py b/docs/conf.py index 20048be018..80a4bfbab5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -172,9 +172,10 @@ "qiskit": ("https://docs.quantum.ibm.com/api/qiskit/", None), "uncertainties": ("https://pythonhosted.org/uncertainties", None), "pandas": ("http://pandas.pydata.org/docs/", None), - "qiskit_aer": ("https://qiskit.github.io/qiskit-aer/", None), - "qiskit_dynamics": ("https://qiskit-extensions.github.io/qiskit-dynamics/", None), + "qiskit_aer": ("https://qiskit.org/ecosystem/aer", None), + "qiskit_dynamics": ("https://qiskit.org/ecosystem/dynamics/", None), "qiskit_ibm_runtime": ("https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/", None), + "qiskit_ibm_provider": ("https://docs.quantum.ibm.com/api/qiskit-ibm-provider/", None), } diff --git a/releasenotes/config.yaml b/releasenotes/config.yaml index cd18b4b856..d5750d20e3 100644 --- a/releasenotes/config.yaml +++ b/releasenotes/config.yaml @@ -2,7 +2,15 @@ encoding: utf8 default_branch: main sections: - - [features, New Features] + - [features, New Features, 1] + - [features_expnew, New Experiments, 2] + - [features_expupdate, Experiment Updates, 2] + - [features_expclass, Experiment Class Features, 2] + - [features_analysis, Analysis Class Features, 2] + - [features_expdata, Experiment Data Features, 2] + - [features_curvefit, Curve Fit Features, 2] + - [features_calibration, Calibration Features, 2] + - [features_visualization, Visualization Features, 2] - [issues, Known Issues] - [upgrade, Upgrade Notes] - [deprecations, Deprecation Notes] diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml index 8530ef67ec..e29f718afc 100644 --- a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml +++ b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml @@ -7,7 +7,9 @@ prelude: > a new :class:`~pandas:pandas.DataFrame`-based :class:`.ScatterTable` container that is stored by default as an artifact in :class:`.ExperimentData` along with the summary of fit results. New experiments include :class:`.StarkP1Spectroscopy`, :class:`.StarkRamseyXY`, and - :class:`.StarkRamseyXYAmpScan`, and :class:`.StandardRB` and :class:`.InterleavedRB` were - significantly updated. The supported provider for running jobs on IBM backends is now + :class:`.StarkRamseyXYAmpScan`. :class:`.StandardRB` and :class:`.InterleavedRB` were + significantly improved. The supported provider for running jobs on IBM backends is now :mod:`qiskit_ibm_runtime`. Using :mod:`qiskit_ibm_provider` is still supported but its use is deprecated. +features: + New features are listed below in subsections by functional area. \ No newline at end of file diff --git a/releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml b/releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml index 8128036e23..2b2cdc6993 100644 --- a/releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml +++ b/releasenotes/notes/0.6/access_figure_without_extension-5b7438c19e223d6b.yaml @@ -1,4 +1,4 @@ --- -features: +features_expdata: - | Figures in :class:`.ExperimentData` objects can now be accessed without the ``.svg`` extension. \ No newline at end of file diff --git a/releasenotes/notes/0.6/add-dataframe-analysis-results-ec8863e826a70621.yaml b/releasenotes/notes/0.6/add-dataframe-analysis-results-ec8863e826a70621.yaml index bd349b8b2a..f323dbf16f 100644 --- a/releasenotes/notes/0.6/add-dataframe-analysis-results-ec8863e826a70621.yaml +++ b/releasenotes/notes/0.6/add-dataframe-analysis-results-ec8863e826a70621.yaml @@ -1,5 +1,5 @@ --- -features: +features_expdata: - | :class:`.ExperimentData` has been upgraded to store analysis result data in a table format with the new inline container :class:`.AnalysisResultTable`. diff --git a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml index 44d8e9b94d..95d1da4ca6 100644 --- a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml +++ b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml @@ -1,5 +1,5 @@ --- -features: +features_curvefit: - | :class:`.ScatterTable` has been introduced as a drop-in replacement of :class:`.CurveData`. diff --git a/releasenotes/notes/0.6/add-support-for-visualization-with-unshared-axis-9f7bfe272353086b.yaml b/releasenotes/notes/0.6/add-support-for-visualization-with-unshared-axis-9f7bfe272353086b.yaml index 8c801288ee..0a8c7bbe78 100644 --- a/releasenotes/notes/0.6/add-support-for-visualization-with-unshared-axis-9f7bfe272353086b.yaml +++ b/releasenotes/notes/0.6/add-support-for-visualization-with-unshared-axis-9f7bfe272353086b.yaml @@ -1,5 +1,5 @@ --- -features: +features_visualization: - | The :class:`.MplDrawer` visualization backend has been upgraded so that it can take list of options for ``xlim``, ``ylim``, ``xval_unit``, ``yval_unit``, diff --git a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml index 62b486e4f2..1f1347d2ca 100644 --- a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml +++ b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml @@ -1,5 +1,5 @@ --- -features: +features_calibration: - | A new method :meth:`~.Calibrations.has_template` has been added to :class:`.Calibrations` diff --git a/releasenotes/notes/0.6/broadcasting-option-8a3b72bfc1df9668.yaml b/releasenotes/notes/0.6/broadcasting-option-8a3b72bfc1df9668.yaml index d6deb84dd4..d0e7717084 100644 --- a/releasenotes/notes/0.6/broadcasting-option-8a3b72bfc1df9668.yaml +++ b/releasenotes/notes/0.6/broadcasting-option-8a3b72bfc1df9668.yaml @@ -1,5 +1,5 @@ --- -features: +features_analysis: - | Added a ``broadcast`` option to :class:`.CompositeAnalysis`. When ``broadcast=True`` is passed, this option will be applied to child experiment analyses within the class. This means it will iterate diff --git a/releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml b/releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml index 550e2f4116..12212f7987 100644 --- a/releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml +++ b/releasenotes/notes/0.6/circuit-count-method-a095bd74aaa1d2fb.yaml @@ -1,5 +1,5 @@ --- -features: +features_expclass: - | A new method :meth:`.BaseExperiment.job_info` has been added that will output the number of jobs the experiment is expected to be split into diff --git a/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml b/releasenotes/notes/0.6/experiment_data_fixes-f69c3569a8ba1342.yaml similarity index 98% rename from releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml rename to releasenotes/notes/0.6/experiment_data_fixes-f69c3569a8ba1342.yaml index 08cf6637cb..1385aae5a1 100644 --- a/releasenotes/notes/0.5/experiment_data_fixes-f69c3569a8ba1342.yaml +++ b/releasenotes/notes/0.6/experiment_data_fixes-f69c3569a8ba1342.yaml @@ -1,5 +1,5 @@ --- -features: +features_expdata: - | :meth:`.ExperimentData.save` now uses the multithreading capability of the experiment service to enable faster saving times. diff --git a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml index d1f2fa3673..54b60feafe 100644 --- a/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml +++ b/releasenotes/notes/0.6/feature-support-calibrations-roundtrip-47f09bd9ff803479.yaml @@ -1,5 +1,5 @@ --- -features: +features_calibration: - | A JSON data format has been added for saving a :class:`.Calibrations` instance. This leverages a custom JSON encoder and decoder to serialize diff --git a/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml b/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml index efeef6b701..d0dfd0364b 100644 --- a/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml +++ b/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml @@ -1,5 +1,5 @@ --- -features: +features_expupdate: - | A new experiment option ``circuit_order`` was added to :class:`~.InterleavedRB`. It allows to change the order of the reference and the interleaved circuits diff --git a/releasenotes/notes/0.6/mod-stark-1f1afb538a94fe9a.yaml b/releasenotes/notes/0.6/mod-stark-1f1afb538a94fe9a.yaml index 855635b1aa..82ec8bc538 100644 --- a/releasenotes/notes/0.6/mod-stark-1f1afb538a94fe9a.yaml +++ b/releasenotes/notes/0.6/mod-stark-1f1afb538a94fe9a.yaml @@ -1,5 +1,5 @@ --- -features: +features_expnew: - | New experiment :class:`.StarkRamseyXY` has been added. This is a variant of the :class:`.RamseyXY` experiment that characterizes diff --git a/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml b/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml index 981dc1af97..5a2596d1f5 100644 --- a/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml +++ b/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml @@ -1,5 +1,5 @@ --- -features: +features_expupdate: - | Added a new experiment option ``clifford_synthesis_method`` to RB experiments, e.g. :class:`~.StandardRB` and :class:`~.InterleavedRB` so that users can diff --git a/releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml b/releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml index d0c4f68899..f87ff2c28a 100644 --- a/releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml +++ b/releasenotes/notes/0.6/qvplotter-04efe280aaa9d555.yaml @@ -1,5 +1,5 @@ --- -features: +features_visualization: - | An :meth:`~.BaseDrawer.hline` method was added to :class:`.BaseDrawer` for generating horizontal lines. See `#1348 diff --git a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml index 6ce3650202..55165b5f65 100644 --- a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml +++ b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml @@ -1,5 +1,5 @@ --- -features: +features_expdata: - | Experiments run via the :mod:`qiskit_ibm_runtime` provider can now be saved to and loaded from the cloud service. diff --git a/releasenotes/notes/0.6/scale_options-745ee6f8e560043f.yaml b/releasenotes/notes/0.6/scale_options-745ee6f8e560043f.yaml index 6516c857f5..fc45ad485c 100644 --- a/releasenotes/notes/0.6/scale_options-745ee6f8e560043f.yaml +++ b/releasenotes/notes/0.6/scale_options-745ee6f8e560043f.yaml @@ -1,5 +1,5 @@ --- -features: +features_visualization: - | New figure options were added to the visualization module: ``xscale`` and ``yscale``. They represent parameters to the Matplotlib functions ``set_xscale`` and ``set_yscale``: ``log``, diff --git a/releasenotes/notes/0.6/selective-figure-generation-0864216f34d3486f.yaml b/releasenotes/notes/0.6/selective-figure-generation-0864216f34d3486f.yaml index 14ac846d53..b41b4dfb82 100644 --- a/releasenotes/notes/0.6/selective-figure-generation-0864216f34d3486f.yaml +++ b/releasenotes/notes/0.6/selective-figure-generation-0864216f34d3486f.yaml @@ -1,5 +1,5 @@ --- -features: +features_analysis: - | The ``generate_figures`` parameter has been added to :class:`.CompositeAnalysis` to control figure generation. By default, ``generate_figures`` is ``always``, meaning figures will always be generated. diff --git a/releasenotes/notes/0.6/setter-methods-for-experiment-099074e59faffb49.yaml b/releasenotes/notes/0.6/setter-methods-for-experiment-099074e59faffb49.yaml index 00d66c572c..493fce6fb5 100644 --- a/releasenotes/notes/0.6/setter-methods-for-experiment-099074e59faffb49.yaml +++ b/releasenotes/notes/0.6/setter-methods-for-experiment-099074e59faffb49.yaml @@ -1,5 +1,5 @@ --- -features: +features_expclass: - | Added ``experiment_type`` as optional ``__init__`` kwarg in :class:`.BatchExperiment` and :class:`.ParallelExperiment`. diff --git a/requirements-dev.txt b/requirements-dev.txt index 1f16c9a9a8..a0abeac142 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -20,7 +20,7 @@ jupyter-sphinx>=0.4.0 nbsphinx pylatexenc qiskit-sphinx-theme -reno>=4.0.0 +reno @ git+https://github.com/openstack/reno.git@270c97d738430e35abae5985be13f30078137504 sphinx>=6.2.1 sphinx-copybutton sphinx-design From 554489985038f6fcfc47e0f8249d9377ceb379ae Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 7 Feb 2024 09:58:12 -0500 Subject: [PATCH 16/20] update provider and aer ref links --- docs/howtos/cloud_service.rst | 4 ++-- docs/howtos/rerun_analysis.rst | 4 ++-- docs/howtos/runtime_sessions.rst | 6 +++--- docs/manuals/characterization/stark_experiment.rst | 2 +- docs/manuals/characterization/t1.rst | 2 +- docs/manuals/characterization/t2ramsey.rst | 2 +- docs/manuals/characterization/tphi.rst | 2 +- docs/manuals/measurement/readout_mitigation.rst | 2 +- docs/manuals/measurement/restless_measurements.rst | 2 +- docs/manuals/verification/quantum_volume.rst | 2 +- docs/manuals/verification/randomized_benchmarking.rst | 2 +- docs/manuals/verification/state_tomography.rst | 2 +- docs/tutorials/custom_experiment.rst | 2 +- docs/tutorials/getting_started.rst | 4 ++-- docs/tutorials/visualization.rst | 4 ++-- qiskit_experiments/framework/experiment_data.py | 3 ++- .../library/calibration/half_angle_cal.py | 2 +- .../library/quantum_volume/qv_experiment.py | 2 +- .../notes/0.5/0_5_release-89f59845afb19e89.yaml | 2 +- .../0.5/calibration-backendv2-e564f466eb1c9999.yaml | 2 +- .../0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml | 2 +- .../notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml | 2 +- .../notes/0.6/0.6_release-4d766733941ad57a.yaml | 5 +++-- .../0.6/runtime-provider-support-5358b72ec0035419.yaml | 10 +++++----- 24 files changed, 37 insertions(+), 35 deletions(-) diff --git a/docs/howtos/cloud_service.rst b/docs/howtos/cloud_service.rst index aa14872359..2848e713a3 100644 --- a/docs/howtos/cloud_service.rst +++ b/docs/howtos/cloud_service.rst @@ -18,8 +18,8 @@ Saving ~~~~~~ .. note:: - This guide requires :mod:`qiskit_ibm_runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. - For how to migrate from the older :mod:`qiskit_ibm_provider` to :mod:`qiskit_ibm_runtime`, + This guide requires :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. + For how to migrate from the older :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime `, consult the `migration guide `_.\ You must run the experiment on a real IBM diff --git a/docs/howtos/rerun_analysis.rst b/docs/howtos/rerun_analysis.rst index c4e0e260b1..f493719d22 100644 --- a/docs/howtos/rerun_analysis.rst +++ b/docs/howtos/rerun_analysis.rst @@ -12,8 +12,8 @@ Solution -------- .. note:: - This guide requires :mod:`qiskit_ibm_runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. - For how to migrate from the older :mod:`qiskit_ibm_provider` to :mod:`qiskit_ibm_runtime`, + This guide requires :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. + For how to migrate from the older :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime `, consult the `migration guide `_.\ Once you recreate the exact experiment you ran and all of its parameters and options, diff --git a/docs/howtos/runtime_sessions.rst b/docs/howtos/runtime_sessions.rst index a6b07b29b6..da08ed6b49 100644 --- a/docs/howtos/runtime_sessions.rst +++ b/docs/howtos/runtime_sessions.rst @@ -11,11 +11,11 @@ Solution -------- .. note:: - This guide requires :mod:`qiskit_ibm_runtime` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. - For how to migrate from the older :mod:`qiskit_ibm_provider` to :mod:`qiskit_ibm_runtime`, + This guide requires :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` version 0.15 and up, which can be installed with ``python -m pip install qiskit-ibm-runtime``. + For how to migrate from the older :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime `, consult the `migration guide `_.\ -Use the :class:`~qiskit_ibm_runtime.IBMBackend` object in :mod:`qiskit_ibm_runtime`, which supports sessions. +Use the :class:`~qiskit_ibm_runtime.IBMBackend` object in :external+qiskit_ibm_runtime:doc:`index`, which supports sessions. In this example, we will set the ``max_circuits`` property to an artificially low value so that the experiment will be split into multiple jobs that run sequentially in a single session. When running real experiments with a diff --git a/docs/manuals/characterization/stark_experiment.rst b/docs/manuals/characterization/stark_experiment.rst index 8233a6ac6f..f34c83b981 100644 --- a/docs/manuals/characterization/stark_experiment.rst +++ b/docs/manuals/characterization/stark_experiment.rst @@ -113,7 +113,7 @@ In a typical IBM device using the cross-resonance drive architecture, such channel can be identified with your backend as follows: .. note:: - This tutorial requires the :mod:`qiskit_ibm_runtime` package to model a + This tutorial requires the :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` package to model a backend. You can install it with ``python -m pip install qiskit-ibm-runtime``. .. jupyter-execute:: diff --git a/docs/manuals/characterization/t1.rst b/docs/manuals/characterization/t1.rst index 82a5801ebe..1fefa30371 100644 --- a/docs/manuals/characterization/t1.rst +++ b/docs/manuals/characterization/t1.rst @@ -30,7 +30,7 @@ The following code demonstrates a basic run of a :math:`T_1` experiment for qubit 0. .. note:: - This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime` + This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer ` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` packages to run simulations. You can install them with ``python -m pip install qiskit-aer qiskit-ibm-runtime``. diff --git a/docs/manuals/characterization/t2ramsey.rst b/docs/manuals/characterization/t2ramsey.rst index f7991572e4..c65f5a434c 100644 --- a/docs/manuals/characterization/t2ramsey.rst +++ b/docs/manuals/characterization/t2ramsey.rst @@ -58,7 +58,7 @@ We run the experiment on a simulated backend using Qiskit Aer with a pure T1/T2 relaxation noise model. .. note:: - This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime` + This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer ` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` packages to run simulations. You can install them with ``python -m pip install qiskit-aer qiskit-ibm-runtime``. diff --git a/docs/manuals/characterization/tphi.rst b/docs/manuals/characterization/tphi.rst index 245614af31..43e117b657 100644 --- a/docs/manuals/characterization/tphi.rst +++ b/docs/manuals/characterization/tphi.rst @@ -21,7 +21,7 @@ From the :math:`T_1` and :math:`T_2` estimates, we compute the results for :math:`T_\varphi.` .. note:: - This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime` + This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer ` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` packages to run simulations. You can install them with ``python -m pip install qiskit-aer qiskit-ibm-runtime``. diff --git a/docs/manuals/measurement/readout_mitigation.rst b/docs/manuals/measurement/readout_mitigation.rst index 418e7c7be4..64a7034cf1 100644 --- a/docs/manuals/measurement/readout_mitigation.rst +++ b/docs/manuals/measurement/readout_mitigation.rst @@ -31,7 +31,7 @@ This notebook demonstrates the usage of both the local and correlated experiments to generate the corresponding mitigators. .. note:: - This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime` + This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer ` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` packages to run simulations. You can install them with ``python -m pip install qiskit-aer qiskit-ibm-runtime``. diff --git a/docs/manuals/measurement/restless_measurements.rst b/docs/manuals/measurement/restless_measurements.rst index fbde9c7a3e..f85829071b 100644 --- a/docs/manuals/measurement/restless_measurements.rst +++ b/docs/manuals/measurement/restless_measurements.rst @@ -59,7 +59,7 @@ observe any meaningful outcomes with fake backends since the circuit simulator they use always starts with the qubits in the ground state. .. note:: - This tutorial requires the :mod:`qiskit_ibm_runtime` package to model a + This tutorial requires the :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` package to model a backend. You can install it with ``python -m pip install qiskit-ibm-runtime``. .. jupyter-execute:: diff --git a/docs/manuals/verification/quantum_volume.rst b/docs/manuals/verification/quantum_volume.rst index 3f78764305..1fb06a9565 100644 --- a/docs/manuals/verification/quantum_volume.rst +++ b/docs/manuals/verification/quantum_volume.rst @@ -25,7 +25,7 @@ probability` > 2/3 with confidence level > 0.977 (corresponding to z_value = 2), and at least 100 trials have been ran. .. note:: - This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime` + This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer ` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` packages to run simulations. You can install them with ``python -m pip install qiskit-aer qiskit-ibm-runtime``. diff --git a/docs/manuals/verification/randomized_benchmarking.rst b/docs/manuals/verification/randomized_benchmarking.rst index 50e7620356..e0c6190e11 100644 --- a/docs/manuals/verification/randomized_benchmarking.rst +++ b/docs/manuals/verification/randomized_benchmarking.rst @@ -12,7 +12,7 @@ error estimates for the quantum device, by calculating the Error Per Clifford. S explanation on the RB method, which is based on Refs. [1]_ [2]_. .. note:: - This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime` + This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer ` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` packages to run simulations. You can install them with ``python -m pip install qiskit-aer qiskit-ibm-runtime``. diff --git a/docs/manuals/verification/state_tomography.rst b/docs/manuals/verification/state_tomography.rst index dd972041dc..3e25f8b884 100644 --- a/docs/manuals/verification/state_tomography.rst +++ b/docs/manuals/verification/state_tomography.rst @@ -8,7 +8,7 @@ of a quantum state by preparing the state many times and measuring them in a tom complete basis of measurement operators. .. note:: - This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime` + This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer ` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` packages to run simulations. You can install them with ``python -m pip install qiskit-aer qiskit-ibm-runtime``. diff --git a/docs/tutorials/custom_experiment.rst b/docs/tutorials/custom_experiment.rst index a094d9d91a..0a1a50b4f9 100644 --- a/docs/tutorials/custom_experiment.rst +++ b/docs/tutorials/custom_experiment.rst @@ -558,7 +558,7 @@ output if the Pauli corresponding to that bit has a nonzero signature. To test our code, we first simulate a noisy backend with asymmetric readout error. .. note:: - This tutorial requires the :mod:`qiskit_aer` package for simulations. + This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer ` package for simulations. You can install it with ``python -m pip install qiskit-aer``. diff --git a/docs/tutorials/getting_started.rst b/docs/tutorials/getting_started.rst index 7ca6e32567..826de87d4a 100644 --- a/docs/tutorials/getting_started.rst +++ b/docs/tutorials/getting_started.rst @@ -58,7 +58,7 @@ Experiments must be run on a backend. We're going to use a simulator, backend, real or simulated, that you can access through Qiskit. .. note:: - This tutorial requires the :mod:`qiskit_aer` and :mod:`qiskit_ibm_runtime` + This tutorial requires the :external+qiskit_aer:doc:`qiskit-aer ` and :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` packages to run simulations. You can install them with ``python -m pip install qiskit-aer qiskit-ibm-runtime``. @@ -184,7 +184,7 @@ value and standard deviation of each value can be accessed as follows: print(exp_data.analysis_results("T1").value.std_dev) For further documentation on how to work with UFloats, consult the ``uncertainties`` -:external+uncertainties:doc:`user_guide`. +:external+uncertainties:doc:`index`. :external+qiskit_ibm_runtime:doc:`index` Raw circuit output data and its associated metadata can be accessed with the :meth:`~.ExperimentData.data` property. Data is indexed by the circuit it corresponds diff --git a/docs/tutorials/visualization.rst b/docs/tutorials/visualization.rst index 5dc5e39483..1b57d079fa 100644 --- a/docs/tutorials/visualization.rst +++ b/docs/tutorials/visualization.rst @@ -34,8 +34,8 @@ Generating and customizing a figure using a plotter First, we display the default figure from a :class:`.Rabi` experiment as a starting point: .. note:: - This tutorial requires the :mod:`qiskit_dynamics`, :mod:`qiskit_aer`, and - :mod:`qiskit_ibm_runtime` packages to run simulations. You can install them + This tutorial requires the :mod:`qiskit_dynamics`, :external+qiskit_aer:doc:`qiskit-aer `, and + :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` packages to run simulations. You can install them with ``python -m pip install qiskit-dynamics qiskit-aer qiskit-ibm-runtime``. .. jupyter-execute:: diff --git a/qiskit_experiments/framework/experiment_data.py b/qiskit_experiments/framework/experiment_data.py index e4b4241318..aac51547ed 100644 --- a/qiskit_experiments/framework/experiment_data.py +++ b/qiskit_experiments/framework/experiment_data.py @@ -2255,7 +2255,8 @@ def load( experiment_id: Experiment ID. service: the database service. provider: an IBMProvider required for loading job data and - can be used to initialize the service. When using :mod:`qiskit_ibm_runtime`, + can be used to initialize the service. When using + :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime `, this is the :class:`~qiskit_ibm_runtime.QiskitRuntimeService` and should not be confused with the experiment database service :meth:`qiskit_ibm_experiment.IBMExperimentService`. diff --git a/qiskit_experiments/library/calibration/half_angle_cal.py b/qiskit_experiments/library/calibration/half_angle_cal.py index 01735fc797..e3c3784ba3 100644 --- a/qiskit_experiments/library/calibration/half_angle_cal.py +++ b/qiskit_experiments/library/calibration/half_angle_cal.py @@ -28,7 +28,7 @@ class HalfAngleCal(BaseCalibrationExperiment, HalfAngle): - """Calibration version of the half-angle experiment.""" + """Calibration version of the :class:`.HalfAngle` experiment.""" def __init__( self, diff --git a/qiskit_experiments/library/quantum_volume/qv_experiment.py b/qiskit_experiments/library/quantum_volume/qv_experiment.py index fc61770986..49e2f6c02b 100644 --- a/qiskit_experiments/library/quantum_volume/qv_experiment.py +++ b/qiskit_experiments/library/quantum_volume/qv_experiment.py @@ -88,7 +88,7 @@ def __init__( simulation_backend: The simulator backend to use to generate the expected results. the simulator must have a 'save_probabilities' method. If None, the :class:`qiskit_aer.AerSimulator` simulator will be used - (in case :mod:`qiskit_aer` is not + (in case :external+qiskit_aer:doc:`qiskit-aer ` is not installed, :class:`qiskit.quantum_info.Statevector` will be used). """ super().__init__(physical_qubits, analysis=QuantumVolumeAnalysis(), backend=backend) diff --git a/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml b/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml index 9d94a8e92a..98f46756e0 100644 --- a/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml +++ b/releasenotes/notes/0.5/0_5_release-89f59845afb19e89.yaml @@ -6,7 +6,7 @@ prelude: > benchmarking experiments has been significantly improved. The ``qubit`` and ``qubits`` input to experiments has been regularized to ``physical_qubits``, and support for ``qiskit-ibmq-provider`` has been deprecated in favor of - :mod:`qiskit_ibm_provider`. New experiments added include + :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider `. New experiments added include :class:`.MultiStateDiscrimination`, :class:`.ZZRamsey`, :class:`.MitigatedStateTomography`, and :class:`.MitigatedProcessTomography`, along with significant improvements to diff --git a/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml b/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml index 8ca5b92784..1a90823806 100644 --- a/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml +++ b/releasenotes/notes/0.5/calibration-backendv2-e564f466eb1c9999.yaml @@ -4,7 +4,7 @@ fixes: Updated querying of :class:`~qiskit.providers.Backend` metadata to support the look up of qubit T1 and measurement drive frequency, in order to support :class:`~qiskit.providers.BackendV2` backends. The look up of the - latter is :mod:`qiskit_ibm_provider` specific. This change fixed errors + latter is :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` specific. This change fixed errors failing to find these properties when using :class:`.ResonatorSpectroscopy` (issue `#1099 `_) and when using restless measurements with ``BackendV2`` backends. diff --git a/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml b/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml index 4e6cffe960..efd602e60d 100644 --- a/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml +++ b/releasenotes/notes/0.5/removed-ibmq-provider-1c757ce5ef01fb19.yaml @@ -2,7 +2,7 @@ upgrade: - | ``qiskit-ibmq-provider`` is deprecated and has been dropped as a requirement. Interactions - with IBM backends should use the :mod:`qiskit_ibm_provider` package instead (must be installed + with IBM backends should use the :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` package instead (must be installed separately; see the `migration guide `_ for more details). diff --git a/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml b/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml index 188ae5b36c..294ea47a2d 100644 --- a/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml +++ b/releasenotes/notes/0.5/tomo-barriers-aae4aafedaca5c3d.yaml @@ -4,7 +4,7 @@ fixes: Fixed qpy serialization and deserialization of tomography experiments. The barrier instructions in tomography experiments were created with the wrong Python type which qpy did not support. This issue was most acute when using - :mod:`qiskit_ibm_provider` which submits circuits to the provider using qpy. + :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` which submits circuits to the provider using qpy. There could have been subtler issues with circuit timing using a different provider if the barriers were not separating important circuit instructions. See `#1060 `_. diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml index e29f718afc..ff7f003ba8 100644 --- a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml +++ b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml @@ -9,7 +9,8 @@ prelude: > results. New experiments include :class:`.StarkP1Spectroscopy`, :class:`.StarkRamseyXY`, and :class:`.StarkRamseyXYAmpScan`. :class:`.StandardRB` and :class:`.InterleavedRB` were significantly improved. The supported provider for running jobs on IBM backends is now - :mod:`qiskit_ibm_runtime`. Using :mod:`qiskit_ibm_provider` is still supported but its use is - deprecated. + :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime `. Using + :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` is still supported + but its use is deprecated. features: New features are listed below in subsections by functional area. \ No newline at end of file diff --git a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml index 55165b5f65..6ebd471556 100644 --- a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml +++ b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml @@ -1,14 +1,14 @@ --- features_expdata: - | - Experiments run via the :mod:`qiskit_ibm_runtime` provider can now be saved + Experiments run via the :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` provider can now be saved to and loaded from the cloud service. upgrade: - | - With the impending deprecation of the :mod:`qiskit_ibm_provider` package, support for - :mod:`qiskit_ibm_provider` is now deprecated and will be removed - in the next release. Users should migrate to :mod:`qiskit_ibm_runtime` following the + With the impending deprecation of the :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` package, support for + :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` is now deprecated and will be removed + in the next release. Users should migrate to :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` following the `runtime migration guide `_. - :mod:`qiskit_ibm_runtime` is not listed as a dependency for compatibility reasons, but users + :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` is not listed as a dependency for compatibility reasons, but users will need it to run experiments on IBM backends. From 5df609082b51105a84a81bdd658bf30587518dc4 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 7 Feb 2024 12:35:49 -0500 Subject: [PATCH 17/20] add feature and bug fix subsections --- docs/tutorials/getting_started.rst | 2 +- releasenotes/config.yaml | 20 +++++++++++++++++-- .../0.5_deprecations-4188ada026cb682b.yaml | 2 +- .../0.6/0.6_release-4d766733941ad57a.yaml | 15 +++++++++++++- ...dataframe-curve-data-a8905c450748b281.yaml | 2 +- ...angle-representation-f5c40007416cf938.yaml | 3 ++- .../attach-other-cals-2f539e7799ceb6c8.yaml | 2 +- ...-rough-frequency-cal-8582610249e2327b.yaml | 2 +- .../bugfix_expdata_copy-2c73a21ad720858d.yaml | 2 +- ...cals-no-coupling-map-5114ae9faa2f9e69.yaml | 2 +- ...p_python_3_7_support-0529a7122e94b004.yaml | 2 +- .../0.6/exp-data-pickle-61511b6e926e3198.yaml | 2 +- ...xperiment_data_fixes-f69c3569a8ba1342.yaml | 2 +- ...ta_metadata_save_fix-912b7180a28cfb03.yaml | 2 +- ...t_data_save_bugfixes-48fe62bf2bfe38b8.yaml | 2 +- .../figure_return_SVG-4ad72fc8a3bee3cb.yaml | 2 +- ...ix-curve-fit-weights-fb43d3aa5ed1c91c.yaml | 2 +- .../fix-guess-rb-decay-f78e40a7d6d8dd67.yaml | 2 +- .../0.6/half-angle-x-600debac368ce2c6.yaml | 2 +- .../irb-circuit-order-619845a707519c44.yaml | 4 ++-- .../0.6/matplotlib-fix-58d938b49771cf17.yaml | 2 +- ...ams_without_schedule-20555d98875a626b.yaml | 2 +- ...b-clifford-synthesis-0e66c62fa3088fba.yaml | 5 ++--- .../qiskit-dependency-3f6b8d71cc4d2c31.yaml | 2 +- .../rabi-and-qv-bugfix-34636baee6651af1.yaml | 2 +- .../rb-v2-none-coupling-fda2b22afdef507b.yaml | 2 +- ...ime-provider-support-5358b72ec0035419.yaml | 2 +- ...ove-circuit-metadata-ec7d3c6b08781184.yaml | 2 +- 28 files changed, 61 insertions(+), 32 deletions(-) diff --git a/docs/tutorials/getting_started.rst b/docs/tutorials/getting_started.rst index 826de87d4a..72fcea1a33 100644 --- a/docs/tutorials/getting_started.rst +++ b/docs/tutorials/getting_started.rst @@ -184,7 +184,7 @@ value and standard deviation of each value can be accessed as follows: print(exp_data.analysis_results("T1").value.std_dev) For further documentation on how to work with UFloats, consult the ``uncertainties`` -:external+uncertainties:doc:`index`. :external+qiskit_ibm_runtime:doc:`index` +:external+uncertainties:doc:`user_guide`. Raw circuit output data and its associated metadata can be accessed with the :meth:`~.ExperimentData.data` property. Data is indexed by the circuit it corresponds diff --git a/releasenotes/config.yaml b/releasenotes/config.yaml index d5750d20e3..db82adba58 100644 --- a/releasenotes/config.yaml +++ b/releasenotes/config.yaml @@ -4,7 +4,7 @@ default_branch: main sections: - [features, New Features, 1] - [features_expnew, New Experiments, 2] - - [features_expupdate, Experiment Updates, 2] + - [features_explib, Experiment Library Updates, 2] - [features_expclass, Experiment Class Features, 2] - [features_analysis, Analysis Class Features, 2] - [features_expdata, Experiment Data Features, 2] @@ -12,11 +12,27 @@ sections: - [features_calibration, Calibration Features, 2] - [features_visualization, Visualization Features, 2] - [issues, Known Issues] - - [upgrade, Upgrade Notes] + - [upgrade, Upgrade Notes, 1] + - [upgrade_package, Package Upgrades, 2] + - [upgrade_explib, Experiment Library Upgrades, 2] + - [upgrade_expclass, Experiment Class Upgrades, 2] + - [upgrade_analysis, Analysis Class Upgrades, 2] + - [upgrade_expdata, Experiment Data Upgrades, 2] + - [upgrade_curvefit, Curve Fit Upgrades, 2] + - [upgrade_calibration, Calibration Upgrades, 2] + - [upgrade_visualization, Visualization Upgrades, 2] - [deprecations, Deprecation Notes] - [critical, Critical Issues] - [security, Security Issues] - [fixes, Bug Fixes] + - [fixes_package, Package Fixes, 2] + - [fixes_explib, Experiment Library Fixes, 2] + - [fixes_expclass, Experiment Class Fixes, 2] + - [fixes_analysis, Analysis Class Fixes, 2] + - [fixes_expdata, Experiment Data Fixes, 2] + - [fixes_curvefit, Curve Fit Fixes, 2] + - [fixes_calibration, Calibration Fixes, 2] + - [fixes_visualization, Visualization Fixes, 2] - [developer, API Changes for Experiment Authors] - [other, Other Notes] template: | diff --git a/releasenotes/notes/0.6/0.5_deprecations-4188ada026cb682b.yaml b/releasenotes/notes/0.6/0.5_deprecations-4188ada026cb682b.yaml index 1288938541..0d84e6c979 100644 --- a/releasenotes/notes/0.6/0.5_deprecations-4188ada026cb682b.yaml +++ b/releasenotes/notes/0.6/0.5_deprecations-4188ada026cb682b.yaml @@ -1,5 +1,5 @@ --- -upgrade: +upgrade_package: - | Several deprecated methods and options have been removed and will no longer work: diff --git a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml index ff7f003ba8..7391325419 100644 --- a/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml +++ b/releasenotes/notes/0.6/0.6_release-4d766733941ad57a.yaml @@ -13,4 +13,17 @@ prelude: > :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` is still supported but its use is deprecated. features: - New features are listed below in subsections by functional area. \ No newline at end of file + - | + New features are listed below in subsections by functional area. +upgrade: + - | + Changes in behavior that users should be aware of when upgrading Qiskit Experiments + to this version are listed below in subsections by functional area. +fixes: + - | + Bug fixes are listed below in subsections by functional area. +issues: + - | + Copied :class:`.ExperimentData` objects don't save their analysis results to the cloud service. + See `#1396 + `_. \ No newline at end of file diff --git a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml index 95d1da4ca6..c7ffa144a1 100644 --- a/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml +++ b/releasenotes/notes/0.6/add-dataframe-curve-data-a8905c450748b281.yaml @@ -12,7 +12,7 @@ features_curvefit: New analysis option ``fit_category`` is added to :class:`.CurveAnalysis` subclasses. This option controls which data subset within the :class:`.ScatterTable` is used for the curve fitting. -upgrade: +upgrade_curvefit: - | The behavior of :class:`.CurveAnalysis` data processing was changed. It used to raise ``DataProcessorError`` error when it encounters an experiment result diff --git a/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml b/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml index 12ce13eeee..89c2df1c41 100644 --- a/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml +++ b/releasenotes/notes/0.6/adjust-symbolic-pulses-amp-angle-representation-f5c40007416cf938.yaml @@ -15,12 +15,13 @@ other: Eventually, support for complex parameters will be dropped altogether, and it is thus pending deprecation - including for saving and loading calibration data with complex values. -upgrade: +upgrade_calibration: - | The representation of pulses in the :class:`.FixedFrequencyTransmon` library was changed from complex amplitude to (``amp``, ``angle``) representation. All pulses now include an ``angle`` parameter, and the default values of ``amp`` are set as type ``float`` instead of ``complex``. +upgrade_explib: - | :class:`.HalfAngleCal` was changed from updating the complex amplitude of the pulse, to updating the angle in the (``amp``, ``angle``) representation. When used with diff --git a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml index 1f1347d2ca..a8e331e942 100644 --- a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml +++ b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml @@ -4,7 +4,7 @@ features_calibration: A new method :meth:`~.Calibrations.has_template` has been added to :class:`.Calibrations` to check if a template schedule exists for a particular set of qubits. -fixes: +fixes_explib: - | :class:`.FineXDragCal` and :class:`.EFRoughXSXAmplitudeCal` were updated to attach ``"sx"`` and ``"x"`` calibrations to their circuits, respectively. diff --git a/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml b/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml index 440e276b30..d5e032246d 100644 --- a/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml +++ b/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_explib: - | Added a missing ``backend`` parameter to :class:`~.RoughEFFrequencyCal` and exposed it in the experiment library. diff --git a/releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml b/releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml index 7c7c3864ff..700939bd5e 100644 --- a/releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml +++ b/releasenotes/notes/0.6/bugfix_expdata_copy-2c73a21ad720858d.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_expdata: - | The :meth:`.ExperimentData.copy` method now copies the provider. \ No newline at end of file diff --git a/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml b/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml index 03187acf2e..0d96a4c3ec 100644 --- a/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml +++ b/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_calibration: - | Fixed error generating circuits for :class:`.BaseCalibrationExperiment` subclasses when the backend instance had no coupling map. Fixed `#1116 diff --git a/releasenotes/notes/0.6/drop_python_3_7_support-0529a7122e94b004.yaml b/releasenotes/notes/0.6/drop_python_3_7_support-0529a7122e94b004.yaml index 6af8ef7962..08b5ab6cf5 100644 --- a/releasenotes/notes/0.6/drop_python_3_7_support-0529a7122e94b004.yaml +++ b/releasenotes/notes/0.6/drop_python_3_7_support-0529a7122e94b004.yaml @@ -1,4 +1,4 @@ --- -upgrade: +upgrade_package: - | Dropped support for Python 3.7 and added support for Python 3.12. diff --git a/releasenotes/notes/0.6/exp-data-pickle-61511b6e926e3198.yaml b/releasenotes/notes/0.6/exp-data-pickle-61511b6e926e3198.yaml index a2d402f130..92e19fb0a7 100644 --- a/releasenotes/notes/0.6/exp-data-pickle-61511b6e926e3198.yaml +++ b/releasenotes/notes/0.6/exp-data-pickle-61511b6e926e3198.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_expdata: - | Fixed :mod:`pickle` deserialization of :class:`.ExperimentData` objects. Previously, :class:`.ExperimentData` objects could be serialized and diff --git a/releasenotes/notes/0.6/experiment_data_fixes-f69c3569a8ba1342.yaml b/releasenotes/notes/0.6/experiment_data_fixes-f69c3569a8ba1342.yaml index 1385aae5a1..a26717a32b 100644 --- a/releasenotes/notes/0.6/experiment_data_fixes-f69c3569a8ba1342.yaml +++ b/releasenotes/notes/0.6/experiment_data_fixes-f69c3569a8ba1342.yaml @@ -23,7 +23,7 @@ features_expdata: fails, unless the ``suppress_errors`` flag is set (on by default). -fixes: +fixes_expdata: - | Fixed a bug in :meth:`.ExperimentData._add_job_data` that caused job id related test fails. diff --git a/releasenotes/notes/0.6/experiment_data_metadata_save_fix-912b7180a28cfb03.yaml b/releasenotes/notes/0.6/experiment_data_metadata_save_fix-912b7180a28cfb03.yaml index 20a067071f..256aaa5636 100644 --- a/releasenotes/notes/0.6/experiment_data_metadata_save_fix-912b7180a28cfb03.yaml +++ b/releasenotes/notes/0.6/experiment_data_metadata_save_fix-912b7180a28cfb03.yaml @@ -1,4 +1,4 @@ --- -fixes: +fixes_expdata: - | Fixed a bug in :class:`.ExperimentData` which caused experiment saves to the cloud service to fail when the metadata is large. diff --git a/releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml b/releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml index 464138333c..c735593ec6 100644 --- a/releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml +++ b/releasenotes/notes/0.6/experiment_data_save_bugfixes-48fe62bf2bfe38b8.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_expdata: - | The :attr:`.ExperimentData.auto_save` setter no longer saves sub-experiments twice. - | diff --git a/releasenotes/notes/0.6/figure_return_SVG-4ad72fc8a3bee3cb.yaml b/releasenotes/notes/0.6/figure_return_SVG-4ad72fc8a3bee3cb.yaml index bd1bf8104f..5b7e69cbef 100644 --- a/releasenotes/notes/0.6/figure_return_SVG-4ad72fc8a3bee3cb.yaml +++ b/releasenotes/notes/0.6/figure_return_SVG-4ad72fc8a3bee3cb.yaml @@ -1,4 +1,4 @@ --- -fixes: +fixes_visualization: - | Figures loaded from the experiment service are now rendered correctly in Jupyter Notebook. diff --git a/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml b/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml index 98b1172c52..68b21b2da5 100644 --- a/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml +++ b/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_curvefit: - | Fix calculation of weight for curve fitting. Previously the weights of data points to obtain the residual of fit curve were computed by the inverse of the error bars of y data. diff --git a/releasenotes/notes/0.6/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml b/releasenotes/notes/0.6/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml index ea9a49cad7..00bb10ae50 100644 --- a/releasenotes/notes/0.6/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml +++ b/releasenotes/notes/0.6/fix-guess-rb-decay-f78e40a7d6d8dd67.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_explib: - | Fixed a bug in :func:`~.rb_decay` where it unintentionally raises an ``IndexError`` if all ``y`` values are below ``b`` value diff --git a/releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml b/releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml index a141e3e30c..30adab1906 100644 --- a/releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml +++ b/releasenotes/notes/0.6/half-angle-x-600debac368ce2c6.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_explib: - | The :class:`.HalfAngle` experiment's circuits were changed so that they use combinations of ``rz`` and ``x`` instead of the less standard ``y`` gate. diff --git a/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml b/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml index d0dfd0364b..543d016106 100644 --- a/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml +++ b/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml @@ -1,12 +1,12 @@ --- -features_expupdate: +features_explib: - | A new experiment option ``circuit_order`` was added to :class:`~.InterleavedRB`. It allows to change the order of the reference and the interleaved circuits and hence slightly alter the impact of noise on interleaved RB results. The default value is set to ``"RIRIRI"`` that alternate a reference and an interleaved circuit. -fixes: +fixes_explib: - | Changed the ordering of circuits generated by :class:`~.InterleavedRB` back to RIRIRI (R: Reference, I: Interleaved) order. diff --git a/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml b/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml index 93c90cf932..7174bea3be 100644 --- a/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml +++ b/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml @@ -1,4 +1,4 @@ --- -fixes: +fixes_visualization: - | Fixed a deprecated Matplotlib ``MarkerStyle`` usage in the visualization module that was causing warnings in Matplotlib 3.6+. diff --git a/releasenotes/notes/0.6/params_without_schedule-20555d98875a626b.yaml b/releasenotes/notes/0.6/params_without_schedule-20555d98875a626b.yaml index 3893c17229..d78c570dc8 100644 --- a/releasenotes/notes/0.6/params_without_schedule-20555d98875a626b.yaml +++ b/releasenotes/notes/0.6/params_without_schedule-20555d98875a626b.yaml @@ -1,5 +1,5 @@ --- -upgrade: +upgrade_calibration: - | The variables ``__drive_freq_parameter__`` and ``__readout_freq_parameter__`` have been removed from :class:`.Calibrations`. These variables were given special diff --git a/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml b/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml index 5a2596d1f5..8b7e05cf1d 100644 --- a/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml +++ b/releasenotes/notes/0.6/plugable-rb-clifford-synthesis-0e66c62fa3088fba.yaml @@ -1,16 +1,15 @@ --- -features_expupdate: +features_explib: - | Added a new experiment option ``clifford_synthesis_method`` to RB experiments, e.g. :class:`~.StandardRB` and :class:`~.InterleavedRB` so that users can plug in a custom Clifford synthesis algorithm used for generating RB circuits. Such a plugin should be implemented as a :class:`~.qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin` (see :class:`~.RBDefaultCliffordSynthesis` for example). -upgrade: - | Updated :class:`~.InterleavedRB` so that it only accepts ``interleaved_element`` consisting only of instructions supported by the backend of interest. -fixes: +fixes_explib: - | Fixed a bug in circuit generation for three or more qubit Randomized Benchmarking where sampled Cliffords may be changed during their circuits synthesis diff --git a/releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml b/releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml index 47ec887c1b..e62386a83d 100644 --- a/releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml +++ b/releasenotes/notes/0.6/qiskit-dependency-3f6b8d71cc4d2c31.yaml @@ -1,5 +1,5 @@ --- -upgrade: +upgrade_package: - | The dependency on ``qiskit-terra`` was replaced with a dependency on ``qiskit``. This change follows the move in upstream Qiskit to rename diff --git a/releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml b/releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml index 81215ed52c..ef3a26c240 100644 --- a/releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml +++ b/releasenotes/notes/0.6/rabi-and-qv-bugfix-34636baee6651af1.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_explib: - | Resolved a serialization issue that affected Rabi experiments when running it through the backend provider using custom amplitudes provided as a numpy array. diff --git a/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml b/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml index 4df8316ac8..b58a0cf37f 100644 --- a/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml +++ b/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml @@ -1,5 +1,5 @@ --- -fixes: +fixes_explib: - | Changed :class:`.StandardRB` to treat two qubit operations in the :class:`qiskit.transpiler.Target` as having all-to-all connectivity if diff --git a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml index 6ebd471556..25325cad6a 100644 --- a/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml +++ b/releasenotes/notes/0.6/runtime-provider-support-5358b72ec0035419.yaml @@ -3,7 +3,7 @@ features_expdata: - | Experiments run via the :external+qiskit_ibm_runtime:doc:`qiskit-ibm-runtime ` provider can now be saved to and loaded from the cloud service. -upgrade: +upgrade_package: - | With the impending deprecation of the :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` package, support for :external+qiskit_ibm_provider:doc:`qiskit-ibm-provider ` is now deprecated and will be removed diff --git a/releasenotes/notes/0.6/upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml b/releasenotes/notes/0.6/upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml index b54e867d17..82ce15c2c2 100644 --- a/releasenotes/notes/0.6/upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml +++ b/releasenotes/notes/0.6/upgrade-remove-circuit-metadata-ec7d3c6b08781184.yaml @@ -1,5 +1,5 @@ --- -upgrade: +upgrade_expclass: - | Removed unnecessary circuit metadata from the builtin experiment classes. Circuit metadata such as the associated qubit indices and experiment type From 8edbd4667f11ffa5acecb43b258f795eaebbdf6e Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 7 Feb 2024 13:48:04 -0500 Subject: [PATCH 18/20] add upgrade instructions --- docs/tutorials/getting_started.rst | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/tutorials/getting_started.rst b/docs/tutorials/getting_started.rst index 72fcea1a33..8a93458ab5 100644 --- a/docs/tutorials/getting_started.rst +++ b/docs/tutorials/getting_started.rst @@ -41,6 +41,30 @@ cloning the repository: The ``-e`` option will keep your installed package up to date as you make or pull new changes. +Upgrading Qiskit Experiments +---------------------------- + +Qiskit Experiments version numbers are in the form ``0.X.Y``, where ``X`` is the minor version and +``Y`` is the patch version. There are two kinds of releases: minor releases, which increment the +minor version, and patch releases, which increment the patch version. New features and API +changes can only be introduced in a minor release. Patch releases contain only bug fixes and changes that do +not affect how you use the package, such as performance optimization and documentation updates. + +Therefore, when you encounter a bug or unexpected behavior, it is recommended that you first check if there's a +patch release you can upgrade to under the same minor version to avoid any breaking changes. When +running ``pip``, you can specify the exact version to install: + +.. code-block:: + + python -m pip install qiskit-experiments==0.X.Y + +Before a nontrivial breaking API change is introduced in a minor release, the old feature will +undergo a deprecation process lasting two releases for a core framework change and one release +otherwise. During this process, deprecation warnings will be issued if you use the old feature that +will instruct you on how to transition to the replacement feature, if applicable. The :doc:`release +notes ` contain full details on which features are deprecated or removed in each +release. + Running your first experiment ============================= @@ -73,11 +97,6 @@ All experiments require a ``physical_qubits`` parameter as input that specifies physical qubit or qubits the circuits will be executed on. The qubits must be given as a Python sequence (usually a tuple or a list). -.. note:: - Since 0.5.0, using ``qubits`` instead of ``physical_qubits`` or specifying an - integer qubit index instead of a one-element sequence for a single-qubit experiment - is deprecated. - In addition, the :math:`T_1` experiment has a second required parameter, ``delays``, which is a list of times in seconds at which to measure the excited state population. In this example, we'll run the :math:`T_1` From 0d62d213c45d5968990a29c58eecbcd0d522d623 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 7 Feb 2024 13:53:10 -0500 Subject: [PATCH 19/20] update deprecation section --- CONTRIBUTING.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df530f2e12..312516944c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -416,6 +416,7 @@ Utilities](https://docs.quantum.ibm.com/api/qiskit/utils) to add warnings: @deprecate_func( since="0.5", additional_msg="Use ``new_function`` instead.", + pending=True, removal_timeline="after 0.7", package_name="qiskit-experiments", ) @@ -428,12 +429,9 @@ Utilities](https://docs.quantum.ibm.com/api/qiskit/utils) to add warnings: Note that all warnings emitted by Qiskit Experiments, including pre-deprecation and deprecation warnings, will cause the CI to fail, but features up for deprecation should continue to be tested -until their removal. All such expected warnings should be caught in tests: - -```python - with self.assertWarns(DeprecationWarning): - # Test something deprecated here -``` +until their removal. For more information on how to use wrappers and test deprecated functionality, +consult [Qiskit's +policy](https://github.com/Qiskit/qiskit/blob/1.0.0rc1/DEPRECATION.md#issuing-deprecation-warnings). ### Development cycle From e1ed9fb040cf5eda3cc2c8d65db6578bf946f305 Mon Sep 17 00:00:00 2001 From: Helena Zhang Date: Wed, 7 Feb 2024 22:58:12 -0500 Subject: [PATCH 20/20] update artifact note --- .../{ => 0.6}/deprecate-is-simulator-c101197a126e456f.yaml | 0 .../{ => 0.6}/experiment-artifacts-c481f4e07226ce9e.yaml | 4 ++-- 2 files changed, 2 insertions(+), 2 deletions(-) rename releasenotes/notes/{ => 0.6}/deprecate-is-simulator-c101197a126e456f.yaml (100%) rename releasenotes/notes/{ => 0.6}/experiment-artifacts-c481f4e07226ce9e.yaml (92%) diff --git a/releasenotes/notes/deprecate-is-simulator-c101197a126e456f.yaml b/releasenotes/notes/0.6/deprecate-is-simulator-c101197a126e456f.yaml similarity index 100% rename from releasenotes/notes/deprecate-is-simulator-c101197a126e456f.yaml rename to releasenotes/notes/0.6/deprecate-is-simulator-c101197a126e456f.yaml diff --git a/releasenotes/notes/experiment-artifacts-c481f4e07226ce9e.yaml b/releasenotes/notes/0.6/experiment-artifacts-c481f4e07226ce9e.yaml similarity index 92% rename from releasenotes/notes/experiment-artifacts-c481f4e07226ce9e.yaml rename to releasenotes/notes/0.6/experiment-artifacts-c481f4e07226ce9e.yaml index c83fc92772..931b8c0439 100644 --- a/releasenotes/notes/experiment-artifacts-c481f4e07226ce9e.yaml +++ b/releasenotes/notes/0.6/experiment-artifacts-c481f4e07226ce9e.yaml @@ -1,5 +1,5 @@ --- -features: +features_expdata: - | An artifact class has been introduced to store long-form data generated by experiments. The :class:`.CurveFitResult` and :class:`.ScatterTable` generated by experiments @@ -10,7 +10,7 @@ features: deprecations: - | Setting the option ``return_data_points`` to ``True`` in curve analysis has been deprecated. - Data points are now automatically provided in :class:`ExperimentData` objects via the ``curve_data`` + Data points are now automatically provided in :class:`.ExperimentData` objects via the ``curve_data`` artifact. - | Direct access to the curve fit summary in :class:`.ExperimentData` has moved from