Skip to content

Commit b16094e

Browse files
committed
Uniformly linking Outplace documents with Inplace documents
1 parent c188b1d commit b16094e

File tree

1 file changed

+31
-30
lines changed

1 file changed

+31
-30
lines changed

python/paddle/tensor/manipulation.py

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6745,20 +6745,8 @@ def index_put_(
67456745
name: str | None = None,
67466746
) -> Tensor:
67476747
"""
6748-
Puts values from the tensor values into the tensor x using the indices specified in indices (which is a tuple of Tensors).
6749-
The expression paddle.index_put_(x, indices, values) is equivalent to tensor[indices] = values. Returns x.
6750-
If accumulate is True, the elements in values are added to x. If accumulate is False, the behavior is undefined if indices contain duplicate elements.
6751-
6752-
Args:
6753-
x (Tensor) : The Source Tensor. Supported data types are int32, int64, float16, float32, float64, bool.
6754-
indices (list[Tensor]|tuple[Tensor]): The tuple of Tensor containing the indices to index.
6755-
The data type of ``tensor in indices`` must be int32, int64 or bool.
6756-
value (Tensor): The tensor used to be assigned to x.
6757-
accumulate (bool, optional): Whether the elements in values are added to x. Default: False.
6758-
name(str|None, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
6759-
6760-
Returns:
6761-
Tensor, same dimension and dtype with x.
6748+
Inplace version of ``index_put_`` API, the output Tensor will be inplaced with input ``x``.
6749+
Please refer to :ref:`api_paddle_index_put`.
67626750
67636751
Examples:
67646752
.. code-block:: python
@@ -6794,8 +6782,20 @@ def index_put(
67946782
name: str | None = None,
67956783
) -> Tensor:
67966784
"""
6797-
Outplace version of ``index_put_`` API, the output Tensor will be inplaced with input ``x``.
6798-
Please refer to :ref:`api_paddle_index_put`.
6785+
Puts values from the tensor values into the tensor x using the indices specified in indices (which is a tuple of Tensors).
6786+
The expression paddle.index_put_(x, indices, values) is equivalent to tensor[indices] = values. Returns x.
6787+
If accumulate is True, the elements in values are added to x. If accumulate is False, the behavior is undefined if indices contain duplicate elements.
6788+
6789+
Args:
6790+
x (Tensor) : The Source Tensor. Supported data types are int32, int64, float16, float32, float64, bool.
6791+
indices (list[Tensor]|tuple[Tensor]): The tuple of Tensor containing the indices to index.
6792+
The data type of ``tensor in indices`` must be int32, int64 or bool.
6793+
value (Tensor): The tensor used to be assigned to x.
6794+
accumulate (bool, optional): Whether the elements in values are added to x. Default: False.
6795+
name(str|None, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
6796+
6797+
Returns:
6798+
Tensor, same dimension and dtype with x.
67996799
68006800
Examples:
68016801
.. code-block:: python
@@ -7162,8 +7162,19 @@ def index_fill(
71627162
x: Tensor, index: Tensor, axis: int, value: float, name: str | None = None
71637163
):
71647164
"""
7165-
Outplace version of ``index_fill_`` API, the output Tensor will be inplaced with input ``x``.
7166-
Please refer to :ref:`api_paddle_index_fill_`.
7165+
Fill the elements of the input tensor with value by the specific axis and index.
7166+
7167+
Args:
7168+
x (Tensor) : The Destination Tensor. Supported data types are int32, int64, float16, float32, float64.
7169+
index (Tensor): The 1-D Tensor containing the indices to index.
7170+
The data type of ``index`` must be int32 or int64.
7171+
axis (int): The dimension along which to index.
7172+
value (int|float): The tensor used to fill with.
7173+
name(str|None, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
7174+
7175+
Returns:
7176+
Tensor, same dimension and dtype with x.
7177+
71677178
71687179
Examples:
71697180
.. code-block:: python
@@ -7193,18 +7204,8 @@ def index_fill_(
71937204
x: Tensor, index: Tensor, axis: int, value: float, name: str | None = None
71947205
):
71957206
"""
7196-
Fill the elements of the input tensor with value by the specific axis and index.
7197-
7198-
Args:
7199-
x (Tensor) : The Destination Tensor. Supported data types are int32, int64, float16, float32, float64.
7200-
index (Tensor): The 1-D Tensor containing the indices to index.
7201-
The data type of ``index`` must be int32 or int64.
7202-
axis (int): The dimension along which to index.
7203-
value (int|float): The tensor used to fill with.
7204-
name(str|None, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
7205-
7206-
Returns:
7207-
Tensor, same dimension and dtype with x.
7207+
Inplace version of ``index_fill_`` API, the output Tensor will be inplaced with input ``x``.
7208+
Please refer to :ref:`api_paddle_index_fill_`.
72087209
72097210
Examples:
72107211
.. code-block:: python

0 commit comments

Comments
 (0)