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.

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

Jump to bottom

Graph docs release 6.3 #121

Open
wants to merge 2 commits into
base: release/rocm-rel-6.3
Choose a base branch
from
Open

Graph docs release 6.3 #121

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bc7ae5
doc: non-Xt Exec can be captured into HIP graph
evetsso Oct 4, 2024
7cfa6c7
Add graph-safe reference
neon60 Nov 26, 2024
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
35 changes: 35 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,41 @@ For complex-to-real transforms, the output buffer XXX

.. doxygenfunction:: hipfftXtExec

.. _hip-graph-support-for-hipfft:

HIP graph support for hipFFT
============================

hipFFT supports capturing kernels launched during FFT execution into
HIP graph nodes. This way, users can capture FFT execution, along
with other work, into a HIP graph and launch the work in the graph
multiple times.

The following hipFFT APIs can be used with graph capture:

* :cpp:func:`hipfftExecC2C`

* :cpp:func:`hipfftExecR2C`

* :cpp:func:`hipfftExecC2R`

* :cpp:func:`hipfftExecZ2Z`

* :cpp:func:`hipfftExecD2Z`

* :cpp:func:`hipfftExecZ2D`

Note that each launch of a HIP graph will provide the same arguments
to the kernels in the graph. In particular, this implies that all of
the parameters to the above APIs remain valid while the HIP graph is
in use:

* The hipFFT plan

* The input and output buffers

hipFFT does not support capturing work performed by other API
functions aside from those listed above.

Callbacks
=========
Expand Down