Skip to content

Commit 5c8e139

Browse files
authored
docs: update docs on supported gatesets (#395)
* docs: cleanup docs on supported gatesets * fix one more link * add missing [2] ref * add missing or * minor wording fix
1 parent 01110e6 commit 5c8e139

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/index.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Every :py:class:`~pytket.backends.backend.Backend` in pytket has its own :py:met
169169
* - `DecomposeBoxes <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.DecomposeBoxes>`_
170170
- `DecomposeBoxes <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.DecomposeBoxes>`_
171171
- `DecomposeBoxes <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.DecomposeBoxes>`_
172-
* - self.rebase_pass [2]
172+
* - `AutoRebase <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.AutoRebase>`_ [2]
173173
- `SynthesiseTket <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.SynthesiseTket>`_
174174
- `FullPeepholeOptimise <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.FullPeepholeOptimise>`_
175175
* - `CXMappingPass <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.CXMappingPass>`_ [3]
@@ -178,24 +178,24 @@ Every :py:class:`~pytket.backends.backend.Backend` in pytket has its own :py:met
178178
* - `NaivePlacementPass <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.NaivePlacementPass>`_
179179
- `NaivePlacementPass <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.NaivePlacementPass>`_
180180
- `NaivePlacementPass <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.NaivePlacementPass>`_
181-
* - self.rebase_pass [2]
181+
* - `AutoRebase <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.AutoRebase>`_ [2]
182182
- `SynthesiseTket <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.SynthesiseTket>`_
183183
- `KAKDecomposition(allow_swaps=False) <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.KAKDecomposition>`_
184184
* - `RemoveRedundancies <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.RemoveRedundancies>`_
185-
- self.rebase_pass [2]
185+
- `AutoRebase <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.AutoRebase>`_ [2]
186186
- `CliffordSimp(allow_swaps=False) <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.CliffordSimp>`_
187187
* -
188188
- `RemoveRedundancies <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.RemoveRedundancies>`_
189189
- `SynthesiseTket <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.SynthesiseTket>`_
190190
* -
191191
-
192-
- self.rebase_pass [2]
192+
- `AutoRebase <https://tket.quantinuum.com/api-docs/placement.html#pytket.passes.AutoRebase>`_ [2]
193193
* -
194194
-
195195
- `RemoveRedundancies <https://tket.quantinuum.com/api-docs/passes.html#pytket.passes.RemoveRedundancies>`_
196196

197197
* [1] If no value is specified then ``optimisation_level`` defaults to a value of 2.
198-
* [2] self.rebase_pass is a rebase to the gateset supported by the backend. For IBM quantum devices and emulators that is either {X, SX, Rz, CX} or {X, SX, Rz, ECR}. The more idealised Aer simulators have a much broader range of supported gates.
198+
* [2] :py:class:`~pytket._tket.passes.AutoRebase` is a conversion to the gateset supported by the backend. For IBM quantum devices and emulators the supported gateset is either :math:`\{X, SX, Rz, CX\}`, :math:`\{X, SX, Rz, ECR\}`, or :math:`\{X, SX, Rz, CZ\}`. The more idealised Aer simulators have a much broader range of supported gates.
199199
* [3] Here :py:class:`~pytket._tket.passes.CXMappingPass` maps program qubits to the architecture using a :py:class:`~pytket._tket.placement.NoiseAwarePlacement`
200200

201201

0 commit comments

Comments
 (0)