Skip to content

Commit

Permalink
Copy edit release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jakelishman committed Feb 15, 2024
1 parent 73d005e commit ec1d934
Show file tree
Hide file tree
Showing 66 changed files with 191 additions and 256 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,9 @@
upgrade_providers:
- |
Changed default value of two arguments (:code:`add_delay` and :code:`filter_faulty`) in
the :func:`.qiskit.providers.backend_compat.convert_to_target` function.
the :func:`.convert_to_target` function.
This conversion function now adds delay instructions and removes faulty instructions by default.
fixes:
- |
Fixed the return of improper measurement schedules in examples like the following:
.. code-block:: python
# import a fake backend which is a sub-class of BackendV2.
from qiskit.providers.fake_provider import FakePerth
backend = FakePerth()
sched = backend.instruction_schedule_map.get('measure', [0])
This unexpectedly returned a measure schedule including all device qubits, when only one was requested.
Now this code returns a schedule for qubit 0 as intended.
Fixed the return of improper measurement schedules when only a subset of qubits was requested.
Previously, a measurement schedule for all qubits would be returned.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
upgrade_misc:
- |
The variable ``qiskit.__qiskit_version__`` is removed as it was deprecated since
Qiskit 0.44 (released on July 2023).
The variable ``qiskit.__qiskit_version__`` is removed as it was deprecated since
Qiskit 0.44 (released in 2023-07).
Instead, you should use ``qiskit.__version__``. The other packages listed in the
former ``qiskit.__qiskit_version__`` have their own ``__version__`` module level dunder,
as standard in PEP 8.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ features_circuit:
SwapGate().control(2, annotated=False)
returns a ``ControlledGate``. When ``annotated==True``, the methods return an object of
returns a ``ControlledGate``. When ``annotated=True``, the methods return an object of
type :class:`~.AnnotatedOperation` instead, avoiding the eager construction of the controlled gate's definition.
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
features_circuits:
- |
Added a new argument, ``annotated``, to the methods :meth:`.QuantumCircuit.inverse`, :meth:`.circuit.Instruction.inverse`
and ``.inverse()`` methods of :class:`~qiskit.circuit.Instruction` subclasses (such as :class:`.SwapGate` or :class:`.SGate`)
to optionally return an :class:`.AnnotatedOperation`.
The default value of ``annotated`` is ``False`` and corresponds to he pre-existing behavior of the method.
and ``.inverse()`` methods of :class:`~qiskit.circuit.Instruction` subclasses (such as :class:`.SwapGate` or :class:`.SGate`)
to optionally return an :class:`.AnnotatedOperation`.
The default value of ``annotated`` is ``False`` and corresponds to the pre-existing behavior of the method.
Furthermore, for standard gates with an explicitly defined ``inverse`` method,
the argument ``annotated`` has no effect, for example, both::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ features_circuits:
Additionally, the :class:`.CommutationChecker` was refactored and now has an upper limit
set on the number of cached commutation relations that are not in the commutation library.
This addressed: `#8020 <https://github.com/Qiskit/qiskit-terra/issues/8020>`__ and
`#7101 <https://github.com/Qiskit/qiskit-terra/issues/7101>`__
This addressed: `#8020 <https://github.com/Qiskit/qiskit/issues/8020>`__ and
`#7101 <https://github.com/Qiskit/qiskit/issues/7101>`__
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ features_providers:
module. This class is configurable, and builds a :class:`~.BackendV2` backend instance that can
be run locally (in the spirit of fake backends). Users can configure the number of qubits, basis gates,
coupling map, ability to run dynamic circuits (control flow instructions), instruction calibrations and
dtm of the backend without having to deal with manual target construction.
Qubit and gate properties (duration, errror) are generated by randomly sampling from default ranges.
measurement timestep of the backend without having to deal with manual target construction.
Qubit and gate properties (duration, error) are generated by randomly sampling from default ranges.
The seed for this
random generation can be fixed to ensure the reproducibility of the backend output.
It's important to note that this backend only supports gates in the standard
Expand Down Expand Up @@ -47,10 +47,15 @@ features_providers:
qc.cx(0, i + 1)
for i in range(18):
qc.measure(i, creg[i])
qc.ecr(20, 21).c_if(creg, 0)
with qc.if_test((creg, 0)):
qc.ecr(20, 21)
# Define backend with custom basis gates and control flow instructions
backend = GenericBackendV2(num_qubits=25, basis_gates = ["ecr","id","rz","sx","x"], control_flow=True)
backend = GenericBackendV2(
num_qubits=25,
basis_gates=["ecr", "id", "rz", "sx", "x"],
control_flow=True,
)
#Transpile
transpiled_qc = transpile(qc, backend)
Expand All @@ -61,4 +66,4 @@ features_providers:
not be used to measure any concrete behaviors. They are "reasonable defaults" that can be used to
test backend-interfacing functionality not tied specific noise values of real quantum systems.
For a more accurate simulation of existing devices, you can manually build a noise model from the
real backend using the functionality offered in ``qiskit-aer``.
real backend using the functionality offered in :mod:`qiskit_aer`.
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
features_qpy:
- |
Added a new warning class, :exc:`~.QPYLoadingDeprecatedFeatureWarning`, to the QPY module.
This class allows for deprecation warnings to surface even if the depreacted feature
is in a variable point in the call stack, as is the case for many QPY loading functions that
This class allows for deprecation warnings to surface even if the deprecated feature
is accessed at a variable point in the call stack, as is the case for many QPY loading functions that
are called recursively.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ features_qpy:
supported versions to emit are limited, only versions between the latest
QPY version (which is the default), and the compatibility QPY version
which is :ref:`qpy_version_10` (which was introduced in Qiskit 0.45.0) can
be used. The compatibility version will remain fixed for the the entire
be used. The compatibility version will remain fixed for the entire
1.x.y major version release series. This does not change the backwards
compatibility guarantees of the QPY format when calling :func:`.qpy.load`,
it just enables users to emit an older version of QPY to maintain
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
upgrade:
- |
Qiskit 1.0 now requires version 0.14.0 of ``rustworkx``, the minimum
Qiskit 1.0 now requires version 0.14.0 of ``rustworkx``. The minimum
version requirement was raised to support the new ``token_swapper``
:class:`.PermutationGate` synthesis plugin for :class:`.HighLevelSynthesisPlugin`.
features_transpiler:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
features_quantum_info:
- |
The function :meth:`~.SparsePauliOp.apply_layout` from :class:`.SparsePauliOp` now allows for the
layout argument to also be None. That is, the method can now also be used for circuits where no transpilation/routing
layout argument to also be ``None``. That is, the method can now also be used for circuits where no transpilation/routing
took place (for example when transpiling for a simulator).
13 changes: 0 additions & 13 deletions releasenotes/notes/1.0/dep-primitives-attr-6b4ec9fde34c42e8.yaml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
upgrade_pulse:
- |
Removed the deprecated class :class:`qiskit.pulse.instructions.Call`.
Removed the deprecated class ``qiskit.pulse.instructions.Call``
No alternative pulse instruction is provided.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ upgrade_synthesis:
- |
The following deprecated functions previously in :mod:`qiskit.quantum_info`
have been removed. These functions were marked as deprecated in the
Qiskit 0.40.0 release, 2023-01.
Qiskit 0.40.0 release in 2023-01.
* ``decompose_clifford``: you should use the
:func:`.qiskit.synthesis.synth_clifford_full` function instead.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
upgrade:
- |
The method ``qiskit.transpiler.target.Target.aquire_alignment``, deprecated in 0.24, has been removed. The method ``qiskit.transpiler.target.Target.acquire_alignment`` should be used instead.
The method ``Target.aquire_alignment``, deprecated in 0.24, has been removed. The method
:meth:`.Target.acquire_alignment` should be used instead.
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
upgrade_quantum_info:
- |
Remove deprecated ``__getitem__``/``__setitem__`` magic methods of
:class:`~qiskit.quantum_info.operators.symplectic.Clifford`.
The methods were deprecated since Qiskit 0.44, released on July 2023. Instead, index or iterate through the :attr:`.Clifford.tableau` attribute.
Removed the deprecated ``__getitem__``/``__setitem__`` magic methods of
:class:`.Clifford`.
The methods were deprecated since Qiskit 0.44, released in 2023-07.
Instead, index or iterate through the :attr:`.Clifford.tableau` attribute.
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
upgrade_transpiler:
- |
Removed deprecated function :func:`~qiskit.transpiler.preset_passmanagers.common.get_vf2_call_limit`
and its corresponding test. Instead, use
:func:`~qiskit.transpiler.preset_passmanagers.common.get_vf2_limits`
Removed deprecated function ``qiskit.transpiler.preset_passmanagers.common.get_vf2_call_limit``.
Instead, use :func:`.get_vf2_limits`.
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@ fixes:
.. code-block:: python
from functools import partial
from scipy.optimize import minimize
from qiskit.transpiler.synthesis.aqc.aqc import AQC
from qiskit.synthesis.unitary.aqc import AQC
optimizer = partial(minimize, args=(), method="L-BFGS-B", options={"maxiter": 200})
aqc = AQC(optimizer=optimizer)
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ fixes:
- |
Fixed an issue with the :class:`.Barrier` class. When adding a
:class:`.Barrier` instance to a :class:`.QuantumCircuit` with the
:meth:`.QuantumCircuit.append` method previously there was no validation
:meth:`.QuantumCircuit.append` method, previously there was no validation
that the size of the barrier matched the qargs specified.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ fixes:
:meth:`.QuantumCircuit.barrier` will now generate correct output when given a :class:`set` as
one of its inputs. Previously, it would append an invalid operation onto the circuit, though in
practice this usually would not cause observable problems.
Fixed `#11208 <https://github.com/Qiskit/qiskit/issues/11208>`__
Fixed `#11208 <https://github.com/Qiskit/qiskit/issues/11208>`__.
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
fixes:
- |
Fixed an issue with :func:`.qpy.load` when attempting to load a QPY format
version that is not supported by this version of Qiskit it will now display
version that is not supported by this version of Qiskit. It will now display
a descriptive error message. Previously, it would raise an internal error
because of the incompatibility between the formats which was difficult to
debug. If the QPY format version is not supported that indicates the Qiskit
because of the incompatibility between the formats, which was difficult to
debug. If the QPY format version is not supported, that indicates the Qiskit
version will need to be upgraded to read the QPY payload.
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
fixes:
- |
Fixed a bug that results in an error when a user tries to load .calibration
data of a gate in :class:`.Target` in a particular situation.
Fixed an error when a user tries to load calibration
data of a gate from a :class:`.Target` in a particular situation.
This occurs when the backend reports only partial calibration data, for
example referencing a waveform pulse in a command definition but not
including that waveform pulse in the pulse library. In this situation, the
Qiskit pulse object cannot be built, resulting in a failure to build the pulse
Qiskit pulse object could not be built, resulting in a failure to build the pulse
schedule for the calibration. Now when calibration data is incomplete
the :class:`.Target` treats it as equivalent to no calibration being reported
at all and does not raise an exception.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@ fixes:
- |
The :meth:`.Operator.power` method now works with floating-point exponents,
matching the documented description.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ fixes:
is now fixed so the pass :class:`.Optimize1qGatesDecomposition` will defer
to the circuit's gate if the error rate (which includes number of gates)
are the same.
Fixed `#10568 <https://github.com/Qiskit/qiskit/issues/10568>`__
Fixed `#10568 <https://github.com/Qiskit/qiskit/issues/10568>`__.
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ fixes:
- |
Fixed an issue with the :class:`~.OptimizeSwapBeforeMeasure` pass where
it would incorrectly optimize circuits involving swap and measure
instructions. This commit fixes the bug by changing ``DAGCircuit.successors``
to ``DAGCircuit.descendants``. Also, added a couple of extra tests to ensure
that the bug is fixed. For example::
instructions. For example::
from qiskit import QuantumCircuit
from qiskit.transpiler.passes import OptimizeSwapBeforeMeasure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ fixes:
Fixed compatibility of :class:`.DynamicalDecoupling` and
:class:`.PadDynamicalDecoupling` with circuits that have a parameterized
global phase.
Fixed `#10569 <https://github.com/Qiskit/qiskit-terra/issues/10569>`__.
Fixed `#10569 <https://github.com/Qiskit/qiskit/issues/10569>`__.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ fixes:
qc = QuantumCircuit(1)
qc.rz(0, 0)
qc.rz(pi, 0)
qc.rz(0, 0)
inverse_pass(qc)
would previously have incorrectly cancelled the two rz gates.
would previously have incorrectly cancelled two of the rz gates.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
fixes:
- |
Adjusted zoom, fontsize, and margins to fit the plot better for more figure
Adjusted zoom, font size, and margins of :func:`.plot_state_city` to fit the plot better for more figure
sizes.
- |
Corrected the Z-ordering behavior of bars and the zero-amplitude plane.
Corrected the Z-ordering behavior of bars and the zero-amplitude plane in :func:`.plot_state_city`.
- |
Corrected display of negative real value bars
Corrected display of negative real value bars in :func:`.plot_state_city`.
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ fixes:
QPY :ref:`qpy_version_11` so that each instance of a custom instruction
is serialized individually and there will no longer be a potential
conflict with overlapping names.
Fixes `#8941 <https://github.com/Qiskit/qiskit/issues/8941>`__
Fixes `#8941 <https://github.com/Qiskit/qiskit/issues/8941>`__.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
fixes:
- |
A bug where :func:`.convert_to_target` of :class:`.BackendV2Converter` raised an unexpected
error was solved. The bug occured when the backend to convert included calibrations
A bug where :func:`.convert_to_target` and :class:`.BackendV2Converter` raised an unexpected
error was solved. The bug occurred when the backend to convert included calibrations
for a gate that didn't have a definition in the backend properties.
Such gate is now broadcasted to all qubits as an ideal error-free instruction,
Such gate is now broadcast to all qubits as an ideal error-free instruction,
even when calibrations for a finite set of qubits are reported.
upgrade_providers:
- |
Expand Down
6 changes: 4 additions & 2 deletions releasenotes/notes/1.0/fix_11143-d32a262538873a9d.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
upgrade_visualization:
- |
The functions ``qiskit.visualization.state_visualization.num_to_latex_ket`` and ``qiskit.visualization.state_visualization.numbers_to_latex_terms``
have been removed, as they were removed in Qiskit 0.40 (released in 2023-01). For similar functionality, see Sympy's ``nsimplify`` and ``latex`` functions.
The functions ``qiskit.visualization.state_visualization.num_to_latex_ket`` and
``qiskit.visualization.state_visualization.numbers_to_latex_terms`` have been removed, as they
were removed in Qiskit 0.40 (released in 2023-01). For similar functionality, see Sympy's
``nsimplify`` and ``latex`` functions.
7 changes: 0 additions & 7 deletions releasenotes/notes/1.0/fix_backend_name-e84661707058b529.yaml

This file was deleted.

6 changes: 0 additions & 6 deletions releasenotes/notes/1.0/fix_sim_backend-f3971b1ed4d0c4e6.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion releasenotes/notes/1.0/fixes_10744-83e5f33f5db74a22.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
upgrade_circuits:
- |
The properties ``Bit.register`` and ``Bit.index`` are removed. They were deprecated in
Qiskit 0.25 (released in April, 2021). The qubits and bits now live only in the context of
Qiskit 0.25 (released in 2021-04). The qubits and bits now live only in the context of
a :class:`.QuantumCircuit`. The alternative to the properties is
to use :meth:`.QuantumCircuit.find_bit` to find all the containing
registers within a circuit and the index of the bit within the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ features_misc:
Added a new warning base class, :exc:`.QiskitWarning`. While Qiskit will continue to use
built-in Python warnings (such as :exc:`DeprecationWarning`) when those are most appropriate,
for cases that are more specific to Qiskit, the warnings will be subclasses of :exc:`.QiskitWarning`.
As a consequence of this addition, :exc:`.QPYLoadingDeprecatedFeatureWarning` is now a subclass of :exc:`.QiskitWarning`.
- |
The optional-functionality testers (:mod:`qiskit.utils.optionals`) will now distinguish an
optional dependency that was completely not found (a normal situation) with one that was found,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
fixes:
- |
The :class:`.UnitarySynthesis` transpiler pass will now generate an error on initialization when
a nonexistent sythesis plugin is specified, rather than waiting until runtime to raise. Fixed
a nonexistent synthesis plugin is specified, rather than waiting until runtime to raise. Fixed
`#11355 <https://github.com/Qiskit/qiskit/issues/11355>`__.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ upgrade:
mean that the default number of processes used by :func:`.parallel_map` and functions that
internally can use :func:`.parallel_map` such as :func:`.transpile` and :meth:`.PassManager.run`
may use more or less parallel processes than in previous releases. If you'd like to adjust the
number of processes used you can use the ``QISKIT_NUM_PROCS`` environment variable or
``num_processes`` field in a user configuration file (see the
`local configuration guide <https://docs.quantum.ibm.com/start/configure-qiskit-local>`__
number of processes used you can use the new ``num_processes`` argument to those functions, or
the ``QISKIT_NUM_PROCS`` environment variable or ``num_processes`` field in a user configuration
file (see the `local configuration guide
<https://docs.quantum.ibm.com/start/configure-qiskit-local>`__
for more details) if you need to adjust the number of processes that Qiskit potentially uses.
Loading

0 comments on commit ec1d934

Please sign in to comment.