Skip to content

Commit 4e08a60

Browse files
authored
[API Compatibility] add ravel (PaddlePaddle#7378)
* fix some doc * fix typo
1 parent cfd59cf commit 4e08a60

File tree

5 files changed

+71
-4
lines changed

5 files changed

+71
-4
lines changed

docs/api/paddle/Overview_cn.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,7 @@ tensor 元素操作相关(如:转置,reshape 等)
508508
" :ref:`paddle.expand_as <cn_api_paddle_expand_as>` ", "根据 y 的形状扩展 x ,扩展后, x 的形状和 y 的形状相同"
509509
" :ref:`paddle.flatten <cn_api_paddle_flatten>` ", "根据给定的 start_axis 和 stop_axis 将连续的维度展平"
510510
" :ref:`paddle.flip <cn_api_paddle_flip>` ", "沿指定轴反转 n 维 tensor"
511+
" :ref:`paddle.ravel <cn_api_paddle_ravel>` ", "返回一个连续的展平的 tensor"
511512
" :ref:`paddle.rot90 <cn_api_paddle_rot90>` ", "沿 axes 指定的平面将 n 维 tensor 旋转 90 度 k 次"
512513
" :ref:`paddle.gather <cn_api_paddle_gather>` ", "根据索引 index 获取输入 x 的指定 axis 维度的条目,并将它们拼接在一起"
513514
" :ref:`paddle.gather_nd <cn_api_paddle_gather_nd>` ", "paddle.gather 的高维推广"
@@ -562,6 +563,7 @@ tensor 元素操作相关(如:转置,reshape 等)
562563
" :ref:`paddle.hstack <cn_api_paddle_hstack>` ", "沿水平轴堆叠输入 x 中的所有张量。"
563564
" :ref:`paddle.vstack <cn_api_paddle_vstack>` ", "沿垂直轴堆叠输入 x 中的所有张量。"
564565
" :ref:`paddle.dstack <cn_api_paddle_dstack>` ", "沿深度轴堆叠输入 x 中的所有张量。"
566+
" :ref:`paddle.narrow <cn_api_paddle_narrow>` ", "沿指定维度 dim 对输入 x 进行切片。"
565567

566568
.. _tensor_manipulation_inplace:
567569

docs/api/paddle/Tensor_cn.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -822,15 +822,27 @@ half()
822822

823823
返回: 转换后的 Tensor
824824

825+
type_as(other)
826+
:::::::::
827+
828+
将当前 Tensor 的数据类型转换至与目标 Tensor 相同。
829+
830+
参数:
831+
- **other** (Tensor) -用作类型参考的张量,返回的新 Tensor 将与其 dtype 保持一致。
832+
833+
返回:类型转换后的新的 Tensor
834+
825835
返回类型:Tensor
826836

827837
**代码示例**
828838
.. code-block:: python
829839
830840
import paddle
831-
x = paddle.to_tensor(1.0)
841+
x = paddle.to_tensor([1, 2, 3], dtype='int32')
842+
y = paddle.to_tensor([4.0, 5.0, 6.0], dtype='float32')
843+
x_float = x.type_as(y)
832844
print("original tensor's dtype is: {}".format(x.dtype))
833-
print("new tensor's dtype is: {}".format(x.half().dtype))
845+
print("new tensor's dtype is: {}".format(x_float.dtype))
834846
835847
int()
836848
:::::::::

docs/api/paddle/narrow_cn.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _cn_api_paddle_narrow:
2+
3+
narrow
4+
-------------------------------
5+
6+
.. py:function:: paddle.narrow(input, dim, start, length)
7+
8+
返回输入张量 input 在指定维度 dim 上的窄切片。
9+
该操作保留所有维度,仅沿 dim 选取索引区间 [start, start + length) 内的元素,则返回结果与输入共享内存(视图)。
10+
11+
参数
12+
:::::::::
13+
- **input** (Tensor) - 输入张量,支持任意数据类型与形状。
14+
- **dim** (int) - 要窄化的维度,支持负索引。
15+
- **start** (int|Tensor) - 起始索引,可为 Python 整数或 0-D 的 int32/int64 张量,负值表示从维度末尾倒数。
16+
- **length** (int) - 从 start 开始选取的元素个数,必须 ≥ 0。
17+
18+
返回
19+
:::::::::
20+
``Tensor``,与 input 数据类型相同,形状仅在 dim 维变为 length,其余维不变。
21+
22+
代码示例
23+
:::::::::
24+
25+
COPY-FROM: paddle.narrow

docs/api/paddle/nn/Sequential_cn.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,20 @@ Sequential
55

66
.. py:class:: paddle.nn.Sequential(*layers)
77
8+
顺序容器。子 Layer 将按构造函数参数的顺序依次添加到此容器中。
9+
参数支持以下三种形式:
810

11+
1. 逐个 Layer 实例:Sequential(layer1, layer2, ...)
12+
2. 带名字的 (name, layer) 对:Sequential(('l1', layer1), ('l2', layer2))
13+
3. OrderedDict:Sequential(OrderedDict([('l1', layer1), ('l2', layer2)]))
914

15+
可通过 整数下标 或 字符串名字 访问、修改、新增子层;支持 append、insert、extend 等列表式操作。
1016

11-
顺序容器。子 Layer 将按构造函数参数的顺序添加到此容器中。传递给构造函数的参数可以是 Layers 或可迭代的 name Layer 元组。
1217

1318
参数
1419
::::::::::::
1520

16-
- **layers** (tuple) - Layers 或可迭代的 name Layer 对
21+
- **layers** (Layer|tuple(str, Layer)|list|OrderedDict) - 任意数量的 Layer 对象,或 (name, layer) 可迭代结构,或一个 OrderedDict
1722

1823
返回
1924
::::::::::::

docs/api/paddle/ravel_cn.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _cn_api_paddle_ravel:
2+
3+
ravel
4+
-------------------------------
5+
6+
.. py:function:: paddle.ravel(input)
7+
返回输入张量 input 的一个展平(一维)视图。
8+
9+
该函数会将输入 Tensor 按行优先(C-style)顺序展平成一个 1 维张量。如果输入 Tensor 已经是连续内存,则返回的结果与原 Tensor 共享数据(即为视图);如果不连续,则会返回一份连续的拷贝。
10+
在 动态图 模式下,返回的 Tensor 默认与输入 Tensor 共享数据。如果需要得到一份新的数据拷贝,可以使用 Tensor.clone 方法,例如:ravel_clone_x = x.ravel().clone()。
11+
12+
参数
13+
:::::::::
14+
- **input** (Tensor) - 输入的张量,数据类型为 float16、float32、float64、int8、int32、int64、uint8 等,维度任意。
15+
16+
返回
17+
:::::::::
18+
输出 一维 Tensor,包含输入张量的所有元素,数据类型与输入相同。
19+
20+
代码示例
21+
:::::::::
22+
23+
COPY-FROM: paddle.ravel

0 commit comments

Comments
 (0)