Skip to content

Commit 74cf2cc

Browse files
authored
[ API Compatibility No.246, 247 ] Support paddle.Tensor.retain_grad And paddle.Tensor.sparse_mask with docs -part (#7847)
Co-authored-by: AuraWu <143194075+BayesianAura@users.noreply.github.com>
1 parent 6af15cc commit 74cf2cc

2 files changed

Lines changed: 32 additions & 0 deletions

File tree

docs/api/paddle/Tensor/Overview_en.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,7 @@ Methods
238238
reshape
239239
reshape_
240240
resize_
241+
retain_grad
241242
reverse
242243
roll
243244
round
@@ -264,6 +265,7 @@ Methods
264265
sort
265266
sparse_dim
266267
split
268+
sparse_mask
267269
sqrt
268270
sqrt_
269271
square

docs/api/paddle/Tensor__upper_cn.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3927,3 +3927,33 @@ new_empty(size, \*, dtype=None, device=None, requires_grad=False, pin_memory=Fal
39273927
**代码示例**
39283928

39293929
COPY-FROM: paddle.Tensor.new_empty
3930+
3931+
retain_grad
3932+
:::::::::
3933+
3934+
启用此 Tensor 在反向传播过程中计算梯度。对于叶子张量(leaf tensor)该方法是无操作(no-op),因为叶子张量默认会保留梯度。
3935+
3936+
返回:
3937+
- **None**
3938+
3939+
**代码示例**
3940+
3941+
COPY-FROM: paddle.Tensor.retain_grad
3942+
3943+
sparse_mask
3944+
:::::::::
3945+
3946+
将当前稠密 Tensor 通过稀疏掩码(sparse mask)进行掩码操作,生成新的稀疏 Tensor。输出稀疏 Tensor 的索引与 ``mask`` 一致,值从当前 Tensor 对应位置提取。
3947+
3948+
参数:
3949+
- **mask** (Tensor) - 用于掩码的稀疏 Tensor(``SparseCooTensor`` 或 ``SparseCsrTensor``)。
3950+
3951+
关键字参数:
3952+
- **name** (str,可选) - 操作名称(在实现中被忽略,不生效)。默认值为 None。
3953+
3954+
返回:
3955+
- **SparseTensor**,新生成的稀疏 Tensor,索引与 ``mask`` 相同,值来自 ``self`` 在掩码位置的元素。
3956+
3957+
**代码示例**
3958+
3959+
COPY-FROM: paddle.Tensor.sparse_mask

0 commit comments

Comments
 (0)