Files
paddlepaddle--paddle/python/paddle/incubate/tensor/math.py
T
2026-07-13 12:40:42 +08:00

310 lines
10 KiB
Python

# Copyright (c) 2021 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
from typing import TYPE_CHECKING
from paddle import _C_ops
from paddle.base.data_feeder import check_variable_and_dtype
from paddle.base.layer_helper import LayerHelper
from paddle.framework import in_dynamic_or_pir_mode
from paddle.utils import deprecated
if TYPE_CHECKING:
from paddle import Tensor
__all__ = []
@deprecated(
since="2.4.0",
update_to="paddle.geometric.segment_sum",
level=1,
reason="paddle.incubate.segment_sum will be removed in future",
)
def segment_sum(
data: Tensor, segment_ids: Tensor, name: str | None = None
) -> Tensor:
r"""
Segment Sum Operator.
Sum the elements of input `data` which with
the same index in `segment_ids`.
It computes a tensor such that
.. math::
out_i = \sum_{j \in \{segment\_ids_j == i \} } data_{j}
where sum is over j such that `segment_ids[j] == i`.
Args:
data (Tensor): A tensor, available data type float32, float64, int32, int64.
segment_ids (Tensor): A 1-D tensor, which have the same size
with the first dimension of input data.
Available data type is int32, int64.
name (str, optional): Name for the operation (optional, default is None).
For more information, please refer to :ref:`api_guide_Name`.
Returns:
Tensor, the Segment Sum result.
Examples:
.. code-block:: pycon
>>> import paddle
>>> data = paddle.to_tensor([[1, 2, 3], [3, 2, 1], [4, 5, 6]], dtype='float32')
>>> segment_ids = paddle.to_tensor([0, 0, 1], dtype='int32')
>>> out = paddle.incubate.segment_sum(data, segment_ids)
>>> print(out)
Tensor(shape=[2, 3], dtype=float32, place=Place(cpu), stop_gradient=True,
[[4., 4., 4.],
[4., 5., 6.]])
"""
if in_dynamic_or_pir_mode():
return _C_ops.segment_pool(data, segment_ids, "SUM")
else:
check_variable_and_dtype(
data, "X", ("float32", "float64", "int32", "int64"), "segment_pool"
)
check_variable_and_dtype(
segment_ids, "SegmentIds", ("int32", "int64"), "segment_pool"
)
helper = LayerHelper("segment_sum", **locals())
out = helper.create_variable_for_type_inference(dtype=data.dtype)
summed_ids = helper.create_variable_for_type_inference(dtype=data.dtype)
helper.append_op(
type="segment_pool",
inputs={"X": data, "SegmentIds": segment_ids},
outputs={"Out": out, "SummedIds": summed_ids},
attrs={"pooltype": "SUM"},
)
return out
@deprecated(
since="2.4.0",
update_to="paddle.geometric.segment_mean",
level=1,
reason="paddle.incubate.segment_mean will be removed in future",
)
def segment_mean(
data: Tensor, segment_ids: Tensor, name: str | None = None
) -> Tensor:
r"""
Segment Mean Operator.
Ihis operator calculate the mean value of input `data` which
with the same index in `segment_ids`.
It computes a tensor such that
.. math::
out_i = \mathop{mean}_{j \in \{segment\_ids_j == i \} } data_{j}
where sum is over j such that 'segment_ids[j] == i' and $n_i$ is the number
of all index 'segment_ids[j] == i'.
Args:
data (tensor): a tensor, available data type float32, float64, int32, int64.
segment_ids (tensor): a 1-d tensor, which have the same size
with the first dimension of input data.
available data type is int32, int64.
name (str, optional): Name for the operation (optional, default is None).
For more information, please refer to :ref:`api_guide_Name`.
Returns:
Tensor, the Segment Mean result.
Examples:
.. code-block:: pycon
>>> import paddle
>>> data = paddle.to_tensor([[1, 2, 3], [3, 2, 1], [4, 5, 6]], dtype='float32')
>>> segment_ids = paddle.to_tensor([0, 0, 1], dtype='int32')
>>> out = paddle.incubate.segment_mean(data, segment_ids)
>>> print(out)
Tensor(shape=[2, 3], dtype=float32, place=Place(cpu), stop_gradient=True,
[[2., 2., 2.],
[4., 5., 6.]])
"""
if in_dynamic_or_pir_mode():
return _C_ops.segment_pool(data, segment_ids, "MEAN")
check_variable_and_dtype(
data, "X", ("float32", "float64", "int32", "int64"), "segment_pool"
)
check_variable_and_dtype(
segment_ids, "SegmentIds", ("int32", "int64"), "segment_pool"
)
helper = LayerHelper("segment_mean", **locals())
out = helper.create_variable_for_type_inference(dtype=data.dtype)
summed_ids = helper.create_variable_for_type_inference(dtype=data.dtype)
helper.append_op(
type="segment_pool",
inputs={"X": data, "SegmentIds": segment_ids},
outputs={"Out": out, "SummedIds": summed_ids},
attrs={"pooltype": "MEAN"},
)
return out
@deprecated(
since="2.4.0",
update_to="paddle.geometric.segment_min",
level=1,
reason="paddle.incubate.segment_min will be removed in future",
)
def segment_min(
data: Tensor, segment_ids: Tensor, name: str | None = None
) -> Tensor:
r"""
Segment min operator.
Calculate the minimum elements of input `data` which with
the same index in `segment_ids`.
It computes a tensor such that
.. math::
out_i = \min_{j \in \{segment\_ids_j == i \} } data_{j}
where min is over j such that `segment_ids[j] == i`.
Args:
data (tensor): a tensor, available data type float32, float64, int32, int64.
segment_ids (tensor): a 1-d tensor, which have the same size
with the first dimension of input data.
available data type is int32, int64.
name (str, optional): Name for the operation (optional, default is None).
For more information, please refer to :ref:`api_guide_Name`.
Returns:
Tensor, the minimum result.
Examples:
.. code-block:: pycon
>>> import paddle
>>> data = paddle.to_tensor([[1, 2, 3], [3, 2, 1], [4, 5, 6]], dtype='float32')
>>> segment_ids = paddle.to_tensor([0, 0, 1], dtype='int32')
>>> out = paddle.incubate.segment_min(data, segment_ids)
>>> print(out)
Tensor(shape=[2, 3], dtype=float32, place=Place(cpu), stop_gradient=True,
[[1., 2., 1.],
[4., 5., 6.]])
"""
if in_dynamic_or_pir_mode():
return _C_ops.segment_pool(data, segment_ids, "MIN")
check_variable_and_dtype(
data, "X", ("float32", "float64", "int32", "int64"), "segment_pool"
)
check_variable_and_dtype(
segment_ids, "SegmentIds", ("int32", "int64"), "segment_pool"
)
helper = LayerHelper("segment_min", **locals())
out = helper.create_variable_for_type_inference(dtype=data.dtype)
summed_ids = helper.create_variable_for_type_inference(dtype=data.dtype)
helper.append_op(
type="segment_pool",
inputs={"X": data, "SegmentIds": segment_ids},
outputs={"Out": out, "SummedIds": summed_ids},
attrs={"pooltype": "MIN"},
)
return out
@deprecated(
since="2.4.0",
update_to="paddle.geometric.segment_max",
level=1,
reason="paddle.incubate.segment_max will be removed in future",
)
def segment_max(
data: Tensor, segment_ids: Tensor, name: str | None = None
) -> Tensor:
r"""
Segment max operator.
Calculate the maximum elements of input `data` which with
the same index in `segment_ids`.
It computes a tensor such that
.. math::
out_i = \max_{j \in \{segment\_ids_j == i \} } data_{j}
where max is over j such that `segment_ids[j] == i`.
Args:
data (tensor): a tensor, available data type float32, float64, int32, int64.
segment_ids (tensor): a 1-d tensor, which have the same size
with the first dimension of input data.
available data type is int32, int64.
name (str, optional): Name for the operation (optional, default is None).
For more information, please refer to :ref:`api_guide_Name`.
Returns:
Tensor, the maximum result.
Examples:
.. code-block:: pycon
>>> import paddle
>>> data = paddle.to_tensor([[1, 2, 3], [3, 2, 1], [4, 5, 6]], dtype='float32')
>>> segment_ids = paddle.to_tensor([0, 0, 1], dtype='int32')
>>> out = paddle.incubate.segment_max(data, segment_ids)
>>> print(out)
Tensor(shape=[2, 3], dtype=float32, place=Place(cpu), stop_gradient=True,
[[3., 2., 3.],
[4., 5., 6.]])
"""
if in_dynamic_or_pir_mode():
out = _C_ops.segment_pool(data, segment_ids, "MAX")
return out
check_variable_and_dtype(
data, "X", ("float32", "float64", "int32", "int64"), "segment_pool"
)
check_variable_and_dtype(
segment_ids, "SegmentIds", ("int32", "int64"), "segment_pool"
)
helper = LayerHelper("segment_max", **locals())
out = helper.create_variable_for_type_inference(dtype=data.dtype)
summed_ids = helper.create_variable_for_type_inference(dtype=data.dtype)
helper.append_op(
type="segment_pool",
inputs={"X": data, "SegmentIds": segment_ids},
outputs={"Out": out, "SummedIds": summed_ids},
attrs={"pooltype": "MAX"},
)
return out