Skip to content

[DLPACK] Update dlpack doc #6882

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

Merged
merged 6 commits into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion ci_scripts/ci_start.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ if [ -z "${PADDLE_WHL}" ] ; then
fi
if [ -z "${PADDLE_WHL}" ] ; then
# as there are two pipelines now, only change the test pipeline's version to py3.7
PADDLE_WHL=https://paddle-wheel.bj.bcebos.com/develop/linux/linux-cpu-mkl-avx/paddlepaddle-0.0.0-cp310-cp310-linux_x86_64.whl
PADDLE_WHL="--pre paddlepaddle -i https://www.paddlepaddle.org.cn/packages/nightly/cpu/"
if [ ${BRANCH} = 'release/2.4' ] ; then
PADDLE_WHL=https://paddle-wheel.bj.bcebos.com/2.4.1/linux/linux-cpu-mkl-avx/paddlepaddle-2.4.1-cp37-cp37m-linux_x86_64.whl
elif [ ${BRANCH} = 'release/2.3' ] ; then
Expand Down
2 changes: 1 addition & 1 deletion ci_scripts/ci_start_en.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ if [ -z "${PADDLE_WHL}" ] ; then
fi
if [ -z "${PADDLE_WHL}" ] ; then
# as there are two pipelines now, only change the test pipeline's version to py3.7
PADDLE_WHL=https://paddle-wheel.bj.bcebos.com/develop/linux/cpu-mkl/paddlepaddle-0.0.0-cp37-cp37m-linux_x86_64.whl
PADDLE_WHL="--pre paddlepaddle -i https://www.paddlepaddle.org.cn/packages/nightly/cpu/"
if [ ${BRANCH} = 'release/2.3' ] ; then
PADDLE_WHL=https://paddle-wheel.bj.bcebos.com/2.3.0/linux/linux-cpu-mkl-avx/paddlepaddle-2.3.0-cp37-cp37m-linux_x86_64.whl
elif [ ${BRANCH} = 'release/2.2' ] ; then
Expand Down
19 changes: 14 additions & 5 deletions docs/api/paddle/utils/dlpack/from_dlpack_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,25 @@ from_dlpack

.. py:function:: paddle.utils.dlpack.from_dlpack(dlpack)

将 DLPack 解码为 Tensor 对象。其中,DLPack 是一种开放的内存 Tensor 结构,可用于不同深度学习框架之间的 Tensor 共享。注意,一个 DLPack 只能被解码一次。
将 DLPack 格式的 Tensor 解码为 Paddle Tensor,DLPACK 是一种通用稳定的内存数据结构,可用于不同深度学习框架之间的 Tensor 共享。

.. note::
一个 dlpack 只能被 ``from_dlpack`` 解码一次。

参数
:::::::::
- **dlpack** (PyCapsule) - DLPack,即带有 dltensor 的 PyCapsule 对象。
- **dlpack** (SupportDLPack | PyCapsule) - 一个实现了 ``__dlpack__`` 与 ``__dlpack_device__`` 方法的对象,或者是一个带有 dltensor 的 ``PyCapsule`` 对象。

返回
:::::::::
- **out** (Tensor) - 从 DLPack 中解码得到的 Tensor。需要注意的是,对于带有`bool`数据类型的 dltensor 输入,我们最终解码得到的 Tensor 对应的数据类型为`uint8`。
- **out** (Tensor) - 从 `dlpack` 中解码得到的 Paddle Tensor,支持的数据类型为: bool,float16,float32,float64,uint8,int8,int16,int32,int64,complex64,complex128,支持的设备类型为: ``CPU``, ``CUDAPlace``, ``CUDAPinnedPlace``。

代码示例
代码示例 1
:::::::::
COPY-FROM: paddle.utils.dlpack.from_dlpack

COPY-FROM: paddle.utils.dlpack.from_dlpack:code-paddle-from-paddle

代码示例 2
:::::::::

COPY-FROM: paddle.utils.dlpack.from_dlpack:code-paddle-from-numpy
16 changes: 11 additions & 5 deletions docs/api/paddle/utils/dlpack/to_dlpack_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,22 @@ to_dlpack

.. py:function:: paddle.utils.dlpack.to_dlpack(x)

将 Tensor 对象转化为 DLPack。其中,DLPack 是一种开放的内存 Tensor 结构,可用于不同深度学习框架之间的 Tensor 共享。
将 Tensor 对象转化为一个带有 dltensor 的 ``PyCapsule`` 对象,该对象是一种称为 DLPack 的通用稳定内存数据结构,可用于不同深度学习框架之间的 Tensor 共享。

参数
:::::::::
- **x** (Tensor) - Paddle Tensor,并且其数据类型为支持 bool,float16,float32,float64,int8,int16,int32,int64,uint8,complex64,complex128。
- **x** (Tensor) - Paddle Tensor,支持的数据类型为: bool,float16,float32,float64,uint8,int8,int16,int32,int64,uint8,complex64,complex128。

返回
:::::::::
- **dlpack** (PyCapsule) - DLPack,即带有 dltensor 的 PyCapsule 对象。
- **dlpack** (PyCapsule) - 一个带有 dltensor 的 ``PyCapsule`` 对象。

代码示例
代码示例 1
:::::::::
COPY-FROM: paddle.utils.dlpack.to_dlpack

COPY-FROM: paddle.utils.dlpack.to_dlpack:code-paddle-to-paddle

代码示例 2
:::::::::

COPY-FROM: paddle.utils.dlpack.to_dlpack:code-paddle-to-torch