Skip to content

Update qjit autograph keyword description #1697

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions frontend/catalyst/jit.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,8 @@ def qjit(
Args:
fn (Callable): the quantum or classical function
autograph (bool): Experimental support for automatically converting Python control
flow statements to Catalyst-compatible control flow. Currently supports Python ``if``,
``elif``, ``else``, and ``for`` statements. Note that this feature requires an
available TensorFlow installation. For more details, see the
flow statements (including ``if`` statements, ``for`` and ``while`` loops), and more,
to Catalyst-compatible control flow. For more details, see the
Comment on lines +112 to +113
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
flow statements (including ``if`` statements, ``for`` and ``while`` loops), and more,
to Catalyst-compatible control flow. For more details, see the
flow statements (including ``if`` statements, ``for`` and ``while`` loops) to
Catalyst-compatible control flow, and more. For more details, see the

:doc:`AutoGraph guide </dev/autograph>`.
autograph_include: A list of (sub)modules to be allow-listed for autograph conversion.
async_qnodes (bool): Experimental support for automatically executing
Expand Down