Skip to content

Commit 1ace0d5

Browse files
authored
add chinese doc for paddle.vecdot (#7354)
* fix randn_like * add vecdot * fix typo * fix * fix * fix * fix ci
1 parent 2535980 commit 1ace0d5

File tree

3 files changed

+44
-27
lines changed

3 files changed

+44
-27
lines changed

docs/api/paddle/linalg/Overview_cn.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ paddle.linalg 目录下包含飞桨框架支持的线性代数相关 API。具
3838

3939
" :ref:`paddle.linalg.multi_dot <cn_api_paddle_linalg_multi_dot>` ", "2 个或更多矩阵的乘法,会自动选择计算量最少的乘法顺序"
4040
" :ref:`paddle.linalg.matrix_power <cn_api_paddle_linalg_matrix_power>` ", "计算方阵的 n 次幂"
41+
" :ref:`paddle.linalg.vecdot <cn_api_paddle_linalg_vecdot>` ", "计算矩阵沿指定轴的点积"
4142
" :ref:`paddle.linalg.inv <cn_api_paddle_linalg_inv>` ", "计算方阵的逆矩阵"
4243
" :ref:`paddle.linalg.pinv <cn_api_paddle_linalg_pinv>` ", "计算矩阵的广义逆"
4344
" :ref:`paddle.linalg.cov <cn_api_paddle_linalg_cov>` ", "计算矩阵的协方差矩阵"

docs/api/paddle/linalg/vecdot_cn.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _cn_api_paddle_linalg_vecdot:
2+
3+
vecdot
4+
-------------------------------
5+
6+
.. py:function:: paddle.linalg.vecdot(x, y, axis=-1, name=None)
7+
计算两个张量沿指定轴的点积。
8+
9+
该函数对两个张量进行逐元素相乘,并沿指定轴求和以计算它们的点积。支持任意维度的张量(包括 0 维张量),只要张量`x`和`y`的形状在指定轴上可广播即可。
10+
11+
12+
参数
13+
:::::::::
14+
15+
- **x** (Tensor) - 第一个输入张量。支持 ``float32`` 、 ``float64`` 、 ``int32`` 、 ``int64`` 、 ``complex64`` 和 ``complex128`` 六种数据类型。
16+
- **y** (Tensor) - 第二个输入张量。其形状必须能沿指定 ``axis`` 与 ``x`` 进行广播运算,且必须与 ``x`` 具有相同的数据类型。
17+
- **axis** (int,可选) - 计算点积所沿的轴。默认为-1,表示最后一个轴。
18+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
19+
20+
21+
返回
22+
:::::::::
23+
``Tensor``, 包含沿指定轴计算的 ``x`` 和 ``y`` 点积结果的张量。
24+
25+
26+
代码示例
27+
:::::::::
28+
COPY-FROM: paddle.linalg.vecdot
Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,37 @@
1-
## [ 组合替代实现 ]torch.randn_like
1+
## [ torch 参数更多 ] torch.randn_like
22

33
### [torch.randn_like](https://pytorch.org/docs/stable/generated/torch.randn_like.html#torch.randn_like)
4+
45
```python
56
torch.randn_like(input, *, dtype=None, layout=None, device=None, requires_grad=False, memory_format=torch.preserve_format)
67
```
78

8-
返回与输入相同大小的张量,该张量由区间[0,1)上均匀分布的随机数填充。
9+
### [paddle.randn_like](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/randn_like_cn.html#randn_like)
10+
11+
```python
12+
paddle.randn_like(x, dtype=None, name=None)
13+
```
14+
15+
PyTorch 相比 Paddle 支持更多其他参数,具体如下:
916

10-
### 参数介绍
17+
### 参数映射
1118
| PyTorch | PaddlePaddle | 备注 |
1219
| ------------- | ------------ | ------------------------------------------------------ |
13-
| input | - | 表示输入的 Tensor |
14-
| dtype | - | 表示数据类型。 |
20+
| input | x | 表示输入的 Tensor,仅参数名不一致。 |
21+
| dtype | dtype | 表示数据类型。 |
1522
| layout | - | 表示布局方式,Paddle 无此参数,一般对网络训练结果影响不大,可直接删除。 |
16-
| device | - | 表示 Tensor 存放位置,Paddle 无此参数,需要转写|
17-
| requires_grad | stop_gradient | 表示是否不阻断梯度传导,Paddle 无此参数,需要转写。 |
23+
| device | - | 表示 Tensor 存放位置,Paddle 无此参数,一般对网络训练结果影响不大,可直接删除|
24+
| requires_grad | - | 表示是否不阻断梯度传导,Paddle 无此参数,需要转写。 |
1825
| memory_format | - | 表示内存格式, Paddle 无此参数,一般对网络训练结果影响不大,可直接删除。 |
1926

20-
PaddlePaddle 目前无对应 API,可使用如下代码组合实现该 API。
21-
2227
### 转写示例
23-
#### input:表示输入的 Tensor
24-
```python
25-
# PyTorch 写法
26-
torch.randn_like(x)
27-
28-
# Paddle 写法
29-
paddle.randn(shape=x.shape, dtype=x.dtype)
30-
```
31-
32-
#### dtype:表示数据类型
33-
```python
34-
# PyTorch 写法
35-
torch.randn_like(x,dtype=torch.float64)
36-
37-
# Paddle 写法
38-
paddle.randn(shape=x.shape, dtype=paddle.float64)
39-
```
4028

4129
#### requires_grad:表示是否不阻断梯度传导
4230
```python
4331
# PyTorch 写法
4432
y = torch.randn_like(x,requires_grad=True)
4533

4634
# Paddle 写法
47-
y = paddle.randn(shape=x.shape, dtype=x.dtype)
35+
y = paddle.randn_like(x)
4836
y.stop_gradient = False
4937
```

0 commit comments

Comments
 (0)