Skip to content

Commit c53c433

Browse files
[API compatibility] Update 6 API Docs (#7438)
* [API compatibility] Update 6 API Docs * Fix ci * update * update * update * Update docs/api/paddle/sub_cn.rst --------- Co-authored-by: zachary sun <[email protected]>
1 parent 557ef21 commit c53c433

File tree

8 files changed

+109
-5
lines changed

8 files changed

+109
-5
lines changed

docs/api/paddle/Overview_cn.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ tensor 数学操作
150150
" :ref:`paddle.stanh <cn_api_paddle_stanh>` ", "stanh 激活函数"
151151
" :ref:`paddle.std <cn_api_paddle_std>` ", "沿给定的轴 axis 计算 x 中元素的标准差"
152152
" :ref:`paddle.subtract <cn_api_paddle_subtract>` ", "逐元素相减算子"
153+
" :ref:`paddle.sub <cn_api_paddle_sub>` ", "逐元素相减算子"
153154
" :ref:`paddle.remainder <cn_api_paddle_remainder>` ", "逐元素取模算子"
154155
" :ref:`paddle.sum <cn_api_paddle_sum>` ", "对指定维度上的 Tensor 元素进行求和运算"
155156
" :ref:`paddle.tan <cn_api_paddle_tan>` ", "三角函数 tangent"
@@ -245,11 +246,13 @@ tensor 数学操作原位(inplace)版本
245246
" :ref:`paddle.sinc_ <cn_api_paddle_sinc_>` ", "Inplace 版本的 sinc API,对输入 x 采用 Inplace 策略"
246247
" :ref:`paddle.sinh_ <cn_api_paddle_sinh_>` ", "Inplace 版本的 sinh API,对输入 x 采用 Inplace 策略"
247248
" :ref:`paddle.subtract_ <cn_api_paddle_subtract_>` ", "Inplace 版本的 subtract API,对输入 x 采用 Inplace 策略"
249+
" :ref:`paddle.sub_ <cn_api_paddle_sub_>` ", "Inplace 版本的 sub API,对输入 x 采用 Inplace 策略"
248250
" :ref:`paddle.tan_ <cn_api_paddle_tan_>` ", "Inplace 版本的 tan API,对输入 x 采用 Inplace 策略"
249251
" :ref:`paddle.cos_ <cn_api_paddle_cos_>` ", "Inplace 版本的 cos API,对输入 x 采用 Inplace 策略"
250252
" :ref:`paddle.atan_ <cn_api_paddle_atan_>` ", "Inplace 版本的 atan API,对输入 x 采用 Inplace 策略"
251253
" :ref:`paddle.acos_ <cn_api_paddle_acos_>` ", "Inplace 版本的 acos API,对输入 x 采用 Inplace 策略"
252254
" :ref:`paddle.uniform_ <cn_api_paddle_uniform_>` ", "Inplace 版本的 uniform API,对输入 x 采用 Inplace 策略"
255+
" :ref:`paddle.random_ <cn_api_paddle_random_>` ", "Inplace 版本的 random API,对输入 x 采用 Inplace 策略"
253256
" :ref:`paddle.lerp_ <cn_api_paddle_lerp_>` ", "Inplace 版本的 lerp API,对输入 x 采用 Inplace 策略"
254257
" :ref:`paddle.hypot_ <cn_api_paddle_hypot_>` ", "Inplace 版本的 hypot API,对输入 x 采用 Inplace 策略"
255258
" :ref:`paddle.multigammaln_ <cn_api_paddle_multigammaln_>` ", "Inplace 版本的 multigammaln API,对输入 x 采用 Inplace 策略"
@@ -331,6 +334,7 @@ tensor 属性相关
331334
" :ref:`paddle.broadcast_shape <cn_api_paddle_broadcast_shape>` ", "返回对 x_shape 大小的 Tensor 和 y_shape 大小的 Tensor 做 broadcast 操作后得到的 shape"
332335
" :ref:`paddle.broadcast_shapes <cn_api_paddle_broadcast_shapes>` ", "返回对多个 shape 做 broadcast 操作后得到的 shape"
333336
" :ref:`paddle.is_floating_point <cn_api_paddle_is_floating_point>` ", "判断输入 Tensor 的数据类型是否为浮点类型"
337+
" :ref:`paddle.Size <cn_api_paddle_Size__upper>` ", "tuple 的子类, paddle.Tensor.size() 的返回类型,用于描述张量的维度大小。"
334338

335339
.. _tensor_creation:
336340

docs/api/paddle/Size__upper_cn.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. _cn_api_paddle_Size__upper:
2+
3+
Size
4+
-------------------------------
5+
6+
.. py:class:: paddle.Size()
7+
``paddle.Tensor.size()`` 的返回类型,用于描述张量的维度大小。作为 ``tuple`` 的子类,支持所有常见的序列操作(如索引、切片、拼接等)。
8+
9+
**参数**
10+
:::::::::
11+
- ``*args``:表示维度的整数序列或多个整数参数。
12+
13+
**返回**
14+
:::::::::
15+
- ``Size``:表示张量维度的特殊元组子类。
16+
17+
**代码示例**
18+
:::::::::
19+
20+
COPY-FROM: paddle.Size

docs/api/paddle/Tensor__upper_cn.rst

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,19 @@ data
329329
**代码示例**
330330
COPY-FROM: paddle.Tensor.data
331331

332+
is_cuda
333+
:::::::::
334+
335+
如果 Tensor 存储在 GPU 上,则为 True,否则为 False。
336+
337+
**代码示例**
338+
339+
.. code-block:: python
340+
341+
import paddle
342+
d = torch.Tensor([1,2,3])
343+
d.is_cuda
344+
332345
333346
numpy()
334347
:::::::::
@@ -2835,7 +2848,7 @@ strided_slice(axes, starts, ends, strides)
28352848

28362849
请参考 :ref:`cn_api_paddle_strided_slice`
28372850

2838-
subtract(y, name=None)
2851+
subtract(y, name=None, \*, alpha=1, out=None)
28392852
:::::::::
28402853

28412854
返回:计算后的 Tensor
@@ -2844,11 +2857,25 @@ subtract(y, name=None)
28442857

28452858
请参考 :ref:`cn_api_paddle_subtract`
28462859

2847-
subtract_(y, name=None)
2860+
subtract_(y, name=None, \*, alpha=1)
28482861
:::::::::
28492862

28502863
Inplace 版本的 :ref:`cn_api_paddle_subtract` API,对输入 `x` 采用 Inplace 策略。
28512864

2865+
sub(y, name=None, \*, alpha=1, out=None)
2866+
:::::::::
2867+
2868+
返回:计算后的 Tensor
2869+
2870+
返回类型:Tensor
2871+
2872+
请参考 :ref:`cn_api_paddle_sub`
2873+
2874+
sub_(y, name=None, \*, alpha=1)
2875+
:::::::::
2876+
2877+
Inplace 版本的 :ref:`cn_api_paddle_sub` API,对输入 `x` 采用 Inplace 策略。
2878+
28522879
sum(axis=None, dtype=None, keepdim=False, name=None)
28532880
:::::::::
28542881

@@ -3035,6 +3062,15 @@ unbind(axis=0)
30353062

30363063
请参考 :ref:`cn_api_paddle_unbind`
30373064

3065+
random_(from=0, to=None, generator=None)
3066+
:::::::::
3067+
3068+
返回:一个从均匀分布采样的随机数填充的 Tensor。输出 Tensor 将被置于输入 x 的位置。
3069+
3070+
返回类型:Tensor
3071+
3072+
请参考 :ref:`cn_api_paddle_random_`
3073+
30383074
uniform_(min=-1.0, max=1.0, seed=0, name=None)
30393075
:::::::::
30403076

docs/api/paddle/random__cn.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _cn_api_paddle_random_:
2+
3+
random\_
4+
-------------------------------
5+
6+
.. py:function:: paddle.random_(x, from=0, to=None, *, generator=None)
7+
8+
将张量自身填充为从离散均匀分布[``from``, ``to`` - 1]范围内采样的随机数。若未指定参数,数值范围通常仅受张量数据类型的限制。
9+
但对于浮点类型,若未指定范围,则默认范围为[0, 2^尾数位数],以确保每个值均可被精确表示。例如,paddle.to_tensor(1, dtype='float64').uniform_() 将在 [0, 2^53] 范围内均匀分布。
10+
random_ 为 Inplace 版本实现,对输入 `x` 采用 Inplace 策略。
11+
12+
参数
13+
::::::::::::
14+
15+
- **x** (Tensor) - 输入多维 Tensor,可选的数据类型为 'int32'、'int64'、'float32'、'float64'、'float16'、'bfloat16'。
16+
- **from** (int,可选) - 生成随机值的范围下限,默认为 0。。
17+
- **to** (int|None,可选) - 生成随机值的范围上限(开区间),默认为 None。
18+
- **generator** (None) - 随机数生成器的占位参数,当前未实现,保留未来使用。
19+
20+
返回
21+
::::::::::::
22+
23+
Tensor:数值服从范围[``from``, ``to`` - 1]内均匀分布的随机 Tensor。

docs/api/paddle/sub__cn.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _cn_api_paddle_sub_:
2+
3+
sub\_
4+
-------------------------------
5+
6+
.. py:function:: paddle.sub_(x, y, name=None, *, alpha=1)
7+
别名函数,功能与 :ref:`cn_api_paddle_subtract_` 完全相同,详情请参考 :ref:`cn_api_paddle_subtract_` 。

docs/api/paddle/sub_cn.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _cn_api_paddle_sub:
2+
3+
sub
4+
-------------------------------
5+
6+
.. py:function:: paddle.sub(x, y, name=None, *, alpha=1, out=None)
7+
别名函数,功能与 :ref:`cn_api_paddle_subtract` 完全相同,详情请参考 :ref:`cn_api_paddle_subtract`。

docs/api/paddle/subtract__cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
subtract\_
44
-------------------------------
55

6-
.. py:function:: paddle.subtract_(x, y, name=None)
6+
.. py:function:: paddle.subtract_(x, y, name=None, *, alpha=1)
77
88
Inplace 版本的 :ref:`cn_api_paddle_subtract` API,对输入 `x` 采用 Inplace 策略。
99

docs/api/paddle/subtract_cn.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,18 @@
33
subtract
44
-------------------------------
55

6-
.. py:function:: paddle.subtract(x, y, name=None)
6+
.. py:function:: paddle.subtract(x, y, name=None, *, alpha=1, out=None)
77
88
9+
.. note::
10+
别名支持: 参数名 ``input`` 可替代 ``x``,参数名 ``other`` 可替代 ``y`` ,如 ``subtract(input=tensor_x, other=tensor_y, ...)`` 等价于 ``subtract(x=tensor_x, y=tensor_y, ...)``。
11+
912
逐元素相减算子,输入 ``x`` 与输入 ``y`` 逐元素相减,并将各个位置的输出元素保存到返回结果中。
1013

1114
等式是:
1215

1316
.. math::
14-
out = x - y
17+
out = x - alpha \times y
1518
1619
.. note::
1720
``paddle.subtract`` 遵守 broadcasting,如您想了解更多,请参见 `Tensor 介绍`_ .
@@ -21,8 +24,12 @@ subtract
2124
参数
2225
:::::::::
2326
- **x** (Tensor) - 输入的 Tensor。数据类型为 ``bfloat16`` 、 ``float16`` 、 ``float32`` 、 ``float64``、 ``int16`` 、 ``int32`` 、 ``int64`` 、 ``complex64`` 或 ``complex128`` 。
27+
``别名: input``
2428
- **y** (Tensor) - 输入的 Tensor。数据类型为 ``bfloat16`` 、 ``float16`` 、 ``float32`` 、 ``float64``、 ``int16`` 、 ``int32`` 、 ``int64`` 、 ``complex64`` 或 ``complex128`` 。
29+
``别名: other``
2530
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
31+
- **alpha** (Number, 可选) - 对 ``y`` 的缩放因子,默认值为 1。
32+
- **out** (Tensor, 可选) - 输出 Tensor,默认值为 None。
2633

2734
返回
2835
:::::::::

0 commit comments

Comments
 (0)