Skip to content

Commit 04bf384

Browse files
DongBaiYuesunzhongkai588
authored andcommitted
[API compatibility] torch.as_tensor, torch.finfo, torch.is_complex, torch.nn.functional.pad (PaddlePaddle#7380)
* [API compatibility] torch.as_tensor, torch.finfo, torch.is_complex, torch.nn.functional.pad * Update docs/api/paddle/finfo_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * Update docs/api/paddle/to_tensor_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * Update docs/api/paddle/to_tensor_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * Update docs/api/paddle/finfo_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * Update docs/api/paddle/is_complex_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * Update docs/api/paddle/nn/functional/pad_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * Update docs/api/paddle/is_complex_cn.rst Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> --------- Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>
1 parent 4c1e226 commit 04bf384

File tree

4 files changed

+16
-1
lines changed

4 files changed

+16
-1
lines changed

docs/api/paddle/finfo_cn.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@ finfo
1111

1212
其功能类似 `numpy.finfo <https://numpy.org/doc/stable/reference/generated/numpy.finfo.html#numpy-finfo>`_ 。
1313

14+
.. note::
15+
别名支持: 参数名 ``type`` 可替代 ``dtype``,如 ``type=paddle.float32`` 等价于 ``dtype=paddle.float32``。
16+
1417

1518
参数
1619
:::::::::
1720
- **dtype** (paddle.dtype|str) - 输入的数据类型,可以是:paddle.float16、 paddle.float32、 paddle.float64、 paddle.bfloat16、 paddle.complex64、 paddle.complex128 或这些类型的字符串形式。
21+
- **type** - ``dtype`` 的别名,行为完全一致。
1822

1923
返回
2024
:::::::::

docs/api/paddle/is_complex_cn.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@ is_complex
55

66
.. py:function:: paddle.is_complex(x)
77
8-
98
判断输入 tensor 的数据类型是否为复数类型(complex64 或者 complex128)。
109

10+
.. note::
11+
别名支持: 参数名 ``input`` 可替代 ``x``,如 ``input=tensor_x`` 等价于 ``x=tensor_x``。
12+
1113
参数
1214
:::::::::
1315
- **x** (Tensor) - 输入 Tensor
16+
- **input** - ``x`` 的别名,行为完全一致。
1417

1518

1619
返回

docs/api/paddle/nn/functional/pad_cn.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,14 @@ pad
2020
3. 当 ``mode`` 为 ``'reflect'``、 ``'replicate'``、 ``'circular'``,或 ``pad`` 是 Tensor,或 ``pad`` 的长度是 2*(N-2) 时,``x`` 的维数只支持 3-D、4—D、5-D。此时 pad 作用在相应 ``data_format`` 的 [D, H, W] 轴上,顺序是从 [D, H, W] 轴的最后一维到第一维。具体地,当 N=3 时,pad 的格式为[pad_left, pad_right];当 N=4 时,pad 的格式为[pad_left, pad_right, pad_top, pad_bottom];当 N=5 时,pad 的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。
2121
4. 如果 ``mode`` 为 ``reflect``,则 ``x`` 对应 [D, H, W] 维度上的长度必须大于对应的 ``pad`` 值。
2222

23+
.. note::
24+
别名支持: 参数名 ``input`` 可替代 ``x``,如 ``input=tensor_x`` 等价于 ``x=tensor_x``。
25+
2326
参数
2427
::::::::::::
2528

2629
- **x** (Tensor) - Tensor,format 可以为 ``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'`` 或 ``'NDHWC'``,默认值为 ``'NCHW'``,数据类型支持 float16、float32、float64、int32、int64、complex64、complex128。
30+
- **input** - ``x`` 的别名,行为完全一致。
2731
- **pad** (Tensor|list[int]|tuple[int]) - 填充大小,基本数据类型是整数类型。具体设置请参照 Note(注解)。
2832

2933
- **mode** (str,可选) - padding 的四种模式,分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``,

docs/api/paddle/to_tensor_cn.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ to_tensor
1212
如果 ``data`` 已经是一个 Tensor,且 ``dtype`` 、 ``place`` 没有发生变化,将不会发生 Tensor 的拷贝并返回原来的 Tensor。
1313
否则会创建一个新的 Tensor,且不保留原来计算图。
1414

15+
.. note::
16+
别名支持: 参数名 ``device`` 可替代 ``place``,如 ``device=paddle.CUDAPlace(0)`` 等价于 ``place=paddle.CUDAPlace(0)``。
17+
1518
.. code-block:: text
1619
1720
我们使用如下规则来进行类型转换:
@@ -32,6 +35,7 @@ to_tensor
3235
- **dtype** (str,可选) - 创建 Tensor 的数据类型,可以是 bool、float16、float32、float64、int8、int16、int32、int64、uint8、complex64、complex128。
3336
默认值为 None,如果 ``data`` 为 python 浮点类型,则从 :ref:`cn_api_paddle_get_default_dtype` 获取类型,如果 ``data`` 为其他类型,则会自动推导类型。
3437
- **place** (CPUPlace|CUDAPinnedPlace|CUDAPlace,可选) - 创建 tensor 的设备位置,可以是 CPUPlace、CUDAPinnedPlace、CUDAPlace。默认值为 None,使用全局的 place。
38+
- **device** - ``place`` 的别名,行为完全一致。
3539
- **stop_gradient** (bool,可选) - 是否阻断 Autograd 的梯度传导。默认值为 True,此时不进行梯度传传导。
3640

3741
返回

0 commit comments

Comments
 (0)