Skip to content

[Doc] Remove checkpoint fixme #755

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.

Sign up for GitHub

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
hughperkins wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Doc] Remove checkpoint fixme #755

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/source/user_guide/algorithms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ These algorithms run on all of Quadrants' GPU backends (CUDA, AMDGPU, Vulkan, Me

## Composable `@qd.func` ops

Every algorithm is a composable `@qd.func` (e.g. `reduce_add`, `sort`): call it at the **top level** of your own `@qd.kernel`, so the op is captured into the same kernel / graph as your surrounding phases. The function is annotated with `requires_top_level=True`, so attempting to use it outside of top level will throw an exception at compile time. Note that within a `qd.loop_do_while` counts as being at top-level [FIXME: add qd.checkpoint here too, once/when we merge qd.checkpoint].
Every algorithm is a composable `@qd.func` (e.g. `reduce_add`, `sort`): call it at the **top level** of your own `@qd.kernel`, so the op is captured into the same kernel / graph as your surrounding phases. The function is annotated with `requires_top_level=True`, so attempting to use it outside of top level will throw an exception at compile time. Note that within a `qd.loop_do_while` or `qd.checkpoint` counts as being at top-level.

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 23, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Do not say algorithms can be called directly in checkpoints

This new wording tells users that a qd.checkpoint body counts as top level for composable algorithms, but the checkpoint transformer rejects any non-docstring bare ast.Expr in a checkpoint body before the call is lowered (checkpoint_transformer.py lines 247-263). Since calls such as qd.algorithms.reduce_add(...) or qd.algorithms.sort(...) are bare expression statements in the documented usage pattern, placing them directly under with qd.checkpoint(...): raises QuadrantsSyntaxError, and wrapping them in a normal for then violates requires_top_level=True. Please qualify this or document the supported wrapping pattern, otherwise the docs advertise an API shape that currently fails at compile time.

Useful? React with 👍 / 👎.

@duburcqa duburcqa Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The bot comment looks legit.


## Key sizing parameters

Expand Down
Loading