math.py 79.1 KB
Newer Older
W
WuHaobo 已提交
1
# Copyright (c) 2020 PaddlePaddle Authors. All Rights Reserved.
2 3 4 5 6 7 8 9 10 11 12 13
#
# 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.
14 15 16
"""
math functions
"""
17
from __future__ import print_function
Y
Yang Zhang 已提交
18
import numpy as np
19

20
from paddle.common_ops_import import *
21 22
from paddle.tensor import cast
import paddle
23
from ..fluid import layers
24
from ..fluid.framework import core, _varbase_creator, in_dygraph_mode, Variable, convert_np_dtype_to_dtype_
L
Li Fuchen 已提交
25 26
from ..fluid.layer_helper import LayerHelper
from ..fluid.data_feeder import check_variable_and_dtype, check_type, check_dtype, convert_dtype
27
from ..fluid.layers.layer_function_generator import _generate_doc_string_, generate_activation_fn, generate_layer_fn
28 29 30

# TODO: define math functions
# yapf: disable
31 32 33 34 35
from ..fluid.layers import abs    #DEFINE_ALIAS
from ..fluid.layers import acos    #DEFINE_ALIAS
from ..fluid.layers import asin    #DEFINE_ALIAS
from ..fluid.layers import ceil    #DEFINE_ALIAS
from ..fluid.layers import cos    #DEFINE_ALIAS
36 37
from ..fluid.layers import sinh    #DEFINE_ALIAS
from ..fluid.layers import cosh    #DEFINE_ALIAS
38 39 40 41 42 43 44
# from ..fluid.layers import elementwise_add    #DEFINE_ALIAS
# from ..fluid.layers import elementwise_div    #DEFINE_ALIAS
# from ..fluid.layers import elementwise_floordiv    #DEFINE_ALIAS
# from ..fluid.layers import elementwise_mod    #DEFINE_ALIAS
# from ..fluid.layers import elementwise_mul    #DEFINE_ALIAS
# from ..fluid.layers import elementwise_pow    #DEFINE_ALIAS
# from ..fluid.layers import elementwise_sub    #DEFINE_ALIAS
45 46 47 48
from ..fluid.layers import exp    #DEFINE_ALIAS
from ..fluid.layers import floor    #DEFINE_ALIAS
from ..fluid.layers import log    #DEFINE_ALIAS
from ..fluid.layers import reciprocal    #DEFINE_ALIAS
49 50
from ..fluid.layers import reduce_all    #DEFINE_ALIAS
from ..fluid.layers import reduce_any    #DEFINE_ALIAS
51 52 53 54
# from ..fluid.layers import reduce_max    #DEFINE_ALIAS
# from ..fluid.layers import reduce_min    #DEFINE_ALIAS
# from ..fluid.layers import reduce_prod    #DEFINE_ALIAS
# from ..fluid.layers import reduce_sum    #DEFINE_ALIAS
55 56 57 58 59 60 61
from ..fluid.layers import round    #DEFINE_ALIAS
from ..fluid.layers import rsqrt    #DEFINE_ALIAS
from ..fluid.layers import scale    #DEFINE_ALIAS
from ..fluid.layers import square    #DEFINE_ALIAS
from ..fluid.layers import stanh    #DEFINE_ALIAS
from ..fluid.layers import atan    #DEFINE_ALIAS
from ..fluid.layers import erf    #DEFINE_ALIAS
62 63
from ..fluid.layers import sqrt    #DEFINE_ALIAS
from ..fluid.layers import sin    #DEFINE_ALIAS
64

65
from ..fluid.layers import multiplex    #DEFINE_ALIAS
G
guofei 已提交
66
from ..fluid import layers
67

68

69
__all__ = [
70 71 72 73 74 75
        'abs',
        'acos',
        'asin',
        'atan',
        'ceil',
        'cos',
76
        'cosh',
77 78 79
        'cumsum',
        'exp',
        'floor',
80
        'increment',
81
        'log',
J
joejiong 已提交
82
        'log2',
J
joejiong 已提交
83
        'log10',
84
        'logsumexp',
85
        'mul',
86
        'multiplex',
87
        'pow',
88
        'prod',
89 90 91 92 93 94
        'reciprocal',
        'round',
        'rsqrt',
        'scale',
        'sign',
        'sin',
95
        'sinh',
96 97 98 99 100
        'sqrt',
        'square',
        'stanh',
        'sum',
        'tanh',
S
Steffy-zxf 已提交
101
        'add_n',
102
        'max',
103
        'maximum',
104
        'min',
105
        'minimum',
106
        'mm',
107 108 109 110 111
        'divide',
        'floor_divide',
        'remainder',
        'mod',
        'floor_mod',
112
        'multiply',
113 114 115
        'add',
        'atan',
        'logsumexp',
116
        'inverse',
117 118 119 120
        'log1p',
        'erf',
        'addcmul',
        'addmm',
Y
Yang Zhang 已提交
121
        'clip',
L
Li Fuchen 已提交
122
        'trace',
J
Jack Zhou 已提交
123 124 125
        'kron',
        'isfinite',
        'isinf',
L
Leo Chen 已提交
126 127
        'isnan',
        'broadcast_shape'
128 129 130
]
# yapf: enable.

131 132 133 134 135 136 137 138 139 140 141 142 143
_supported_int_dtype_ = [
    VarDesc.VarType.UINT8,
    VarDesc.VarType.INT8,
    VarDesc.VarType.INT16,
    VarDesc.VarType.INT32,
    VarDesc.VarType.INT64,
]

_supported_float_dtype_ = [
    VarDesc.VarType.FP32,
    VarDesc.VarType.FP64,
]

144
def pow(x, y, name=None):
145
    """
146
    Compute the power of tensor elements. The equation is:
S
swtkiwi 已提交
147

148 149
    .. math::
        out = x^{y} 
150

151 152
    **Note**:
    ``paddle.pow`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
153 154


155 156 157 158 159
    Args:
        x (Tensor): An N-D Tensor, the data type is float32, float64, int32 or int64.
        y (Tensor): An N-D Tensor with type float32, float64, int32 or int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
    
160
    Returns:
161
        N-D Tensor. A location into which the result is stored. Its dimension equals with $x$.
162 163 164

    Examples:

165
        ..  code-block:: python
166 167 168

            import paddle

169 170 171
            paddle.disable_static()
            
            # example 1: y is a float
172
            x = paddle.to_tensor([1, 2, 3])
173 174 175 176 177
            y = 2
            res = paddle.pow(x, y)
            print(res.numpy()) # [1 4 9]
            
            # example 2: y is a Tensor
178
            y = paddle.full(shape=[1], fill_value=2, dtype='float32')
179 180
            res = paddle.pow(x, y)
            print(res.numpy()) # [1 4 9]
181 182

    """
183
    # in dynamic graph mode
W
WuHaobo 已提交
184
    if in_dygraph_mode():
185 186 187
        if isinstance(y, (int, float)):
            return core.ops.pow(x, 'factor', y)
        elif isinstance(y, (paddle.Tensor, Variable)):
188

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
            if x.dtype != y.dtype:
                y = cast(y, dtype='float64')
                x = cast(x, dtype='float64')
                out_dygraph = _elementwise_op_in_dygraph(
                x, y, axis=-1, act=None, op_name='elementwise_pow')
                return out_dygraph

            return _elementwise_op_in_dygraph(
                x, y, axis=-1, act=None, op_name='elementwise_pow')
        else:
            raise TypeError('y must be scalar or tensor type, but received: %s '% (y.dtype))
    # in static graph mode
    else:
        if isinstance(y, (int, float)):
            helper = LayerHelper('pow', **locals())
            inputs = {'X': x}
            attrs = {'factor': y}
            out = helper.create_variable_for_type_inference(dtype=x.dtype)
            helper.append_op(
                type='pow', inputs=inputs, outputs={'Out': out}, attrs=attrs)
            return out
        elif isinstance(y, (paddle.Tensor, Variable)):
            # TODO A potential speed improvement is supporting different types in C++ and removing the cast ops here
            helper = LayerHelper('elementwise_pow', **locals())
            if x.dtype != y.dtype:
                y = cast(y, dtype='float64')
                x = cast(x, dtype='float64')
                out = helper.create_variable_for_type_inference(dtype=x.dtype)
            else:
                out = helper.create_variable_for_type_inference(dtype=x.dtype)
            return _elementwise_op(LayerHelper('elementwise_pow', **locals()))
        else:
            raise TypeError('y must be scalar or tensor type, but received: %s '% (type(y)))
222 223 224



225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
@dygraph_only
def _elementwise_op_in_dygraph(x,
                               y,
                               axis=-1,
                               act=None,
                               use_mkldnn=False,
                               op_name=None):
    op = getattr(core.ops, op_name)
    out = op(x, y, 'axis', axis, 'use_mkldnn', use_mkldnn)

    return dygraph_utils._append_activation_in_dygraph(
        out, act, use_mkldnn=use_mkldnn)


def _elementwise_op(helper):
    op_type = helper.layer_type
    original_op_type = helper.kwargs.get('original_op_type', op_type)
    x = helper.kwargs.get('x', None)
    y = helper.kwargs.get('y', None)

245 246
    out = helper.kwargs.get('out', None)

247 248 249 250 251 252 253 254 255 256 257 258
    assert x is not None, 'x cannot be None in {}'.format(original_op_type)
    assert y is not None, 'y cannot be None in {}'.format(original_op_type)
    check_variable_and_dtype(
        x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'],
        original_op_type)
    check_variable_and_dtype(
        y, 'y', ['float16', 'float32', 'float64', 'int32', 'int64'],
        original_op_type)

    axis = helper.kwargs.get('axis', -1)
    use_mkldnn = helper.kwargs.get('use_mkldnn', False)
    name = helper.kwargs.get('name', None)
259 260 261 262 263 264

    if out is None:
        if name is None:
            out = helper.create_variable_for_type_inference(dtype=x.dtype)
        else:
            out = helper.create_variable(name=name, dtype=x.dtype, persistable=False)
265 266 267 268 269 270 271 272 273 274 275

    helper.append_op(
        type=op_type,
        inputs={'X': x,
                'Y': y},
        outputs={'Out': out},
        attrs={'axis': axis,
               'use_mkldnn': use_mkldnn})
    return helper.append_activation(out)


Y
Yang Zhang 已提交
276
def add(x, y, name=None):
277
    """
278
    Examples:
279 280 281 282

    ..  code-block:: python

        import paddle
283 284
        x = paddle.to_tensor([2, 3, 4], 'float64')
        y = paddle.to_tensor([1, 5, 2], 'float64')
W
WuHaobo 已提交
285
        z = paddle.add(x, y)
286
        print(z)  # [3., 8., 6. ]
287 288 289 290 291 292

    """
    op_type = 'elementwise_add'
    axis = -1
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
Y
Yang Zhang 已提交
293
            x, y, axis=axis, op_name=op_type)
294 295 296 297

    return _elementwise_op(LayerHelper(op_type, **locals()))


298
def divide(x, y, name=None):
299
    """
300
    Divide two tensors element-wise. The equation is:
301

302 303
    .. math::
        out = x / y
304

305 306
    **Note**:
    ``paddle.divide`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
307

308 309 310 311
    Args:
        x (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
312

313 314
    Returns:
        N-D Tensor. A location into which the result is stored. It's dimension equals with $x$.
315

316
    Examples:
317

318
        ..  code-block:: python
319

320
            import paddle
321

322
            paddle.disable_static()
323

324 325
            x = paddle.to_tensor([2, 3, 4], dtype='float64')
            y = paddle.to_tensor([1, 5, 2], dtype='float64')
326 327
            z = paddle.divide(x, y)
            print(z.numpy())  # [2., 0.6, 2.]
328

329 330 331 332 333 334 335
    """
    op_type = 'elementwise_div'
    axis = -1
    act = None
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name=op_type)
336

337
    return _elementwise_op(LayerHelper(op_type, **locals()))
338 339


340 341 342
def floor_divide(x, y, name=None):
    """
    Floor divide two tensors element-wise. The equation is:
343

344 345
    .. math::
        out = x // y
346

347 348
    **Note**:
    ``paddle.floor_divide`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
349

350 351 352 353
    Args:
        x (Tensor): the input tensor, it's data type should be int32, int64.
        y (Tensor): the input tensor, it's data type should be int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
354

355 356
    Returns:
        N-D Tensor. A location into which the result is stored. It's dimension equals with $x$.
357

358
    Examples:
359

360
        ..  code-block:: python
361

362
            import paddle
363

364
            paddle.disable_static()
365

366 367
            x = paddle.to_tensor([2, 3, 8, 7])
            y = paddle.to_tensor([1, 5, 3, 3])
368 369
            z = paddle.floor_divide(x, y)
            print(z.numpy())  # [2, 0, 2, 2]
370

371 372 373 374 375 376
    """
    op_type = 'elementwise_floordiv'
    axis = -1
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, op_name=op_type)
377

378
    return _elementwise_op(LayerHelper(op_type, **locals()))
379 380


381
def remainder(x, y, name=None):
382
    r"""
383 384 385 386 387 388
    Mod two tensors element-wise. The equation is:

    .. math::
        out = x \% y

    **Note**:
W
WangXi 已提交
389
    ``paddle.mod`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
390 391

    Args:
W
WangXi 已提交
392 393
        x (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, it's data type should be float32, float64, int32, int64.
394 395 396 397 398 399 400 401 402 403 404
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        N-D Tensor. A location into which the result is stored. It's dimension equals with $x$.

    Examples:

        ..  code-block:: python

            import paddle

405 406
            x = paddle.to_tensor([2, 3, 8, 7])
            y = paddle.to_tensor([1, 5, 3, 3])
W
WangXi 已提交
407 408
            z = paddle.mod(x, y)
            print(z)  # [0, 3, 2, 1]
409 410 411

    """
    op_type = 'elementwise_mod'
412 413 414
    axis = -1
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
415
            x, y, axis=axis, op_name=op_type)
416 417 418 419

    return _elementwise_op(LayerHelper(op_type, **locals()))


420 421 422 423
mod = remainder  #DEFINE_ALIAS
floor_mod = remainder  #DEFINE_ALIAS


424 425
def multiply(x, y, axis=-1, name=None):
    """
426
    multiply two tensors element-wise. The equation is:
427

428 429
    .. math::
        out = x * y
430

431 432
    **Note**:
    ``paddle.multiply`` supports broadcasting. If you would like to know more about broadcasting, please refer to :ref:`user_guide_broadcasting` .
433

434 435 436 437
    Args:
        x (Tensor): the input tensor, its data type should be float32, float64, int32, int64.
        y (Tensor): the input tensor, its data type should be float32, float64, int32, int64.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
438

439 440
    Returns:
        N-D Tensor. A location into which the result is stored. Its dimension equals with $x$.
441

442 443 444 445 446 447 448
    Examples:

        ..  code-block:: python

            import paddle

            paddle.disable_static()
449 450
            x = paddle.to_tensor([[1, 2], [3, 4]])
            y = paddle.to_tensor([[5, 6], [7, 8]])
451 452 453
            res = paddle.multiply(x, y)
            print(res.numpy()) # [[5, 12], [21, 32]]

454 455
            x = paddle.to_tensor([[[1, 2, 3], [1, 2, 3]]])
            y = paddle.to_tensor([1, 2])
456 457
            res = paddle.multiply(x, y, axis=1)
            print(res.numpy()) # [[[1, 2, 3], [2, 4, 6]]]
458 459 460 461

    """
    op_type = 'elementwise_mul'
    act = None
462

463 464 465 466 467
    if x.dtype != y.dtype:
        raise TypeError(
            'Input tensors must be same type, but received type of x: %s, type of y: %s '
            % (x.dtype, y.dtype))

468
    if in_dygraph_mode():
469 470 471 472
        if not isinstance(x, (paddle.Tensor)):
            x = paddle.to_tensor(x)
        if not isinstance(y, (paddle.Tensor)):
            y = paddle.to_tensor(y)
473 474 475
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name=op_type)

476 477 478 479 480 481 482
    if not isinstance(x, (paddle.Tensor, Variable)):
        x = paddle.static.data(
            name='x', shape=x.shape, dtype=x.dtype)
    if not isinstance(y, (paddle.Tensor, Variable)):
        y = paddle.static.data(
            name='y', shape=y.shape, dtype=y.dtype)

483 484
    return _elementwise_op(LayerHelper(op_type, **locals()))

485 486 487 488 489 490 491 492 493 494 495
def maximum(x, y, axis=-1, name=None):
    """
Examples:

    .. code-block:: python

        import paddle
        import numpy as np

        paddle.disable_static()
  
496 497
        x = paddle.to_tensor([[1, 2], [3, 4]])
        y = paddle.to_tensor([[5, 6], [7, 8]])
498 499 500 501 502
        res = paddle.maximum(x, y)
        print(res.numpy())
        #[[5. 6.]
        # [7. 8.]]

503 504
        x = paddle.to_tensor([[[1, 2, 3], [1, 2, 3]]])
        y = paddle.to_tensor([1, 2])
505 506 507 508 509
        res = paddle.maximum(x, y, axis=1)
        print(res.numpy())
        #[[[1. 2. 3.]
        #  [2. 2. 3.]]]

510 511
        x = paddle.to_tensor([2, 3, 5], dtype='float32')
        y = paddle.to_tensor([1, 4, np.nan], dtype='float32')
512 513 514 515
        res = paddle.maximum(x, y)
        print(res.numpy())
        #[ 2.  4. nan]

516 517
        x = paddle.to_tensor([5, 3, np.inf], dtype='float32')
        y = paddle.to_tensor([1, 4, 5], dtype='float32')
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
        res = paddle.maximum(x, y)
        print(res.numpy())
        #[ 5.  4. inf]
    """
    op_type = 'elementwise_max'
    act = None
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name=op_type)
    return _elementwise_op(LayerHelper(op_type, **locals()))

def minimum(x, y, axis=-1, name=None):
    """
Examples:

    .. code-block:: python

        import paddle
        import numpy as np
537

538 539
        paddle.disable_static()
  
540 541
        x = paddle.to_tensor([[1, 2], [3, 4]], dtype='float32')
        y = paddle.to_tensor([[5, 6], [7, 8]], dtype='float32')
542 543 544 545 546
        res = paddle.minimum(x, y)
        print(res.numpy())
        #[[1. 2.]
        # [3. 4.]]

547 548
        x = paddle.to_tensor([[[1, 2, 3], [1, 2, 3]]], dtype='float32')
        y = paddle.to_tensor([1, 2], dtype='float32')
549 550 551 552 553
        res = paddle.minimum(x, y, axis=1)
        print(res.numpy())
        #[[[1. 1. 1.]
        #  [2. 2. 2.]]]

554 555
        x = paddle.to_tensor([2, 3, 5], dtype='float32')
        y = paddle.to_tensor([1, 4, np.nan], dtype='float32')
556 557 558 559
        res = paddle.minimum(x, y)
        print(res.numpy())
        #[ 1.  3. nan]

560 561
        x = paddle.to_tensor([5, 3, np.inf], dtype='float32')
        y = paddle.to_tensor([1, 4, 5], dtype='float32')
562 563 564 565 566 567 568 569 570 571
        res = paddle.minimum(x, y)
        print(res.numpy())
        #[1. 3. 5.]
    """
    op_type = 'elementwise_min'
    act = None
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name=op_type)
    return _elementwise_op(LayerHelper(op_type, **locals()))
572

573 574
for func in [
        add,
575 576 577
        maximum,
        minimum,
        multiply
578
]:
579
    proto_dict = {'add': 'elementwise_add', 'div': 'elementwise_div', 'maximum': 'elementwise_max', 'minimum': 'elementwise_min', 'multiply': 'elementwise_mul'}
580 581
    op_proto = OpProtoHolder.instance().get_op_proto(proto_dict[func.__name__])

Y
Yang Zhang 已提交
582 583 584 585 586 587 588
    additional_args_lines = [
        "name (string, optional): Name of the output. \
        Default is None. It's used to print debug info for developers. Details: \
        :ref:`api_guide_Name` "
    ]

    func.__doc__ = _generate_doc_string_(
589 590
        op_proto,
        additional_args_lines=additional_args_lines,
591
        skip_attrs_set={"x_data_format", "y_data_format", "axis",
592
            "use_quantizer", "mkldnn_data_type", "Scale_x", "Scale_y", "Scale_out"
593
        }) + """\n""" + str(func.__doc__)
594

Y
Yang Zhang 已提交
595

596
def sum(x, axis=None, dtype=None, keepdim=False, name=None):
597 598 599 600
    """
    Computes the sum of tensor elements over the given dimension.

    Args:
601 602 603
        x (Tensor): An N-D Tensor, the data type is float32, float64, int32 or int64.
        axis (int|list|tuple, optional): The dimensions along which the sum is performed. If
            :attr:`None`, sum all elements of :attr:`x` and return a
604
            Tensor variable with a single element, otherwise must be in the
605 606 607 608 609 610 611
            range :math:`[-rank(x), rank(x))`. If :math:`axis[i] < 0`,
            the dimension to reduce is :math:`rank + axis[i]`.
        dtype (str, optional): The dtype of output Tensor. The default value is None, the dtype
            of output is the same as input Tensor `x`.
        keepdim (bool, optional): Whether to reserve the reduced dimension in the
            output Tensor. The result Tensor will have one fewer dimension
            than the :attr:`x` unless :attr:`keepdim` is true, default
612
            value is False.
613
        name (str, optional): The default value is None. Normally there is no need for
614 615 616
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
617 618
        Tensor: Results of summation operation on the specified axis of input Tensor `x`,
        it's data type is the same as `x`.
619 620

    Raises:
621 622
        ValueError: If the data type of `x` is float64, :attr:`dtype` can not be float32 or int32.
        ValueError: If the data type of `x` is int64, :attr:`dtype` can not be int32.
623
        TypeError: The type of :attr:`axis` must be int, list or tuple.
624

625 626 627 628
    Examples:
        .. code-block:: python

            import paddle
629

630
            # x is a Tensor with following elements:
631 632 633
            #    [[0.2, 0.3, 0.5, 0.9]
            #     [0.1, 0.2, 0.6, 0.7]]
            # Each example is followed by the corresponding output tensor.
634 635
            x = paddle.to_tensor([[0.2, 0.3, 0.5, 0.9],
                                  [0.1, 0.2, 0.6, 0.7]])
636
            out1 = paddle.sum(x)  # [3.5]
637 638 639
            out2 = paddle.sum(x, axis=0)  # [0.3, 0.5, 1.1, 1.6]
            out3 = paddle.sum(x, axis=-1)  # [1.9, 1.6]
            out4 = paddle.sum(x, axis=1, keepdim=True)  # [[1.9], [1.6]]
640

641
            # y is a Tensor with shape [2, 2, 2] and elements as below:
642 643 644
            #      [[[1, 2], [3, 4]],
            #      [[5, 6], [7, 8]]]
            # Each example is followed by the corresponding output tensor.
645 646
            y = paddle.to_tensor([[[1, 2], [3, 4]], 
                                  [[5, 6], [7, 8]]])
647 648
            out5 = paddle.sum(y, axis=[1, 2]) # [10, 26]
            out6 = paddle.sum(y, axis=[0, 1]) # [16, 20]
649
    """
650 651 652 653 654 655 656 657 658 659 660
    if axis is not None and not isinstance(axis, (list, tuple)):
        axis = [axis]

    if not axis:
        reduce_all_flag = True
    else:
        if len(axis) == len(x.shape):
            reduce_all_flag = True
        else:
            reduce_all_flag = False

661
    attrs = {
662 663 664
        'dim': axis if axis != None and axis != [] and axis != () else [0],
        'keep_dim': keepdim,
        'reduce_all': reduce_all_flag
665 666 667 668
    }
    dtype_flag = False
    if dtype is not None:
        if dtype in ['float64', 'int64']:
669 670
            if (convert_dtype(x.dtype) == "float32" and dtype == "float64") or \
               (convert_dtype(x.dtype) == "int32" and dtype == "int64"):
671
                attrs.update({
672
                    'in_dtype': x.dtype,
673 674 675 676 677
                    'out_dtype': convert_np_dtype_to_dtype_(dtype)
                })
                dtype_flag = True

    if in_dygraph_mode():
678
        axis = axis if axis != None and axis != [] else [0]
679
        if dtype_flag:
680 681 682
            return core.ops.reduce_sum(x, 'dim', axis, 'keep_dim', keepdim,
                                       'reduce_all', reduce_all_flag, 'in_dtype',
                                       x.dtype, 'out_dtype',
683 684
                                       convert_np_dtype_to_dtype_(dtype))
        else:
685 686
            return core.ops.reduce_sum(x, 'dim', axis, 'keep_dim', keepdim,
                                       'reduce_all', reduce_all_flag)
687
    check_variable_and_dtype(
688
        x, 'x', ['float32', 'float64', 'int32', 'int64'], 'sum')
689 690 691 692 693 694 695 696 697 698 699

    if dtype is not None:
        check_dtype(dtype, 'dtype', ['float32', 'float64', 'int32', 'int64'], 'sum')
        x_dtype = convert_dtype(x.dtype)

        if (x_dtype == "float64" and dtype in ["float32", "int32"]) or \
                (x_dtype == "int64" and dtype == "int32"):
            raise ValueError("The input(x)'s dtype is {} but the attr(dtype) of sum is {}, "
                             "which may cause data type overflows. Please reset attr(dtype) of sum."
                             .format(x_dtype, dtype))

700 701
    check_type(axis, 'axis', (int, list, tuple, type(None)), 'sum')

702 703 704 705 706
    helper = LayerHelper('sum', **locals())
    if dtype_flag:
        out = helper.create_variable_for_type_inference(
            dtype=convert_np_dtype_to_dtype_(dtype))
    else:
707
        out = helper.create_variable_for_type_inference(dtype=x.dtype)
708 709
    helper.append_op(
        type='reduce_sum',
710
        inputs={'X': x},
711 712 713
        outputs={'Out': out},
        attrs=attrs)
    return out
714

715

716
@templatedoc(op_type="sum")
S
Steffy-zxf 已提交
717
def add_n(inputs, name=None):
718
    """
S
Steffy-zxf 已提交
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
    This OP is used to sum one or more Tensor of the input.
    
    For example:

    .. code-block:: text
    
        Case 1:

            Input:
                input.shape = [2, 3]
                input = [[1, 2, 3],
                         [4, 5, 6]]

            Output:
                output.shape = [2, 3]
                output = [[1, 2, 3],
                          [4, 5, 6]]

        Case 2:
       
            Input:
                First input:
                    input1.shape = [2, 3]
                    Input1 = [[1, 2, 3],
                              [4, 5, 6]]

                The second input:
                    input2.shape = [2, 3]
                    input2 = [[7, 8, 9],
                              [10, 11, 12]]

                Output:
                    output.shape = [2, 3]
                    output = [[8, 10, 12],
                              [14, 16, 18]]
754 755

    Args:
S
Steffy-zxf 已提交
756 757
        inputs (Tensor|list(Tensor)):  A Tensor list. The shape and data type of the list elements should be consistent.
            Input can be multi-dimensional Tensor, and data types can be: float32, float64, int32, int64.
758 759 760 761
        name(str, optional): The default value is None. Normally there is no need for
            user to set this property. For more information, please refer to :ref:`api_guide_Name`

    Returns:
S
Steffy-zxf 已提交
762
        Tensor, the sum of input :math:`inputs` , its shape and data types are consistent with :math:`inputs`.
763 764 765 766 767 768

    Examples:
        .. code-block:: python

            import paddle

S
Steffy-zxf 已提交
769 770 771 772 773
            input0 = paddle.to_tensor([[1, 2, 3], [4, 5, 6]], dtype='float32')
            input1 = paddle.to_tensor([[7, 8, 9], [10, 11, 12]], dtype='float32')
            output = paddle.add_n([input0, input1])
            # [[8., 10., 12.], 
            #  [14., 16., 18.]]
774
    """
S
Steffy-zxf 已提交
775 776 777 778
    if in_dygraph_mode():
        if isinstance(inputs, Variable):
            inputs = [inputs]
        return core.ops.sum(inputs, 'use_mkldnn', False)
779

S
Steffy-zxf 已提交
780 781
    helper = LayerHelper('add_n', **locals())
    check_type(inputs, 'inputs', (Variable, tuple, list), 'add_n')
782 783 784 785
    if isinstance(inputs, list) or isinstance(inputs, tuple):
        if len(inputs) > 0:
            for input in inputs:
                check_variable_and_dtype(input, "inputs", \
S
Steffy-zxf 已提交
786
                   ['float32', 'float64', 'int32', 'int64'], 'add_n')
787 788
    else:
        check_variable_and_dtype(inputs, "inputs", \
S
Steffy-zxf 已提交
789
                ['float32', 'float64', 'int32', 'int64'], 'add_n')
790 791


792 793 794 795 796 797 798 799 800 801 802
    out = helper.create_variable_for_type_inference(
        dtype=helper.input_dtype('inputs'))
    helper.append_op(
        type='sum',
        inputs={'X': inputs},
        outputs={'Out': out},
        attrs={'use_mkldnn': False})

    return out


W
WuHaobo 已提交
803
def mm(input, mat2, name=None):
804
    """
805 806
	:alias_main: paddle.mm
	:alias: paddle.mm,paddle.tensor.mm,paddle.tensor.math.mm
S
swtkiwi 已提交
807

808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
    Applies matrix multiplication to two tensors.

    Currently, the input tensors' rank can be any, but when the rank of any
    inputs is bigger than 3, this two inputs' rank should be equal.


    Also note that if the raw tensor :math:`x` or :math:`mat2` is rank-1 and
    nontransposed, the prepended or appended dimension :math:`1` will be
    removed after matrix multiplication.

    Args:
        x (Variable): The input variable which is a Tensor or LoDTensor.
        mat2 (Variable): The input variable which is a Tensor or LoDTensor.
        name(str, optional): The default value is None. Normally there is no need for
            user to set this property. For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Variable: The product Tensor (or LoDTensor) variable.

    Examples:
        .. code-block:: python

            # Examples to clarify shapes of the inputs and output
            # x: [B, ..., M, K], mat2: [B, ..., K, N]
            # fluid.layers.matmul(x, mat2)  # out: [B, ..., M, N]

            # x: [B, M, K], mat2: [B, K, N]
            # fluid.layers.matmul(x, mat2)  # out: [B, M, N]

            # x: [B, M, K], mat2: [K, N]
            # fluid.layers.matmul(x, mat2)  # out: [B, M, N]

            # x: [M, K], mat2: [K, N]
            # fluid.layers.matmul(x, mat2)  # out: [M, N]

            # x: [B, M, K], mat2: [K]
            # fluid.layers.matmul(x, mat2)  # out: [B, M]

            # x: [K], mat2: [K]
            # fluid.layers.matmul(x, mat2)  # out: [1]

            import paddle
            import paddle.fluid as fluid
            x = fluid.data(name='x', shape=[2, 3], dtype='float32')
            mat2 = fluid.data(name='mat2', shape=[3, 2], dtype='float32')
            out = paddle.mm(x, mat2) # out shape is [2, 2]
    """
    if in_dygraph_mode():
W
WuHaobo 已提交
856
        out = _varbase_creator(dtype=input.dtype)
857 858
        core.ops.matmul(input, mat2, out)
        return out
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895

    def __check_input(x, y):
        var_names = {'x': x, 'y': y}
        for name, val in var_names.items():
            check_variable_and_dtype(val, name,
                                     ['float16', 'float32', 'float64'], 'mm')
        x_shape = list(x.shape)
        y_shape = list(y.shape)
        if len(x_shape) == 1:
            x_shape = [1] + x_shape
        if len(y_shape) == 1:
            y_shape = y_shape + [1]

        # check the inner 2 dimensions
        if x_shape[-1] != y_shape[-2]:
            if not ((x_shape[-1] == -1) or (y_shape[-2] == -1)):
                raise ValueError(
                    "After performing an optional transpose, Input X's width should be "
                    "equal to Y's width for multiplication "
                    "prerequisites. But received X's shape: %s, Y's shape: %s\n"
                    % (x_shape, y_shape))

        if len(y_shape) > 2 and len(x_shape) > 2:
            for i, dim_x in enumerate(x_shape[:-2]):
                # don't check neg shape
                if dim_x < 0 or y_shape[i] < 0:
                    continue
                if dim_x != y_shape[i]:
                    raise ValueError(
                        "When the matrix is larger than 2 dimensions, the higher "
                        "dimensional values of the two matrices need to be equal. "
                        "But received x_shape[%d] != y_shape[%d]. X's shape: %s, "
                        "Y's shape: %s.\n" % (i, i, x_shape, y_shape))

    __check_input(input, mat2)

    helper = LayerHelper('mm', **locals())
W
WuHaobo 已提交
896
    out = helper.create_variable_for_type_inference(dtype=input.dtype)
897 898 899 900
    helper.append_op(
        type='matmul', inputs={'X': input,
                               'Y': mat2}, outputs={'Out': out})
    return out
901

902

Y
yaoxuefeng 已提交
903
def addmm(input, x, y, beta=1.0, alpha=1.0, name=None):
904
    """
905 906
	:alias_main: paddle.addmm
	:alias: paddle.addmm,paddle.tensor.addmm,paddle.tensor.math.addmm
S
swtkiwi 已提交
907

908 909 910 911 912 913 914 915 916 917 918 919
    **addmm**

    This operator is used to perform matrix multiplication for input $x$ and $y$.
    $input$ is added to the final result.
    The equation is:

    ..  math::
        Out = alpha * x * y + beta * input

    $Input$, $x$ and $y$ can carry the LoD (Level of Details) information, or not. But the output only shares the LoD information with input $input$.

    Args:
Y
yaoxuefeng 已提交
920 921 922
        input (Tensor): The input Tensor to be added to the final result.
        x (Tensor): The first input Tensor for matrix multiplication.
        y (Tensor): The second input Tensor for matrix multiplication.
923
        beta (float): Coefficient of $input$.
Y
yaoxuefeng 已提交
924
        alpha (float): Coefficient of $x*y$.
925 926 927
        name (str, optional): Name of the output. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`. Default is None.

    Returns:
Y
yaoxuefeng 已提交
928
        Tensor: The output Tensor of addmm op.
929 930 931

    Examples:
        ..  code-block:: python
Y
yaoxuefeng 已提交
932
            
933 934
            import paddle

Y
yaoxuefeng 已提交
935 936 937
            x = paddle.ones([2,2])
            y = paddle.ones([2,2])
            input = paddle.ones([2,2])
Y
yaoxuefeng 已提交
938

Y
yaoxuefeng 已提交
939
            out = paddle.addmm( input=input, x=x, y=y, beta=0.5, alpha=5.0 )
Y
yaoxuefeng 已提交
940 941

            print( out.numpy() )
942 943 944
            # [[10.5 10.5]
            # [10.5 10.5]]
    """
Y
yaoxuefeng 已提交
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
    input_shape = input.shape
    x_shape = x.shape
    y_shape = y.shape
    if not len(input_shape) == len(x_shape) == len(y_shape) == 2:
        raise ValueError("The dimention of input, x, y should be 2 but receive input's shape: {}, x's shape: {}, y's shape: {}".format(input_shape, x_shape, y_shape))
    if input_shape[0] != x_shape[0]:
        if input_shape[0] != 1:
            raise ValueError( "When x's dimension[0] is not equal with input's dimension[0], input's dimension[0] must be 1 but got {}".format(input_shape[0]))
        if input_shape[1] != y_shape[1] and input_shape[1] != 1:
            raise ValueError( "When y's dimension[1] is not equal with input's dimension[1], input's dimension[1] must be 1 but got {}".format(input_shape[1]))
    if input_shape[1] != y_shape[1]:
        if input_shape[1] != 1:
            raise ValueError( "When y's dimension[1] is not equal with input's dimension[1], input's dimension[1] must be 1 but got {}".format(input_shape[1]))
        if input_shape[0] != x_shape[0] and input_shape[0] != 1:
            raise ValueError( "When x's dimension[0] is not equal with input's dimension[0], input's dimension[0] must be 1 but got {}".format(input_shape[0]))
    if x_shape[1] != y_shape[0]:
        raise ValueError("The input Variable x's width must be equal with Variable y' height. But received x's shape = {}, y's shape = {}.".format(x_shape, y_shape))



965 966 967 968
    if in_dygraph_mode():
        out = core.ops.addmm(input, x, y, "Alpha", alpha, "Beta", beta)
        return out

969 970 971 972
    inputs = {'Input': input, "X": x, "Y": y}
    attrs = {'Alpha': alpha, 'Beta': beta}

    helper = LayerHelper("addmm", **locals())
Y
yaoxuefeng 已提交
973
    check_variable_and_dtype(input, 'Input', ['float32', 'float64'], 'addmm')
974 975 976 977 978 979 980
    check_variable_and_dtype(x, 'X', ['float32', 'float64'], 'addmm')
    check_variable_and_dtype(y, 'Y', ['float32', 'float64'], 'addmm')
    out = helper.create_variable_for_type_inference(dtype=x.dtype)

    helper.append_op(
        type="addmm", inputs=inputs, attrs=attrs, outputs={"Out": out})
    return out
981 982


983
def logsumexp(x, axis=None, keepdim=False, name=None):
984
    r"""
985
    This OP calculates the log of the sum of exponentials of ``x`` along ``axis`` .
986

987
    .. math::
988
       logsumexp(x) = \\log\\sum exp(x)
989

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
    Args:
        x (Tensor): The input Tensor with data type float32, float64.
        axis (int|list|tuple, optional): The axis along which to perform
            logsumexp calculations. ``axis`` should be int, list(int) or
            tuple(int). If ``axis`` is a list/tuple of dimension(s), logsumexp
            is calculated along all element(s) of ``axis`` . ``axis`` or
            element(s) of ``axis`` should be in range [-D, D), where D is the
            dimensions of ``x`` . If ``axis`` or element(s) of ``axis`` is
            less than 0, it works the same way as :math:`axis + D` . If
            ``axis`` is None, logsumexp is calculated along all elements of
            ``x``. Default is None.
        keepdim (bool, optional): Whether to reserve the reduced dimension(s)
            in the output Tensor. If ``keep_dim`` is True, the dimensions of
            the output Tensor is the same as ``x`` except in the reduced
            dimensions(it is of size 1 in this case). Otherwise, the shape of
            the output Tensor is squeezed in ``axis`` . Default is False.
        name (str, optional): Name for the operation (optional, default is None).
            For more information, please refer to :ref:`api_guide_Name`.
1008

1009
    Returns:
1010 1011
        Tensor, results of logsumexp along ``axis`` of ``x``, with the same data
        type as ``x``.
1012

1013
    Examples:
1014

1015
    .. code-block:: python
1016

1017 1018
        import paddle

1019
        x = paddle.to_tensor([[-1.5, 0., 2.], [3., 1.2, -2.4]])
1020 1021
        out1 = paddle.logsumexp(x) # [3.4691226]
        out2 = paddle.logsumexp(x, 1) # [2.15317821, 3.15684602]
1022 1023

    """
1024 1025 1026 1027 1028 1029 1030
    if isinstance(axis, int):
        axis = [axis]
    reduce_all = True if axis is None \
        or len(axis)==0 \
        or len(axis) == len(x.shape) else False
    if axis is None or len(axis) == 0:
        axis = [0]
1031

1032
    if in_dygraph_mode():
1033
        return core.ops.logsumexp(x, 'axis', axis, 'keepdim', keepdim, 'reduce_all', reduce_all)
1034

1035 1036 1037
    check_variable_and_dtype(x, 'x',
                             ['float32', 'float64'],
                             'logsumexp')
1038

1039
    helper = LayerHelper('logsumexp', **locals())
1040
    attrs = {'axis': axis, 'keepdim': keepdim, 'reduce_all':reduce_all}
1041 1042 1043 1044
    out = helper.create_variable_for_type_inference(x.dtype)
    helper.append_op(
        type='logsumexp', inputs={'X': x}, outputs={'Out': out}, attrs=attrs)
    return out
1045

S
swtkiwi 已提交
1046

1047 1048
def inverse(x, name=None):
    """
1049 1050 1051 1052 1053
    Takes the inverse of the square matrix. A square matrix is a matrix with
    the same number of rows and columns. The input can be a square matrix
    (2-D Tensor) or batches of square matrices.

    Args:
1054
        x (Variable): The input tensor. The last two
1055 1056 1057 1058 1059 1060 1061 1062
            dimensions should be equal. When the number of dimensions is
            greater than 2, it is treated as batches of square matrix. The data
            type can be float32 and float64.
        name (str, optional): The default value is None. Normally there is no need for
            user to set this property. For more information,
            please refer to :ref:`api_guide_Name`

    Returns:
1063 1064
        Variable: A Tensor holds the inverse of x. The shape and data type
                        is the same as x.
1065 1066 1067 1068 1069

    Examples:
        .. code-block:: python

            import paddle
1070
            paddle.disable_static()
1071 1072

            mat = paddle.to_tensor([[2, 0], [0, 2]], dtype='float32')
1073 1074
            inv = paddle.inverse(mat)
            print(inv) # [[0.5, 0], [0, 0.5]]
1075 1076 1077

    """
    if in_dygraph_mode():
1078
        return core.ops.inverse(x)
1079

1080 1081
    def _check_input(x):
        check_variable_and_dtype(x, 'x',
1082
                                 ['float32', 'float64'], 'inverse')
1083
        if len(x.shape) < 2:
1084 1085 1086
            raise ValueError(
                "The input of inverse is expected to be a Tensor whose number "
                "of dimensions is no less than 2. But reviced: %d, "
1087 1088
                "x's shape: %s." % (len(x.shape), x.shape))
    _check_input(x)
1089
    helper = LayerHelper('inverse', **locals())
1090
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
1091
    helper.append_op(
1092
        type='inverse', inputs={'Input': [x] }, outputs={'Output': [out]})
1093 1094 1095
    return out


1096
def max(x, axis=None, keepdim=False, name=None):
1097
    """
S
swtkiwi 已提交
1098

1099
    Computes the maximum of tensor elements over the given axis.
1100 1101

    Args:
1102
        x(Tensor): A tensor, the data type is float32,
1103
            float64, int32, int64.
1104
        axis(list|int, optional): The axis along which the maximum is computed.
1105
            If :attr:`None`, compute the maximum over all elements of
李灿 已提交
1106
            `x` and return a Tensor variable with a single element,
1107 1108 1109
            otherwise must be in the range :math:`[-x.ndim(x), x.ndim(x))`.
            If :math:`axis[i] < 0`, the axis to reduce is :math:`x.ndim + axis[i]`.
        keepdim(bool, optional): Whether to reserve the reduced dimension in the
1110
            output Tensor. The result tensor will have one fewer dimension
1111
            than the `x` unless :attr:`keepdim` is true, default
1112
            value is False.
1113
        name(str, optional): The default value is None.  Normally there is no need for
1114 1115 1116
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
1117
        Tensor, results of maximum on the specified axis of input tensor,
1118
        it's data type is the same as `x`.
1119 1120 1121

    Examples:
        .. code-block:: python
1122

1123
            import paddle
1124

1125 1126 1127 1128
            paddle.disable_static()

            # data_x is a variable with shape [2, 4]
            # the axis is a int element
1129 1130 1131

            x = paddle.to_tensor([[0.2, 0.3, 0.5, 0.9],
                                  [0.1, 0.2, 0.6, 0.7]])
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
            result1 = paddle.max(x)
            print(result1.numpy())
            #[0.9]
            result2 = paddle.max(x, axis=0)
            print(result2.numpy()) 
            #[0.2 0.3 0.6 0.9]
            result3 = paddle.max(x, axis=-1)
            print(result3.numpy())
            #[0.9 0.7]
            result4 = paddle.max(x, axis=1, keepdim=True)
            print(result4.numpy())
            #[[0.9]
            # [0.7]]

            # data_y is a variable with shape [2, 2, 2]
            # the axis is list 
1148 1149 1150

            y = paddle.to_tensor([[[1.0, 2.0], [3.0, 4.0]],
                                  [[5.0, 6.0], [7.0, 8.0]]])
1151 1152 1153 1154 1155 1156
            result5 = paddle.max(y, axis=[1, 2])
            print(result5.numpy())
            #[4. 8.]
            result6 = paddle.max(y, axis=[0, 1])
            print(result6.numpy())
            #[7. 8.]
1157 1158
    """

1159
    if axis is not None and not isinstance(axis, list):
1160 1161 1162 1163 1164 1165 1166 1167
        if isinstance(axis, tuple):
            axis = list(axis)
        elif isinstance(axis, int):
            axis= [axis]
        else:
            raise TypeError(
                "The type of axis must be int, list or tuple, but received {}".format(type(axis)))

1168 1169 1170 1171 1172
    reduce_all = True if axis == None or axis == [] else False
    axis = axis if axis != None and axis != [] else [0]
    if in_dygraph_mode():
        return core.ops.reduce_max(x, 'dim', axis, 'keep_dim', keepdim,
                                   'reduce_all', reduce_all)
1173

1174
    helper = LayerHelper('max', **locals())
1175
    check_variable_and_dtype(
1176
        x, 'x', ['float32', 'float64', 'int32', 'int64'], 'max')
1177

1178
    out = helper.create_variable_for_type_inference(
1179
            dtype=x.dtype)
1180 1181
    helper.append_op(
        type='reduce_max',
1182
        inputs={'X': x},
1183 1184
        outputs={'Out': out},
        attrs={
1185 1186
            'dim': axis,
            'keep_dim': keepdim,
1187 1188 1189 1190
            'reduce_all': reduce_all
        })
    return out

1191
def min(x, axis=None, keepdim=False, name=None):
1192
    """
S
swtkiwi 已提交
1193

1194
    Computes the minimum of tensor elements over the given axis
1195

1196
    Args:
1197 1198
        x(Tensor): A tensor, the data type is float32, float64, int32, int64.
        axis(list|int, optional): The axis along which the minimum is computed.
1199
            If :attr:`None`, compute the minimum over all elements of
1200
            `x` and return a Tensor variable with a single element,
1201 1202 1203
            otherwise must be in the range :math:`[-x.ndim, x.ndim)`.
            If :math:`axis[i] < 0`, the axis to reduce is :math:`x.ndim + axis[i]`.
        keepdim(bool, optional): Whether to reserve the reduced dimension in the
1204
            output Tensor. The result tensor will have one fewer dimension
1205
            than the `x` unless :attr:`keepdim` is true, default
1206
            value is False.
W
WuHaobo 已提交
1207
        name(str, optional): The default value is None.  Normally there is no need for 
1208
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
1209

1210
    Returns:
1211
        Tensor, results of minimum on the specified axis of input tensor,
1212
        it's data type is the same as input's Tensor.
1213

1214 1215 1216
    Examples:
        .. code-block:: python

1217
            import paddle
1218

1219
            paddle.disable_static()
1220

1221
            # x is a tensor with shape [2, 4]
1222
            # the axis is a int element
1223 1224
            x = paddle.to_tensor([[0.2, 0.3, 0.5, 0.9],
                                  [0.1, 0.2, 0.6, 0.7]])
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
            result1 = paddle.min(x)
            print(result1.numpy())
            #[0.1]
            result2 = paddle.min(x, axis=0)
            print(result2.numpy())
            #[0.1 0.2 0.5 0.7]
            result3 = paddle.min(x, axis=-1)
            print(result3.numpy()) 
            #[0.2 0.1]
            result4 = paddle.min(x, axis=1, keepdim=True)
            print(result4.numpy())
            #[[0.2]
            # [0.1]]

1239
            # y is a variable with shape [2, 2, 2]
1240
            # the axis is list 
1241 1242
            y = paddle.to_tensor([[[1.0, 2.0], [3.0, 4.0]],
                                  [[5.0, 6.0], [7.0, 8.0]]])
1243 1244 1245 1246 1247 1248 1249
            result5 = paddle.min(y, axis=[1, 2])
            print(result5.numpy()) 
            #[1. 5.]
            result6 = paddle.min(y, axis=[0, 1])
            print(result6.numpy())
            #[1. 2.]
    """
1250

1251
    if axis is not None and not isinstance(axis, list):
1252 1253 1254 1255 1256 1257 1258
        if isinstance(axis, tuple):
            axis = list(axis)
        elif isinstance(axis, int):
            axis= [axis]
        else:
            raise TypeError(
                "The type of axis must be int, list or tuple, but received {}".format(type(axis)))
1259 1260
    reduce_all = True if axis == None or axis == [] else False
    axis = axis if axis != None and axis != [] else [0]
1261
    if in_dygraph_mode():
1262
        return core.ops.reduce_min(x, 'dim', axis, 'keep_dim', keepdim,
1263
                                   'reduce_all', reduce_all)
1264 1265 1266 1267 1268 1269

    helper = LayerHelper('min', **locals())
    check_variable_and_dtype(
        x, 'x', ['float32', 'float64', 'int32', 'int64'], 'min')

    out = helper.create_variable_for_type_inference(
1270
            dtype=x.dtype)
1271 1272
    helper.append_op(
        type='reduce_min',
1273
        inputs={'X': x},
1274 1275
        outputs={'Out': out},
        attrs={
1276 1277
            'dim': axis,
            'keep_dim': keepdim,
1278 1279 1280 1281 1282
            'reduce_all': reduce_all
        })
    return out


W
WuHaobo 已提交
1283
def log1p(x, name=None):
1284
    r"""
1285 1286 1287
    Calculates the natural log of the given input tensor, element-wise.
    .. math::
        Out = \\ln(x+1)
S
Steffy-zxf 已提交
1288

1289
    Args:
S
Steffy-zxf 已提交
1290
        x (Tensor): Input Tensor. Must be one of the following types: float32, float64.
1291 1292 1293
        name(str, optional): The default value is None.  Normally there is no need for 
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
    Returns:
S
Steffy-zxf 已提交
1294
        Tensor, the natural log of the input Tensor computed element-wise.
1295

1296 1297
    Examples:
        .. code-block:: python
S
Steffy-zxf 已提交
1298

1299
            import paddle
S
Steffy-zxf 已提交
1300 1301 1302 1303

            data = paddle.to_tensor([[0], [1]], dtype='float32')
            res = paddle.log1p(data)
            # [[0.], [0.6931472]]
1304 1305 1306 1307 1308 1309 1310 1311 1312
    """

    if in_dygraph_mode():
        return core.ops.log1p(x)

    check_variable_and_dtype(x, 'x', ['float32', 'float64'], "log1p")
    inputs = {'X': [x]}
    helper = LayerHelper('log1p', **locals())
    dtype = helper.input_dtype(input_param_name='x')
W
WuHaobo 已提交
1313
    out = helper.create_variable_for_type_inference(dtype)
1314 1315
    helper.append_op(type="log1p", inputs={"X": x}, outputs={"Out": out})
    return out
B
Bai Yifan 已提交
1316

J
joejiong 已提交
1317
def log2(x, name=None):
1318
    r"""
J
joejiong 已提交
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364
    Calculates the log to the base 2 of the given input tensor, element-wise.

    .. math::

        Out = \\log_2x

    Args:
        x (Tensor): Input tensor must be one of the following types: float32, float64.
        name (str|None): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`


    Returns:
        Tensor: The log to the base 2 of the input Tensor computed element-wise.

    Examples:

        .. code-block:: python
        
            import paddle

            # example 1: x is a float
            x_i = paddle.to_tensor([[1.0], [2.0]])
            res = paddle.log2(x_i) # [[0.], [1.0]]

            # example 2: x is float32
            x_i = paddle.full(shape=[1], fill_value=2, dtype='float32')
            paddle.to_tensor(x_i)
            res = paddle.log2(x_i)
            print(res) # [1.0]

            # example 3: x is float64
            x_i = paddle.full(shape=[1], fill_value=2, dtype='float64')
            paddle.to_tensor(x_i)
            res = paddle.log2(x_i)
            print(res) # [1.0]
    """
    if in_dygraph_mode():
        return core.ops.log2(x)

    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], "log2")
    inputs = {'X': [x]}
    helper = LayerHelper('log2', **locals())
    dtype = helper.input_dtype(input_param_name='x')
    out = helper.create_variable_for_type_inference(dtype)
    helper.append_op(type="log2", inputs={"X": x}, outputs={"Out": out})
    return out
W
WuHaobo 已提交
1365

J
joejiong 已提交
1366 1367

def log10(x, name=None):
1368
    r"""
J
joejiong 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
    Calculates the log to the base 10 of the given input tensor, element-wise.

    .. math::

        Out = \\log_10_x

    Args:
        x (Tensor): Input tensor must be one of the following types: float32, float64.
        name (str|None): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`


    Returns:
        Tensor: The log to the base 10 of the input Tensor computed element-wise.

    Examples:

        .. code-block:: python
        
            import paddle

            # example 1: x is a float
            x_i = paddle.to_tensor([[1.0], [10.0]])
            res = paddle.log10(x_i) # [[0.], [1.0]]

            # example 2: x is float32
            x_i = paddle.full(shape=[1], fill_value=10, dtype='float32')
            paddle.to_tensor(x_i)
            res = paddle.log10(x_i)
            print(res) # [1.0]

            # example 3: x is float64
            x_i = paddle.full(shape=[1], fill_value=10, dtype='float64')
            paddle.to_tensor(x_i)
            res = paddle.log10(x_i)
            print(res) # [1.0]
    """
    if in_dygraph_mode():
        return core.ops.log10(x)

    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], "log10")
    inputs = {'X': [x]}
    helper = LayerHelper('log10', **locals())
    dtype = helper.input_dtype(input_param_name='x')
    out = helper.create_variable_for_type_inference(dtype)
    helper.append_op(type="log10", inputs={"X": x}, outputs={"Out": out})
    return out


W
WuHaobo 已提交
1417
def addcmul(input, tensor1, tensor2, value=1.0, name=None):
B
Bai Yifan 已提交
1418
    """
S
swtkiwi 已提交
1419

B
Bai Yifan 已提交
1420 1421 1422 1423 1424
    Calculate the element-wise multiplication of tensor1 and tensor2,
    then multiply the result by value, and add it to input. The shape of input,
    tensor1, tensor2 should be broadcastable.
    The equation is:
    ..  math::
1425

B
Bai Yifan 已提交
1426 1427
        out = input + value * tensor1 * tensor2
    Args:
1428 1429 1430
        input(Tensor): The input to be added. A Tensor with type float32, float64, int32, int64.
        tensor1(Tensor): The tensor to be multiplied. A Tensor with type float32, float64, int32, int64.
        tensor2(Tensor): The tensor to be multiplied. A Tensor with type float32, float64, int32, int64.
B
Bai Yifan 已提交
1431 1432 1433 1434
        value(int|float): The multiplier for tensor1*tensor2. For float32 and float64 type input, value must be float, otherwise an integer.
        name(str, Optional): For details, please refer to :ref:`api_guide_Name`.
                        Generally, no setting is required. Default: None.
    Returns:
1435
        out(Tensor): The output result. A Tensor with the same data type as input's.
B
Bai Yifan 已提交
1436 1437
    Examples:
        .. code-block:: python
1438
          
B
Bai Yifan 已提交
1439
          import paddle
1440 1441 1442
          input = paddle.ones([2,2])
          tensor1 = paddle.ones([2,2])
          tensor2 = paddle.ones([2,2])
1443
          out = paddle.tensor.math.addcmul(input, tensor1, tensor2, value=0.5)
1444 1445 1446
          print(out.numpy())
          # [[1.5 1.5]
          # [1.5 1.5]]
B
Bai Yifan 已提交
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456
    """

    check_variable_and_dtype(input, 'input', ['float32', 'float64', 'int32', 'int64'], 'addcmul')
    check_variable_and_dtype(tensor1, 'tensor1', ['float32', 'float64', 'int32', 'int64'], 'addcmul')
    check_variable_and_dtype(tensor2, 'tensor2', ['float32', 'float64', 'int32', 'int64'], 'addcmul')
    if convert_dtype(input.dtype) in ['float32', 'float64']:
        check_type(value, 'value', float, 'addcmul')
    if convert_dtype(input.dtype) in ['int32', 'int64']:
        check_type(value, 'value', int, 'addcmul')

W
WuHaobo 已提交
1457
    out = layers.elementwise_add(input, layers.elementwise_mul(tensor1, tensor2) * value)
B
Bai Yifan 已提交
1458
    return out
1459 1460


Y
Yang Zhang 已提交
1461
def clip(x, min=None, max=None, name=None):
1462
    """
Y
Yang Zhang 已提交
1463
    **clip layer**
1464

Y
Yang Zhang 已提交
1465
    This operator clip all elements in input into the range [ min, max ] and return
1466 1467 1468 1469
    a resulting tensor as the following equation:

    .. math::

1470
        Out = MIN(MAX(x, min), max)
1471 1472

    Args:
Y
Yang Zhang 已提交
1473 1474
        x (Tensor): An N-D Tensor with data type float32 or float64.
        min (float32|Tensor): The lower bound with type ``float32`` or a ``Tensor``
1475
            with shape [1] and type ``int32``, ``float32``, ``float64``.
Y
Yang Zhang 已提交
1476
        max (float32|Tensor): The upper bound with type ``float32`` or a ``Tensor``
1477 1478 1479 1480 1481 1482
            with shape [1] and type ``int32``, ``float32``, ``float64``.
        name (str, optional): The default value is None. Normally there is no
            need for user to set this property. For more information, please
            refer to :ref:`api_guide_Name`.

    Returns:
Y
Yang Zhang 已提交
1483
        Tensor: A Tensor with the same data type and data shape as input.
1484 1485 1486 1487 1488

    Examples:
        .. code-block:: python

            import paddle
1489
            x1 = paddle.to_tensor([[1.2, 3.5], [4.5, 6.4]], 'float32')
Y
Yang Zhang 已提交
1490 1491
            out1 = paddle.clip(x1, min=3.5, max=5.0)
            out2 = paddle.clip(x1, min=2.5)
1492
            print(out1)
Y
Yang Zhang 已提交
1493 1494
            # [[3.5, 3.5]
            # [4.5, 5.0]]
1495
            print(out2)
Y
Yang Zhang 已提交
1496 1497
            # [[2.5, 3.5]
            # [[4.5, 6.4]
1498 1499
    """

Y
Yang Zhang 已提交
1500 1501
    fmin = float(np.finfo(np.float32).min)
    fmax = float(np.finfo(np.float32).max)
1502

W
WuHaobo 已提交
1503
    if in_dygraph_mode():
1504 1505 1506 1507
        if isinstance(min, Variable):
            min = min.numpy().item(0)
        if isinstance(max, Variable):
            max = max.numpy().item(0)
Y
Yang Zhang 已提交
1508 1509
        min = fmin if min is None else min
        max = fmax if max is None else max
Y
Yang Zhang 已提交
1510
        return core.ops.clip(x, "min", min, "max", max)
W
WuHaobo 已提交
1511

1512
    if min is not None:
Y
Yang Zhang 已提交
1513
        check_type(min, 'min', (float, int, Variable), 'clip')
1514 1515
        if isinstance(min, Variable):
            check_dtype(min.dtype, 'min', ['float32', 'float64', 'int32'],
Y
Yang Zhang 已提交
1516
                        'clip', '(When the type of min in clip is Variable.)')
1517
    if max is not None:
Y
Yang Zhang 已提交
1518
        check_type(max, 'max', (float, int, Variable), 'clip')
1519 1520
        if isinstance(max, Variable):
            check_dtype(max.dtype, 'max', ['float32', 'float64', 'int32'],
Y
Yang Zhang 已提交
1521
                        'clip', '(When the type of max in clip is Variable.)')
1522

Y
Yang Zhang 已提交
1523
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'clip')
Y
Yang Zhang 已提交
1524 1525

    inputs = {'X': x}
Y
Yang Zhang 已提交
1526
    attrs = {'min': fmin, 'max': fmax}
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539

    if isinstance(min, Variable):
        min.stop_gradient = True
        inputs['Min'] = min
    elif min is not None:
        attrs['min'] = min

    if isinstance(max, Variable):
        max.stop_gradient = True
        inputs['Max'] = max
    elif max is not None:
        attrs['max'] = max

Y
Yang Zhang 已提交
1540
    helper = LayerHelper('clip', **locals())
W
WuHaobo 已提交
1541
    output = helper.create_variable_for_type_inference(
Y
Yang Zhang 已提交
1542
        dtype=helper.input_dtype('x'))
1543 1544 1545 1546
    helper.append_op(
        type='clip', inputs=inputs, outputs={'Out': [output]}, attrs=attrs)

    return output
F
Feiyu Chan 已提交
1547

W
WuHaobo 已提交
1548

1549
def trace(x, offset=0, axis1=0, axis2=1, name=None):
L
Li Fuchen 已提交
1550
    """
1551
    **trace**
S
swtkiwi 已提交
1552

1553
    This OP computes the sum along diagonals of the input tensor x.
1554 1555

    If ``x`` is 2D, returns the sum of diagonal.
L
Li Fuchen 已提交
1556

1557
    If ``x`` has larger dimensions, then returns an tensor of diagonals sum, diagonals be taken from
1558
    the 2D planes specified by axis1 and axis2. By default, the 2D planes formed by the first and second axes
1559
    of the input tensor x.
L
Li Fuchen 已提交
1560

1561
    The argument ``offset`` determines where diagonals are taken from input tensor x:
L
Li Fuchen 已提交
1562 1563 1564 1565

    - If offset = 0, it is the main diagonal.
    - If offset > 0, it is above the main diagonal.
    - If offset < 0, it is below the main diagonal.
1566
    - Note that if offset is out of input's shape indicated by axis1 and axis2, 0 will be returned.
1567

L
Li Fuchen 已提交
1568
    Args:
1569
        x(Tensor): The input tensor x. Must be at least 2-dimensional. The input data type should be float32, float64, int32, int64.
1570 1571 1572
        offset(int, optional): Which diagonals in input tensor x will be taken. Default: 0 (main diagonals).
        axis1(int, optional): The first axis with respect to take diagonal. Default: 0.
        axis2(int, optional): The second axis with respect to take diagonal. Default: 1.
L
Li Fuchen 已提交
1573 1574 1575
        name (str, optional): Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`. Default: None.

    Returns:
1576
        Tensor: the output data type is the same as input data type.
L
Li Fuchen 已提交
1577 1578 1579 1580 1581

    Examples:
        .. code-block:: python

            import paddle
1582

1583 1584 1585
            case1 = paddle.randn([2, 3])
            case2 = paddle.randn([3, 10, 10])
            case3 = paddle.randn([3, 10, 5, 10])
1586 1587 1588
            data1 = paddle.trace(case1) # data1.shape = [1]
            data2 = paddle.trace(case2, offset=1, axis1=1, axis2=2) # data2.shape = [3]
            data3 = paddle.trace(case3, offset=-3, axis1=1, axis2=-1) # data2.shape = [3, 5]
L
Li Fuchen 已提交
1589
    """
1590 1591
    inputs = {'Input': [x]}
    attrs = {'offset': offset, 'axis1': axis1, 'axis2': axis2}
L
Li Fuchen 已提交
1592 1593

    def __check_input(input, offset, dim1, dim2):
1594
        check_dtype(x.dtype, 'Input',
L
Li Fuchen 已提交
1595 1596 1597
                    ['int32', 'int64', 'float16', 'float32', 'float64'],
                    'trace')

1598
        input_shape = list(x.shape)
L
Li Fuchen 已提交
1599
        assert len(input_shape) >= 2,                     \
1600 1601
                "The x must be at least 2-dimensional, "   \
                "But received Input x's dimensional: %s.\n" %  \
L
Li Fuchen 已提交
1602 1603
                len(input_shape)

1604 1605
        axis1_ = axis1 if axis1 >= 0 else len(input_shape) + axis1
        axis2_ = axis2 if axis2 >= 0 else len(input_shape) + axis2
L
Li Fuchen 已提交
1606

1607 1608 1609
        assert axis1_ < len(input_shape),     \
            "The argument axis1 is out of range (expected to be in range of [%d, %d], but got %d).\n"  \
            % (-(len(input_shape)), len(input_shape) - 1, axis1)
L
Li Fuchen 已提交
1610

1611 1612 1613
        assert axis2_ < len(input_shape),   \
            "The argument axis2 is out of range (expected to be in range of [%d, %d], but got %d).\n"   \
            % (-(len(input_shape)), len(input_shape) - 1, axis2)
L
Li Fuchen 已提交
1614 1615


1616 1617 1618
        assert  axis1_ != axis2_,   \
               "axis1 and axis2 cannot be the same axis." \
                "But received axis1 = %d, axis2 = %d\n"%(axis1, axis2)
L
Li Fuchen 已提交
1619

1620 1621 1622
    if in_dygraph_mode():
        return core.ops.trace(x, 'offset', offset, 'axis1', axis1, 'axis2', axis2)

L
Li Fuchen 已提交
1623
    if not in_dygraph_mode():
1624
        __check_input(input, offset, axis1, axis2)
L
Li Fuchen 已提交
1625 1626
    helper = LayerHelper('trace', **locals())

1627
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
L
Li Fuchen 已提交
1628 1629 1630

    helper.append_op(
        type='trace',
1631
        inputs={'Input': [x]},
L
Li Fuchen 已提交
1632
        attrs={'offset': offset,
1633 1634
               'axis1': axis1,
               'axis2': axis2},
L
Li Fuchen 已提交
1635 1636 1637
        outputs={'Out': [out]})
    return out

F
Feiyu Chan 已提交
1638
@templatedoc(op_type="kron")
W
WuHaobo 已提交
1639
def kron(x, y, name=None):
S
swtkiwi 已提交
1640
    """
1641 1642
	:alias_main: paddle.kron
	:alias: paddle.kron,paddle.tensor.kron,paddle.tensor.math.kron
S
swtkiwi 已提交
1643 1644

${comment}
F
Feiyu Chan 已提交
1645 1646

    Args:
1647
        x (Variable): the fist operand of kron op, data type: float16, float32,
F
Feiyu Chan 已提交
1648
            float64, int32 or int64.
1649 1650
        y (Variable): the second operand of kron op, data type: float16,
            float32, float64, int32 or int64. Its data type should be the same
F
Feiyu Chan 已提交
1651
            with x.
1652 1653
        name(str, optional): The default value is None.  Normally there is no
            need for user to set this property.  For more information, please
F
Feiyu Chan 已提交
1654 1655 1656 1657 1658 1659 1660
            refer to :ref:`api_guide_Name`.

    Returns:
        Variable: The output of kron op, data type: float16, float32, float64, int32 or int64. Its data is the same with x.

    Examples:
        .. code-block:: python
1661

F
Feiyu Chan 已提交
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
          import paddle
          from paddle import fluid
          import paddle.fluid.dygraph as dg
          import numpy as np

          a = np.arange(1, 5).reshape(2, 2).astype(np.float32)
          b = np.arange(1, 10).reshape(3, 3).astype(np.float32)

          place = fluid.CPUPlace()
          with dg.guard(place):
              a_var = dg.to_variable(a)
              b_var = dg.to_variable(b)
              c_var = paddle.kron(a_var, b_var)
              c_np = c_var.numpy()
          print(c_np)

          #[[ 1.  2.  3.  2.  4.  6.]
          # [ 4.  5.  6.  8. 10. 12.]
          # [ 7.  8.  9. 14. 16. 18.]
          # [ 3.  6.  9.  4.  8. 12.]
          # [12. 15. 18. 16. 20. 24.]
          # [21. 24. 27. 28. 32. 36.]]
    """
    if in_dygraph_mode():
        return core.ops.kron(x, y)

    helper = LayerHelper('kron', **locals())
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], 'kron')
    check_variable_and_dtype(y, 'y', ['float16', 'float32', 'float64', 'int32', 'int64'], 'kron')

W
WuHaobo 已提交
1692
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
F
Feiyu Chan 已提交
1693 1694
    helper.append_op(type="kron", inputs={"X": x, "Y": y}, outputs={"Out": out})
    return out
1695 1696 1697 1698


def cumsum(x, axis=None, dtype=None, name=None):
    """
1699 1700 1701 1702
    The cumulative sum of the elements along a given axis. 
    
    **Note**:
    The first element of the result is the same of the first element of the input. 
1703 1704

    Args:
1705
        x (Tensor): The input tensor needed to be cumsumed.
1706 1707 1708 1709 1710
        axis (int, optional): The dimension to accumulate along. -1 means the last dimension. The default (None) is to compute the cumsum over the flattened array.
        dtype (str, optional): The data type of the output tensor, can be float32, float64, int32, int64. If specified, the input tensor is casted to dtype before the operation is performed. This is useful for preventing data type overflows. The default value is None. 
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
1711
        Tensor, the result of cumsum operator. 
1712 1713 1714 1715 1716

    Examples:
        .. code-block:: python
            
            import paddle
1717 1718 1719
            
            data = paddle.arange(12)
            data = paddle.reshape(data, (3, 4))
1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758

            y = paddle.cumsum(data)
            # [ 0  1  3  6 10 15 21 28 36 45 55 66]

            y = paddle.cumsum(data, axis=0)
            # [[ 0  1  2  3]
            #  [ 4  6  8 10]
            #  [12 15 18 21]]
            
            y = paddle.cumsum(data, axis=-1)
            # [[ 0  1  3  6]
            #  [ 4  9 15 22]
            #  [ 8 17 27 38]]

            y = paddle.cumsum(data, dtype='float64')
            print(y.dtype)
            # VarType.FP64
    """
    if axis is None:
        flatten = True
    else:
        flatten = False
    if dtype is not None and x.dtype != convert_np_dtype_to_dtype_(dtype):
        x = layers.cast(x, dtype)

    if in_dygraph_mode():
        if axis is None:
            return core.ops.cumsum(x, 'flatten', flatten)
        else:
            return core.ops.cumsum(x, 'axis', axis, 'flatten', flatten)

    check_type(x, 'x', (Variable), 'cumsum')
    locals_var = locals().copy()
    kwargs = dict()
    for name, val in locals_var.items():
        if val is not None:
            kwargs[name] = val
    _cum_sum_ = generate_layer_fn('cumsum')
    return _cum_sum_(**kwargs)
G
guofei 已提交
1759

J
Jack Zhou 已提交
1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
def isfinite(x, name=None):
    """

    Return whether every element of input tensor is finite number or not.

    Args:
        x (Tensor): The input tensor, it's data type should be float16, float32, float64, 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 bool result which shows every element of `x` whether it is finite number or not.

    Examples:
        .. code-block:: python

            import paddle
            paddle.disable_static()
1777
            x = paddle.to_tensor([float('-inf'), -2, 3.6, float('inf'), 0, float('-nan'), float('nan')])
J
Jack Zhou 已提交
1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
            out = paddle.tensor.isfinite(x)
            print(out.numpy())  # [False  True  True False  True False False]
    """
    if in_dygraph_mode():
        return core.ops.isfinite_v2(x)
    helper = LayerHelper("isfinite_v2", **locals())
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], 'isfinite')
    out = helper.create_variable_for_type_inference('bool')
    helper.append_op(type="isfinite_v2", inputs={"X": x}, outputs={"Out": out})
    return out

def isinf(x, name=None):
    """

    Return whether every element of input tensor is `+/-INF` or not.

    Args:
        x (Tensor): The input tensor, it's data type should be float16, float32, float64, 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 bool result which shows every element of `x` whether it is `+/-INF` or not.

    Examples:
        .. code-block:: python

            import paddle
            paddle.disable_static()
1806
            x = paddle.to_tensor([float('-inf'), -2, 3.6, float('inf'), 0, float('-nan'), float('nan')])
J
Jack Zhou 已提交
1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834
            out = paddle.tensor.isinf(x)
            print(out.numpy())  # [ True False False  True False False False]
    """
    if in_dygraph_mode():
        return core.ops.isinf_v2(x)
    helper = LayerHelper("isinf_v2", **locals())
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], 'isinf')
    out = helper.create_variable_for_type_inference(dtype='bool')
    helper.append_op(type="isinf_v2", inputs={"X": x}, outputs={"Out": out})
    return out

def isnan(x, name=None):
    """

    Return whether every element of input tensor is `NaN` or not.

    Args:
        x (Tensor): The input tensor, it's data type should be float16, float32, float64, 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 bool result which shows every element of `x` whether it is `NaN` or not.

    Examples:
        .. code-block:: python

            import paddle
            paddle.disable_static()
1835
            x = paddle.to_tensor([float('-inf'), -2, 3.6, float('inf'), 0, float('-nan'), float('nan')])
J
Jack Zhou 已提交
1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
            out = paddle.tensor.isnan(x)
            print(out.numpy())  # [False False False False False  True  True]
    """
    if in_dygraph_mode():
        return core.ops.isnan_v2(x)
    helper = LayerHelper("isnan_v2", **locals())
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], 'isnan')
    out = helper.create_variable_for_type_inference(dtype='bool')
    helper.append_op(type="isnan_v2", inputs={"X": x}, outputs={"Out": out})
    return out


G
guofei 已提交
1848 1849 1850 1851 1852
def prod(x, axis=None, keepdim=False, dtype=None, name=None):
    """
    Compute the product of tensor elements over the given axis.

    Args:
1853
        x(Tensor): The input tensor, its data type should be float32, float64, int32, int64.
G
guofei 已提交
1854 1855 1856 1857 1858 1859 1860 1861 1862
        axis(int|list|tuple, optional): The axis along which the product is computed. If :attr:`None`, 
            multiply all elements of `x` and return a Tensor with a single element, 
            otherwise must be in the range :math:`[-x.ndim, x.ndim)`. If :math:`axis[i]<0`, 
            the axis to reduce is :math:`x.ndim + axis[i]`. Default is None.
        dtype(str|np.dtype, optional): The desired date type of returned tensor, can be float32, float64, 
            int32, int64. If specified, the input tensor is casted to dtype before operator performed. 
            This is very useful for avoiding data type overflows. The default value is None, the dtype 
            of output is the same as input Tensor `x`.
        keepdim(bool, optional): Whether to reserve the reduced dimension in the output Tensor. The result 
1863
            tensor will have one fewer dimension than the input unless `keepdim` is true. Default is False.
G
guofei 已提交
1864 1865 1866 1867 1868 1869 1870 1871 1872
        name(string, optional): The default value is None. Normally there is no need for user to set this property.
            For more information, please refer to :ref:`api_guide_Name` .

    Returns:
        Tensor, result of product on the specified dim of input tensor.

    Raises:
        ValueError: The :attr:`dtype` must be float32, float64, int32 or int64.
        TypeError: The type of :attr:`axis` must be int, list or tuple.
J
Jack Zhou 已提交
1873
    
G
guofei 已提交
1874 1875 1876 1877 1878 1879
    Examples:
        .. code-block:: python

            import paddle

            # the axis is a int element
1880 1881
            x = paddle.to_tensor([[0.2, 0.3, 0.5, 0.9],
                                  [0.1, 0.2, 0.6, 0.7]])
G
guofei 已提交
1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
            out1 = paddle.prod(x)
            # [0.0002268]

            out2 = paddle.prod(x, -1)
            # [0.027  0.0084]

            out3 = paddle.prod(x, 0)
            # [0.02 0.06 0.3  0.63]

            out4 = paddle.prod(x, 0, keepdim=True)
            # [[0.02 0.06 0.3  0.63]]

            out5 = paddle.prod(x, 0, dtype='int64')
            # [0 0 0 0]

            # the axis is list
1898 1899
            y = paddle.to_tensor([[[1.0, 2.0], [3.0, 4.0]],
                                  [[5.0, 6.0], [7.0, 8.0]]])
G
guofei 已提交
1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
            out6 = paddle.prod(y, [0, 1])
            # [105. 384.]

            out7 = paddle.prod(y, (1, 2))
            # [  24. 1680.]

    """
    if dtype is not None:
        check_dtype(dtype, 'dtype', ['float32', 'float64', 'int32', 'int64'], 'prod')
        if x.dtype != convert_np_dtype_to_dtype_(dtype):
            x = layers.cast(x, dtype)

    return layers.reduce_prod(input=x, dim=axis, keep_dim=keepdim, name=name)
W
WangXi 已提交
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932


def sign(x, name=None):
    """
    This OP returns sign of every element in `x`: 1 for positive, -1 for negative and 0 for zero.

    Args:
        x(Tensor): The input tensor. The data type can be float16, float32 or float64.
        name (str, optional): The default value is None. Normally there is no need for user to
            set this property. For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor: The output sign tensor with identical shape and data type to the input :attr:`x`.

    Examples:
        .. code-block:: python

          import paddle

          paddle.disable_static()
1933
          x = paddle.to_tensor([3.0, 0.0, -2.0, 1.7], dtype='float32')
W
WangXi 已提交
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949
          out = paddle.sign(x=x)
          print(out)  # [1.0, 0.0, -1.0, 1.0]
    """
    if in_dygraph_mode():
        return core.ops.sign(x)

    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'sign')
    helper = LayerHelper("sign", **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)

    helper.append_op(type='sign', inputs={'X': [x]}, outputs={'Out': [out]})

    return out


def tanh(x, name=None):
1950
    r"""
W
WangXi 已提交
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
    Tanh Activation Operator.

    .. math::
        out = \\frac{e^{x} - e^{-x}}{e^{x} + e^{-x}}

    Args:
        x (Tensor): Input of Tanh operator, an N-D Tensor, with data type float32, float64 or float16.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        Output of Tanh operator, a Tensor with same data type and shape as input.

    Examples:

        .. code-block:: python

            import paddle

            paddle.disable_static()
1970
            x = paddle.to_tensor([-0.4, -0.2, 0.1, 0.3])
W
WangXi 已提交
1971 1972 1973 1974 1975 1976 1977 1978
            out = paddle.tanh(x)
            print(out.numpy())
            # [-0.37994896 -0.19737532  0.09966799  0.29131261]
    """
    if in_dygraph_mode():
        return core.ops.tanh(x)

    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'tanh')
S
ShenLiang 已提交
1979
    check_type(x, 'x', (Variable), 'tanh')
W
WangXi 已提交
1980 1981 1982 1983
    helper = LayerHelper('tanh', **locals())
    out = helper.create_variable_for_type_inference(x.dtype)
    helper.append_op(type='tanh', inputs={'X': x}, outputs={'Out': out})
    return out
S
Steffy-zxf 已提交
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019

def increment(x, value=1.0, name=None):
    """
    The OP is usually used for control flow to increment the data of :attr:`x` by an amount :attr:`value`.
    Notice that the number of elements in :attr:`x` must be equal to 1.

    Args:
        x (Tensor): A tensor that must always contain only one element, its data type supports float32, float64, int32 and int64.
        value(float, optional): The amount to increment the data of :attr:`x`. Default: 1.0.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.

    Returns:
        Tensor, the elementwise-incremented tensor with the same shape and data type as :attr:`x`.

    Examples:
        .. code-block:: python

            import paddle

            data = paddle.zeros(shape=[1], dtype='float32')
            counter = paddle.increment(data)
            # [1.]

    """
    if in_dygraph_mode():
        return core.ops.increment(x, 'step', value)

    check_variable_and_dtype(x, 'x', ['float32', 'float64', 'int32', 'int64'],
                             'increment')
    helper = LayerHelper("increment", **locals())
    helper.append_op(
        type='increment',
        inputs={'X': [x]},
        outputs={'Out': [x]},
        attrs={'step': float(value)})
    return x
2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217


def all(x, axis=None, keepdim=False, name=None):
    """
    Computes the the ``logical and`` of tensor elements over the given dimension.

    Args:
        x (Tensor): An N-D Tensor, the input data type should be `bool`.
        axis (int|list|tuple, optional): The dimensions along which the ``logical and`` is compute. If
            :attr:`None`, and all elements of :attr:`x` and return a
            Tensor variable with a single element, otherwise must be in the
            range :math:`[-rank(x), rank(x))`. If :math:`axis[i] < 0`,
            the dimension to reduce is :math:`rank + axis[i]`.
        keepdim (bool, optional): Whether to reserve the reduced dimension in the
            output Tensor. The result Tensor will have one fewer dimension
            than the :attr:`x` unless :attr:`keepdim` is true, default
            value is False.
        name (str, optional): The default value is None. Normally there is no need for
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor: Results the ``logical and`` on the specified axis of input Tensor `x`,  it's data type is bool.

    Raises:
        ValueError: If the data type of `x` is not bool.
        TypeError: The type of :attr:`axis` must be int, list or tuple.

    Examples:
        .. code-block:: python

            import paddle
            import paddle.fluid as fluid
            import paddle.fluid.layers as layers
            import numpy as np
            
            # set as static mode
            paddle.disable_static()
            
            # x is a bool Tensor variable with following elements:
            #    [[True, False]
            #     [True, True]]
            x = layers.assign(np.array([[1, 0], [1, 1]], dtype='int32'))
            print(x)
            x = layers.cast(x, 'bool')
            
            # out1 should be [False]
            out1 = paddle.all(x)  # [False]
            print(out1)
            
            # out2 should be [True, False]
            out2 = paddle.all(x, axis=0)  # [True, False]
            print(out2)
            
            # keep_dim=False, out3 should be [False, True], out.shape should be (2,)
            out3 = paddle.all(x, axis=-1)  # [False, True]
            print(out3)
            
            # keep_dim=True, out4 should be [[False], [True]], out.shape should be (2,1)
            out4 = paddle.all(x, axis=1, keep_dim=True)
            out4 = layers.cast(out4, 'int32')  # [[False], [True]]
            print(out4)
            
    """
    if axis is not None and not isinstance(axis, (list, tuple)):
        axis = [axis]

    if not axis:
        reduce_all_flag = True
    else:
        if len(axis) == len(x.shape):
            reduce_all_flag = True
        else:
            reduce_all_flag = False

    attrs = {
        'dim': axis if axis != None and axis != [] and axis != () else [0],
        'keep_dim': keepdim,
        'reduce_all': reduce_all_flag
    }
    dtype_flag = False


    if in_dygraph_mode():
        axis = axis if axis != None and axis != [] else [0]
        return core.ops.reduce_all(x, 'dim', axis, 'keep_dim', keepdim,
                                       'reduce_all', reduce_all_flag)
    check_variable_and_dtype(x, 'x', ['bool'], 'all')


    check_type(axis, 'axis', (int, list, tuple, type(None)), 'all')

    helper = LayerHelper('all', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(
        type='reduce_all',
        inputs={'X': x},
        outputs={'Out': out},
        attrs=attrs)
    return out


def any(x, axis=None, keepdim=False, name=None):
    """
    Computes the the ``logical or`` of tensor elements over the given dimension.

    Args:
        x (Tensor): An N-D Tensor, the input data type should be `bool`.
        axis (int|list|tuple, optional): The dimensions along which the ``logical or`` is compute. If
            :attr:`None`, and all elements of :attr:`x` and return a
            Tensor variable with a single element, otherwise must be in the
            range :math:`[-rank(x), rank(x))`. If :math:`axis[i] < 0`,
            the dimension to reduce is :math:`rank + axis[i]`.
        keepdim (bool, optional): Whether to reserve the reduced dimension in the
            output Tensor. The result Tensor will have one fewer dimension
            than the :attr:`x` unless :attr:`keepdim` is true, default
            value is False.
        name (str, optional): The default value is None. Normally there is no need for
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`

    Returns:
        Tensor: Results the ``logical or`` on the specified axis of input Tensor `x`,  it's data type is bool.

    Raises:
        ValueError: If the data type of `x` is not bool.
        TypeError: The type of :attr:`axis` must be int, list or tuple.

    Examples:
        .. code-block:: python

            import paddle
            import paddle.fluid as fluid
            import paddle.fluid.layers as layers
            import numpy as np
            
            # set as static mode
            paddle.disable_static()
            
            # x is a bool Tensor variable with following elements:
            #    [[True, False]
            #     [False, False]]
            x = layers.assign(np.array([[1, 0], [1, 1]], dtype='int32'))
            print(x)
            x = layers.cast(x, 'bool')
            
            # out1 should be [True]
            out1 = paddle.any(x)  # [True]
            print(out1)
            
            # out2 should be [True, False]
            out2 = paddle.any(x, axis=0)  # [True, False]
            print(out2)
            
            # keep_dim=False, out3 should be [True, False], out.shape should be (2,)
            out3 = paddle.any(x, axis=-1)  # [True, False]
            print(out3)
            
            # keep_dim=True, result should be [[True], [False]], out.shape should be (2,1)
            out4 = paddle.any(x, axis=1, keep_dim=True)
            out4 = layers.cast(out4, 'int32')  # [[True], [False]]
            print(out4)
            
    """
    if axis is not None and not isinstance(axis, (list, tuple)):
        axis = [axis]

    if not axis:
        reduce_all_flag = True
    else:
        if len(axis) == len(x.shape):
            reduce_all_flag = True
        else:
            reduce_all_flag = False

    attrs = {
        'dim': axis if axis != None and axis != [] and axis != () else [0],
        'keep_dim': keepdim,
        'reduce_all': reduce_all_flag
    }
    dtype_flag = False


    if in_dygraph_mode():
        axis = axis if axis != None and axis != [] else [0]
        return core.ops.reduce_any(x, 'dim', axis, 'keep_dim', keepdim,
                                       'reduce_all', reduce_all_flag)
    check_variable_and_dtype(x, 'x', ['bool'], 'any')


    check_type(axis, 'axis', (int, list, tuple, type(None)), 'any')

    helper = LayerHelper('any', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(
        type='reduce_any',
        inputs={'X': x},
        outputs={'Out': out},
        attrs=attrs)
    return out
L
Leo Chen 已提交
2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244

def broadcast_shape(x_shape, y_shape):
    """
    The function returns the shape of doing operation with broadcasting on tensors of x_shape and y_shape, please refer to :ref:`user_guide_broadcasting` for more details.

    Args:
        x_shape (list[int]|tuple[int]): A shape of tensor.
        y_shape (list[int]|tuple[int]): A shape of tensor.
        

    Returns:
        list[int], the result shape.

    Examples:
        .. code-block:: python

            import paddle

            shape = paddle.broadcast_shape([2, 1, 3], [1, 3, 1])
            # [2, 3, 3]
            
            # shape = paddle.broadcast_shape([2, 1, 3], [3, 3, 1])
            # ValueError (terminated with error message).

    """

    return core.broadcast_shape(x_shape, y_shape)