Consistent typehints for NLocal family
#10479
Conversation
|
One or more of the the following people are requested to review this:
|
Cryoris
added
documentation
| @@ -730,7 +715,7 @@ def parameter_bounds(self, bounds: list[tuple[float, float]]) -> None: | |||
|
|
|||
| def add_layer( | |||
| self, | |||
| other: Union["NLocal", qiskit.circuit.Instruction, QuantumCircuit], | |||
| other: QuantumCircuit | qiskit.circuit.Instruction, | |||
There was a problem hiding this comment.
QuantumCircuit includes "NLocal" therefore I removed the explicit mention
| initial_state: Optional[Any] = None, | ||
| initial_state: QuantumCircuit | None = None, |
There was a problem hiding this comment.
Did this change deliberately?
There was a problem hiding this comment.
Oh I thought I left a comment on that -- yes this is on purpose, we deprecated Any a few months ago (it's already gone in some NLocal circuits) but it seems we forgot it here 🙂 Any was mainly for backwards compatibility with old applications code so we don't need it anymore
| def _convert_to_block(self, layer: Any) -> QuantumCircuit: | ||
| def _convert_to_block(self, layer: typing.Any) -> QuantumCircuit: |
There was a problem hiding this comment.
Any means "don't type check this", whereas object is the base of all Python objects. The fact that this function takes either probably indicates that there's some usage of these objects that ought to be tightened up a bit, but it's not a big deal (and out of scope of this PR anyway).
There was a problem hiding this comment.
Yes, this can probably be changed to Operation
| num_qubits: Optional[int] = None, | ||
| entanglement: Union[str, List[List[int]], Callable[[int], List[int]]] = "reverse_linear", | ||
| num_qubits: int | None = None, | ||
| entanglement: str | list[list[int]] | Callable[[int], list[int]] = "full", |
There was a problem hiding this comment.
This is a change in default.
There was a problem hiding this comment.
Good catch, that change was not on purpose 😄
There was a problem hiding this comment.
yes, it's always better to do "reverse_linear" and not "full" since it provides the same unitary, but with O(n) CX gates instead of O(n^2)
jakelishman
added
the
stable backport potential
| num_qubits: int | None = None, | ||
| rotation_blocks: str | ||
| | type | ||
| | qiskit.circuit.Instruction |
There was a problem hiding this comment.
TwoLocal was missing Instruction as supported type
* consistent typehints * lint * attempt to fix docs 1/? * fix accidental default change * fix lint * fix , instead of | (cherry picked from commit eda570c) Co-authored-by: Julien Gacon <[email protected]>
* consistent typehints * lint * attempt to fix docs 1/? * fix accidental default change * fix lint * fix , instead of |
Summary
Fixes #10456 and generally use
collections.abcovertyping.Details and comments
Also makes the docs more consistent by removing the first line of the
__init__doc and theTODOin the Examples section (tracked in #10480).