Skip to content

[DOCS] Include exchange api in the docs #181

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
junrushao merged 1 commit into from
Dec 11, 2025
+19 −1
Merged

[DOCS] Include exchange api in the docs #181

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
17 changes: 17 additions & 0 deletions docs/source/c_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ Enumerations

.. doxygenenum:: DLDataTypeCode


Typedefs
~~~~~~~~

.. doxygentypedef:: DLPackManagedTensorAllocator
.. doxygentypedef:: DLPackManagedTensorFromPyObjectNoSync
.. doxygentypedef:: DLPackManagedTensorToPyObjectNoSync
.. doxygentypedef:: DLPackDLTensorFromPyObjectNoSync
.. doxygentypedef:: DLPackCurrentWorkStream


Structs
~~~~~~~

Expand All @@ -47,3 +58,9 @@ Structs

.. doxygenstruct:: DLManagedTensorVersioned
:members:

.. doxygenstruct:: DLPackExchangeAPIHeader
:members:

.. doxygenstruct:: DLPackExchangeAPI
:members:
3 changes: 2 additions & 1 deletion include/dlpack/dlpack.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,7 @@ typedef int (*DLPackManagedTensorAllocator)(
*
* \param py_object The Python object to convert. Must have the same type
* as the one the `DLPackExchangeAPI` was discovered from.
* \param out The output DLManagedTensorVersioned.
* \return The owning DLManagedTensorVersioned* or NULL on failure with a
* Python exception set. If the data cannot be described using DLPack
* this should be a BufferError if possible.
Expand Down Expand Up @@ -616,7 +617,7 @@ typedef struct DLPackExchangeAPI {
/*!
* \brief Producer function pointer for DLPackManagedTensorToPyObject
* This function must be not NULL.
* \sa DLPackManagedTensorToPyObject
* \sa DLPackManagedTensorToPyObjectNoSync
*/
DLPackManagedTensorToPyObjectNoSync managed_tensor_to_py_object_no_sync;
/*!
Expand Down