Skip to content

Commit 812e273

Browse files
authored
update vector_norm doc (#7447)
1 parent 9de426f commit 812e273

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/api/paddle/linalg/Overview_cn.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ paddle.linalg 目录下包含飞桨框架支持的线性代数相关 API。具
2424
" :ref:`paddle.linalg.slogdet <cn_api_paddle_linalg_slogdet>` ", "计算方阵行列式的符号、绝对值的自然对数"
2525
" :ref:`paddle.linalg.cond <cn_api_paddle_linalg_cond>` ", "根据矩阵的范数,来计算矩阵的条件数"
2626
" :ref:`paddle.linalg.norm <cn_api_paddle_linalg_norm>` ", "计算矩阵范数或向量范数"
27+
" :ref:`paddle.linalg.vector_norm <cn_api_paddle_linalg_vector_norm>` ", "计算向量范数"
2728
" :ref:`paddle.linalg.matrix_rank <cn_api_paddle_linalg_matrix_rank>` ", "计算矩阵的秩"
2829

2930

docs/api/paddle/linalg/vector_norm_cn.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
vector_norm
44
-------------------------------
55

6-
.. py:function:: paddle.linalg.vector_norm(x, p=2.0, axis=None, keepdim=False, name=None)
6+
.. py:function:: paddle.linalg.vector_norm(x, p=2.0, axis=None, keepdim=False, name=None, *, dtype=None, out=None)
77
88
99
@@ -16,9 +16,13 @@ vector_norm
1616

1717
- **x** (Tensor) - 输入 Tensor。维度为多维,数据类型为 float32 或 float64。
1818
- **p** (int|float,可选) - 范数(ord)的种类。目前支持的值为任何实数 p 对应的 p 范数。默认值为 2.0 。
19+
``别名: ord``
1920
- **axis** (int|list|tuple,可选) - 使用范数计算的轴。如果 ``axis`` 为 None,则忽略 input 的维度,将其当做向量来计算。如果 ``axis`` 为 int 或者 list|tuple,计算 Tensor 对应 axis 上的向量范数。默认值为 `None` 。
21+
``别名: dim``
2022
- **keepdim** (bool,可选) - 是否在输出的 Tensor 中保留和输入一样的维度,默认值为 False。当 :attr:`keepdim` 为 False 时,输出的 Tensor 会比输入 :attr:`input` 的维度少一些。
2123
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
24+
- **dtype** (str|paddle.dtype|np.dtype,可选) - 可用于以更精确的数据类型执行计算。它在语义上等同于调用 ``linalg.vector_norm(x.to(dtype))`` 。 默认值为 None。
25+
- **out** (Tensor, 可选) - 输出 Tensor,默认值为 None。
2226

2327
返回
2428
:::::::::

0 commit comments

Comments
 (0)