creation.py 82.5 KB
Newer Older
1
#   Copyright (c) 2022 PaddlePaddle Authors. All Rights Reserved.
2 3 4 5 6 7 8 9 10 11 12 13 14
#
# 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.

15 16
# TODO: define functions to get create a tensor

17
import math
18
import re
19 20 21 22 23 24
import warnings

import numpy as np

import paddle
from paddle import _C_ops, _legacy_C_ops
25
from paddle.common_ops_import import fill_constant
26

27 28
from ..fluid.data_feeder import (
    check_dtype,
29 30
    check_type,
    check_variable_and_dtype,
31 32 33
    convert_dtype,
)
from ..fluid.framework import (
34
    Variable,
35
    _in_eager_without_dygraph_check,
36
    device_guard,
37
)
38
from ..fluid.initializer import Constant, Initializer
39
from ..fluid.layers import utils
40
from ..fluid.param_attr import ParamAttr
41 42 43 44 45 46 47 48
from ..framework import (
    LayerHelper,
    _current_expected_place,
    _get_paddle_place,
    convert_np_dtype_to_dtype_,
    core,
    in_dygraph_mode,
)
49

50 51
__all__ = []

W
wangchaochaohu 已提交
52

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
def _complex_to_real_dtype(dtype):
    if dtype == core.VarDesc.VarType.COMPLEX64:
        return core.VarDesc.VarType.FP32
    elif dtype == core.VarDesc.VarType.COMPLEX128:
        return core.VarDesc.VarType.FP64
    else:
        return dtype


def _real_to_complex_dtype(dtype):
    if dtype == core.VarDesc.VarType.FP32:
        return core.VarDesc.VarType.COMPLEX64
    elif dtype == core.VarDesc.VarType.FP64:
        return core.VarDesc.VarType.COMPLEX128
    else:
        return dtype


71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
def create_global_var(
    shape, value, dtype, persistable=False, force_cpu=False, name=None
):
    """
    This function creates a new tensor variable with value in the global block(block 0).

    Args:
        shape (list[int]|tuple[int]): Shape of the variable
        value (float): The value of the variable. The new created
                      variable will be filled with it.
        dtype (str): Data type of the variable
        persistable (bool, optional): If this variable is persistable.
                           Default: False
        force_cpu (bool, optional): Force this variable to be on CPU.
                         Default: False
        name (str, optional): For detailed information, please refer to
           :ref:`api_guide_Name` . Usually name is no need to set and None by default.

    Returns:
        Variable: The created Variable

    Examples:
        .. code-block:: python

            import paddle
            paddle.enable_static()
            var = paddle.static.create_global_var(shape=[2,3], value=1.0, dtype='float32',
                                           persistable=True, force_cpu=True, name='new_var')
    """
    check_type(shape, 'shape', (list, tuple, np.ndarray), 'create_global_var')
    for item in shape:
        check_type(
            item,
            'item of shape',
            (
                int,
                np.uint8,
                np.int8,
                np.int16,
                np.int32,
                np.int64,
            ),
            'create_global_var',
        )

    check_dtype(
        dtype,
        'dtype',
        [
            'bool',
            'float16',
            'float32',
            'float64',
            'int8',
            'int16',
            'int32',
            'int64',
            'uint8',
            'uint16',
        ],
        'create_global_var',
    )

    helper = LayerHelper("global_var", **locals())
    var = helper.create_global_variable(
        dtype=dtype,
        shape=shape,
        persistable=persistable,
        name=name,
        stop_gradient=True,
    )
    helper.set_variable_initializer(
        var, initializer=Constant(value=float(value), force_cpu=force_cpu)
    )

    return var


149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
def create_parameter(
    shape, dtype, name=None, attr=None, is_bias=False, default_initializer=None
):
    """
    This function creates a parameter. The parameter is a learnable variable, which can have
    gradient, and can be optimized.

    Note:
        This is a very low-level API. This API is useful when you create operator by your self, instead of using layers.

    Args:
        shape (list of int): Shape of the parameter
        dtype (str): Data type of the parameter
        name (str, optional): For detailed information, please refer to
           :ref:`api_guide_Name` . Usually name is no need to set and None by default.
        attr (ParamAttr, optional): Attributes of the parameter
        is_bias (bool, optional): This can affect which default initializer is chosen
                       when default_initializer is None. If is_bias,
                       initializer.Constant(0.0) will be used. Otherwise,
                       Xavier() will be used.
        default_initializer (Initializer, optional): Initializer for the parameter

    Returns:
        The created parameter.

    Examples:
        .. code-block:: python

            import paddle
            paddle.enable_static()
179
            W = paddle.create_parameter(shape=[784, 200], dtype='float32')
180 181 182 183 184 185 186 187 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 222 223 224 225 226 227 228
    """
    check_type(shape, 'shape', (list, tuple, np.ndarray), 'create_parameter')
    for item in shape:
        check_type(
            item,
            'item of shape',
            (
                int,
                np.uint8,
                np.int8,
                np.int16,
                np.int32,
                np.int64,
            ),
            'create_parameter',
        )

    check_dtype(
        dtype,
        'dtype',
        [
            'bool',
            'float16',
            'float32',
            'float64',
            'int8',
            'int16',
            'int32',
            'int64',
            'uint8',
        ],
        'create_parameter',
    )
    check_type(attr, 'attr', (type(None), ParamAttr), 'create_parameter')
    check_type(
        default_initializer,
        'default_initializer',
        (type(None), Initializer),
        'create_parameter',
    )

    helper = LayerHelper("create_parameter", **locals())
    if attr is None:
        attr = ParamAttr(name=name)
    return helper.create_parameter(
        attr, shape, convert_dtype(dtype), is_bias, default_initializer
    )


229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
def create_tensor(dtype, name=None, persistable=False):
    """
    Create a variable, which will hold a Tensor with data type dtype.

    Args:
        dtype(string|numpy.dtype): the data type of Tensor to be created, the
            data type is bool, float16, float32, float64, int8, int16, int32 and int64.
        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`
        persistable(bool): Set the persistable flag of the create tensor.
            default value is False.

    Returns:
        Variable: The tensor to be created according to dtype.

    Examples:
        .. code-block:: python

          import paddle
          tensor = paddle.tensor.create_tensor(dtype='float32')
    """
    check_dtype(
        dtype,
        'dtype',
        [
            'bool',
            'float16',
            'float32',
            'float64',
            'int8',
            'int32',
            'int32',
            'int64',
        ],
        'create_tensor',
    )
    helper = LayerHelper("create_tensor", **locals())
    return helper.create_variable(
        name=helper.name, dtype=dtype, persistable=persistable
    )


271 272
def linspace(start, stop, num, dtype=None, name=None):
    r"""
L
LoneRanger 已提交
273
    Return fixed number of evenly spaced values within a given interval. Note: no gradient calculation is performed.
274 275

    Args:
276 277
        start(int|float|Tensor): The input :attr:`start` is start of range. It is a int, float, \
            or a 0-D Tensor with data type int32, int64, float32 or float64.
L
LoneRanger 已提交
278
        stop(int|float|Tensor): The input :attr:`stop` is end of range. It is a int, float, \
279 280 281
            or a 0-D Tensor with data type int32, int64, float32 or float64.
        num(int|Tensor): The input :attr:`num` is given num of the sequence. It is an int, \
            or a 0-D Tensor with data type int32.
282 283
        dtype(np.dtype|str, optional): The data type of output tensor, it could be
            int32, int64, float32 and float64. Default: if None, the data type is float32.
284
        name(str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
285 286 287 288

    Returns:
        Tensor: the output data type will be float32, float64. The 1-D tensor with fixed number of evenly spaced values, \
        the data shape of this tensor is :math:`[num]` . If the :attr:`num` is set 1, the output tensor just has \
289
        the value with input :attr:`start`.
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309

    Examples:
        .. code-block:: python

             import paddle
             data = paddle.linspace(0, 10, 5, 'float32') # [0.0,  2.5,  5.0,  7.5, 10.0]
             data = paddle.linspace(0, 10, 1, 'float32') # [0.0]

    """
    if dtype is None:
        dtype = 'float32'
    tensor_num = num
    tensor_start = start
    tensor_stop = stop
    if not isinstance(num, Variable):
        check_type(num, 'num', (int), 'linspace')
    if not isinstance(dtype, core.VarDesc.VarType):
        dtype = convert_np_dtype_to_dtype_(dtype)
    if not isinstance(start, Variable):
        with device_guard("cpu"):
310
            tensor_start = fill_constant([1], dtype, start, force_cpu=True)
311 312
    if not isinstance(stop, Variable):
        with device_guard("cpu"):
313
            tensor_stop = fill_constant([1], dtype, stop, force_cpu=True)
314 315
    if not isinstance(num, Variable):
        with device_guard("cpu"):
316
            tensor_num = fill_constant([1], 'int32', num, force_cpu=True)
317
    if in_dygraph_mode():
318 319 320 321 322 323 324
        return _C_ops.linspace(
            tensor_start,
            tensor_stop,
            tensor_num,
            dtype,
            _current_expected_place(),
        )
325
    else:
326 327 328 329 330 331 332 333 334 335 336 337 338 339
        helper = LayerHelper("linspace", **locals())

        start_dtype = convert_dtype(tensor_start.dtype)
        stop_dtype = convert_dtype(tensor_stop.dtype)
        out_dtype = convert_dtype(dtype)
        if isinstance(start, Variable):
            check_dtype(
                start.dtype,
                'start',
                ['float32', 'float64', 'int32', 'int64'],
                'linspace',
            )
        else:
            check_type(start, 'start', (int, float), 'linspace')
340

341 342 343 344 345 346 347 348 349 350 351
        if isinstance(stop, Variable):
            check_dtype(
                stop.dtype,
                'stop',
                ['float32', 'float64', 'int32', 'int64'],
                'linspace',
            )
        else:
            check_type(stop, 'stop', (int, float), 'linspace')
        if isinstance(num, Variable):
            check_dtype(num.dtype, 'num', ['int32'], 'linspace')
352
        check_dtype(
353
            dtype, 'dtype', ['int32', 'int64', 'float32', 'float64'], 'linspace'
354
        )
355 356 357 358 359 360 361 362 363 364 365 366
        if (
            (stop_dtype == "float64" or start_dtype == "float64")
            and out_dtype in ["float32", "int32"]
        ) or (
            (stop_dtype == "int64" or start_dtype == "int64")
            and out_dtype == "int32"
        ):
            raise ValueError(
                "The dtype of start/stop is {}/{} but the attr(dtype) of linspace is {}, "
                "which may cause data type overflows. Please reset attr(dtype) of linspace.".format(
                    start_dtype, stop_dtype, dtype
                )
367
            )
368

369
        out = helper.create_variable_for_type_inference(dtype=dtype)
370

371 372 373 374 375 376 377 378 379 380 381 382 383
        helper.append_op(
            type='linspace',
            inputs={
                'Start': tensor_start,
                'Stop': tensor_stop,
                'Num': tensor_num,
            },
            attrs={'dtype': dtype},
            outputs={'Out': [out]},
        )
        if isinstance(num, int):
            out.desc.set_shape((num,))
        return out
384 385


386 387 388 389
def logspace(start, stop, num, base=10.0, dtype=None, name=None):
    r"""
    Return fixed number of logarithmical-evenly spaced values within the interval \
    :math:`[base^{start}, base^{stop}]`.
390

391 392
    Notes:
        This API does not compute the gradient.
393

394 395 396 397 398 399 400 401 402 403 404 405 406 407
    Args:
        start(int|float|Tensor): The input :attr:`start` is exponent of first entry in \
            the sequence. It is a scalar, or a Tensor of shape [1] with input data \
            type int32, int64, float32 or float64.
        stop(int|float|Tensor): The input :attr:`stop` is exponent of last entry in the \
            sequence. It is a scalar, or a Tensor of shape [1] with input data \
            type int32, int64, float32 or float64.
        num(int|Tensor): The input :attr:`num` is given number of items in the sequence. \
            It is an int scalar, or a Tensor of shape [1] with data type int32.
        base(int|float|Tensor): The input :attr:`base` is base of the logarithm function. \
            It is a scalar, or a Tensor of shape [1] with input data type int32, int64, \
            float32 or float64.
        dtype(np.dtype|str, optional): The data type of output tensor, it could be \
            int32, int64, float32 or float64. Default: if None, the data type is float32. \
408
        name(str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
409 410 411 412 413

    Returns:
        Tensor: The output data type will be float32, float64. The 1-D tensor with \
        fixed number of logarithmical-evenly spaced values, the data shape of this \
        tensor is :math:`[num]`. If the :attr:`num` is set 1, the output tensor \
414
        just has the value with exponential of :attr:`start` with base :attr:`base`.
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446

    Examples:
        .. code-block:: python

            import paddle
            data = paddle.logspace(0, 10, 5, 2, 'float32')
            # [1.          , 5.65685415  , 32.         , 181.01933289, 1024.       ]
            data = paddle.logspace(0, 10, 1, 2, 'float32')
            # [1.]
    """
    if dtype is None:
        dtype = 'float32'
    tensor_num = num
    tensor_start = start
    tensor_stop = stop
    tensor_base = base
    if not isinstance(num, Variable):
        check_type(num, 'num', (int), 'logspace')
    if not isinstance(dtype, core.VarDesc.VarType):
        dtype = convert_np_dtype_to_dtype_(dtype)
    if not isinstance(start, Variable):
        with device_guard("cpu"):
            tensor_start = fill_constant([1], dtype, start)
    if not isinstance(stop, Variable):
        with device_guard("cpu"):
            tensor_stop = fill_constant([1], dtype, stop)
    if not isinstance(num, Variable):
        with device_guard("cpu"):
            tensor_num = fill_constant([1], 'int32', num)
    if not isinstance(base, Variable):
        with device_guard("cpu"):
            tensor_base = fill_constant([1], dtype, base)
447
    if in_dygraph_mode():
448 449 450
        return _legacy_C_ops.logspace(
            tensor_start, tensor_stop, tensor_num, tensor_base, 'dtype', dtype
        )
451 452
    else:
        helper = LayerHelper("logspace", **locals())
453

454 455 456 457 458 459 460 461 462 463 464 465 466
        start_dtype = convert_dtype(tensor_start.dtype)
        stop_dtype = convert_dtype(tensor_stop.dtype)
        base_dtype = convert_dtype(tensor_base.dtype)
        out_dtype = convert_dtype(dtype)
        if isinstance(start, Variable):
            check_dtype(
                start.dtype,
                'start',
                ['float32', 'float64', 'int32', 'int64'],
                'logspace',
            )
        else:
            check_type(start, 'start', (int, float), 'logspace')
467

468 469 470 471 472 473 474 475 476
        if isinstance(stop, Variable):
            check_dtype(
                stop.dtype,
                'stop',
                ['float32', 'float64', 'int32', 'int64'],
                'logspace',
            )
        else:
            check_type(stop, 'stop', (int, float), 'logspace')
477

478 479
        if isinstance(num, Variable):
            check_dtype(num.dtype, 'num', ['int32'], 'logspace')
480

481 482 483 484 485 486 487 488 489
        if isinstance(base, Variable):
            check_dtype(
                base.dtype,
                'base',
                ['float32', 'float64', 'int32', 'int64'],
                'logspace',
            )
        else:
            check_type(base, 'base', (int, float), 'logspace')
490

491
        check_dtype(
492
            dtype, 'dtype', ['int32', 'int64', 'float32', 'float64'], 'logspace'
493
        )
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
        if (
            (
                stop_dtype == "float64"
                or start_dtype == "float64"
                or base_dtype == "float64"
            )
            and out_dtype in ["float32", "int32"]
        ) or (
            (
                stop_dtype == "int64"
                or start_dtype == "int64"
                or base_dtype == "int64"
            )
            and out_dtype == "int32"
        ):
            raise ValueError(
                "The dtype of start/stop/base is {}/{}/{} but the attr(dtype) of logspace is {}, "
                "which may cause data type overflows. Please reset attr(dtype) of logspace.".format(
                    start_dtype, stop_dtype, base_dtype, dtype
                )
514
            )
515

516
        out = helper.create_variable_for_type_inference(dtype=dtype)
517

518 519 520 521 522 523 524 525 526 527 528 529 530 531
        helper.append_op(
            type='logspace',
            inputs={
                'Start': tensor_start,
                'Stop': tensor_stop,
                'Num': tensor_num,
                'Base': tensor_base,
            },
            attrs={'dtype': dtype},
            outputs={'Out': [out]},
        )
        if isinstance(num, int):
            out.desc.set_shape((num,))
        return out
532 533


534
def _to_tensor_non_static(data, dtype=None, place=None, stop_gradient=True):
535 536

    if not isinstance(data, np.ndarray):
537

538
        def _handle_dtype(data, dtype):
539 540 541 542 543
            if dtype:
                if convert_dtype(dtype) != convert_dtype(data.dtype):
                    return data.astype(convert_dtype(dtype))
            return data

544 545 546 547
        if np.isscalar(data) and not isinstance(data, str):
            data = np.array([data])
        elif isinstance(data, (list, tuple)):
            data = np.array(data)
548
            if data.dtype == np.object_:
549 550 551 552
                raise ValueError(
                    "\n\tFaild to convert input data to a regular ndarray :\n\t - Usually "
                    "this means the input data contains nested lists with different lengths. "
                )
W
wanghuancoder 已提交
553 554 555 556 557 558
        elif isinstance(data, paddle.Tensor) and not in_dygraph_mode():
            data = data._copy_to(place, False)
            data = _handle_dtype(data, dtype)
            data.stop_gradient = stop_gradient
            return data
        elif isinstance(data, core.eager.Tensor) and in_dygraph_mode():
559
            data = data._copy_to(place, False)
560
            data = _handle_dtype(data, dtype)
561
            data.stop_gradient = stop_gradient
562
            return data
563
        elif isinstance(data, (core.LoDTensor, core.Tensor)):
564
            # should't expose it to users, just for internal use.
565 566
            # convert core.Tensor/core.LoDTensor to VarBase first
            # Currenly, there is no copy when places are same
W
wanghuancoder 已提交
567 568 569 570
            if in_dygraph_mode():
                data = core.eager.Tensor(data)
            else:
                data = paddle.Tensor(data)
571 572 573 574
            if not data.place._equals(place):
                data = data._copy_to(place, False)
            data = _handle_dtype(data, dtype)
            data.stop_gradient = stop_gradient
575
            return data
576 577
        else:
            raise TypeError(
578 579 580 581
                "Can't constructs a 'paddle.Tensor' with data type {}, data type must be scalar|list|tuple|np.ndarray|paddle.Tensor".format(
                    type(data)
                )
            )
582 583
        if not dtype:
            if data.dtype in [
584 585 586 587 588
                'float16',
                'float32',
                'float64',
                'complex64',
                'complex128',
589 590 591
            ]:
                default_type = paddle.get_default_dtype()
                if np.iscomplexobj(data):
592 593 594 595 596
                    default_type = (
                        'complex64'
                        if default_type in ['float16', 'float32']
                        else 'complex128'
                    )
597 598 599 600 601
                data = data.astype(default_type)
            # Windows default type is 'int32', while Linux/Mac is 'int64'. Unify they.
            if data.dtype in ['int32']:
                default_type = "int64"
                data = data.astype(default_type)
602 603

    if dtype and convert_dtype(dtype) != data.dtype:
604
        data = data.astype(convert_dtype(dtype))
605

J
Jiabin Yang 已提交
606
    if _in_eager_without_dygraph_check() and isinstance(data, np.ndarray):
607 608 609 610 611 612 613 614
        return core.eager.Tensor(
            value=data,
            place=place,
            persistable=False,
            zero_copy=False,
            name=None,
            stop_gradient=stop_gradient,
        )
615
    else:
616 617 618 619 620 621 622
        return paddle.Tensor(
            value=data,
            place=place,
            persistable=False,
            zero_copy=False,
            stop_gradient=stop_gradient,
        )
623 624


625 626 627 628 629
def _to_tensor_static(data, dtype=None, stop_gradient=None):

    if isinstance(data, Variable) and (dtype is None or dtype == data.dtype):
        output = data
    else:
630 631 632 633 634 635 636

        if not isinstance(data, np.ndarray):
            if np.isscalar(data) and not isinstance(data, str):
                data = np.array([data])
            elif isinstance(data, (list, tuple)):
                data = np.array(data)

637 638 639 640 641
            if (
                isinstance(data, np.ndarray)
                and not dtype
                and data.dtype != 'object'
            ):
642 643 644 645 646
                if data.dtype in ['float16', 'float32', 'float64']:
                    data = data.astype(paddle.get_default_dtype())
                elif data.dtype in ['int32']:
                    data = data.astype('int64')

647 648
        if dtype:
            target_dtype = dtype
649
        elif hasattr(data, 'dtype') and data.dtype != 'object':
650 651 652 653 654 655
            target_dtype = data.dtype
        else:
            target_dtype = paddle.get_default_dtype()

        target_dtype = convert_dtype(target_dtype)

656 657 658 659 660
        if (
            isinstance(data, np.ndarray)
            and len(data.shape) > 0
            and any(isinstance(x, Variable) for x in data)
        ):
661
            if not all(
662 663
                [x.shape == (1,) for x in data if isinstance(x, Variable)]
            ):
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
                raise TypeError(
                    "Unsupport paddle.to_tensor([Variable, Variable...]) with non-scalar variable."
                )
            to_stack_list = [None] * data.shape[0]
            for idx, d in enumerate(data):
                to_stack_list[idx] = _to_tensor_static(d, dtype, stop_gradient)
            data = paddle.stack(to_stack_list)
            data = paddle.squeeze(data, -1)

        if not isinstance(data, Variable):
            output = assign(data)
        else:
            output = data
        if convert_dtype(output.dtype) != target_dtype:
            output = paddle.cast(output, target_dtype)

    output.stop_gradient = stop_gradient

    return output


685 686
def to_tensor(data, dtype=None, place=None, stop_gradient=True):
    r"""
687
    Constructs a ``paddle.Tensor`` from ``data`` ,
688 689 690 691 692 693 694 695
    which can be scalar, tuple, list, numpy\.ndarray, paddle\.Tensor.

    If the ``data`` is already a Tensor, copy will be performed and return a new tensor.
    If you only want to change stop_gradient property, please call ``Tensor.stop_gradient = stop_gradient`` directly.

    Args:
        data(scalar|tuple|list|ndarray|Tensor): Initial data for the tensor.
            Can be a scalar, list, tuple, numpy\.ndarray, paddle\.Tensor.
696
        dtype(str|np.dtype, optional): The desired data type of returned tensor. Can be 'bool' , 'float16' ,
697
            'float32' , 'float64' , 'int8' , 'int16' , 'int32' , 'int64' , 'uint8',
698
            'complex64' , 'complex128'. Default: None, infers dtype from ``data``
699
            except for python float number which gets dtype from ``get_default_type`` .
700 701 702
        place(CPUPlace|CUDAPinnedPlace|CUDAPlace|str, optional): The place to allocate Tensor. Can be
            CPUPlace, CUDAPinnedPlace, CUDAPlace. Default: None, means global place. If ``place`` is
            string, It can be ``cpu``, ``gpu:x`` and ``gpu_pinned``, where ``x`` is the index of the GPUs.
703 704 705 706 707 708 709 710 711 712
        stop_gradient(bool, optional): Whether to block the gradient propagation of Autograd. Default: True.

    Returns:
        Tensor: A Tensor constructed from ``data`` .

    Examples:

    .. code-block:: python

        import paddle
713

714 715 716 717 718 719 720 721 722 723 724 725 726 727
        type(paddle.to_tensor(1))
        # <class 'paddle.Tensor'>

        paddle.to_tensor(1)
        # Tensor(shape=[1], dtype=int64, place=CPUPlace, stop_gradient=True,
        #        [1])

        x = paddle.to_tensor(1, stop_gradient=False)
        print(x)
        # Tensor(shape=[1], dtype=int64, place=CPUPlace, stop_gradient=False,
        #        [1])

        paddle.to_tensor(x)  # A new tensor will be created with default stop_gradient=True
        # Tensor(shape=[1], dtype=int64, place=CPUPlace, stop_gradient=True,
728
        #        [1])
729 730 731 732 733 734 735 736 737 738 739 740 741 742

        paddle.to_tensor([[0.1, 0.2], [0.3, 0.4]], place=paddle.CPUPlace(), stop_gradient=False)
        # Tensor(shape=[2, 2], dtype=float32, place=CPUPlace, stop_gradient=False,
        #        [[0.10000000, 0.20000000],
        #         [0.30000001, 0.40000001]])

        type(paddle.to_tensor([[1+1j, 2], [3+2j, 4]], dtype='complex64'))
        # <class 'paddle.Tensor'>

        paddle.to_tensor([[1+1j, 2], [3+2j, 4]], dtype='complex64')
        # Tensor(shape=[2, 2], dtype=complex64, place=CPUPlace, stop_gradient=True,
        #        [[(1+1j), (2+0j)],
        #         [(3+2j), (4+0j)]])
    """
743 744 745 746
    place = _get_paddle_place(place)
    if place is None:
        place = _current_expected_place()

747
    if paddle.fluid.framework._non_static_mode():
748 749 750 751
        return _to_tensor_non_static(data, dtype, place, stop_gradient)

    # call assign for static graph
    else:
752
        re_exp = re.compile(r'[(](.+?)[)]', re.S)
753 754 755
        place_str = re.findall(re_exp, str(place))[0]

        with paddle.static.device_guard(place_str):
756
            return _to_tensor_static(data, dtype, stop_gradient)
757 758


759
def full_like(x, fill_value, dtype=None, name=None):
P
Pei Yang 已提交
760
    """
S
swtkiwi 已提交
761

762 763
    This function creates a tensor filled with ``fill_value`` which has identical shape of ``x`` and ``dtype``.
    If the ``dtype`` is None, the data type of Tensor is same with ``x``.
764

P
Pei Yang 已提交
765
    Args:
766 767
        x(Tensor): The input tensor which specifies shape and data type. The data type can be bool, float16, float32, float64, int32, int64.
        fill_value(bool|float|int): The value to fill the tensor with. Note: this value shouldn't exceed the range of the output data type.
W
wangchaochaohu 已提交
768
        dtype(np.dtype|str, optional): The data type of output. The data type can be one
769
            of bool, float16, float32, float64, int32, int64. The default value is None, which means the output
770
            data type is the same as input.
771
        name(str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
772

P
Pei Yang 已提交
773
    Returns:
774
        Tensor: Tensor which is created according to ``x``, ``fill_value`` and ``dtype``.
775

P
Pei Yang 已提交
776 777
    Examples:
        .. code-block:: python
778

P
Pei Yang 已提交
779
          import paddle
780

781
          input = paddle.full(shape=[2, 3], fill_value=0.0, dtype='float32', name='input')
P
Pei Yang 已提交
782
          output = paddle.full_like(input, 2.0)
783 784
          # [[2. 2. 2.]
          #  [2. 2. 2.]]
P
Pei Yang 已提交
785 786
    """
    if dtype is None:
787
        dtype = x.dtype
788
    else:
789 790
        if not isinstance(dtype, core.VarDesc.VarType):
            dtype = convert_np_dtype_to_dtype_(dtype)
791
    if in_dygraph_mode():
792
        return _C_ops.full_like(x, fill_value, dtype, x.place)
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
    else:
        helper = LayerHelper("full_like", **locals())
        check_variable_and_dtype(
            x,
            'x',
            [
                'bool',
                'float16',
                'float32',
                'float64',
                'int16',
                'int32',
                'int64',
            ],
            'full_like',
808
        )
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
        check_dtype(
            dtype,
            'dtype',
            [
                'bool',
                'float16',
                'float32',
                'float64',
                'int16',
                'int32',
                'int64',
            ],
            'full_like/zeros_like/ones_like',
        )
        out = helper.create_variable_for_type_inference(dtype=dtype)
P
Pei Yang 已提交
824

825 826 827 828 829 830 831 832
        helper.append_op(
            type='fill_any_like',
            inputs={'X': [x]},
            attrs={'value': fill_value, "dtype": dtype},
            outputs={'Out': [out]},
        )
        out.stop_gradient = True
        return out
P
Pei Yang 已提交
833 834


835
def ones(shape, dtype=None, name=None):
836
    """
B
BrilliantYuKaimin 已提交
837
    Create a Tensor of specified :attr:`shape` and :attr:`dtype` and fill it with 1.
838 839

    Args:
840 841 842
        shape (tuple|list|Tensor): Shape of the Tensor to be created. The data type is ``int32`` or ``int64`` .
            If ``shape`` is a list or tuple, the elements of it should be integers or 0-D Tensor with shape [].
            If ``shape`` is an Tensor, it should be an 1-D Tensor which represents a list.
B
BrilliantYuKaimin 已提交
843 844 845
        dtype (np.dtype|str, optional): Data type of output Tensor, it should be one of
            bool, float16, float32, float64, int32 and int64. If it is set to None, the data type will be float32.
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
846

847
    Returns:
B
BrilliantYuKaimin 已提交
848
        Tensor: A Tensor of data type :attr:`dtype` with shape :attr:`shape` and all elements are 1.
849 850 851 852

    Examples:
        .. code-block:: python

853
            import paddle
854

855
            # shape is a list/tuple
856
            data1 = paddle.ones(shape=[3, 2])
857 858 859 860 861
            # [[1. 1.]
            #  [1. 1.]
            #  [1. 1.]]

            # shape is a Tensor
862 863 864 865 866 867 868 869 870 871 872 873
            shape = paddle.to_tensor([3, 2])
            data2 = paddle.ones(shape=shape)
            # [[1. 1.]
            #  [1. 1.]
            #  [1. 1.]]

            # shape is a Tensor List
            shape = [paddle.to_tensor(3), paddle.to_tensor(2)]
            data3 = paddle.ones(shape=shape)
            # [[1. 1.]
            #  [1. 1.]
            #  [1. 1.]]
874
    """
875
    if dtype is None:
W
Weilong Wu 已提交
876
        dtype = core.VarDesc.VarType.FP32
877
    return fill_constant(value=1.0, shape=shape, dtype=dtype, name=name)
878 879


880
def ones_like(x, dtype=None, name=None):
881
    """
C
Chen Long 已提交
882
    Returns a Tensor filled with the value 1, with the same shape and
883
    data type (use ``dtype`` if ``dtype`` is not None) as ``x``.
884 885

    Args:
886 887
        x(Tensor): The input tensor which specifies shape and dtype. The
            dtype of ``x`` can be bool, float16, float32, float64, int32, int64.
888
        dtype(str|np.dtype, optional): The data type of the
889 890 891
            output tensor. Supported data types: bool, float16, float32, float64,
            int32, int64. If ``dtype`` is None, the data type is the same as ``x``.
            Default is None.
892
        name(str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
893

894
    Returns:
895 896 897
        Tensor: A Tensor filled with the value 1, with the same shape and
        data type (use ``dtype`` if ``dtype`` is not None) as ``x``.

898 899 900
    Examples:
        .. code-block:: python

901
            import paddle
902

903
            x = paddle.to_tensor([1,2,3])
Z
zhupengyang 已提交
904 905
            out1 = paddle.ones_like(x) # [1., 1., 1.]
            out2 = paddle.ones_like(x, dtype='int32') # [1, 1, 1]
906

907 908
    """
    return full_like(x=x, fill_value=1, dtype=dtype, name=name)
909 910


911
def zeros(shape, dtype=None, name=None):
912
    """
C
Chen Long 已提交
913
    Creates a tensor of specified :attr:`shape` and :attr:`dtype`, and fills it with 0.
914 915

    Args:
916 917 918
        shape (tuple|list|Tensor): Shape of the Tensor to be created. The data type is ``int32`` or ``int64`` .
            If ``shape`` is a list or tuple, each element of it should be integer or 0-D Tensor with shape [].
            If ``shape`` is an Tensor, it should be an 1-D Tensor which represents a list.
W
wangchaochaohu 已提交
919
        dtype(np.dtype|str, optional): Data type of output Tensor, it supports
920 921 922
            bool, float16, float32, float64, int32 and int64. Default: if None, the date type is float32.
        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`.
923 924

    Returns:
925
        Tensor: A tensor of data type :attr:`dtype` with shape :attr:`shape` and all elements set to 0.
926 927 928 929

    Examples:
        .. code-block:: python

930
            import paddle
931

932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
            # shape is a list/tuple
            data1 = paddle.zeros(shape=[3, 2])
            # [[0. 0.]
            #  [0. 0.]
            #  [0. 0.]]

            # shape is a Tensor
            shape = paddle.to_tensor([3, 2])
            data2 = paddle.zeros(shape=shape)
            # [[0. 0.]
            #  [0. 0.]
            #  [0. 0.]]

            # shape is a Tensor List
            shape = [paddle.to_tensor(3), paddle.to_tensor(2)]
            data3 = paddle.zeros(shape=shape)
            # [[0. 0.]
            #  [0. 0.]
            #  [0. 0.]]
951
    """
952 953 954
    if dtype is None:
        dtype = 'float32'
    return fill_constant(value=0.0, shape=shape, dtype=dtype, name=name)
955 956


957
def zeros_like(x, dtype=None, name=None):
958
    """
959
    Returns a Tensor filled with the value 0, with the same shape and
960
    data type (use ``dtype`` if ``dtype`` is not None) as ``x``.
961 962

    Args:
963 964
        x(Tensor): The input tensor which specifies shape and dtype. The
            dtype of ``x`` can be bool, float16, float32, float64, int32, int64.
965
        dtype(str|np.dtype, optional): The data type of the
966 967 968
            output tensor. Supported data types: bool, float16, float32, float64,
            int32, int64. If ``dtype`` is None, the data type is the same as ``x``.
            Default is None.
969
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
970 971

    Returns:
972 973
        Tensor: A Tensor filled with the value 0, with the same shape and
        data type (use ``dtype`` if ``dtype`` is not None) as ``x``.
974

975

976 977 978
    Examples:
        .. code-block:: python

979
            import paddle
980

Z
zhupengyang 已提交
981
            x = paddle.to_tensor([1, 2, 3])
982 983
            out1 = paddle.zeros_like(x) # [0., 0., 0.]
            out2 = paddle.zeros_like(x, dtype='int32') # [0, 0, 0]
984

985 986
    """
    return full_like(x=x, fill_value=0, dtype=dtype, name=name)
987 988


989
def eye(num_rows, num_columns=None, dtype=None, name=None):
990
    """
991

992
    This function constructs 2-D Tensor with ones on the diagonal and zeros elsewhere.
993

994
    Args:
995 996
        num_rows(int): the number of rows in each batch Tensor.
        num_columns(int, optional): the number of columns in each batch Tensor.
997
            If None, default: num_rows.
W
wangchaochaohu 已提交
998
        dtype(np.dtype|str, optional): The data type of the returned Tensor.
999 1000
            It should be int32, int64, float16, float32, float64. Default: if None, the data type
            is float32.
1001
        name(str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
1002

1003
    Returns:
1004
        Tensor: An identity Tensor or LoDTensor of shape [num_rows, num_columns].
1005

1006 1007
    Examples:
        .. code-block:: python
1008

1009
          import paddle
1010

1011
          data = paddle.eye(3, dtype='int32')
1012 1013 1014
          # [[1 0 0]
          #  [0 1 0]
          #  [0 0 1]]
1015
          data = paddle.eye(2, 3, dtype='int32')
1016 1017
          # [[1 0 0]
          #  [0 1 0]]
1018 1019
    """

1020
    def _check_attr(attr, message):
1021
        if isinstance(attr, ((Variable, core.eager.Tensor))):
1022 1023 1024 1025 1026 1027
            assert len(attr.shape) == 1 and attr.shape[0] in [1, -1]
        elif not isinstance(attr, int) or attr < 0:
            raise TypeError("{} should be a non-negative int.".format(message))

    _check_attr(num_rows, "num_rows")

1028
    if dtype is None:
1029 1030
        dtype = core.VarDesc.VarType.FP32
    elif not isinstance(dtype, core.VarDesc.VarType):
1031 1032
        dtype = convert_np_dtype_to_dtype_(dtype)
    if num_columns is not None:
1033
        _check_attr(num_columns, "num_columns")
1034 1035 1036
    else:
        num_columns = num_rows

1037 1038 1039 1040
    if in_dygraph_mode():
        out = _C_ops.eye(
            num_rows, num_columns, dtype, _current_expected_place()
        )
1041 1042
    else:
        helper = LayerHelper("eye", **locals())
1043 1044 1045 1046 1047 1048
        check_dtype(
            dtype,
            'dtype',
            ['float16', 'float32', 'float64', 'int32', 'int64'],
            'eye',
        )
1049
        out = helper.create_variable_for_type_inference(dtype=dtype)
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
        helper.append_op(
            type='eye',
            inputs={},
            outputs={'Out': [out]},
            attrs={
                'num_rows': num_rows,
                'num_columns': num_columns,
                'dtype': dtype,
            },
            stop_gradient=True,
        )
1061 1062 1063

    out.stop_gradient = True
    return out
1064 1065


1066
def full(shape, fill_value, dtype=None, name=None):
W
wangchaochaohu 已提交
1067
    """
S
swtkiwi 已提交
1068

1069
    Return a Tensor with the ``fill_value`` which size is same as ``shape``.
1070

W
wangchaochaohu 已提交
1071
    Args:
1072 1073 1074 1075 1076
        shape (tuple|list|Tensor): Shape of the Tensor to be created. The data type is ``int32`` or ``int64`` .
            If ``shape`` is a list or tuple, each element of it should be integer or 0-D Tensor with shape [].
            If ``shape`` is an Tensor, it should be an 1-D Tensor which represents a list.
        fill_value(bool|float|int|Tensor): The constant value used to initialize the Tensor to be created.
            If ``fill_value`` is an Tensor, it shoule be an 0-D Tensor which represents a scalar.
W
wangchaochaohu 已提交
1077
        dtype(np.dtype|str, optional): Data type of the output Tensor
W
wangchaochaohu 已提交
1078
            which can be float16, float32, float64, int32, int64, if dytpe is `None`, the data
1079 1080
            type of created Tensor is `float32`.
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
1081

1082
    Returns:
1083
        Tensor: Tensor which is created according to ``shape``, ``fill_value`` and ``dtype``.
1084

W
wangchaochaohu 已提交
1085 1086 1087
    Examples:
        .. code-block:: python

1088
            import paddle
W
wangchaochaohu 已提交
1089

1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
            # shape is a list/tuple
            data1 = paddle.full(shape=[3, 2], fill_value=1.)
            # [[1. 1.]
            #  [1. 1.]
            #  [1. 1.]]

            # shape is a Tensor
            shape = paddle.to_tensor([3, 2])
            data2 = paddle.full(shape=shape, fill_value=2.)
            # [[2. 2.]
            #  [2. 2.]
            #  [2. 2.]]

            # shape is a Tensor List
            shape = [paddle.to_tensor(3), paddle.to_tensor(2)]
            data3 = paddle.full(shape=shape, fill_value=3.)
            # [[3. 3.]
            #  [3. 3.]
            #  [3. 3.]]

            # fill_value is a Tensor.
            val = paddle.full([], 2.0, "float32")
            data5 = paddle.full(shape=[3, 2], fill_value=val)
            # [[2. 2.]
            #  [2. 2.]
            #  [2. 2.]]
W
wangchaochaohu 已提交
1116 1117 1118 1119 1120
    """

    if dtype is None:
        dtype = 'float32'

1121
    return fill_constant(shape=shape, dtype=dtype, value=fill_value, name=name)
1122 1123


1124
def arange(start=0, end=None, step=1, dtype=None, name=None):
1125
    """
1126
    Returns a 1-D Tensor with spaced values within a given interval.
1127

1128 1129
    Values are generated into the half-open interval [``start``, ``end``) with
    the ``step``. (the interval including ``start`` but excluding ``end``).
1130

1131 1132
    If ``dtype`` is float32 or float64, we advise adding a small epsilon to
    ``end`` to avoid floating point rounding errors when comparing against ``end``.
1133 1134

    Parameters:
1135 1136
        start(float|int|Tensor): Start of interval. The interval includes this
            value. If ``end`` is None, the half-open interval is [0, ``start``).
1137 1138
            If ``start`` is a Tensor, it is a 0-D Tensor which represents a scalar
            and data type is int32, int64, float32, float64. Default is 0.
1139
        end(float|int|Tensor, optional): End of interval. The interval does not
1140 1141 1142 1143
            include this value. If ``end`` is a Tensor, it is a 0-D Tensor which
            represents a scalar and data type is int32, int64, float32, float64.
            If ``end`` is None, the half-open interval is [0, ``start``).
            Default is None.
1144 1145
        step(float|int|Tensor, optional): Spacing between values. For any out,
            it is the istance between two adjacent values, out[i+1] - out[i].
1146 1147
            If ``step`` is a Tensor, it is a 0-D Tensor which represents a scalar
            and data type is int32, int64, float32, float64. . Default is 1.
1148
        dtype(str|np.dtype, optional): The data type of the
1149 1150
            output tensor. Supported data types: int32, int64, float32, float64.
            If ``dytpe`` is None, the data type is float32. Default is None.
1151
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
1152

1153
    Returns:
1154
        Tensor: A 1-D Tensor with values from the interval [``start``, ``end``)
Z
zhupengyang 已提交
1155 1156
        taken with common difference ``step`` beginning from ``start``. Its
        data type is set by ``dtype``.
1157

Z
zhupengyang 已提交
1158
    Examples:
1159 1160
        .. code-block:: python

Z
zhupengyang 已提交
1161
            import paddle
1162

Z
zhupengyang 已提交
1163 1164
            out1 = paddle.arange(5)
            # [0, 1, 2, 3, 4]
1165

Z
zhupengyang 已提交
1166 1167
            out2 = paddle.arange(3, 9, 2.0)
            # [3, 5, 7]
1168

Z
zhupengyang 已提交
1169 1170 1171
            # use 4.999 instead of 5.0 to avoid floating point rounding errors
            out3 = paddle.arange(4.999, dtype='float32')
            # [0., 1., 2., 3., 4.]
1172

1173
            start_var = paddle.to_tensor(3)
Z
zhupengyang 已提交
1174 1175
            out4 = paddle.arange(start_var, 7)
            # [3, 4, 5, 6]
1176

1177 1178 1179 1180 1181 1182
    """
    if dtype is None:
        dtype = 'int64'
    if end is None:
        end = start
        start = 0
1183

1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
    if not isinstance(dtype, core.VarDesc.VarType):
        dtype = convert_np_dtype_to_dtype_(dtype)

    if not isinstance(start, Variable):
        with device_guard("cpu"):
            start = fill_constant([1], dtype, start, force_cpu=True)
    elif start.dtype != dtype:
        start = paddle.cast(start, dtype)

    if not isinstance(end, Variable):
        with device_guard("cpu"):
            end = fill_constant([1], dtype, end, force_cpu=True)
    elif end.dtype != dtype:
        end = paddle.cast(end, dtype)

    if not isinstance(step, Variable):
        with device_guard("cpu"):
            step = fill_constant([1], dtype, step, force_cpu=True)
    elif step.dtype != dtype:
        step = paddle.cast(step, dtype)

    if in_dygraph_mode():
1206
        return _C_ops.arange(start, end, step, dtype, _current_expected_place())
1207 1208 1209 1210 1211 1212 1213 1214
    else:
        check_dtype(
            dtype,
            'dtype',
            ['float32', 'float64', 'int32', 'int64'],
            'range/arange',
        )
        helper = LayerHelper('range', **locals())
1215 1216 1217 1218 1219 1220 1221
        out_shape = None
        if (
            not isinstance(start, Variable)
            and not isinstance(end, Variable)
            and not isinstance(step, Variable)
        ):
            out_shape = [int(math.ceil((end - start) / step))]
1222 1223 1224 1225 1226 1227
        out = helper.create_variable_for_type_inference(dtype, shape=out_shape)
        helper.append_op(
            type='range',
            inputs={'Start': start, 'End': end, 'Step': step},
            outputs={'Out': out},
        )
1228
        out.stop_gradient = True
1229 1230
        if out_shape is not None:
            out.desc.set_shape(out_shape)
1231 1232
        return out

W
WuHaobo 已提交
1233 1234

def _tril_triu_op(helper):
1235
    """Base op of tril_op and triu_op"""
W
WuHaobo 已提交
1236
    op_type = helper.layer_type
Y
yaoxuefeng 已提交
1237
    x = helper.kwargs.get('x', None)
W
WuHaobo 已提交
1238 1239

    assert x is not None, 'x cannot be None in {}'.format(op_type)
1240
    check_variable_and_dtype(
1241 1242 1243 1244 1245
        x,
        'x',
        ['float16', 'float32', 'float64', 'int32', 'int64', 'bool'],
        op_type,
    )
W
WuHaobo 已提交
1246
    if len(x.shape) < 2:
Y
yaoxuefeng 已提交
1247
        raise ValueError("x shape in {} must be at least 2-D".format(op_type))
W
WuHaobo 已提交
1248
    diagonal = helper.kwargs.get('diagonal', 0)
1249
    if not isinstance(diagonal, (int,)):
W
WuHaobo 已提交
1250 1251 1252 1253 1254 1255
        raise TypeError("diagonal in {} must be a python Int".format(op_type))
    name = helper.kwargs.get('name', None)

    if name is None:
        out = helper.create_variable_for_type_inference(dtype=x.dtype)
    else:
1256 1257 1258
        out = helper.create_variable(
            name=name, dtype=x.dtype, persistable=False
        )
W
WuHaobo 已提交
1259 1260 1261 1262 1263 1264 1265 1266

    helper.append_op(
        type="tril_triu",
        inputs={"X": x},
        attrs={
            "diagonal": diagonal,
            "lower": True if op_type == 'tril' else False,
        },
1267 1268
        outputs={"Out": out},
    )
W
WuHaobo 已提交
1269 1270 1271 1272

    return out


Y
yaoxuefeng 已提交
1273
def tril(x, diagonal=0, name=None):
1274
    r"""
1275
    Returns the lower triangular part of a matrix (2-D tensor) or batch
1276 1277
    of matrices :attr:`x`, the other elements of the result tensor are set
    to 0. The lower triangular part of the matrix is defined as the elements
W
WuHaobo 已提交
1278 1279 1280
    on and below the diagonal.

    Args:
Y
yaoxuefeng 已提交
1281
        x (Tensor): The input x which is a Tensor.
L
liuyuhui 已提交
1282
            Support data types: ``bool``, ``float64``, ``float32``, ``int32``, ``int64``.
W
WuHaobo 已提交
1283 1284 1285 1286 1287 1288 1289
        diagonal (int, optional): The diagonal to consider, default value is 0.
            If :attr:`diagonal` = 0, all elements on and below the main diagonal are
            retained. A positive value includes just as many diagonals above the main
            diagonal, and similarly a negative value excludes just as many diagonals below
            the main diagonal. The main diagonal are the set of indices
            :math:`\{(i, i)\}` for :math:`i \in [0, \min\{d_{1}, d_{2}\} - 1]` where
            :math:`d_{1}, d_{2}` are the dimensions of the matrix.
1290
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
W
WuHaobo 已提交
1291 1292

    Returns:
Y
yaoxuefeng 已提交
1293
        Tensor: Results of lower triangular operation by the specified diagonal of input tensor x,
Y
yaoxuefeng 已提交
1294
        it's data type is the same as x's Tensor.
W
WuHaobo 已提交
1295 1296 1297 1298

    Examples:
        .. code-block:: python

Y
yaoxuefeng 已提交
1299
            import paddle
W
WuHaobo 已提交
1300

1301 1302 1303 1304 1305
            data = paddle.arange(1, 13, dtype="int64").reshape([3,-1])
            # Tensor(shape=[3, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1 , 2 , 3 , 4 ],
            #         [5 , 6 , 7 , 8 ],
            #         [9 , 10, 11, 12]])
Y
yaoxuefeng 已提交
1306

1307 1308 1309 1310 1311
            tril1 = paddle.tril(data)
            # Tensor(shape=[3, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1 , 0 , 0 , 0 ],
            #         [5 , 6 , 0 , 0 ],
            #         [9 , 10, 11, 0 ]])
W
WuHaobo 已提交
1312 1313

            # example 2, positive diagonal value
1314 1315 1316 1317 1318
            tril2 = paddle.tril(data, diagonal=2)
            # Tensor(shape=[3, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1 , 2 , 3 , 0 ],
            #         [5 , 6 , 7 , 8 ],
            #         [9 , 10, 11, 12]])
W
WuHaobo 已提交
1319 1320

            # example 3, negative diagonal value
1321 1322 1323 1324 1325
            tril3 = paddle.tril(data, diagonal=-1)
            # Tensor(shape=[3, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[0 , 0 , 0 , 0 ],
            #         [5 , 0 , 0 , 0 ],
            #         [9 , 10, 0 , 0 ]])
1326
    """
F
From00 已提交
1327
    if in_dygraph_mode():
1328
        return _C_ops.tril(x, diagonal, True)
1329 1330
    else:
        return _tril_triu_op(LayerHelper('tril', **locals()))
W
WuHaobo 已提交
1331 1332


Y
yaoxuefeng 已提交
1333
def triu(x, diagonal=0, name=None):
1334
    r"""
1335
    Return the upper triangular part of a matrix (2-D tensor) or batch of matrices
Y
yaoxuefeng 已提交
1336
    :attr:`x`, the other elements of the result tensor are set to 0.
W
WuHaobo 已提交
1337 1338 1339 1340
    The upper triangular part of the matrix is defined as the elements on and
    above the diagonal.

    Args:
Y
yaoxuefeng 已提交
1341
        x (Tensor): The input x which is a Tensor.
W
WuHaobo 已提交
1342 1343 1344 1345 1346 1347 1348 1349
            Support data types: ``float64``, ``float32``, ``int32``, ``int64``.
        diagonal (int, optional): The diagonal to consider, default value is 0.
            If :attr:`diagonal` = 0, all elements on and above the main diagonal are
            retained. A positive value excludes just as many diagonals above the main
            diagonal, and similarly a negative value includes just as many diagonals below
            the main diagonal. The main diagonal are the set of indices
            :math:`\{(i, i)\}` for :math:`i \in [0, \min\{d_{1}, d_{2}\} - 1]` where
            :math:`d_{1}, d_{2}` are the dimensions of the matrix.
1350
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
W
WuHaobo 已提交
1351 1352

    Returns:
Y
yaoxuefeng 已提交
1353
        Tensor: Results of upper triangular operation by the specified diagonal of input tensor x,
Y
yaoxuefeng 已提交
1354
        it's data type is the same as x's Tensor.
W
WuHaobo 已提交
1355 1356 1357 1358

    Examples:
        .. code-block:: python

Y
yaoxuefeng 已提交
1359
            import paddle
W
WuHaobo 已提交
1360

1361 1362 1363 1364 1365
            x = paddle.arange(1, 13, dtype="int64").reshape([3,-1])
            # Tensor(shape=[3, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1 , 2 , 3 , 4 ],
            #         [5 , 6 , 7 , 8 ],
            #         [9 , 10, 11, 12]])
W
WuHaobo 已提交
1366 1367

            # example 1, default diagonal
Y
yaoxuefeng 已提交
1368
            triu1 = paddle.tensor.triu(x)
1369 1370 1371 1372
            # Tensor(shape=[3, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1 , 2 , 3 , 4 ],
            #         [0 , 6 , 7 , 8 ],
            #         [0 , 0 , 11, 12]])
W
WuHaobo 已提交
1373 1374

            # example 2, positive diagonal value
Y
yaoxuefeng 已提交
1375
            triu2 = paddle.tensor.triu(x, diagonal=2)
1376 1377 1378 1379
            # Tensor(shape=[3, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[0, 0, 3, 4],
            #         [0, 0, 0, 8],
            #         [0, 0, 0, 0]])
W
WuHaobo 已提交
1380 1381

            # example 3, negative diagonal value
Y
yaoxuefeng 已提交
1382
            triu3 = paddle.tensor.triu(x, diagonal=-1)
1383 1384 1385 1386
            # Tensor(shape=[3, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1 , 2 , 3 , 4 ],
            #         [5 , 6 , 7 , 8 ],
            #         [0 , 10, 11, 12]])
W
WuHaobo 已提交
1387 1388

    """
F
From00 已提交
1389
    if in_dygraph_mode():
1390
        return _C_ops.triu(x, diagonal, False)
1391 1392
    else:
        return _tril_triu_op(LayerHelper('triu', **locals()))
S
suytingwan 已提交
1393 1394


1395
def meshgrid(*args, **kwargs):
S
suytingwan 已提交
1396
    """
1397

1398
    Takes a list of N tensors as input :attr:`*args`, each of which is 1-dimensional vector, and creates N-dimensional grids.
1399

S
suytingwan 已提交
1400
    Args:
1401
        *args(Tensor|list of Tensor) : tensors (tuple(list) of tensor): the shapes of input k tensors are (N1,),
S
suytingwan 已提交
1402
            (N2,),..., (Nk,). Support data types: ``float64``, ``float32``, ``int32``, ``int64``.
1403
        **kwargs (optional): Currently, only accept name in **kwargs
1404
            The default value is None. Normally there is no need for
S
suytingwan 已提交
1405
            user to set this property. For more information, please refer to :ref:`api_guide_Name`.
1406

S
suytingwan 已提交
1407
    Returns:
Y
yaoxuefeng 已提交
1408
         Tensor: k tensors. The shape of each tensor is (N1, N2, ..., Nk)
S
suytingwan 已提交
1409 1410 1411 1412 1413 1414

    Examples:
      .. code-block:: python

          import paddle

Y
yaoxuefeng 已提交
1415 1416 1417 1418
          x = paddle.randint(low=0, high=100, shape=[100])
          y = paddle.randint(low=0, high=100, shape=[200])

          grid_x, grid_y = paddle.meshgrid(x, y)
S
suytingwan 已提交
1419

Y
yaoxuefeng 已提交
1420 1421
          print(grid_x.shape)
          print(grid_y.shape)
S
suytingwan 已提交
1422 1423 1424 1425 1426 1427

          #the shape of res_1 is (100, 200)
          #the shape of res_2 is (100, 200)

    """

1428 1429
    if len(args) == 1 and isinstance(args[0], (list, tuple)):
        args = args[0]
Y
YuanRisheng 已提交
1430
    if in_dygraph_mode():
1431
        return _C_ops.meshgrid(list(args))
1432 1433 1434
    else:
        name = kwargs.get("name", None)
        helper = LayerHelper('meshgrid', **locals())
S
suytingwan 已提交
1435

1436 1437 1438 1439
        if not isinstance(args, (list, tuple)):
            raise TypeError(
                "The type of input args in meshgrid should be list."
            )
S
suytingwan 已提交
1440

1441 1442 1443 1444 1445 1446 1447
        for id, input_ in enumerate(args):
            check_dtype(
                input_.dtype,
                'create data type',
                ['float16', 'float32', 'float64', 'int32', 'int64'],
                'meshgrid',
            )
S
suytingwan 已提交
1448

1449 1450 1451 1452 1453 1454 1455
        num = len(args)
        out = [
            helper.create_variable_for_type_inference(dtype=args[i].dtype)
            for i in range(num)
        ]
        helper.append_op(
            type='meshgrid', inputs={'X': list(args)}, outputs={'Out': out}
1456
        )
S
suytingwan 已提交
1457

1458
        return out
1459 1460


L
Li Min 已提交
1461 1462
def diagflat(x, offset=0, name=None):
    """
1463
    If ``x`` is a vector (1-D tensor), a 2-D square tensor with the elements of ``x`` as the diagonal is returned.
L
Li Min 已提交
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478

    If ``x`` is a tensor (more than 1-D), a 2-D square tensor with the elements of flattened ``x`` as the diagonal is returned.

    The argument ``offset`` controls the diagonal offset.


    If ``offset`` = 0, it is the main diagonal.

    If ``offset`` > 0, it is superdiagonal.

    If ``offset`` < 0, it is subdiagonal.

    Args:
        x (Tensor): The input tensor. It can be any shape. Its data type should be float32, float64, int32, int64.
        offset (int, optional): The diagonal offset. A positive value represents superdiagonal, 0 represents the main diagonal, and a negative value represents subdiagonal. Default: 0 (main diagonal).
1479
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
L
Li Min 已提交
1480 1481 1482 1483 1484 1485

    Returns:
        Tensor, a square matrix. The output data type is the same as input data type.

    Examples:
        .. code-block:: python
1486
            :name: code-example-1
L
Li Min 已提交
1487

1488 1489 1490 1491
            import paddle

            x = paddle.to_tensor([1, 2, 3])
            y = paddle.diagflat(x)
1492 1493 1494 1495 1496
            print(y)
            # Tensor(shape=[3, 3], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1, 0, 0],
            #         [0, 2, 0],
            #         [0, 0, 3]])
1497 1498

            y = paddle.diagflat(x, offset=1)
1499 1500 1501 1502 1503 1504
            print(y)
            # Tensor(shape=[4, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[0, 1, 0, 0],
            #         [0, 0, 2, 0],
            #         [0, 0, 0, 3],
            #         [0, 0, 0, 0]])
1505 1506

            y = paddle.diagflat(x, offset=-1)
1507 1508 1509 1510 1511 1512
            print(y)
            # Tensor(shape=[4, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[0, 0, 0, 0],
            #         [1, 0, 0, 0],
            #         [0, 2, 0, 0],
            #         [0, 0, 3, 0]])
L
Li Min 已提交
1513 1514

        .. code-block:: python
1515
            :name: code-example-2
L
Li Min 已提交
1516

1517
            import paddle
L
Li Min 已提交
1518

1519 1520
            x = paddle.to_tensor([[1, 2], [3, 4]])
            y = paddle.diagflat(x)
1521 1522 1523 1524 1525 1526
            print(y)
            # Tensor(shape=[4, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1, 0, 0, 0],
            #         [0, 2, 0, 0],
            #         [0, 0, 3, 0],
            #         [0, 0, 0, 4]])
1527 1528

            y = paddle.diagflat(x, offset=1)
1529 1530 1531 1532 1533 1534 1535
            print(y)
            # Tensor(shape=[5, 5], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[0, 1, 0, 0, 0],
            #         [0, 0, 2, 0, 0],
            #         [0, 0, 0, 3, 0],
            #         [0, 0, 0, 0, 4],
            #         [0, 0, 0, 0, 0]])
1536 1537

            y = paddle.diagflat(x, offset=-1)
1538 1539 1540 1541 1542 1543 1544
            print(y)
            # Tensor(shape=[5, 5], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[0, 0, 0, 0, 0],
            #         [1, 0, 0, 0, 0],
            #         [0, 2, 0, 0, 0],
            #         [0, 0, 3, 0, 0],
            #         [0, 0, 0, 4, 0]])
L
Li Min 已提交
1545
    """
1546
    if in_dygraph_mode():
1547
        if len(x.shape) <= 1:
1548
            return _C_ops.diag(x, offset, 0)
1549
        else:
1550
            y = _C_ops.flatten(x, 0, -1)
1551 1552 1553 1554 1555 1556 1557 1558
            return _C_ops.diag(y, offset, 0)
    else:
        padding_value = 0
        check_type(x, 'x', (Variable), 'diagflat')
        check_dtype(
            x.dtype, 'x', ['float32', 'float64', 'int32', 'int64'], 'diagflat'
        )
        check_type(offset, 'offset', (int), 'diagflat')
1559

1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
        helper = LayerHelper("diagflat", **locals())
        out1 = helper.create_variable_for_type_inference(dtype=x.dtype)
        out1_shape = helper.create_variable_for_type_inference(x.dtype)
        out2 = helper.create_variable_for_type_inference(dtype=x.dtype)

        if len(x.shape) <= 1:
            helper.append_op(
                type='diag_v2',
                inputs={'X': x},
                outputs={'Out': out2},
                attrs={'offset': offset, 'padding_value': padding_value},
1571
            )
L
Li Min 已提交
1572
        else:
1573 1574 1575 1576 1577
            helper.append_op(
                type='flatten_contiguous_range',
                inputs={'X': x},
                outputs={'Out': out1, 'XShape': out1_shape},
                attrs={'start_axis': 0, 'stop_axis': -1},
1578
            )
1579
            out1.stop_gradient = True
L
Li Min 已提交
1580

1581 1582 1583 1584 1585 1586 1587 1588
            helper.append_op(
                type='diag_v2',
                inputs={'X': out1},
                outputs={'Out': out2},
                attrs={'offset': offset, 'padding_value': padding_value},
            )
        out2.stop_gradient = True
        return out2
L
Li Min 已提交
1589 1590


1591 1592
def diag(x, offset=0, padding_value=0, name=None):
    """
1593
    If ``x`` is a vector (1-D tensor), a 2-D square tensor with the elements of ``x`` as the diagonal is returned.
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608

    If ``x`` is a matrix (2-D tensor), a 1-D tensor with the diagonal elements of ``x`` is returned.

    The argument ``offset`` controls the diagonal offset:

    If ``offset`` = 0, it is the main diagonal.

    If ``offset`` > 0, it is superdiagonal.

    If ``offset`` < 0, it is subdiagonal.

    Args:
        x (Tensor): The input tensor. Its shape is either 1-D or 2-D. Its data type should be float32, float64, int32, int64.
        offset (int, optional): The diagonal offset. A positive value represents superdiagonal, 0 represents the main diagonal, and a negative value represents subdiagonal.
        padding_value (int|float, optional): Use this value to fill the area outside the specified diagonal band. Only takes effect when the input is a 1-D Tensor. The default value is 0.
1609
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
1610

1611 1612 1613 1614 1615
    Returns:
        Tensor, a square matrix or a vector. The output data type is the same as input data type.

    Examples:
        .. code-block:: python
1616
            :name: code-example-1
1617

1618
            import paddle
1619

1620 1621 1622
            paddle.disable_static()
            x = paddle.to_tensor([1, 2, 3])
            y = paddle.diag(x)
1623 1624 1625 1626 1627
            print(y)
            # Tensor(shape=[3, 3], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1, 0, 0],
            #         [0, 2, 0],
            #         [0, 0, 3]])
1628 1629

            y = paddle.diag(x, offset=1)
1630 1631 1632 1633 1634 1635
            print(y)
            # Tensor(shape=[4, 4], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[0, 1, 0, 0],
            #         [0, 0, 2, 0],
            #         [0, 0, 0, 3],
            #         [0, 0, 0, 0]])
1636 1637

            y = paddle.diag(x, padding_value=6)
1638 1639 1640 1641 1642
            print(y)
            # Tensor(shape=[3, 3], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [[1, 6, 6],
            #         [6, 2, 6],
            #         [6, 6, 3]])
1643 1644

        .. code-block:: python
1645
            :name: code-example-2
1646

1647
            import paddle
1648

1649 1650 1651
            paddle.disable_static()
            x = paddle.to_tensor([[1, 2, 3], [4, 5, 6]])
            y = paddle.diag(x)
1652 1653 1654
            print(y)
            # Tensor(shape=[2], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [1, 5])
1655

1656
            y = paddle.diag(x, offset=1)
1657 1658 1659
            print(y)
            # Tensor(shape=[2], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [2, 6])
1660

1661
            y = paddle.diag(x, offset=-1)
1662 1663 1664
            print(y)
            # Tensor(shape=[1], dtype=int64, place=Place(cpu), stop_gradient=True,
            #        [4])
1665
    """
J
Jiabin Yang 已提交
1666
    if in_dygraph_mode():
1667
        return _C_ops.diag(x, offset, padding_value)
J
Jiabin Yang 已提交
1668
    else:
1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
        check_type(x, 'x', (Variable), 'diag_v2')
        check_dtype(
            x.dtype,
            'x',
            ['float32', 'float64', 'int32', 'int64'],
            'diag_v2',
        )
        check_type(offset, 'offset', (int), 'diag_v2')
        check_type(padding_value, 'padding_value', (int, float), 'diag_v2')
        if len(x.shape) != 1 and len(x.shape) != 2:
            raise ValueError(
                "The dimension of input x must be either 1 or 2, but received {}".format(
                    len(x.shape)
1682
                )
1683
            )
1684

1685
        helper = LayerHelper("diag_v2", **locals())
1686

1687
        out = helper.create_variable_for_type_inference(dtype=x.dtype)
1688

1689 1690 1691 1692 1693 1694
        helper.append_op(
            type='diag_v2',
            inputs={'X': x},
            outputs={'Out': out},
            attrs={'offset': offset, 'padding_value': padding_value},
        )
1695

1696 1697
        out.stop_gradient = True
        return out
1698 1699 1700 1701


def empty(shape, dtype=None, name=None):
    """
1702
    Returns a Tensor with uninitialized data which size is same as ``shape``.
1703

1704
    Args:
1705 1706 1707
        shape (tuple|list|Tensor): Shape of the Tensor to be created. The data type is ``int32`` or ``int64`` .
            If ``shape`` is a list or tuple, each element of it should be integer or 0-D Tensor with shape [].
            If ``shape`` is an Tensor, it should be an 1-D Tensor which represents a list.
1708 1709 1710 1711
        dtype(np.dtype|str, optional): Data type of the output Tensor
            which can be bool, float16, float32, float64, int32, int64, if dytpe is `None`, the data
            type of created Tensor use global default dtype (see ``get_default_dtype``
            for details).
1712
        name(str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
1713

1714 1715 1716 1717 1718 1719
    Returns:
        Tensor: Tensor which is created according to ``shape`` and ``dtype``, and is uninitialized.

    Examples:
        .. code-block:: python

1720
            import paddle
1721

1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
            # shape is a list/tuple
            data1 = paddle.empty(shape=[3, 2])
            # [[1. 1.]
            #  [1. 1.]
            #  [1. 1.]]

            # shape is a Tensor
            shape = paddle.to_tensor([3, 2])
            data2 = paddle.empty(shape=shape)
            # [[1. 1.]
            #  [1. 1.]
            #  [1. 1.]]

            # shape is a Tensor List
            shape = [paddle.to_tensor(3), paddle.to_tensor(2)]
            data3 = paddle.empty(shape=shape)
            # [[1. 1.]
            #  [1. 1.]
            #  [1. 1.]]
1741 1742 1743 1744 1745 1746 1747
    """

    if dtype is None:
        dtype = paddle.get_default_dtype()

    dtype = convert_dtype(dtype)

1748 1749
    if in_dygraph_mode():
        shape = utils.convert_shape_to_list(shape)
1750 1751 1752
        out = _C_ops.empty(
            shape, convert_np_dtype_to_dtype_(dtype), _current_expected_place()
        )
1753 1754
        out.stop_gradient = True
        return out
1755 1756 1757
    else:
        helper = LayerHelper("empty", **locals())
        inputs = {}
1758

1759 1760 1761 1762 1763
        check_dtype(
            dtype,
            'dtype',
            ['bool', 'float16', 'float32', 'float64', 'int32', 'int64'],
            'empty',
1764
        )
1765
        check_type(shape, 'shape', (Variable, list, tuple), 'empty')
1766

1767 1768
        if isinstance(shape, Variable):
            check_dtype(shape.dtype, 'shape', ['int32', 'int64'], 'empty')
1769

1770 1771 1772 1773
        attrs = {}
        utils.get_shape_tensor_inputs(
            inputs=inputs, attrs=attrs, shape=shape, op_type='empty'
        )
1774

1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785
        out = helper.create_variable_for_type_inference(dtype=dtype)
        attrs['dtype'] = convert_np_dtype_to_dtype_(dtype)
        helper.append_op(
            type='empty',
            inputs=inputs,
            outputs={'Out': [out]},
            attrs=attrs,
            stop_gradient=True,
        )
        out.stop_gradient = True
        return out
1786 1787 1788 1789


def empty_like(x, dtype=None, name=None):
    """
C
Chen Long 已提交
1790
    Returns a Tensor with uninitialized data which has identical shape of ``x`` and ``dtype``.
1791
    If the ``dtype`` is None, the data type of Tensor is same with ``x``.
1792

1793 1794 1795
    Args:
        x(Tensor): The input tensor which specifies shape and data type. The data type can be bool, float16, float32, float64, int32, int64.
        dtype(np.dtype|str, optional): The data type of output. The data type can be one
1796
            of bool, float16, float32, float64, int32, int64. The default value is None, which means the output
1797
            data type is the same as input.
1798
        name(str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
1799

1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
    Returns:
        Tensor: Tensor which is created according to ``x`` and ``dtype``, and is uninitialized.

    Examples:
        .. code-block:: python

          import paddle

          paddle.set_device("cpu")  # and use cpu device

          x = paddle.randn([2, 3], 'float32')
          output = paddle.empty_like(x)
          #[[1.8491974e+20 1.8037303e+28 1.7443726e+28]     # uninitialized
          # [4.9640171e+28 3.0186127e+32 5.6715899e-11]]    # uninitialized
    """

    if dtype is None:
        dtype = x.dtype
    dtype = convert_dtype(dtype)

1820
    if in_dygraph_mode():
1821 1822 1823 1824 1825
        out = _C_ops.empty(
            x.shape,
            convert_np_dtype_to_dtype_(dtype),
            _current_expected_place(),
        )
1826 1827
        out.stop_gradient = True
        return out
1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842
    else:
        helper = LayerHelper("empty_like", **locals())
        check_variable_and_dtype(
            x,
            'x',
            ['bool', 'float16', 'float32', 'float64', 'int32', 'int64'],
            'empty_like',
        )
        check_dtype(
            dtype,
            'dtype',
            ['bool', 'float16', 'float32', 'float64', 'int32', 'int64'],
            'empty_like',
        )
        out = helper.create_variable_for_type_inference(dtype=dtype)
1843

1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857
        inputs = {}
        attrs = {}
        attrs['dtype'] = convert_np_dtype_to_dtype_(dtype)
        shape = paddle.shape(x)
        utils.get_shape_tensor_inputs(
            inputs=inputs, attrs=attrs, shape=shape, op_type='empty_like'
        )

        helper.append_op(
            type='empty',
            inputs=inputs,
            outputs={'Out': [out]},
            attrs=attrs,
            stop_gradient=True,
1858
        )
1859 1860 1861
        out.stop_gradient = True
        return out

1862 1863 1864

def assign(x, output=None):
    """
1865

1866
    Copy value of the :attr:`x` to the :attr:`output`.
1867

1868
    Parameters:
1869 1870
        x (Tensor|np.ndarray|list|tuple|scalar): A Tensor, numpy ndarray, tuple/list of scalar,
            or scalar. Its data type can be float16, float32, float64, int32, int64 or bool. Note: the float64 data will be converted to float32 because of current platform protobuf
1871
            data limitation.
1872
        output (Tensor, optional): A Tensor. If :attr:`output` is None, a new Tensor will be created as :attr:`output`. Default: None.
1873

1874
    Returns:
1875
        Tensor: A Tensor with the same shape, data type and value as :attr:`x`.
1876

1877 1878
    Examples:
        .. code-block:: python
1879

1880 1881 1882 1883 1884 1885 1886 1887 1888 1889
            import paddle
            import numpy as np
            data = paddle.full(shape=[3, 2], fill_value=2.5, dtype='float64') # [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]]
            array = np.array([[1, 1],
                                [3, 4],
                                [1, 3]]).astype(np.int64)
            result1 = paddle.zeros(shape=[3, 3], dtype='float32')
            paddle.assign(array, result1) # result1 = [[1, 1], [3 4], [1, 3]]
            result2 = paddle.assign(data)  # result2 = [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]]
            result3 = paddle.assign(np.array([[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]], dtype='float32')) # result3 = [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]]
1890
    """
1891 1892
    input = x
    helper = LayerHelper('assign', **locals())
1893 1894 1895 1896 1897 1898
    check_type(
        input,
        'input',
        (Variable, np.ndarray, list, tuple, float, int, bool),
        'assign',
    )
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
    is_inplace = True if output is not None else False

    if np.isscalar(input) and not isinstance(input, str):
        input = np.array([input])
    elif isinstance(input, (list, tuple)):
        input = np.array(input)
    # NOTE(Aurelius84): Why we judge core.VarBase?
    # In case of @to_static, a VarBase can be as input of `assign`,
    # but _non_static_mode()==False under @to_static, which means
    # isinstance(VarBase, Variable) == False. It will cause return None
    # after this api.
1910
    if isinstance(input, (Variable, core.VarBase, core.eager.Tensor)):
Z
zyfncg 已提交
1911
        if in_dygraph_mode():
1912
            if output is None:
1913
                output = _C_ops.assign(input)
Z
zyfncg 已提交
1914
            else:
1915
                _C_ops.assign_out_(input, output)
1916
        else:
1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932
            check_dtype(
                input.dtype,
                'input',
                [
                    'float16',
                    'uint16',
                    'float32',
                    'float64',
                    'int32',
                    'int64',
                    'uint8',
                    'bool',
                ],
                'assign',
                '(When the type of input in assign is Variable.)',
            )
1933 1934
            if output is None:
                output = helper.create_variable_for_type_inference(
1935 1936 1937 1938 1939
                    dtype=input.dtype
                )
            helper.append_op(
                type='assign', inputs={'X': [input]}, outputs={'Out': [output]}
            )
1940
    elif isinstance(input, np.ndarray):
1941
        # We now support the form of [var, VAR...] if the Var.shape=[1,]
1942
        if len(input.shape) > 0 and any(isinstance(x, Variable) for x in input):
1943
            # We only deal with the case where the list is nested one level, convert all scalars into variables, and then use stack to process. It is necessary to ensure the consistency of types.
1944 1945 1946 1947
            if not all(
                [
                    x.shape == (1,)
                    for x in input
1948
                    if isinstance(x, (Variable, core.eager.Tensor))
1949 1950
                ]
            ):
1951 1952 1953 1954 1955
                raise TypeError(
                    "Unsupport paddle.assign([Variable, Variable...]) with non-scalar variable."
                )

            def convert_scalar(x):
1956
                if not isinstance(x, (Variable, core.eager.Tensor)):
1957 1958 1959 1960 1961 1962 1963 1964 1965
                    return assign(x)
                return x

            to_stack_list = list(map(convert_scalar, input))
            ret = paddle.stack(to_stack_list)
            ret = paddle.squeeze(ret, -1)
            return ret

        if input.dtype == 'object':
1966
            """may be this form [[Var], [Var], [3], [4]], we reject them."""
1967
            raise TypeError(
1968
                "The type of received input == `object`, it is not supported to convert to tensor, such as [[Var], [Var], [3], [4]]"
1969
            )
1970

1971 1972 1973 1974 1975 1976 1977
        dtype = convert_np_dtype_to_dtype_(input.dtype)
        if dtype == core.VarDesc.VarType.FP64:
            # Setting FP64 numpy data is not supported in Paddle, so we
            # use FP32 here
            warnings.warn(
                "paddle.assign doesn't support float64 input now due "
                "to current platform protobuf data limitation, we convert "
1978 1979
                "it to float32"
            )
1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996
            dtype = core.VarDesc.VarType.FP32
        if dtype == core.VarDesc.VarType.BOOL:
            value_name = "bool_values"
            values = [int(v) for v in input.flat]
        elif dtype == core.VarDesc.VarType.FP32:
            value_name = "fp32_values"
            values = [float(v) for v in input.flat]
        elif dtype == core.VarDesc.VarType.INT32:
            value_name = "int32_values"
            values = [int(v) for v in input.flat]
        elif dtype == core.VarDesc.VarType.INT64:
            value_name = "int64_values"
            values = [int(v) for v in input.flat]
        else:
            raise TypeError(
                "When the type of 'input' in assign is numpy.ndarray, "
                "the data type of 'input' must be bool, float32, int32 or int64, but "
1997 1998
                "received %s." % convert_dtype(dtype)
            )
1999
        if input.size > 1024 * 1024:
2000 2001 2002 2003
            raise ValueError(
                "The size of input is too big. Please consider "
                "saving it to file and 'load_op' to load it"
            )
2004 2005 2006
        if in_dygraph_mode():
            if output is None:
                output = zeros(list(input.shape), dtype)
2007 2008 2009 2010 2011 2012 2013
            _C_ops.assign_value_(
                output,
                list(input.shape),
                dtype,
                values,
                _current_expected_place(),
            )
2014
        else:
2015 2016
            if output is None:
                output = helper.create_variable_for_type_inference(
2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
                    dtype=input.dtype
                )
            helper.append_op(
                type='assign_value',
                outputs={'Out': [output]},
                attrs={
                    'dtype': dtype,
                    'shape': list(input.shape),
                    value_name: values,
                },
            )
2028 2029

    return output
2030 2031


2032 2033
def clone(x, name=None):
    """
2034 2035
    Returns a copy of input Tensor. It will always have a Tensor copy.

2036 2037 2038 2039
    In addition, This function is derivable, so gradients will flow back from the output to input.

    Parameters:
        x (Tensor): The input Tensor.
2040
        name(str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
2041

2042
    Returns:
2043
        Tensor, A Tensor copied from ``input``.
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061

    Examples:
        .. code-block:: python

            import paddle

            x = paddle.ones([2])
            x.stop_gradient = False
            clone_x = paddle.clone(x)

            y = clone_x**3
            y.backward()
            print(clone_x.grad)          # [3]
            print(x.grad)                # [3]
    """
    return x.clone()


2062
# NOTE(zhiqiu): not public
2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
def _memcpy(input, place=None, output=None):
    """

    The OP copies the :attr:`input` to the :attr:`output`.
    NOTE: currently, only support CUDAPlace <-> CUDAPinnedPlace or NPUPlace <-> CPUPlace.

    Parameters:
        input (Tensor): A tensor. Its data type supports float16, float32, float64, int32, int64, and bool.
        device (Place): Target place for the output.
        output (Tensor, optional): A tensor. If :attr:`output` is None, a new tensor will
            be created as :attr:`output`. Default: None.

    Returns:
2076
        Tensor, A tensor with the same shape, data type and value as :attr:`input`.
2077 2078 2079 2080 2081

    Examples:
        .. code-block:: python

          import paddle
2082

2083 2084 2085 2086 2087 2088 2089
          data = paddle.full(shape=[3, 2], fill_value=2.5, dtype='float64') # [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]]
          result = paddle._memcpy(data, place=paddle.CPUPlace())  # result2 = [[2.5, 2.5], [2.5, 2.5], [2.5, 2.5]]
    """
    helper = LayerHelper('memcpy', **locals())
    check_type(input, 'input', (Variable), 'memcpy')

    if isinstance(input, (Variable, core.VarBase)):
2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105
        check_dtype(
            input.dtype,
            'input',
            [
                'float16',
                'uint16',
                'float32',
                'float64',
                'int32',
                'int64',
                'uint8',
                'bool',
            ],
            'memcpy',
            '(When the type of input in memcpy is Variable.)',
        )
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126
    if output is None:
        output = helper.create_variable_for_type_inference(dtype=input.dtype)

    dst_place_type = -1
    if place is None:
        dst_place_type = -1
    else:
        p = core.Place()
        p.set_place(place)
        if p.is_cpu_place():
            dst_place_type = 0
        elif p.is_gpu_place():
            dst_place_type = 1
        elif p.is_cuda_pinned_place():
            dst_place_type = 2
        elif p.is_xpu_place():
            dst_place_type = 3
        elif p.is_npu_place():
            dst_place_type = 4

    attrs = {'dst_place_type': dst_place_type}
2127 2128 2129 2130 2131 2132
    helper.append_op(
        type='memcpy',
        inputs={'X': [input]},
        outputs={'Out': [output]},
        attrs=attrs,
    )
2133
    return output
F
Feiyu Chan 已提交
2134 2135 2136 2137 2138 2139 2140 2141


def complex(real, imag, name=None):
    """Return a compelx tensor given the real and image component.

    Args:
        real (Tensor): The real component. The data type should be 'float32' or 'float64'.
        imag (Tensor): The image component. The data type should be the same as ``real``.
2142
        name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
F
Feiyu Chan 已提交
2143 2144 2145 2146

    Returns:
        Tensor: The output tensor. The data type is 'complex64' or 'complex128', with the same precision as ``real`` and ``imag``.

I
Infinity_lee 已提交
2147 2148 2149 2150
    Note:
        ``paddle.complex`` supports broadcasting. If you want know more about broadcasting, please refer to `Introduction to Tensor`_ .

        .. _Introduction to Tensor: ../../guides/beginner/tensor_en.html#chapter5-broadcasting-of-tensor
F
Feiyu Chan 已提交
2151 2152 2153 2154 2155 2156 2157 2158

    Examples:
        .. code-block:: python

            import paddle
            x = paddle.arange(2, dtype=paddle.float32).unsqueeze(-1)
            y = paddle.arange(3, dtype=paddle.float32)
            z = paddle.complex(x, y)
2159 2160 2161 2162
            print(z)
            # Tensor(shape=[2, 3], dtype=complex64, place=Place(cpu), stop_gradient=True,
            #        [[0j    , 1j    , 2j    ],
            #         [(1+0j), (1+1j), (1+2j)]])
F
Feiyu Chan 已提交
2163
    """
2164
    if in_dygraph_mode():
2165
        return _C_ops.complex(real, imag)
2166 2167 2168 2169 2170 2171 2172
    else:
        check_variable_and_dtype(
            real, 'real', ['float32', 'float64'], 'complex'
        )
        check_variable_and_dtype(
            imag, 'imag', ['float32', 'float64'], 'complex'
        )
2173

2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185
        op_type = "complex"
        helper = LayerHelper(op_type, **locals())
        inputs = {"X": real, "Y": imag}
        out = helper.create_variable_for_type_inference(
            dtype=_real_to_complex_dtype(real.dtype)
        )
        outputs = {"Out": out}
        attrs = {}
        helper.append_op(
            type=op_type, inputs=inputs, attrs=attrs, outputs=outputs
        )
        return out
2186 2187 2188 2189


def tril_indices(row, col, offset=0, dtype='int64'):
    """
2190 2191
    Return the indices of the lower triangular part of the 2-D matrix
    whose row and col is knowed.Indices are ordered based on row and then columns.
2192 2193
    The lower triangular part of the matrix is defined as the elements on
    and below the diagonal.
2194

2195 2196 2197 2198 2199
    Args:
        row (int): The input x which is a int number describe the number of row of the matrix.
        col (int): The input x which is a int number describe the number of col of the matrix.
        offset (int, optional): The offset to consider, default value is 0.

2200 2201 2202 2203
            - If offset = 0, all elements on and below the main diagonal are retained.
            - If offset > 0, include just as many diagonals above the main diagonal.
            - If offset < 0, excludes just as many diagonals below the main diagonal.

2204 2205 2206 2207 2208 2209 2210 2211 2212 2213
        dtype (int, optional): the data type of the output tensor, can be int32, int64.

    Returns:
        Tensor: Results of the indices of lower triangular part of a row * col matrix,
        where the first row contains row coordinates of and the second row contains column coordinates.

    Examples:
        .. code-block:: python

            import paddle
2214

2215 2216 2217
            # example 1, default offset value
            data1 = paddle.tril_indices(4,4,0)
            print(data1)
2218
            # [[0, 1, 1, 2, 2, 2, 3, 3, 3, 3],
2219 2220 2221 2222 2223
            #  [0, 0, 1, 0, 1, 2, 0, 1, 2, 3]]

            # example 2, positive offset value
            data2 = paddle.tril_indices(4,4,2)
            print(data2)
2224
            # [[0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3],
2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
            #  [0, 1, 2, 0, 1, 2, 3, 0, 1, 2, 3, 0, 1, 2, 3]]

            # example 3, negative offset value
            data3 = paddle.tril_indices(4,4,-1)
            print(data3)
            # [[ 1, 2, 2, 3, 3, 3],
            #  [ 0, 0, 1, 0, 1, 2]]
    """
    if not isinstance(dtype, core.VarDesc.VarType):
        dtype = convert_np_dtype_to_dtype_(dtype)

    if in_dygraph_mode():
2237 2238
        if col is None:
            col = row
2239 2240 2241
        out = _C_ops.tril_indices(
            row, col, offset, dtype, _current_expected_place()
        )
2242
        return out
2243 2244 2245
    else:
        if not isinstance(row, int) or row < 0:
            raise TypeError("row should be a non-negative int")
2246

2247 2248 2249 2250 2251 2252 2253 2254
        if col is not None:
            if not isinstance(col, int) or col < 0:
                raise TypeError("col should be a non-negative int")
        else:
            col = row

        if not isinstance(offset, int):
            raise TypeError("offset should be a  int")
2255 2256 2257 2258 2259

        helper = LayerHelper("tril_indices", **locals())

        out = helper.create_variable_for_type_inference(dtype=dtype)

2260 2261 2262 2263 2264 2265
        helper.append_op(
            type='tril_indices',
            inputs={},
            outputs={'out': [out]},
            attrs={'rows': row, 'cols': col, 'offset': offset, 'dtype': dtype},
        )
2266
    return out
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315


def triu_indices(row, col=None, offset=0, dtype='int64'):
    """
    Return the indices of the upper triangular part of the 2-D matrix
    whose row and col is known. Indices are ordered based on row and then columns.
    The upper triangular part of the matrix is defined as the elements on
    and above the diagonal.

    Args:
        row (int): The input x which is a int number describe the number of row of the matrix.
        col (int, optional): The input x which is a int number describe the number of col of the matrix.
            default value for col is None, then it will be set equal to row, indicting a square matix.
        offset (int, optional): The offset to consider, default value is 0.

            - If offset = 0, all elements on and above the main diagonal are retained.
            - If offset > 0, include just as few diagonals above the main diagonal.
            - If offset < 0, excludes just as few diagonals below the main diagonal.

        dtype (str|np.dtype|paddle.dtype, optional): the data type of the output tensor,
            can be int32, int64, default value is int64.
    Returns:
        Tensor: Results of the indices of upper triangular part of a row * col matrix,
        where the first row contains row coordinates of and the second row contains column coordinates.

    Examples:
        .. code-block:: python

            import paddle
            # example 1, default offset value
            data1 = paddle.triu_indices(4,4,0)
            print(data1)
            # [[0, 0, 0, 0, 1, 1, 1, 2, 2, 3],
            #  [0, 1, 2, 3, 1, 2, 3, 2, 3, 3]]
            # example 2, positive offset value
            data2 = paddle.triu_indices(4,4,2)
            print(data2)
            # [[0, 0, 1],
            #  [2, 3, 3]]
            # example 3, negative offset value
            data3 = paddle.triu_indices(4,4,-1)
            print(data3)
            # [[0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 3, 3],
            #  [0, 1, 2, 3, 0, 1, 2, 3, 1, 2, 3, 2, 3]]
    """
    if not isinstance(dtype, core.VarDesc.VarType):
        dtype = convert_np_dtype_to_dtype_(dtype)

    if in_dygraph_mode():
2316 2317
        if col is None:
            col = row
2318 2319 2320
        out = _C_ops.triu_indices(
            row, col, offset, dtype, _current_expected_place()
        )
2321
        return out
2322 2323 2324
    else:
        if not isinstance(row, int) or row < 0:
            raise TypeError("row should be a non-negative int")
2325

2326 2327 2328 2329 2330 2331 2332 2333
        if col is not None:
            if not isinstance(col, int) or col < 0:
                raise TypeError("col should be a non-negative int")
        else:
            col = row

        if not isinstance(offset, int):
            raise TypeError("offset should be a int")
2334 2335 2336 2337 2338

        helper = LayerHelper("triu_indices", **locals())

        out = helper.create_variable_for_type_inference(dtype=dtype)

2339 2340 2341 2342 2343 2344
        helper.append_op(
            type='triu_indices',
            inputs={},
            outputs={'out': [out]},
            attrs={'row': row, 'col': col, 'offset': offset, 'dtype': dtype},
        )
2345
    return out