Skip to content

AISPARSE-766: publish rocsparse_handle_create/destroy reference #12206

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

Merged
kliegeois merged 1 commit into from
Sep 16, 2026
Merged

AISPARSE-766: publish rocsparse_handle_create/destroy reference #12206

Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions projects/rocsparse/docs/how-to/using-rocsparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ consumed by the rocSPARSE library. You **cannot** switch devices
between :ref:`rocsparse_create_handle_` and :ref:`rocsparse_destroy_handle_`. To change the device,
you must destroy the current handle and create another rocSPARSE handle on a new device.

:ref:`rocsparse_create_handle_` blocks the calling thread until the handle is ready.
If you want handle creation to be stream-ordered instead, use :ref:`rocsparse_handle_create_`,
which binds the handle to a user-provided stream and enqueues all setup work on that stream
without blocking the host. Handles created this way are destroyed with
:ref:`rocsparse_handle_destroy_`, which also reports an optional error descriptor.
Neither routine can be called during HIP graph stream capture.

.. note::

:cpp:func:`hipSetDevice` and :cpp:func:`hipGetDevice` are not part of the rocSPARSE API.
Expand Down
4 changes: 4 additions & 0 deletions projects/rocsparse/docs/reference/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,12 @@ Auxiliary functions
+-----------------------------------------------------+
|:cpp:func:`rocsparse_create_handle` |
+-----------------------------------------------------+
|:cpp:func:`rocsparse_handle_create` |
+-----------------------------------------------------+
|:cpp:func:`rocsparse_destroy_handle` |
+-----------------------------------------------------+
|:cpp:func:`rocsparse_handle_destroy` |
+-----------------------------------------------------+
|:cpp:func:`rocsparse_set_stream` |
+-----------------------------------------------------+
|:cpp:func:`rocsparse_get_stream` |
Expand Down
14 changes: 14 additions & 0 deletions projects/rocsparse/docs/reference/auxiliary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,27 @@ rocsparse_create_handle()

.. doxygenfunction:: rocsparse_create_handle

.. _rocsparse_handle_create_:

rocsparse_handle_create()
-------------------------

.. doxygenfunction:: rocsparse_handle_create

.. _rocsparse_destroy_handle_:

rocsparse_destroy_handle()
--------------------------

.. doxygenfunction:: rocsparse_destroy_handle

.. _rocsparse_handle_destroy_:

rocsparse_handle_destroy()
--------------------------

.. doxygenfunction:: rocsparse_handle_destroy

.. _rocsparse_set_stream_:

rocsparse_set_stream()
Expand Down
Loading