Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
01d3690
Bug fix for layer_and_model documentation (#4069)
jim19930609 Nov 11, 2021
dfab71f
update docs (#4067)
TCChenlong Nov 11, 2021
3236350
update Tables in develop branch (#4071)
pangyoki Nov 11, 2021
f585f79
Update 01_quick_start_cn.rst
TCChenlong Nov 11, 2021
298ba1e
Add FAQ of load/save API (#4060)
YuanRisheng Nov 11, 2021
e9718b4
Update 2.0.md
TCChenlong Nov 11, 2021
c3ddcf8
add_faq_einsum (#4076)
Ligoml Nov 11, 2021
578d943
Update 2.0.md
TCChenlong Nov 11, 2021
1456677
polish linalg doc and add triangular_solve doc (#4073)
zhwesky2010 Nov 11, 2021
d2d18e8
add cuda11.1 in dev doc (#4079)
pangyoki Nov 11, 2021
6b5e24f
[PaddlePaddle Hackathon] add WideResNet zh-cn docs (#4034)
SigureMo Nov 12, 2021
667aa66
Add gather cn faq (#4082)
sneaxiy Nov 12, 2021
30bbba0
Add sparse_attention warning (#4083)
Liu-xiandong Nov 12, 2021
792bcea
update bn faq (#4080)
ceci3 Nov 12, 2021
fc1652e
Add faq about pack_padded_sequence & pad_packed_sequence API (#4066)
yingyibiao Nov 12, 2021
a72b88d
add fqa for optimizer (#4081)
sljlp Nov 12, 2021
d3ce8ea
fix bincount arg description (#4086)
smallv0221 Nov 15, 2021
3418e03
add some args (#4096)
Nov 16, 2021
640c28e
add LODTensor deprecation explanation (#4098)
jzhang533 Nov 16, 2021
7a7c0fb
all subdir in docs will have ipynb files, not only 'pratices'. (#4106)
wadefelix Nov 17, 2021
c06723e
加个转换paddle.device.cuda.Event=paddle.fluid.core_avx.CUDAEvent的配置,与sphi…
wadefelix Nov 18, 2021
1cd543c
Add img to collective docs (#4038)
youth123 Nov 19, 2021
34959c4
Fix doc for shard_index (#4062)
Nov 19, 2021
dbede61
update elu formula (#4114)
zhupengyang Nov 22, 2021
79874e0
Add paddle.incubate.graph_send_recv API docs (#4104)
DesmonDay Nov 23, 2021
3a025b6
fix typo (#4105)
Nov 23, 2021
768d50a
add isclose chinese doc (#4117)
andyjiang1116 Nov 25, 2021
5aa707a
update module list (#4057)
zoooo0820 Nov 29, 2021
ab21e76
Refine dy2stat docs (#4103)
0x45f Dec 1, 2021
9592ff7
【PaddlePaddle Hackathon】6、在 Paddle 中新增 ZeroPad2d (#4111)
gsq7474741 Dec 2, 2021
cb49f94
动转静概述更新 (#4099)
moguguo Dec 2, 2021
47d7dc4
add deg2rad & rad2deg docs (#4121)
luotao1 Dec 2, 2021
41af9ff
add doc for paddle.angle (#4124)
Dec 2, 2021
7d1ea19
fix jit (#4128)
TCChenlong Dec 6, 2021
5483cf7
add diff chinese doc (#4122)
andyjiang1116 Dec 6, 2021
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/hooks/pre-doc-compile.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ done

## 2 convert all ipynb files to markdown, and delete the ipynb files.
# ../practices/**/*.ipynb
for i in ${SCRIPT_DIR}/../../docs/practices/**/*.ipynb ; do
for i in $(find ${SCRIPT_DIR}/../../docs/ -name '*.ipynb' -type f ) ; do
echo "convert $i to markdown and delete ipynb"
jupyter nbconvert --to markdown "$i"
rm "$i"
Expand Down
6 changes: 6 additions & 0 deletions docs/api/api_aliases.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[help]
help_zh=左侧是target name,右侧是origin name, 如paddle.device.cuda.Event=paddle.fluid.core_avx.CUDAEvent

[en]
paddle.device.cuda.Event=paddle.fluid.core_avx.CUDAEvent
paddle.device.cuda.Stream=paddle.fluid.core_avx.CUDAStream
2 changes: 2 additions & 0 deletions docs/api/gen_doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,7 @@ def set_api_sketch():
paddle.nn.utils,
paddle.static,
paddle.static.nn,
paddle.signal,
paddle.io,
paddle.jit,
paddle.metric,
Expand All @@ -427,6 +428,7 @@ def set_api_sketch():
paddle.utils.profiler,
paddle.utils.cpp_extension,
paddle.utils.unique_name,
paddle.utils.dlpack,
paddle.sysconfig,
paddle.vision,
paddle.vision.datasets,
Expand Down
12 changes: 6 additions & 6 deletions docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@ tensor数学操作
:widths: 10, 30

" :ref:`paddle.abs <cn_api_fluid_layers_abs>` ", "绝对值函数"
" :ref:`paddle.angle <cn_api_paddle_angle>` ", "相位角函数"
" :ref:`paddle.acos <cn_api_fluid_layers_acos>` ", "arccosine函数"
" :ref:`paddle.add <cn_api_tensor_add>` ", "Tensor逐元素相加"
" :ref:`paddle.add_n <cn_api_tensor_add_n>` ", "对输入的一至多个Tensor或LoDTensor求和"
" :ref:`paddle.addmm <cn_api_tensor_addmm>` ", "计算输入Tensor x和y的乘积,将结果乘以标量alpha,再加上input与beta的乘积,得到输出"
" :ref:`paddle.all <cn_api_tensor_all>` ", "对指定维度上的Tensor元素进行逻辑与运算"
" :ref:`paddle.allclose <cn_api_tensor_allclose>` ", "逐个检查输入Tensor x和y的所有元素是否均满足 ∣x−y∣≤atol+rtol×∣y∣"
" :ref:`paddle.isclose <cn_api_tensor_isclose>` ", "逐个检查输入Tensor x和y的所有元素是否满足 ∣x−y∣≤atol+rtol×∣y∣"
" :ref:`paddle.any <cn_api_tensor_any>` ", "对指定维度上的Tensor元素进行逻辑或运算"
" :ref:`paddle.asin <cn_api_fluid_layers_asin>` ", "arcsine函数"
" :ref:`paddle.atan <cn_api_fluid_layers_atan>` ", "arctangent函数"
Expand All @@ -61,7 +63,6 @@ tensor数学操作
" :ref:`paddle.greater_equal <cn_api_tensor_cn_greater_equal>` ", "逐元素地返回 x>=y 的逻辑值"
" :ref:`paddle.greater_than <cn_api_tensor_cn_greater_than>` ", "逐元素地返回 x>y 的逻辑值"
" :ref:`paddle.increment <cn_api_tensor_increment>` ", "在控制流程中用来让 x 的数值增加 value"
" :ref:`paddle.inverse <cn_api_tensor_inverse>` ", "计算方阵的逆"
" :ref:`paddle.kron <cn_api_paddle_tensor_kron>` ", "计算两个张量的克罗内克积"
" :ref:`paddle.less_equal <cn_api_tensor_cn_less_equal>` ", "逐元素地返回 x<=y 的逻辑值"
" :ref:`paddle.less_than <cn_api_tensor_cn_less_than>` ", "逐元素地返回 x<y 的逻辑值"
Expand Down Expand Up @@ -112,6 +113,9 @@ tensor数学操作
" :ref:`paddle.diagonal <cn_api_tensor_diagonal>` ", "根据给定的轴 axis 返回输入 Tensor 的局部视图"
" :ref:`paddle.trunc <cn_api_tensor_trunc>` ", "对输入 Tensor 每个元素的小数部分进行截断"
" :ref:`paddle.log1p <cn_api_paddle_tensor_log1p>` ", "该OP计算Log1p(加一的自然对数)结果"
" :ref:`paddle.diff <cn_api_tensor_diff>` ", "沿着指定维度对输入Tensor计算n阶的前向差值"
" :ref:`paddle.rad2deg <cn_api_paddle_tensor_rad2deg>` ", "将元素从弧度的角度转换为度"
" :ref:`paddle.deg2rad <cn_api_paddle_tensor_deg2rad>` ", "将元素从度的角度转换为弧度"

.. _tensor_logic:

Expand Down Expand Up @@ -236,20 +240,16 @@ tensor线性代数相关

" :ref:`paddle.bincount <cn_api_tensor_bincount>` ", "统计输入张量中元素的出现次数"
" :ref:`paddle.bmm <cn_api_paddle_tensor_bmm>` ", "对输入x及输入y进行矩阵相乘"
" :ref:`paddle.cholesky <cn_api_tensor_cholesky>` ", "计算一个对称正定矩阵或一批对称正定矩阵的Cholesky分解"
" :ref:`paddle.cross <cn_api_tensor_linalg_cross>` ", "计算张量 x 和 y 在 axis 维度上的向量积(叉积)"
" :ref:`paddle.dist <cn_api_tensor_linalg_dist>` ", "计算 (x-y) 的 p 范数(p-norm)"
" :ref:`paddle.dot <cn_api_paddle_tensor_linalg_dot>` ", "计算向量的内积"
" :ref:`paddle.histogram <cn_api_tensor_histogram>` ", "计算输入张量的直方图"
" :ref:`paddle.matmul <cn_api_tensor_matmul>` ", "计算两个Tensor的乘积,遵循完整的广播规则"
" :ref:`paddle.matrix_power <cn_api_tensor_matrix_power>` ", "计算一个(或一批)方阵的 n 次幂"
" :ref:`paddle.mv <cn_api_tensor_mv>` ", "计算矩阵 x 和向量 vec 的乘积"
" :ref:`paddle.norm <cn_api_tensor_norm>` ", "计算给定Tensor的矩阵范数(Frobenius 范数)和向量范数(向量1范数、2范数、或者通常的p范数)"
" :ref:`paddle.rank <cn_api_fluid_layers_rank>` ", "计算输入Tensor的维度(秩)"
" :ref:`paddle.t <cn_api_paddle_tensor_t>` ", "对小于等于2维的Tensor进行数据转置"
" :ref:`paddle.tril <cn_api_tensor_tril>` ", "返回输入矩阵 input 的下三角部分,其余部分被设为0"
" :ref:`paddle.triu <cn_api_tensor_triu>` ", "返回输入矩阵 input 的上三角部分,其余部分被设为0"
" :ref:`paddle.multi_dot<cn_api_tensor_multi_dot>` ", "计算多个矩阵相乘"

.. _tensor_manipulation:

Expand Down Expand Up @@ -299,7 +299,7 @@ tensor元素操作相关(如:转置,reshape等)
.. einsum:

爱因斯坦求和
::::::
::::::::::::::::::

.. csv-table::
:header: "API名称", "API功能"
Expand Down
3 changes: 3 additions & 0 deletions docs/api/paddle/Tensor/Overview_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Methods
addmm
all
allclose
angle
any
argmax
argmin
Expand Down Expand Up @@ -113,6 +114,7 @@ Methods
dist
divide
dot
diff
eigvals
equal
equal_all
Expand Down Expand Up @@ -143,6 +145,7 @@ Methods
index_sample
index_select
inverse
isclose
is_empty
is_tensor
isfinite
Expand Down
72 changes: 65 additions & 7 deletions docs/api/paddle/Tensor_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,15 @@ abs(name=None)

请参考 :ref:`cn_api_fluid_layers_abs`

angle(name=None)
:::::::::

返回:计算后的Tensor

返回类型:Tensor

请参考 :ref:`cn_api_paddle_angle`

acos(name=None)
:::::::::

Expand Down Expand Up @@ -271,6 +280,15 @@ allclose(y, rtol=1e-05, atol=1e-08, equal_nan=False, name=None)

请参考 :ref:`cn_api_tensor_allclose`

isclose(x, y, rtol=1e-05, atol=1e-08, equal_nan=False, name=None)
:::::::::

返回:计算后的Tensor

返回类型:Tensor

请参考 :ref:`cn_api_tensor_isclose`

any(axis=None, keepdim=False, name=None)
:::::::::

Expand Down Expand Up @@ -480,7 +498,7 @@ cholesky(upper=False, name=None)

返回类型:Tensor

请参考 :ref:`cn_api_tensor_cholesky`
请参考 :ref:`cn_api_linalg_cholesky`

chunk(chunks, axis=0, name=None)
:::::::::
Expand Down Expand Up @@ -671,6 +689,17 @@ cumsum(axis=None, dtype=None, name=None)

请参考 :ref:`cn_api_tensor_cn_cumsum`

deg2rad(x, name=None)
:::::::::

将元素从度的角度转换为弧度

返回:计算后的Tensor

返回类型:Tensor

请参考 :ref:`cn_api_paddle_tensor_deg2rad`

detach()
:::::::::

Expand Down Expand Up @@ -748,6 +777,15 @@ dot(y, name=None)

请参考 :ref:`cn_api_paddle_tensor_linalg_dot`

diff(x, n=1, axis=-1, prepend=None, append=None, name=None)
:::::::::

返回:计算后的Tensor

返回类型:Tensor

请参考 :ref:`cn_api_tensor_diff`

equal(y, name=None)
:::::::::

Expand Down Expand Up @@ -814,7 +852,7 @@ eigvals(y, name=None)

返回类型:Tensor

请参考 :ref:`cn_api_paddle_linalg_eigvals`
请参考 :ref:`cn_api_linalg_eigvals`

fill_(x, value, name=None)
:::::::::
Expand Down Expand Up @@ -1076,14 +1114,14 @@ index_select(index, axis=0, name=None)

请参考 :ref:`cn_api_tensor_search_index_select`

inverse(name=None)
inv(name=None)
:::::::::

返回:计算后的Tensor

返回类型:Tensor

请参考 :ref:`cn_api_tensor_inverse`
请参考 :ref:`cn_api_linalg_inv`

is_empty(cond=None)
:::::::::
Expand Down Expand Up @@ -1263,7 +1301,7 @@ matrix_power(x, n, name=None)

返回类型:Tensor

请参考 :ref:`cn_api_tensor_matrix_power`
请参考 :ref:`cn_api_linalg_matrix_power`

max(axis=None, keepdim=False, name=None)
:::::::::
Expand Down Expand Up @@ -1402,7 +1440,7 @@ norm(p=fro, axis=None, keepdim=False, name=None)

返回类型:Tensor

请参考 :ref:`cn_api_tensor_norm`
请参考 :ref:`cn_api_linalg_norm`

not_equal(y, name=None)
:::::::::
Expand Down Expand Up @@ -1479,6 +1517,17 @@ prod(axis=None, keepdim=False, dtype=None, name=None)

请参考 :ref:`cn_api_tensor_cn_prod`

rad2deg(x, name=None)
:::::::::

将元素从弧度的角度转换为度

返回:计算后的Tensor

返回类型:Tensor

请参考 :ref:`cn_api_paddle_tensor_rad2deg`

rank()
:::::::::

Expand Down Expand Up @@ -1950,6 +1999,15 @@ transpose(perm, name=None)

请参考 :ref:`cn_api_fluid_layers_transpose`

triangular_solve(b, upper=True, transpose=False, unitriangular=False, name=None)
:::::::::

返回:计算后的Tensor

返回类型:Tensor

请参考 :ref:`cn_api_linalg_triangular_solve`

trunc(name=None)
:::::::::

Expand Down Expand Up @@ -2064,7 +2122,7 @@ multi_dot(x, name=None)

返回类型:Tensor

请参考 :ref:`cn_api_tensor_multi_dot`
请参考 :ref:`cn_api_linalg_multi_dot`

solve(x, y name=None)
:::::::::
Expand Down
27 changes: 27 additions & 0 deletions docs/api/paddle/angle_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _cn_api_paddle_angle:

angle
-------------------------------

.. py:function:: paddle.angle(x, name=None)


逐元素计算复数的相位角。对于非负实数,相位角为 0,而对于负实数,相位角为 :math:`\pi`.

.. math::

angle(x) = arctan2(x.imag, x.real)

参数
:::::::::
- x (Tensor) - 输入的Tensor,数据类型为:complex64, complex128 或 float32, float64。
- name (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。

返回
:::::::::
输出实数Tensor,与 ``x`` 的数值精度一致。

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

COPY-FROM: paddle.angle
2 changes: 1 addition & 1 deletion docs/api/paddle/bincount_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ bincount

- **x** (Tensor) - 输入Tensor。必须是一维Tensor,其中元素必须大于等于0,数据类型为int32, int64。
- **weights** (Tensor, 可选) - weights Tensor,代表输入Tensor中每个元素的权重。长度必须与输入Tensor相同。数据类型为int32, int64, float32或float64。默认为None
- **minlength** (int, 可选) - 输出Tensor的最小长度,如果大于输入Tensor的长度,则多出的位置补0。该值必须大于等于0。默认为0。
- **minlength** (int, 可选) - 输出Tensor的最小长度,如果大于输入Tensor中的最大值,则多出的位置补0。该值必须大于等于0。默认为0。
- **name** (str,可选)- 具体用法请参见 :ref:`api_guide_Name` ,一般无需设置,默认值为None。

返回:
Expand Down
5 changes: 2 additions & 3 deletions docs/api/paddle/broadcast_tensors_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@ broadcast_tensors
输入应符合Broadcast规范

.. note::
如您想了解更多Broadcasting内容,请参见 :ref:`cn_user_guide_broadcasting` 。
如想了解更多Broadcasting内容,请参见 :ref:`cn_user_guide_broadcasting` 。

参数
:::::::::
- inputs (list(Tensor)|tuple(Tensor)) - 一组输入Tensor,数据类型为:bool、float32、float64、int32或int64。
- 所有的输入Tensor均需要满足rank <= 5
- inputs (list(Tensor)|tuple(Tensor)) - 一组输入Tensor,数据类型为:bool、float32、float64、int32或int64。所有的输入Tensor均需要满足rank <= 5。
- name (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name` 。

返回
Expand Down
44 changes: 44 additions & 0 deletions docs/api/paddle/deg2rad_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
.. _cn_api_paddle_tensor_deg2rad:

deg2rad
-------------------------------

.. py:function:: paddle.deg2rad(x, name=None)

将元素从弧度的角度转换为度

.. math::

deg2rad(x)=\pi * x / 180

参数
:::::::::

- **x** (Tensor) - 输入的Tensor,数据类型为:int32、int64、float32、float64。
- **name** (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name`。

返回
:::::::::

输出Tensor,与 ``x`` 维度相同、数据类型相同(输入为int时,输出数据类型为float32)。

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

.. code-block:: python

import paddle
import numpy as np

x1 = paddle.to_tensor([180.0, -180.0, 360.0, -360.0, 90.0, -90.0])
result1 = paddle.deg2rad(x1)
print(result1)
# Tensor(shape=[6], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
# [3.14159274, -3.14159274, 6.28318548, -6.28318548, 1.57079637,
# -1.57079637])

x2 = paddle.to_tensor(180)
result2 = paddle.deg2rad(x2)
print(result2)
# Tensor(shape=[1], dtype=float32, place=CUDAPlace(0), stop_gradient=True,
# [3.14159274])
Loading