Skip to content

Commit

Permalink
update linalg docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ligoml committed Mar 31, 2022
1 parent 62743c3 commit da15f1f
Show file tree
Hide file tree
Showing 13 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/cholesky_solve_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ cholesky_solve
::::::::::::
Tensor,线性方程的解X。

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

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/cond_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ cond
::::::::::::
Tensor, 条件数的计算结果, 数据类型和输入 ``x`` 的一致。

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

COPY-FROM: paddle.linalg.cond
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/det_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ det

Tensor, 输出矩阵的行列式值 Shape为 ``[*]`` 。

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

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/eigvalsh_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ eigvalsh

Tensor,输出矩阵的特征值,输出顺序按照从小到大进行排序。Shape为 ``[*, M]`` 。

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

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/lstsq_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ lstsq
- ``rank`` 指 ``x`` 中矩阵的秩,形状为 ``(*)`` 的 Tensor;当 ``driver`` 为 'gelsy', 'gelsd', 'gelss' 时,该值会被计算,否则返回空 Tensor。
- ``singular_values`` 指 ``x`` 中矩阵的奇异值,形状为 ``(*, min(M, N))`` 的 Tensor;当 ``driver`` 为 'gelsd', 'gelss' 时,该值会被计算,否则返回空 Tensor。

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

COPY-FROM: paddle.linalg.lstsq
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/lu_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ LU和pivot可以通过调用paddle.linalg.lu_unpack展开获得L、U、P矩阵
- Tensor(dtype=int) Pivots,旋转矩阵对应的旋转序列,详情见说明部分pivot部分,对于输入[*,m,n]的x,Pivots shape为[*, m]。
- Tensor(dtype=int) Infos,矩阵分解状态信息矩阵,对于输入[*,m,n],Infos shape为[*]。每个元素表示每组矩阵的LU分解是否成功,0表示分解成功。

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

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/lu_unpack_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ lu_unpack
- Tensor U,由LU展开得到的U矩阵,若unpack_ludata为False,则为None。
- Tensor P,由序列pivots展开得到的旋转矩阵P,若unpack_pivots为False,则为None。

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

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/qr_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ qr
- Tensor Q, 正交三角分解的Q正交矩阵,需注意如果 ``mode = "reduced"`` ,则不返回Q矩阵,只返回R矩阵。
- Tensor R, 正交三角分解的R上三角矩阵。

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

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/slogdet_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ slogdet

Tensor ,输出矩阵的行列式值 Shape为 ``[2, *]``。

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

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/svd_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ svd
- Tensor S,奇异值向量,Shape为 ``[*, K]`` 。
- Tensor VH,奇异值分解的VH矩阵。如果full_matrics设置为False,则Shape为 ``[*, K, N]`` ,如果full_metrics设置为True,那么Shape为 ``[*, N, N]`` 。其中K为M和N的最小值。

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

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/static/nn/sequence_reshape_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sequence_reshape
.. note::
该OP的输入只能是LoDTensor,如果您需要处理的输入是Tensor类型,请使用 :ref:`paddle.reshape <cn_api_fluid_layers_reshape>` 。
该API的输入只能是LoDTensor,如果您需要处理的输入是Tensor类型,请使用 :ref:`paddle.reshape <cn_api_fluid_layers_reshape>` 。

在指定 ``new_dim`` 参数下,通过序列原始长度、和原始shape计算出新的shape,以输出包含新维度(new_dim)下的LoDTensor。目前仅支持1-level LoDTensor,请确保(原长度*原维数)可以除以新的维数,且每个序列没有余数。

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/text/WMT14_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ http://paddlemodels.bj.bcebos.com/wmt/wmt14.tgz

参数
:::::::::
- **data_file**(str)- 保存数据集压缩文件的路径, 如果参数:attr: `download` 设置为True,可设置为None。默认为None。
- **data_file**(str)- 保存数据集压缩文件的路径,如果参数:attr: `download` 设置为True,可设置为None。默认为None。
- **mode**(str)- 'train','test' 或'gen'。默认为'train'。
Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/utils/cpp_extension/CppExtension_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ CppExtension
参数
::::::::::::

- **sources** (list[str]): 用于指定自定义 OP 对应的源码文件。cpp 源文件支持 .cc、.cpp等后缀
- **\*args, \*\*kwargs** (可选): 用于指定 Extension 的其他参数,支持的参数与 ``setuptools.Extension`` 一致。
- **sources** (list[str]) - 用于指定自定义 OP 对应的源码文件。cpp 源文件支持 .cc、.cpp等后缀
- **\*args, \*\*kwargs** (可选) - 用于指定 Extension 的其他参数,支持的参数与 ``setuptools.Extension`` 一致。

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

0 comments on commit da15f1f

Please sign in to comment.