Skip to content

Commit

Permalink
Improving linking between transpilaiton documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GuillermoAbadLopez committed Dec 30, 2024
1 parent 7d0f697 commit 0764d9b
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/fundamentals/transpilation.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _transpilation:

Transpilation
=============

Expand Down
4 changes: 4 additions & 0 deletions src/qililab/digital/circuit_transpiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,10 @@ def transpile_circuit(
# Or also specifying the `router` with kwargs:
transpiled_circuit, final_layouts = transpiler.transpile_circuit(c, router=(Sabre, {"lookahead": 2}))
.. note::
Check :ref:`Transpilation <transpilation>`, for more examples of how ``execute()``'s methods automatically apply this.
Args:
circuit (Circuit): Qibo circuit.
routing (bool, optional): whether to route the circuit. Defaults to False.
Expand Down
2 changes: 1 addition & 1 deletion src/qililab/execute_circuit.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def execute(
The ``program`` argument is first translated into pulses using the transpilation settings of the runcard and the passed transpile
configuration. Then the pulse will be compiled into the runcard machines assembly programs, and executed.
The transpilation is performed using the :meth:`.CircuitTranspiler.transpile_circuit()` method. Refer to the method's documentation for more detailed information. The main stages of this process are:
The transpilation is performed using the :meth:`.CircuitTranspiler.transpile_circuit()` method. Refer to the method's documentation or :ref:`Transpilation <transpilation>` for more detailed information. The main stages of this process are:
1. \\*)Routing, 2. \\**)Canceling Hermitian pairs, 3. Translate to native gates, 4. Commute virtual RZ & adding CZ phase corrections, 5. \\**)Optimize Drag gates, 6. Convert to pulse schedule.
.. note ::
Expand Down
4 changes: 2 additions & 2 deletions src/qililab/platform/platform.py
Original file line number Diff line number Diff line change
Expand Up @@ -993,7 +993,7 @@ def execute(
To compile to assembly programs, the ``platform.compile()`` method is called; check its documentation for more information.
The transpilation is performed using the :meth:`.CircuitTranspiler.transpile_circuit()` method. Refer to the method's documentation for more detailed information. The main stages of this process are:
The transpilation is performed using the :meth:`.CircuitTranspiler.transpile_circuit()` method. Refer to the method's documentation or :ref:`Transpilation <transpilation>` for more detailed information. The main stages of this process are:
1. \\*)Routing, 2. \\**)Canceling Hermitian pairs, 3. Translate to native gates, 4. Commute virtual RZ & adding CZ phase corrections, 5. \\**)Optimize Drag gates, 6. Convert to pulse schedule.
.. note ::
Expand Down Expand Up @@ -1141,7 +1141,7 @@ def compile(
If the ``program`` argument is a :class:`.Circuit`, it will first be translated into a :class:`.PulseSchedule` using the transpilation
settings of the platform and passed transpile configuration. Then the pulse schedules will be compiled into the assembly programs.
The transpilation is performed using the :meth:`.CircuitTranspiler.transpile_circuit()` method. Refer to the method's documentation for more detailed information. The main stages of this process are:
The transpilation is performed using the :meth:`.CircuitTranspiler.transpile_circuit()` method. Refer to the method's documentation or :ref:`Transpilation <transpilation>` for more detailed information. The main stages of this process are:
1. \\*)Routing, 2. \\**)Canceling Hermitian pairs, 3. Translate to native gates, 4. Commute virtual RZ & adding CZ phase corrections, 5. \\**)Optimize Drag gates, 6. Convert to pulse schedule.
.. note ::
Expand Down

0 comments on commit 0764d9b

Please sign in to comment.