Skip to content

fix bracket and wrong english #5972

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
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 docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ tensor 创建相关
" :ref:`paddle.complex <cn_api_paddle_complex>` ", "给定实部和虚部,返回一个复数 Tensor"
" :ref:`paddle.create_parameter <cn_api_fluid_layers_create_parameter>` ", "创建一个参数,该参数是一个可学习的变量, 拥有梯度并且可优化"
" :ref:`paddle.clone <cn_api_tensor_clone>` ", "对输入 Tensor ``x`` 进行拷贝,并返回一个新的 Tensor,并且该操作提供梯度回传"
" :ref:`paddle.batch <cn_api_paddle_batch>` ", "一个 reader 的装饰器。返回的 reader 将输入 reader 的数据打包成指定的 batch_size 大小的批处理数据(不推荐使用)"
" :ref:`paddle.batch <cn_api_paddle_batch>` ", "一个 reader 的装饰器。返回的 reader 将输入 reader 的数据打包成指定的 batch_size 大小的批处理数据不推荐使用"
" :ref:`paddle.polar <cn_api_paddle_polar>`", "对于给定的模 ``abs`` 和相位角 ``angle``,返回一个对应复平面上的坐标复数 Tensor"
" :ref:`paddle.vander <cn_api_paddle_vander>` ", "生成范德蒙德矩阵。"

Expand Down
24 changes: 12 additions & 12 deletions docs/api/paddle/Tensor_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -370,9 +370,9 @@ backward(grad_tensor=None, retain_graph=False)
从当前 Tensor 开始计算反向的神经网络,传导并计算计算图中 Tensor 的梯度。

参数:
- **grad_tensor** (Tensor, optional) - 当前 Tensor 的初始梯度值。如果 ``grad_tensor`` 是 None,当前 Tensor 的初始梯度值将会是值全为 1.0 的 Tensor;如果 ``grad_tensor`` 不是 None,必须和当前 Tensor 有相同的长度。默认值:None。
- **grad_tensor** (Tensor, 可选) - 当前 Tensor 的初始梯度值。如果 ``grad_tensor`` 是 None,当前 Tensor 的初始梯度值将会是值全为 1.0 的 Tensor;如果 ``grad_tensor`` 不是 None,必须和当前 Tensor 有相同的长度。默认值:None。

- **retain_graph** (bool, optional) - 如果为 False,反向计算图将被释放。如果在 backward()之后继续添加 OP,
- **retain_graph** (bool, 可选) - 如果为 False,反向计算图将被释放。如果在 backward()之后继续添加 OP,
需要设置为 True,此时之前的反向计算图会保留。将其设置为 False 会更加节省内存。默认值:False。

返回:无
Expand Down Expand Up @@ -682,8 +682,8 @@ cuda(device_id=None, blocking=False)
如果当前 Tensor 已经在 GPU 上,且 device_id 为 None,则不会发生任何拷贝。

参数:
- **device_id** (int, optional) - 目标 GPU 的设备 Id,默认为 None,此时为当前 Tensor 的设备 Id,如果当前 Tensor 不在 GPU 上,则为 0。
- **blocking** (bool, optional) - 如果为 False 并且当前 Tensor 处于固定内存上,将会发生主机到设备端的异步拷贝。否则,会发生同步拷贝。默认为 False。
- **device_id** (int, 可选) - 目标 GPU 的设备 Id,默认为 None,此时为当前 Tensor 的设备 Id,如果当前 Tensor 不在 GPU 上,则为 0。
- **blocking** (bool, 可选) - 如果为 False 并且当前 Tensor 处于固定内存上,将会发生主机到设备端的异步拷贝。否则,会发生同步拷贝。默认为 False。

返回:拷贝到 GPU 上的 Tensor

Expand Down Expand Up @@ -981,8 +981,8 @@ fill_diagonal_(x, value, offset=0, wrap=False, name=None)
参数:
- **x** (Tensor) - 需要修改对角线元素值的原始 Tensor。
- **value** (float) - 以输入 value 值修改原始 Tensor 对角线元素。
- **offset** (int, optional) - 所选取对角线相对原始主对角线位置的偏移量,正向右上方偏移,负向左下方偏移,默认为 0。
- **wrap** (bool, optional) - 对于 2 维 Tensor,height>width 时是否循环填充,默认为 False。
- **offset** (int,可选) - 所选取对角线相对原始主对角线位置的偏移量,正向右上方偏移,负向左下方偏移,默认为 0。
- **wrap** (bool,可选) - 对于 2 维 Tensor,height>width 时是否循环填充,默认为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回:修改原始 Tensor x 的对角线元素为 value 以后的新的 Tensor。
Expand All @@ -1008,9 +1008,9 @@ fill_diagonal_tensor(x, y, offset=0, dim1=0, dim2=1, name=None)
参数:
- **x** (Tensor) - 需要填充局部对角线区域的原始 Tensor。
- **y** (Tensor) - 需要被填充到原始 Tensor x 对角线区域的输入 Tensor。
- **offset** (int, optional) - 选取局部区域对角线位置相对原始主对角线位置的偏移量,正向右上方偏移,负向左下方偏移,默认为 0。
- **dim1** (int, optional) - 指定对角线所参考第一个维度,默认为 0。
- **dim2** (int, optional) - 指定对角线所参考第二个维度,默认为 1。
- **offset** (int,可选) - 选取局部区域对角线位置相对原始主对角线位置的偏移量,正向右上方偏移,负向左下方偏移,默认为 0。
- **dim1** (int,可选) - 指定对角线所参考第一个维度,默认为 0。
- **dim2** (int,可选) - 指定对角线所参考第二个维度,默认为 1。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回:将 y 的值填充到输入 Tensor x 对角线区域以后所组合成的新 Tensor。
Expand Down Expand Up @@ -2304,9 +2304,9 @@ Inplace 版本的 :ref:`cn_api_tensor_uniform`,返回一个从均匀分布采

参数:
- **x** (Tensor) - 待被随机数填充的输入 Tensor。
- **min** (float|int, optional) - 生成随机数的下界,min 包含在该范围内。默认为-1.0。
- **max** (float|int, optional) - 生成随机数的上界,max 不包含在该范围内。默认为 1.0。
- **seed** (int, optional) - 用于生成随机数的随机种子。如果 seed 为 0,将使用全局默认生成器的种子(可通过 paddle.seed 设置)。
- **min** (float|int,可选) - 生成随机数的下界,min 包含在该范围内。默认为-1.0。
- **max** (float|int,可选) - 生成随机数的上界,max 不包含在该范围内。默认为 1.0。
- **seed** (int,可选) - 用于生成随机数的随机种子。如果 seed 为 0,将使用全局默认生成器的种子(可通过 paddle.seed 设置)。
注意如果 seed 不为 0,该操作每次将生成同一个随机值。默认为 0。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

Expand Down
6 changes: 3 additions & 3 deletions docs/api/paddle/amp/debugging/check_numerics_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ check_numerics
参数
:::::::::

- **tensor** Tensor– 需要检查的目标 Tensor 。
- **op_type** str– 产生目标 Tensor 的 OP 或 API 。
- **tensor** (Tensor) – 需要检查的目标 Tensor 。
- **op_type** (str) – 产生目标 Tensor 的 OP 或 API 。
- **var_name** (str) – 目标 Tensor 的名字。
- **debug_mode** (paddle.amp.debugging.DebugMode, 可选) : 要使用的调试类型。默认值为 ``paddle.amp.debugging.DebugMode.CHECK_NAN_INF_AND_ABORT``。
- **debug_mode** (paddle.amp.debugging.DebugMode, 可选) - 要使用的调试类型。默认值为 ``paddle.amp.debugging.DebugMode.CHECK_NAN_INF_AND_ABORT``。

返回
:::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/amp/is_bfloat16_supported_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ is_bfloat16_supported
参数
::::::::::::

- **device** (str|None, optional) - 指定要查询的设备,它可以是 cpu、 gpu、 xpu、gpu:x、xpu:x。其中,x 是 GPU、 XPU 的编号。如果 ``device`` 为 None, 则查询当前设备(与飞桨安装版本保持一致),默认为 None。
- **device** (str|None,可选) - 指定要查询的设备,它可以是 cpu、 gpu、 xpu、gpu:x、xpu:x。其中,x 是 GPU、 XPU 的编号。如果 ``device`` 为 None, 则查询当前设备(与飞桨安装版本保持一致),默认为 None。


代码示例
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/amp/is_float16_supported_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ is_float16_supported
参数
::::::::::::

- **device** (str|None, optional) - 指定要查询的设备,它可以是 cpu、 gpu、 xpu、gpu:x、xpu:x。其中,x 是 GPU、 XPU 的编号。如果 ``device`` 为 None, 则查询当前设备(与飞桨安装版本保持一致), 默认为 None。
- **device** (str|None,可选) - 指定要查询的设备,它可以是 cpu、 gpu、 xpu、gpu:x、xpu:x。其中,x 是 GPU、 XPU 的编号。如果 ``device`` 为 None, 则查询当前设备(与飞桨安装版本保持一致), 默认为 None。


代码示例
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/argmax_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ argmax
::::::::
- **x** (Tensor) - 输入的多维 ``Tensor``,支持的数据类型:float16、float32、float64、int16、int32、int64、uint8。
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴,``axis`` 的有效范围是[-R, R),R 是输入 ``x`` 的维度个数,``axis`` 为负数时,进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为 None,将会对输入的 `x` 进行平铺展开,返回最大值的索引。
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 keepdim 为 True,则输出 Tensor 和 x 具有相同的维度(减少的维度除外,减少的维度的大小为 1),默认值为 False。
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 keepdim 为 True,则输出 Tensor 和 x 具有相同的维度减少的维度除外,减少的维度的大小为 1,默认值为 False。
- **dtype** (np.dtype|str,可选) - 输出 Tensor 的数据类型,可选值为 int32,int64,默认值为 int64,将返回 int64 类型的结果。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/atan2_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ atan2

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

返回
:::::::::
Expand Down
14 changes: 7 additions & 7 deletions docs/api/paddle/audio/features/LogMelSpectrogram_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ LogMelSpectrogram
- **n_fft** (int,可选) - 离散傅里叶变换中频率窗大小,默认 512。
- **hop_length** (int,可选) - 帧移,默认 512。
- **win_length** (int,可选) - 短时 FFT 的窗长,默认为 None。
- **window** (str,可选) - 窗函数名,默认'hann'
- **power** (float,可选) - 幅度谱的指数,默认是2.0。
- **window** (str,可选) - 窗函数名,默认``hann``
- **power** (float,可选) - 幅度谱的指数,默认是 2.0。
- **center** (bool,可选) - 对输入信号填充,如果 True,那么 t 以 t*hop_length 为中心,如果为 False,则 t 以 t*hop_length 开始,默认是 True。
- **pad_mode** (str,可选) - 如果 center 是 True,选择填充的方式,默认值是'reflect'。
- **n_mels** (int,可选) - mel bins 的数目,默认是64
- **n_mels** (int,可选) - mel bins 的数目,默认是 64
- **f_min** (float,可选) - 最小频率(hz),默认 50.0。
- **f_max** (float,可选) - 最大频率(hz),默认为 None。
- **htk** (bool,可选) - 在计算 fbank 矩阵时是否用在 HTK 公式缩放,默认是 False。
- **norm** (Union[str,float],可选) - 计算 fbank 矩阵时正则化的种类,默认是'slaney',你也可以 norm=0.5,使用 p-norm 正则化。
- **norm** (Union[str,float],可选) - 计算 fbank 矩阵时正则化的种类,默认是``slaney``,你也可以 norm=0.5,使用 p-norm 正则化。
- **ref_value** (float,可选) - 参照值,如果小于 1.0,信号的 db 会被提升,相反 db 会下降,默认值为 1.0。
- **amin** (float,可选) - 输入的幅值的最小值,默认是1e-10。
- **top_db** (float,可选) - log-mel 谱的最大值(db),默认是None
- **dtype** (str,可选) - 输入和窗的数据类型,默认是'float32'
- **amin** (float,可选) - 输入的幅值的最小值,默认是 1e-10。
- **top_db** (float,可选) - log-mel 谱的最大值(db),默认是 None
- **dtype** (str,可选) - 输入和窗的数据类型,默认是``float32``


返回
Expand Down
10 changes: 5 additions & 5 deletions docs/api/paddle/audio/functional/compute_fbank_matrix_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ compute_fbank_matrix

- **sr** (int) - 采样率。
- **n_fft** (int) - fft bins 的数目。
- **n_mels** (float,可选) - mels bins 的数目,默认是64
- **f_min** (float,可选) - 最小频率(hz),默认是0.0。
- **n_mels** (float,可选) - mels bins 的数目,默认是 64
- **f_min** (float,可选) - 最小频率(hz),默认是 0.0。
- **f_max** (Optional[float],可选) - 最大频率(hz),默认是 None。
- **htk** (bool,可选) - 是否使用 htk 缩放,默认是 False。
- **norm** (Union[str, float],可选) - norm 的类型,默认是'slaney'
- **dtype** (str,可选) - 返回矩阵的数据类型,默认'float32'
- **norm** (Union[str, float],可选) - norm 的类型,默认是``slaney``
- **dtype** (str,可选) - 返回矩阵的数据类型,默认``float32``

返回
:::::::::

``paddle.Tensor``,Tensor shape (n_mels n_fft//2 + 1)。
``paddle.Tensor``,Tensor shape (n_mels, n_fft//2 + 1)。

代码示例
:::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/autograd/hessian_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ hessian

- **ys** (Tensor) - 因变量 ``ys`` ,数据类型为单个 Tensor。
- **xs** (Tensor|Tuple[Tensor, ...]) - 自变量 ``xs`` ,数据类型为 Tensor 或 Tensor 元组。
- **batch_axis** (int, optional) - ``0`` 表示参数包含 batch 维度,且第 0 维为 batch 维,
- **batch_axis** (int,可选) - ``0`` 表示参数包含 batch 维度,且第 0 维为 batch 维,
``None`` 表示参数不包含 batch。默认值为 ``None`` 。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/autograd/jacobian_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jacobian

- **ys** (Tensor|Tuple[Tensor, ...]) - 因变量 ``ys`` ,数据类型为 Tensor 或 Tensor 元组。
- **xs** (Tensor|Tuple[Tensor, ...]) - 自变量 ``xs`` ,数据类型为 Tensor 或 Tensor 元组。
- **batch_axis** (int, optional) - ``0`` 表示参数包含 batch 维度,且第 0 维为 batch 维,
- **batch_axis** (int,可选) - ``0`` 表示参数包含 batch 维度,且第 0 维为 batch 维,
``None`` 表示参数不包含 batch。默认值为 ``None`` 。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/deg2rad_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ deg2rad
:::::::::

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

返回
:::::::::
Expand Down
Loading