Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add property-set documentation to transpiler passes #10727

Open
jakelishman opened this issue Aug 29, 2023 · 0 comments
Open

Add property-set documentation to transpiler passes #10727

jakelishman opened this issue Aug 29, 2023 · 0 comments
Labels
documentation Something is not clear or an error documentation mod: transpiler Issues and PRs related to Transpiler

Comments

@jakelishman
Copy link
Member

jakelishman commented Aug 29, 2023

Transpiler passes should document which elements of the PropertySet they both read and write, with what types, and for what purpose. For example, see the linked code in #10721 (comment):

Property Set Fields Read
------------------------
``sabre_starting_layout`` (``list[Layout]``)
An optional list of :class:`~.Layout` objects to use for additional layout trials. This is
in addition to the full random trials specified with the ``layout_trials`` argument.
Property Set Values Written
---------------------------
``layout`` (:class:`.Layout`)
The chosen initial mapping of virtual to physical qubits, including the ancilla allocation.
``final_layout`` (:class:`.Layout`)
A permutation of how swaps have been applied to the input qubits at the end of the circuit.

@jakelishman jakelishman added documentation Something is not clear or an error documentation mod: transpiler Issues and PRs related to Transpiler labels Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or an error documentation mod: transpiler Issues and PRs related to Transpiler
Projects
Status: No status
Status: No status
Development

No branches or pull requests

1 participant