nn.py 589.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
# Copyright (c) 2018 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
Y
Yu Yang 已提交
14
"""
15
All layers just related to the neural network.
Y
Yu Yang 已提交
16
"""
17 18
from __future__ import print_function

P
peizhilin 已提交
19
import os
S
sneaxiy 已提交
20
import inspect
21 22 23 24 25 26
import warnings

import numpy as np
import six

import paddle
Y
Yu Yang 已提交
27
from ..layer_helper import LayerHelper
28
from ..initializer import Normal, Constant, NumpyArrayInitializer
29
from ..framework import Variable, OpProtoHolder, in_dygraph_mode, dygraph_only, _dygraph_tracer, default_main_program
30
from .. import dygraph_utils
Y
yangyaming 已提交
31
from ..param_attr import ParamAttr
S
sneaxiy 已提交
32
from .layer_function_generator import autodoc, templatedoc, _generate_doc_string_
33
from .tensor import concat, assign, fill_constant, zeros, tensor_array_to_tensor
34
from . import utils
F
fengjiayi 已提交
35
from .. import unique_name
36
from functools import reduce
37
from .. import core
38
from ..data_feeder import convert_dtype, check_variable_and_dtype, check_type, check_dtype
39
import paddle
40
from paddle.utils import deprecated
Y
Yu Yang 已提交
41 42

__all__ = [
X
Xin Pan 已提交
43 44 45 46 47 48 49 50 51 52 53
    'fc',
    'embedding',
    'linear_chain_crf',
    'crf_decoding',
    'cos_sim',
    'chunk_eval',
    'conv2d',
    'conv3d',
    'softmax',
    'pool2d',
    'pool3d',
54 55
    'adaptive_pool2d',
    'adaptive_pool3d',
X
Xin Pan 已提交
56
    'batch_norm',
K
Kaipeng Deng 已提交
57
    'inplace_abn',
L
lvmengsi 已提交
58
    'instance_norm',
H
heqiaozhi 已提交
59
    'data_norm',
X
Xin Pan 已提交
60 61 62 63 64 65 66
    'conv2d_transpose',
    'conv3d_transpose',
    'reduce_sum',
    'reduce_mean',
    'reduce_max',
    'reduce_min',
    'reduce_prod',
Z
zhoukunsheng 已提交
67 68
    'reduce_all',
    'reduce_any',
X
Xin Pan 已提交
69 70 71 72 73 74 75 76 77 78 79
    'dropout',
    'split',
    'ctc_greedy_decoder',
    'l2_normalize',
    'matmul',
    'topk',
    'transpose',
    'im2sequence',
    'row_conv',
    'multiplex',
    'layer_norm',
D
Dun 已提交
80
    'group_norm',
D
dengkaipeng 已提交
81
    'spectral_norm',
X
Xin Pan 已提交
82 83 84 85 86 87 88
    'smooth_l1',
    'one_hot',
    'autoincreased_step_counter',
    'reshape',
    'squeeze',
    'unsqueeze',
    'lod_reset',
89
    'lod_append',
X
Xin Pan 已提交
90 91 92 93 94
    'lrn',
    'pad',
    'pad_constant_like',
    'label_smooth',
    'roi_pool',
J
jerrywgz 已提交
95
    'roi_align',
X
Xin Pan 已提交
96 97 98
    'dice_loss',
    'image_resize',
    'image_resize_short',
99
    'resize_linear',
X
Xin Pan 已提交
100
    'resize_bilinear',
K
Kaipeng Deng 已提交
101
    'resize_trilinear',
102
    'resize_nearest',
X
Xin Pan 已提交
103
    'gather',
104
    'gather_nd',
X
Xin Pan 已提交
105
    'scatter',
106 107
    'scatter_nd_add',
    'scatter_nd',
X
Xin Pan 已提交
108 109 110
    'random_crop',
    'mean_iou',
    'relu',
C
chengduo 已提交
111
    'selu',
X
Xin Pan 已提交
112 113
    'log',
    'crop',
114
    'crop_tensor',
X
Xin Pan 已提交
115 116 117 118 119 120 121 122 123 124 125 126 127 128
    'elu',
    'relu6',
    'pow',
    'stanh',
    'hard_sigmoid',
    'swish',
    'prelu',
    'brelu',
    'leaky_relu',
    'soft_relu',
    'flatten',
    'stack',
    'pad2d',
    'unstack',
Z
zhoukunsheng 已提交
129
    'unique',
130
    'unique_with_counts',
X
Xin Pan 已提交
131
    'expand',
132
    'expand_as',
X
Xin Pan 已提交
133 134 135 136 137 138 139 140
    'scale',
    'elementwise_add',
    'elementwise_div',
    'elementwise_sub',
    'elementwise_mul',
    'elementwise_max',
    'elementwise_min',
    'elementwise_pow',
Z
zhoukunsheng 已提交
141 142
    'elementwise_mod',
    'elementwise_floordiv',
X
Xin Pan 已提交
143 144 145 146 147 148
    'uniform_random_batch_size_like',
    'gaussian_random',
    'sampling_id',
    'gaussian_random_batch_size_like',
    'sum',
    'slice',
W
wangchaochaohu 已提交
149
    'strided_slice',
X
Xin Pan 已提交
150
    'shape',
Z
zhoukunsheng 已提交
151
    'rank',
Z
zhoukunsheng 已提交
152
    'size',
X
Xin Pan 已提交
153 154 155 156 157 158 159 160 161
    'logical_and',
    'logical_or',
    'logical_xor',
    'logical_not',
    'clip',
    'clip_by_norm',
    'mean',
    'mul',
    'maxout',
J
JiabinYang 已提交
162
    'space_to_depth',
W
whs 已提交
163
    'affine_grid',
164
    'affine_channel',
B
barrierye 已提交
165
    'similarity_focus',
M
minqiyang 已提交
166
    'hash',
D
dengkaipeng 已提交
167
    'grid_sampler',
G
gmcather 已提交
168 169
    'log_loss',
    'add_position_encoding',
Q
Qiao Longfei 已提交
170
    'bilinear_tensor_product',
C
chengduo 已提交
171 172
    'merge_selected_rows',
    'get_tensor_from_selected_rows',
S
shippingwang 已提交
173
    'shuffle_channel',
174
    'temporal_shift',
S
sneaxiy 已提交
175
    'py_func',
176
    'psroi_pool',
177
    'prroi_pool',
R
ruri 已提交
178
    'pixel_shuffle',
179
    'fsp_matrix',
H
heqiaozhi 已提交
180
    'continuous_value_model',
Z
zhoukunsheng 已提交
181
    'where',
Z
zhoukunsheng 已提交
182
    'sign',
183
    'deformable_conv',
184
    'unfold',
C
cjt222 已提交
185
    'deformable_roi_pooling',
J
Jiawei Wang 已提交
186
    'filter_by_instag',
187
    'shard_index',
H
huangjun12 已提交
188
    'hard_swish',
K
Kaipeng Deng 已提交
189
    'mish',
G
Guo Sheng 已提交
190
    'gather_tree',
191
    'uniform_random',
myq406450149's avatar
myq406450149 已提交
192
    'unbind',
Y
Yu Yang 已提交
193 194 195
]


196 197 198 199 200 201 202 203
@dygraph_only
def _elementwise_op_in_dygraph(x,
                               y,
                               axis=-1,
                               act=None,
                               use_mkldnn=False,
                               op_name=None):
    op = getattr(core.ops, op_name)
204
    out = op(x, y, 'axis', axis, 'use_mkldnn', use_mkldnn)
205

206 207
    return dygraph_utils._append_activation_in_dygraph(
        out, act, use_mkldnn=use_mkldnn)
208 209


Y
Yu Yang 已提交
210 211 212 213 214 215
def fc(input,
       size,
       num_flatten_dims=1,
       param_attr=None,
       bias_attr=None,
       act=None,
216
       name=None):
Y
Yu Yang 已提交
217
    """
218 219
    :api_attr: Static Graph

220
    **Fully Connected Layer**
Y
Yu Yang 已提交
221

222 223 224
    This operator creates a fully connected layer in the network. It can take
    a Tensor(or LoDTensor) or a list of Tensor(or LoDTensor) as its inputs(see
    Args in detail). It creates a variable called weight for each input Tensor,
225
    which represents a fully connected weight matrix from each input unit to
226 227 228 229
    each output unit. The fully connected layer multiplies each input Tensor
    with its corresponding weight to produce an output Tensor with shape :math:`[M, size]` ,
    where M is batch size. If a list of Tensor is given, the results of
    multiple output Tensors with shape :math:`[M, size]` will be summed up. If :attr:`bias_attr`
230
    is not None, a bias variable will be created and added to the output.
231
    Finally, if :attr:`act` is not None, it will be applied to the output as well.
C
caoying03 已提交
232

233
    When the input is a single Tensor(or LoDTensor):
C
caoying03 已提交
234

235 236 237 238
    .. math::

        Out = Act({XW + b})

239
    When the input is a list of Tensor(or LoDTensor):
240 241 242

    .. math::

243
        Out = Act({\sum_{i=0}^{N-1}X_iW_i + b})
244 245 246

    In the above equation:

247 248 249
    * :math:`N`: Number of the input. N equals to len(input) if input is list of Variable.
    * :math:`X_i`: The i-th input tensor.
    * :math:`W_i`: The i-th weights matrix corresponding i-th input tensor.
C
caoying03 已提交
250
    * :math:`b`: The bias parameter created by this layer (if needed).
251
    * :math:`Act`: The activation function.
252
    * :math:`Out`: The output Tensor.
253 254 255

    .. code-block:: text

256 257 258 259 260 261 262 263 264 265 266 267 268 269
        Case 1:
        Given a single Tensor data_1, and num_flatten_dims = 2:
            data_1.data = [[[0.1, 0.2],
                            [0.3, 0.4]]]
            data_1.shape = (1, 2, 2) # 1 is batch_size

            out = fluid.layers.fc(input=data_1, size=1, num_flatten_dims=2)

        Then output is:
            out.data = [[0.83234344], [0.34936576]]
            out.shape = (1, 2, 1)

        Case 2:
        Given a list of Tensor:
270 271 272 273 274 275 276 277 278 279 280 281 282
            data_1.data = [[[0.1, 0.2],
                           [0.3, 0.4]]]
            data_1.shape = (1, 2, 2) # 1 is batch_size

            data_2 = [[[0.1, 0.2, 0.3]]]
            data_2.shape = (1, 1, 3)

            out = fluid.layers.fc(input=[data_1, data_2], size=2)

        Then:
            out.data = [[0.18669507, 0.1893476]]
            out.shape = (1, 2)

Y
Yu Yang 已提交
283
    Args:
284 285 286
        input (Variable|list of Variable): A Tensor(or LoDTensor) with shape :math:`[N_1, N_2,..., N_k]` or
            a list of Tensor(or LoDTensor). The dimensions of the input Tensor is at least 2 and the data
            type should be float32 or float64.
T
tianshuo78520a 已提交
287
        size(int): The number of output units in this layer, which also means the feature size of output
288 289
            Tensor(or LoDTensor).
        num_flatten_dims (int): The fc layer can accept an input Tensor with more than
R
ranqiu 已提交
290
            two dimensions. If this happens, the multidimensional tensor will first be flattened
291 292
            into a 2-D matrix. The parameter :attr:`num_flatten_dims` determines how the input
            Tensor is flattened: the first :attr:`num_flatten_dims` (inclusive, index starts from 1)
R
ranqiu 已提交
293
            dimensions will be flatten to form the first dimension of the final matrix (height of
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
            the matrix), and the rest :math:`rank(X) - num\_flatten\_dims` dimensions are flattened to
            form the second dimension of the final matrix (width of the matrix). For example, assuming that
            X is a 5-dimensional Tensor with a shape [2, 3, 4, 5, 6], and :attr:`num_flatten_dims` = 3.
            Then, the flattened matrix will have a shape [2 x 3 x 4, 5 x 6] = [24, 30]. Default: 1.
        param_attr (ParamAttr): To specify the weight parameter property. Default: None, which means the
            default weight parameter property is used. See usage for details in :ref:`api_fluid_ParamAttr` .
        bias_attr (ParamAttr): To specify the bias parameter property. Default: None, which means the
            default bias parameter property is used. See usage for details in :ref:`api_fluid_ParamAttr` .
        act (str): Activation to be applied to the output of this layer, such as tanh, softmax,
            sigmoid, relu. For more information, please refer to :ref:`api_guide_activations_en` . Default: None.
        name (str, optional): The default value is None.  Normally there is no need for user to set this property.
            For more information, please refer to :ref:`api_guide_Name` .

    Returns:
        Variable: Tensor or LoDTensor calculated by fc layer. The data type is same with input.
309 310

    Raises:
311
        ValueError: If dimensions of the input Tensor is less than 2.
312 313 314 315

    Examples:
        .. code-block:: python

316
          import paddle.fluid as fluid
317
          # when input is single tensor
318
          data = fluid.data(name="data", shape=[-1, 32], dtype="float32")
319
          fc = fluid.layers.fc(input=data, size=1000, act="tanh")
320 321

          # when input are multiple tensors
322 323
          data_1 = fluid.data(name="data_1", shape=[-1, 32], dtype="float32")
          data_2 = fluid.data(name="data_2", shape=[-1, 36], dtype="float32")
324
          fc = fluid.layers.fc(input=[data_1, data_2], size=1000, act="tanh")
Y
Yu Yang 已提交
325
    """
C
caoying03 已提交
326
    helper = LayerHelper("fc", **locals())
327
    check_type(input, 'input', (list, tuple, Variable), 'fc')
328 329
    if isinstance(input, (list, tuple)):
        for i, input_x in enumerate(input):
330
            check_type(input_x, 'input[' + str(i) + ']', Variable, 'fc')
Y
Yu Yang 已提交
331
    dtype = helper.input_dtype()
332
    check_dtype(dtype, 'input', ['float16', 'float32', 'float64'], 'fc')
Y
Yu Yang 已提交
333
    mul_results = []
334 335
    for input_var, param_attr in helper.iter_inputs_and_params():
        input_shape = input_var.shape
336 337
        if num_flatten_dims == -1:
            num_flatten_dims = len(input_shape) - 1
Y
Yu Yang 已提交
338 339 340
        param_shape = [
            reduce(lambda a, b: a * b, input_shape[num_flatten_dims:], 1)
        ] + [size]
Y
ying 已提交
341

Y
Yu Yang 已提交
342
        w = helper.create_parameter(
343
            attr=param_attr, shape=param_shape, dtype=dtype, is_bias=False)
X
Xin Pan 已提交
344
        tmp = helper.create_variable_for_type_inference(dtype)
345
        helper.append_op(
346 347 348
            type="mul",
            inputs={"X": input_var,
                    "Y": w},
349
            outputs={"Out": tmp},
M
mozga-intel 已提交
350 351
            attrs={"x_num_col_dims": num_flatten_dims,
                   "y_num_col_dims": 1})
352 353 354 355
        mul_results.append(tmp)

    if len(mul_results) == 1:
        pre_bias = mul_results[0]
356
    else:
X
Xin Pan 已提交
357
        pre_bias = helper.create_variable_for_type_inference(dtype)
358
        helper.append_op(
359 360 361
            type="sum",
            inputs={"X": mul_results},
            outputs={"Out": pre_bias},
X
Xin Pan 已提交
362
            attrs={"use_mkldnn": False})
363 364 365 366
    # add bias
    pre_activation = helper.append_bias_op(pre_bias, dim_start=num_flatten_dims)
    # add activation
    return helper.append_activation(pre_activation)
Y
Yu Yang 已提交
367 368


369 370 371
def embedding(input,
              size,
              is_sparse=False,
372
              is_distributed=False,
373 374 375
              padding_idx=None,
              param_attr=None,
              dtype='float32'):
Y
Yu Yang 已提交
376
    """
377
    :api_attr: Static Graph
378

379 380 381 382 383 384 385 386 387 388 389 390
    **WARING:** This OP will be deprecated in a future release. This OP requires the
    last dimension of Tensor shape must be equal to 1. It is recommended to use
    fluid. :ref:`api_fluid_embedding` .

    The operator is used to lookup embeddings vector of ids provided by :attr:`input` .
    It automatically constructs a 2D embedding matrix based on the
    input :attr:`size` (vocab_size, emb_size) and :attr:`dtype` .

    This OP requires the last dimension of Tensor shape must be equal to 1. The shape
    of output Tensor is generated by replacing the last dimension of the input Tensor shape
    with emb_size.

391
    **Note:** The id in :attr:`input` must satisfy :math:`0 =< id < size[0]` ,
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
    otherwise the program will throw an exception and exit.

    .. code-block:: text

        Case 1:

        input is a Tensor. padding_idx = -1
            input.data = [[[1], [3]], [[2], [4]], [[4], [127]]]
            input.shape = [3, 2, 1]
        Given size = [128, 16]
        output is a Tensor:
            out.shape = [3, 2, 16]
            out.data = [[[0.129435295, 0.244512452, ..., 0.436322452],
                        [0.345421456, 0.524563927, ..., 0.144534654]],

                        [[0.345249859, 0.124939536, ..., 0.194353745],
                        [0.945345345, 0.435394634, ..., 0.435345365]],
409

410 411 412 413
                        [[0.945345345, 0.435394634, ..., 0.435345365],
                        [0.0,         0.0,         ..., 0.0        ]]]  # padding data
        The input padding_idx is less than 0, it is automatically converted to padding_idx = -1 + 128 = 127
        It will pad all-zero data when ids is 127.
414

415
        Case 2:
416

417 418 419 420 421 422 423 424 425 426 427 428 429 430
        input is a LoDTensor with 1-level LoD. padding_idx = 0
            input.lod = [[2, 3]]
            input.data = [[1], [3], [2], [4], [0]]
            input.shape = [5, 1]
        Given size = [128, 16]
        output is a LoDTensor:
            out.lod = [[2, 3]]
            out.shape = [5, 16]
            out.data = [[0.129435295, 0.244512452, ..., 0.436322452],
                        [0.345421456, 0.524563927, ..., 0.144534654],
                        [0.345249859, 0.124939536, ..., 0.194353745],
                        [0.945345345, 0.435394634, ..., 0.435345365],
                        [0.0,         0.0,         ..., 0.0        ]]  # padding data
        It will pad all-zero data when ids is 0.
Y
Yu Yang 已提交
431 432

    Args:
433 434 435 436 437 438
        input(Variable): A Tensor or LoDTensor with type int64, which contains the id information.
            The last dimension of Tensor shape must be equal to 1. The value of the input id should
            satisfy :math:`0<= id < size[0]` .
        size(tuple|list): The shape of lookup table parameter. It should have two elements which
            indicates the size of the dictionary of embeddings and the size of each embedding vector respectively.
        is_sparse(bool): The flag indicating whether to use sparse update. This parameter only
439
            affects the performance of the backwards gradient update. It is recommended to set
440
            True because sparse update is faster. But some optimizer does not support sparse update,
441
            such as :ref:`api_fluid_optimizer_AdadeltaOptimizer` , :ref:`api_fluid_optimizer_AdamaxOptimizer` ,
442 443 444 445 446
            :ref:`api_fluid_optimizer_DecayedAdagradOptimizer` , :ref:`api_fluid_optimizer_FtrlOptimizer` ,
            :ref:`api_fluid_optimizer_LambOptimizer` and :ref:`api_fluid_optimizer_LarsMomentumOptimizer` .
            In these case, is_sparse must be False. Default: False.
        is_distributed(bool): Whether to store the embedding matrix in a distributed manner. Only used
            in multi-machine distributed CPU training. Default: False.
447
        padding_idx(int|long|None): padding_idx needs to be in the interval [-vocab_size, vocab_size).
448 449 450 451 452 453
            If :math:`padding\_idx < 0`, the :math:`padding\_idx` will automatically be converted
            to :math:`vocab\_size + padding\_idx` . It will output all-zero padding data whenever lookup
            encounters :math:`padding\_idx` in id. And the padding data will not be updated while training.
            If set None, it makes no effect to output. Default: None.
        param_attr(ParamAttr): To specify the weight parameter property. Default: None, which means the
            default weight parameter property is used. See usage for details in :ref:`api_fluid_ParamAttr` . In addition,
454
            user-defined or pre-trained word vectors can be loaded with the :attr:`param_attr` parameter.
455
            The local word vector needs to be transformed into numpy format, and the shape of local word
T
tianshuo78520a 已提交
456
            vector should be consistent with :attr:`size` . Then :ref:`api_fluid_initializer_NumpyArrayInitializer`
457 458 459
            is used to load custom or pre-trained word vectors. See code example 2 for details.
        dtype(str|core.VarDesc.VarType): It refers to the data type of output Tensor.
            It must be float32 or float64. Default: float32.
Y
Yu Yang 已提交
460

461
    Returns:
462
        Variable: Embedding Tensor or LoDTensor mapped by input. The data type is the same as :attr:`dtype` .
Y
Yu Yang 已提交
463

464 465
    Examples:
        .. code-block:: python
Y
Yu Yang 已提交
466

B
bdzhuxiaoning 已提交
467
          import paddle.fluid as fluid
468 469 470
          import numpy as np
          data = fluid.data(name='x', shape=[None, 1], dtype='int64')

T
tianshuo78520a 已提交
471
          # example 1
472 473 474 475 476 477 478 479 480
          emb_1 = fluid.embedding(input=data, size=[128, 64])

          # example 2: load custom or pre-trained word vectors
          weight_data = np.random.random(size=(128, 100))  # word vectors with numpy format
          w_param_attrs = fluid.ParamAttr(
              name="emb_weight",
              learning_rate=0.5,
              initializer=fluid.initializer.NumpyArrayInitializer(weight_data),
              trainable=True)
481
          emb_2 = fluid.layers.embedding(input=data, size=(128, 100), param_attr=w_param_attrs, dtype='float32')
Y
Yu Yang 已提交
482 483 484
    """

    helper = LayerHelper('embedding', **locals())
485 486
    check_variable_and_dtype(input, 'input', ['int64'],
                             'fluid.layers.embedding')
487 488
    check_dtype(dtype, 'dtype', ['float16', 'float32', 'float64'],
                'fluid.layers.embedding')
489 490 491 492 493 494 495 496 497

    if is_distributed:
        is_distributed = False
        warnings.warn(
            "is_distributed is go out of use, `fluid.contrib.layers.sparse_embedding` is your needed"
        )

    remote_prefetch = True if is_sparse else False

Y
Yu Yang 已提交
498 499
    w = helper.create_parameter(
        attr=helper.param_attr, shape=size, dtype=dtype, is_bias=False)
X
Xin Pan 已提交
500
    tmp = helper.create_variable_for_type_inference(dtype)
501 502
    padding_idx = -1 if padding_idx is None else padding_idx if padding_idx >= 0 else (
        size[0] + padding_idx)
Y
Yu Yang 已提交
503 504 505 506 507
    helper.append_op(
        type='lookup_table',
        inputs={'Ids': input,
                'W': w},
        outputs={'Out': tmp},
508 509 510
        attrs={
            'is_sparse': is_sparse,
            'is_distributed': is_distributed,
Q
Qiao Longfei 已提交
511
            'remote_prefetch': remote_prefetch,
512 513
            'padding_idx': padding_idx
        })
Y
Yu Yang 已提交
514 515 516
    return tmp


517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
def _pull_sparse(input,
                 size,
                 table_id,
                 accessor_class,
                 name="embedding",
                 ctr_label_name="",
                 padding_id=0,
                 dtype='float32',
                 scale_sparse_grad=True):
    """
    **Pull Fleet Sparse Layer**

    This layer is used to lookup embeddings of IDs, provided by :attr:`input`, in
    Fleet lookup table. The result of this lookup is the embedding of each ID in the
    :attr:`input`.

    Args:
        input(Variable|list of Variable): Input is a Tensor<int64> Variable, which
            contains the IDs information.
        size(int): The embedding size parameter, which indicates the size of
            each embedding vector respectively.
        table_id(int): the fleet table id of this embedding.
        accessor_class(str): the pslib accessor of the table, default is DownpourCtrAccessor.
        ctr_label_name(str): the layer name of click.
        padding_id(int): the padding id during lookup, default is 0.
        dtype(str): The dtype refers to the data type of output tensor. Only supports
            float32 now.
        scale_sparse_grad(bool): whether to scale sparse gradient with batch size. default
            is True.

    Returns:
        Variable|list of Variable: The tensor variable storing the embeddings of the \
                  supplied inputs.

    Examples:
        .. code-block:: python

          import paddle.fluid as fluid
          data = fluid.layers.data(name='sequence', shape=[1], dtype='int64', lod_level=1)
          emb = fluid.layers.nn._pull_sparse(
              input=data, size=11, table_id=0, accessor_class="DownpourCtrAccessor")
    """
    helper = LayerHelper(name, **locals())
    inputs = helper.multiple_input()
    outs = [helper.create_variable_for_type_inference(dtype)]
    input_names = [i.name for i in inputs]
    attrs = {
        'EmbeddingDim': size,
        'TableId': table_id,
        'AccessorClass': accessor_class,
        'CtrLabelName': ctr_label_name,
        'PaddingId': padding_id,
        'ScaleSparseGrad': scale_sparse_grad,
        'InputNames': input_names,
        # this is only for compatible with embedding op
        'is_distributed': True
    }
    # this is only for compatible with embedding op
    w, _ = helper.create_or_get_global_variable(
        name=name, shape=[size], dtype=dtype, is_bias=False, persistable=True)
    helper.append_op(
        type='pull_sparse',
        inputs={'Ids': inputs,
                'W': w},
        outputs={'Out': outs},
        attrs=attrs)
    if len(outs) == 1:
        return outs[0]
    return outs


def _pull_sparse_v2(input,
                    size,
                    table_id,
                    accessor_class,
                    name="embedding",
                    ctr_label_name="",
                    padding_id=0,
                    dtype='float32',
                    scale_sparse_grad=True):
    """
    **Pull Fleet Sparse Layer**

    This layer is used to lookup embeddings of IDs, provided by :attr:`input`, in
    Fleet lookup table. The result of this lookup is the embedding of each ID in the
    :attr:`input`.

    Args:
        input(Variable|list of Variable): Input is a Tensor<int64> Variable, which
            contains the IDs information.
        size(int): The embedding size parameter, which indicates the size of
            each embedding vector respectively.
        table_id(int): the pslib table id of this embedding.
        accessor_class(str): the fleet accessor of the table, default is DownpourCtrAccessor.
        ctr_label_name(str): the layer name of click.
        padding_id(int): the padding id during lookup, default is 0.
        dtype(str): The dtype refers to the data type of output tensor. Only supports
            float32 now.
        scale_sparse_grad(bool): whether to scale sparse gradient with batch size. default
            is True.

    Returns:
        Variable|list of Variable: The tensor variable storing the embeddings of the \
                  supplied inputs.

    Examples:
        .. code-block:: python

          import paddle.fluid as fluid
          data = fluid.layers.data(name='sequence', shape=[1], dtype='int64', lod_level=1)
          emb = fluid.layers.nn._pull_sparse_v2(
              input=data, size=11, table_id=0, accessor_class="DownpourCtrAccessor")
    """
    helper = LayerHelper(name, **locals())
    inputs = helper.multiple_input()
    outs = [helper.create_variable_for_type_inference(dtype)]
    input_names = [i.name for i in inputs]
    attrs = {
        'EmbeddingDim': size,
        'TableId': table_id,
        'AccessorClass': accessor_class,
        'CtrLabelName': ctr_label_name,
        'PaddingId': padding_id,
        'ScaleSparseGrad': scale_sparse_grad,
        'InputNames': input_names,
        # this is only for compatible with embedding op
        'is_distributed': True
    }
    # this is only for compatible with embedding op
    w, _ = helper.create_or_get_global_variable(
        name=name, shape=[size], dtype=dtype, is_bias=False, persistable=True)
    helper.append_op(
        type='pull_sparse_v2',
        inputs={'Ids': inputs,
                'W': w},
        outputs={'Out': outs},
        attrs=attrs)
    if len(outs) == 1:
        return outs[0]
    return outs


H
hutuxian 已提交
659 660 661 662 663 664 665 666 667
def _pull_box_sparse(input, size, dtype='float32'):
    """
    **Pull Box Sparse Layer**

    This layer is used to lookup embeddings of IDs, provided by :attr:`input`, in
    BoxPS lookup table. The result of this lookup is the embedding of each ID in the
    :attr:`input`.

    Args:
668
        input(Variable|list of Variable): Input is a Tensor<int64> Variable, which
H
hutuxian 已提交
669
            contains the IDs information.
670
        size(int): The embedding size parameter, which indicates the size of
H
hutuxian 已提交
671
            each embedding vector respectively.
672
        dtype(str): The dtype refers to the data type of output tensor. Only supports
H
hutuxian 已提交
673 674 675 676 677 678 679 680 681 682 683
	    float32 now.

    Returns:
        Variable|list of Variable: The tensor variable storing the embeddings of the \
                  supplied inputs.

    Examples:
        .. code-block:: python

          import paddle.fluid as fluid
          data = fluid.layers.data(name='sequence', shape=[1], dtype='int64', lod_level=1)
684
          emb = fluid.layers.pull_box_sparse(input=data, size=[11])
H
hutuxian 已提交
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
    """
    helper = LayerHelper('pull_box_sparse', **locals())
    if dtype != 'float32':
        raise ValueError(
            "BoxPS only support float type embedding now, and your type is: " +
            dtype)
    helper.input_dtype()
    inputs = helper.multiple_input()
    outs = [
        helper.create_variable_for_type_inference(dtype)
        for i in range(len(inputs))
    ]
    helper.append_op(
        type='pull_box_sparse',
        inputs={'Ids': inputs},
        outputs={'Out': outs},
        attrs={'size': size})
    if len(outs) == 1:
        return outs[0]
    return outs


Y
yuyang18 已提交
707
@templatedoc()
708
def linear_chain_crf(input, label, param_attr=None, length=None):
Y
yuyang18 已提交
709
    """
710 711
    :api_attr: Static Graph

Y
yuyang18 已提交
712 713 714 715 716
    Linear Chain CRF.

    ${comment}

    Args:
717
        input(${emission_type}): ${emission_comment}
Y
yuyang18 已提交
718
        label(${label_type}): ${label_comment}
719
        Length(${length_type}): ${length_comment}
720
        param_attr(ParamAttr): The attribute of the learnable parameter for transition parameter.
Y
yuyang18 已提交
721 722

    Returns:
D
dzhwinter 已提交
723 724
        output(${emission_exps_type}): ${emission_exps_comment} \n
        output(${transition_exps_type}): ${transition_exps_comment} \n
725
        output(${log_likelihood_type}): ${log_likelihood_comment} \n
Y
yuyang18 已提交
726

J
JesseyXujin 已提交
727 728 729
    Examples:
        .. code-block:: python

730 731 732 733 734 735 736
            import paddle.fluid as fluid
            import numpy as np

            #define net structure, using LodTensor
            train_program = fluid.Program()
            startup_program = fluid.Program()
            with fluid.program_guard(train_program, startup_program):
737 738
                input_data = fluid.data(name='input_data', shape=[-1,10], dtype='float32')
                label = fluid.data(name='label', shape=[-1,1], dtype='int')
739 740 741 742 743 744
                emission= fluid.layers.fc(input=input_data, size=10, act="tanh")
                crf_cost = fluid.layers.linear_chain_crf(
                    input=emission,
                    label=label,
                    param_attr=fluid.ParamAttr(
                    name='crfw',
745
                    learning_rate=0.01))
746 747 748
            use_cuda = False
            place = fluid.CUDAPlace(0) if use_cuda else fluid.CPUPlace()
            exe = fluid.Executor(place)
749
            exe.run(startup_program)
750 751 752 753 754
            #define data, using LoDTensor
            a = fluid.create_lod_tensor(np.random.rand(12,10).astype('float32'), [[3,3,4,2]], place)
            b = fluid.create_lod_tensor(np.array([[1],[1],[2],[3],[1],[1],[1],[3],[1],[1],[1],[1]]),[[3,3,4,2]] , place)
            feed1 = {'input_data':a,'label':b}
            loss= exe.run(train_program,feed=feed1, fetch_list=[crf_cost])
755
            print(loss)
756 757 758 759 760

            #define net structure, using padding
            train_program = fluid.Program()
            startup_program = fluid.Program()
            with fluid.program_guard(train_program, startup_program):
761 762 763
                input_data2 = fluid.data(name='input_data2', shape=[-1,10,10], dtype='float32')
                label2 = fluid.data(name='label2', shape=[-1,10,1], dtype='int')
                label_length = fluid.data(name='length', shape=[-1,1], dtype='int')
764 765 766 767 768 769
                emission2= fluid.layers.fc(input=input_data2, size=10, act="tanh", num_flatten_dims=2)
                crf_cost2 = fluid.layers.linear_chain_crf(
                    input=emission2,
                    label=label2,
                    length=label_length,
                    param_attr=fluid.ParamAttr(
J
JesseyXujin 已提交
770
                     name='crfw',
771 772 773 774 775 776
                     learning_rate=0.01))

            use_cuda = False
            place = fluid.CUDAPlace(0) if use_cuda else fluid.CPUPlace()
            exe = fluid.Executor(place)
            exe.run(startup_program)
J
JesseyXujin 已提交
777

778 779 780
            #define data, using padding
            cc=np.random.rand(4,10,10).astype('float32')
            dd=np.random.rand(4,10,1).astype('int64')
781
            ll=np.array([[3],[3],[4],[2]])
782 783
            feed2 = {'input_data2':cc,'label2':dd,'length':ll}
            loss2= exe.run(train_program,feed=feed2, fetch_list=[crf_cost2])
784
            print(loss2)
785 786 787 788 789
            #[array([[ 7.8902354],
            #        [ 7.3602567],
            #        [ 10.004011],
            #        [ 5.86721  ]], dtype=float32)]

790 791 792
            #you can use find_var to get transition parameter.
            transition=np.array(fluid.global_scope().find_var('crfw').get_tensor())
            print(transition)
793

Y
yuyang18 已提交
794
    """
795 796 797
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'linear_chain_crf')
    check_variable_and_dtype(label, 'label', ['int64'], 'linear_chain_crf')
Y
Yu Yang 已提交
798
    helper = LayerHelper('linear_chain_crf', **locals())
799
    size = input.shape[2] if length else input.shape[1]
Y
Yu Yang 已提交
800 801 802 803
    transition = helper.create_parameter(
        attr=helper.param_attr,
        shape=[size + 2, size],
        dtype=helper.input_dtype())
X
Xin Pan 已提交
804 805 806 807 808 809 810 811
    alpha = helper.create_variable_for_type_inference(
        dtype=helper.input_dtype())
    emission_exps = helper.create_variable_for_type_inference(
        dtype=helper.input_dtype())
    transition_exps = helper.create_variable_for_type_inference(
        dtype=helper.input_dtype())
    log_likelihood = helper.create_variable_for_type_inference(
        dtype=helper.input_dtype())
812 813 814 815 816 817
    this_inputs = {
        "Emission": [input],
        "Transition": transition,
        "Label": [label]
    }
    if length:
818
        this_inputs['Length'] = [length]
Y
Yu Yang 已提交
819 820
    helper.append_op(
        type='linear_chain_crf',
821
        inputs=this_inputs,
Y
Yu Yang 已提交
822 823 824 825 826 827 828 829 830 831
        outputs={
            "Alpha": [alpha],
            "EmissionExps": [emission_exps],
            "TransitionExps": transition_exps,
            "LogLikelihood": log_likelihood
        })

    return log_likelihood


W
wopeizl 已提交
832
@templatedoc()
833
def crf_decoding(input, param_attr, label=None, length=None):
W
wopeizl 已提交
834
    """
835
    :api_attr: Static Graph
W
wopeizl 已提交
836
    ${comment}
Y
yi.wu 已提交
837

W
wopeizl 已提交
838 839
    Args:
        input(${emission_type}): ${emission_comment}
Y
yi.wu 已提交
840

841 842
        param_attr (ParamAttr|None): To specify the weight parameter attribute.
            Default: None, which means the default weight parameter property is
Y
Yibing Liu 已提交
843
            used. See usage for details in :ref:`api_fluid_ParamAttr` .
Y
yuyang18 已提交
844

Y
Yibing Liu 已提交
845
        label(${label_type}, optional): ${label_comment}
846

Y
Yibing Liu 已提交
847
        length(${length_type}, optional): ${length_comment}
848

W
wopeizl 已提交
849 850
    Returns:
        Variable: ${viterbi_path_comment}
Y
yi.wu 已提交
851

W
wopeizl 已提交
852 853
    Examples:
        .. code-block:: python
Y
yi.wu 已提交
854

855
           import paddle.fluid as fluid
856 857 858

           # LoDTensor-based example
           num_labels = 10
Y
Yibing Liu 已提交
859 860
           feature = fluid.data(name='word_emb', shape=[-1, 784], dtype='float32', lod_level=1)
           label = fluid.data(name='label', shape=[-1, 1], dtype='int64', lod_level=1)
861
           emission = fluid.layers.fc(input=feature, size=num_labels)
862 863

           crf_cost = fluid.layers.linear_chain_crf(input=emission, label=label,
Y
Yibing Liu 已提交
864
                     param_attr=fluid.ParamAttr(name="crfw"))
865
           crf_decode = fluid.layers.crf_decoding(input=emission,
Y
Yibing Liu 已提交
866
                     param_attr=fluid.ParamAttr(name="crfw"))
867 868 869

           # Common tensor example
           num_labels, max_len = 10, 20
Y
Yibing Liu 已提交
870 871 872
           feature = fluid.data(name='word_emb_pad', shape=[-1, max_len, 784], dtype='float32')
           label = fluid.data(name='label_pad', shape=[-1, max_len, 1], dtype='int64')
           length = fluid.data(name='length', shape=[-1, 1], dtype='int64')
873 874
           emission = fluid.layers.fc(input=feature, size=num_labels,
                                      num_flatten_dims=2)
875 876

           crf_cost = fluid.layers.linear_chain_crf(input=emission, label=label, length=length,
877 878 879
                     param_attr=fluid.ParamAttr(name="crfw_pad"))
           crf_decode = fluid.layers.crf_decoding(input=emission, length=length,
                     param_attr=fluid.ParamAttr(name="crfw_pad"))
W
wopeizl 已提交
880
    """
881 882
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'crf_decoding')
W
wopeizl 已提交
883 884 885
    helper = LayerHelper('crf_decoding', **locals())
    transition = helper.get_parameter(param_attr.name)
    viterbi_path = helper.create_variable_for_type_inference(
886
        dtype=core.VarDesc.VarType.INT64)
887 888 889
    inputs = {"Emission": [input], "Transition": transition, "Label": label}
    if length:
        inputs['Length'] = length
W
wopeizl 已提交
890 891
    helper.append_op(
        type='crf_decoding',
892
        inputs=inputs,
W
wopeizl 已提交
893
        outputs={"ViterbiPath": [viterbi_path]})
Y
Yu Yang 已提交
894

W
wopeizl 已提交
895
    return viterbi_path
Y
Yu Yang 已提交
896 897


Y
yi.wu 已提交
898
@templatedoc()
F
fengjiayi 已提交
899
def cos_sim(X, Y):
Y
Yu Yang 已提交
900
    """
Y
yi.wu 已提交
901 902 903
    ${comment}

    Args:
904 905
        X (Variable): ${x_comment}.
        Y (Variable): ${y_comment}.
F
fengjiayi 已提交
906

Y
yi.wu 已提交
907
    Returns:
L
lvmengsi 已提交
908
        A Variable holding LoDTensor representing the output of cosine(X, Y).
L
lvmengsi 已提交
909 910 911 912

    Examples:
        .. code-block:: python

913
            import paddle.fluid as fluid
L
lvmengsi 已提交
914 915
            x = fluid.data(name='x', shape=[3, 7], dtype='float32')
            y = fluid.data(name='y', shape=[1, 7], dtype='float32')
L
lvmengsi 已提交
916
            out = fluid.layers.cos_sim(x, y)
Y
Yu Yang 已提交
917
    """
918 919
    check_variable_and_dtype(X, 'X', ['float32'], 'cos_sim')
    check_variable_and_dtype(Y, 'Y', ['float32'], 'cos_sim')
F
fengjiayi 已提交
920
    helper = LayerHelper('cos_sim', **locals())
X
Xin Pan 已提交
921 922 923
    out = helper.create_variable_for_type_inference(dtype=X.dtype)
    xnorm = helper.create_variable_for_type_inference(dtype=X.dtype)
    ynorm = helper.create_variable_for_type_inference(dtype=X.dtype)
Y
Yu Yang 已提交
924 925 926 927 928 929 930 931 932 933
    helper.append_op(
        type='cos_sim',
        inputs={'X': [X],
                'Y': [Y]},
        outputs={'Out': [out],
                 'XNorm': [xnorm],
                 'YNorm': [ynorm]})
    return out


P
phlrain 已提交
934 935 936 937 938
def dropout(x,
            dropout_prob,
            is_test=False,
            seed=None,
            name=None,
P
phlrain 已提交
939
            dropout_implementation="downgrade_in_infer"):
940
    """
941 942 943 944
    :alias_main: paddle.nn.functional.dropout
	:alias: paddle.nn.functional.dropout,paddle.nn.functional.common.dropout
	:old_api: paddle.fluid.layers.dropout

945 946 947 948
    Computes dropout.

    Drop or keep each element of `x` independently. Dropout is a regularization
    technique for reducing overfitting by preventing neuron co-adaption during
949
    training. The dropout operator randomly sets (according to the given dropout
950 951 952
    probability) the outputs of some units to zero, while others are remain
    unchanged.

H
haowang101779990 已提交
953 954
    dropout op can be removed from the program to make the program more efficient.

955
    Args:
L
lvmengsi 已提交
956
        x (Variable): The input tensor variable. The data type is float16 or float32 or float64.
957
        dropout_prob (float): Probability of setting units to zero.
958 959 960 961
        is_test (bool): A flag indicating whether it is in test phrase or not.
        seed (int): A Python integer used to create random seeds. If this
                    parameter is set to None, a random seed is used.
                    NOTE: If an integer seed is given, always the same output
L
lvmengsi 已提交
962
                    units will be dropped. DO NOT use a fixed seed in training.Default: None.
963 964
        name (str|None): A name for this layer(optional). If set None, the layer
                         will be named automatically.
H
haowang101779990 已提交
965 966
        dropout_implementation(string): ['downgrade_in_infer'(default)|'upscale_in_train']

P
phlrain 已提交
967
                                        1. downgrade_in_infer(default), downgrade the outcome at inference
H
haowang101779990 已提交
968 969

                                           - train: out = input * mask
C
ceci3 已提交
970
                                           - inference: out = input * (1.0 - dropout_prob)
H
haowang101779990 已提交
971 972 973

                                           (mask is a tensor same shape with input, value is 0 or 1
                                           ratio of 0 is dropout_prob)
P
phlrain 已提交
974
                                        2. upscale_in_train, upscale the outcome at training time
975

H
haowang101779990 已提交
976 977
                                           - train: out = input * mask / ( 1.0 - dropout_prob )
                                           - inference: out = input
P
phlrain 已提交
978

H
haowang101779990 已提交
979 980
                                           (mask is a tensor same shape with input, value is 0 or 1
                                           ratio of 0 is dropout_prob)
981

M
minqiyang 已提交
982

983
    Returns:
L
lvmengsi 已提交
984
        A Variable holding Tensor representing the dropout, has same shape and data type with `x`.
985 986

    Examples:
987

988 989
        .. code-block:: python

990
            import paddle.fluid as fluid
L
lvmengsi 已提交
991
            x = fluid.data(name="data", shape=[None, 32, 32], dtype="float32")
T
tianshuo78520a 已提交
992
            dropped = fluid.layers.dropout(x, dropout_prob=0.5)
993 994
    """

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
    def get_attrs(prog, dropout_prob, is_test, seed):
        if (seed is None or seed == 0) and prog.random_seed != 0:
            seed = prog.random_seed
        attrs = {
            'dropout_prob': dropout_prob,
            'is_test': is_test,
            'fix_seed': seed is not None,
            'seed': seed if seed is not None else 0,
            'dropout_implementation': dropout_implementation,
        }
        return attrs

    if in_dygraph_mode():
1008 1009 1010 1011
        if (seed is None or
                seed == 0) and default_main_program().random_seed != 0:
            seed = default_main_program().random_seed
        _is_test = not _dygraph_tracer()._train_mode
1012 1013 1014 1015
        out, mask = core.ops.dropout(
            x, 'dropout_prob', dropout_prob, 'is_test', _is_test, 'fix_seed',
            seed is not None, 'seed', seed if seed is not None else 0,
            'dropout_implementation', dropout_implementation)
1016
        return out
1017

F
fengjiayi 已提交
1018
    helper = LayerHelper('dropout', **locals())
1019 1020
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'],
                             'dropout')
1021

X
Xin Pan 已提交
1022 1023
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    mask = helper.create_variable_for_type_inference(
Z
Zeng Jinle 已提交
1024
        dtype=core.VarDesc.VarType.UINT8, stop_gradient=True)
C
chengduo 已提交
1025

1026
    attrs = get_attrs(helper.main_program, dropout_prob, is_test, seed)
C
chengduo 已提交
1027

1028 1029 1030 1031 1032
    helper.append_op(
        type='dropout',
        inputs={'X': [x]},
        outputs={'Out': [out],
                 'Mask': [mask]},
1033
        attrs=attrs)
1034 1035 1036
    return out


Y
yi.wu 已提交
1037
@templatedoc()
Y
Yu Yang 已提交
1038 1039 1040 1041
def chunk_eval(input,
               label,
               chunk_scheme,
               num_chunk_types,
1042 1043
               excluded_chunk_types=None,
               seq_length=None):
Y
Yu Yang 已提交
1044
    """
G
Guo Sheng 已提交
1045 1046
    This operator computes the precision, recall and F1-score for chunk detection.
    It is often used in sequence tagging tasks, such as Named Entity Recognition(NER).
Y
yi.wu 已提交
1047

M
minqiyang 已提交
1048
    For some basics of chunking, please refer to
H
haowang101779990 已提交
1049
    `Chunking with Support Vector Machines <https://aclanthology.info/pdf/N/N01/N01-1025.pdf>`_ .
Y
yi.wu 已提交
1050

G
Guo Sheng 已提交
1051 1052
    This operator supports IOB, IOE, IOBES and IO (also known as plain) tagging schemes.
    Here is a NER example for the usage of these tagging schemes:
Y
yi.wu 已提交
1053 1054

    .. code-block:: python
1055

Y
yi.wu 已提交
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
       ====== ====== ======  =====  ==  ============   =====  ===== =====  ==  =========
              Li     Ming    works  at  Agricultural   Bank   of    China  in  Beijing.
       ====== ====== ======  =====  ==  ============   =====  ===== =====  ==  =========
       IO     I-PER  I-PER   O      O   I-ORG          I-ORG  I-ORG I-ORG  O   I-LOC
       IOB    B-PER  I-PER   O      O   B-ORG          I-ORG  I-ORG I-ORG  O   B-LOC
       IOE    I-PER  E-PER   O      O   I-ORG          I-ORG  I-ORG E-ORG  O   E-LOC
       IOBES  B-PER  E-PER   O      O   I-ORG          I-ORG  I-ORG E-ORG  O   S-LOC
       ====== ====== ======  =====  ==  ============   =====  ===== =====  ==  =========

    There are three chunk types(named entity types) including PER(person), ORG(organization)
G
Guo Sheng 已提交
1066
    and LOC(location), and we can see that the labels have the form `<tag type>-<chunk type>` .
Y
yi.wu 已提交
1067

G
Guo Sheng 已提交
1068 1069 1070
    Since the implementation of this operator actually uses label ids rather than
    label strings, to make it work, there should be a way to map label ids to
    tag types and chunk types. This operator uses the following way to do mapping:
Y
yi.wu 已提交
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080

    .. code-block:: python

       tag_type = label % num_tag_type
       chunk_type = label / num_tag_type

    where `num_tag_type` is the num of tag types in the tagging scheme, `num_chunk_type`
    is the num of chunk types, and `tag_type` get its value from the following table.

    .. code-block:: python
1081

Y
yi.wu 已提交
1082 1083 1084 1085 1086 1087
       Scheme Begin Inside End   Single
        plain   0     -      -     -
        IOB     0     1      -     -
        IOE     -     0      1     -
        IOBES   0     1      2     3

G
Guo Sheng 已提交
1088 1089
    Accordingly, in the above NER example, if the tagging scheme is IOB and chunk
    types are ORG, PER and LOC, then the label ids would be as follows:
Y
yi.wu 已提交
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100

    .. code-block:: python

       B-ORG  0
       I-ORG  1
       B-PER  2
       I-PER  3
       B-LOC  4
       I-LOC  5
       O      6

G
Guo Sheng 已提交
1101 1102
    With which we can map each label id to the corresponding tag type and chunk
    type correctly.
Y
yi.wu 已提交
1103

Y
yi.wu 已提交
1104
    Args:
G
Guo Sheng 已提交
1105 1106 1107 1108 1109 1110
        input (Variable): A Tensor or LoDTensor, representing the predicted labels
            from the network. When it is a Tensor, its shape would be `[N, M, 1]`,
            where `N` stands for batch size, `M` for sequence length; When it is
            a LoDTensor, its shape would be `[N, 1]` where `N` stands for the total
            sequence lengths in this mini-batch. The data type should be int64.
        label (Variable): A Tensor or LoDTensor representing the ground-truth labels.
T
tianshuo78520a 已提交
1111
            It should have the same shape, lod and data type as ``input`` .
G
Guo Sheng 已提交
1112 1113 1114 1115 1116 1117 1118 1119 1120
        chunk_scheme (str): Indicate the tagging schemes used here. The value must
            be IOB, IOE, IOBES or plain.
        num_chunk_types (int): The number of chunk types.
        excluded_chunk_types (list, optional): Indicate the chunk types shouldn't
            be taken into account. It should be a list of chunk type ids(integer).
            Default None.
        seq_length(Variable, optional): A 1D Tensor containing the length of each
            sequence when ``input`` and ``label`` are Tensor. It needn't be
            provided if ``input`` and ``label`` are LoDTensor. Default None.
F
fengjiayi 已提交
1121

Y
yi.wu 已提交
1122
    Returns:
G
Guo Sheng 已提交
1123 1124 1125 1126
        tuple: A tuple including precision, recall, F1-score, chunk number detected, \
            chunk number in ground-truth, chunk number correctly detected. Each \
            is a Tensor with shape `[1]`. The data type of precision, recall and \
            F1-score all is float32, and the others' data type all is int64.
1127

Y
yi.wu 已提交
1128 1129 1130
    Examples:
        .. code-block:: python

1131 1132 1133 1134
            import paddle.fluid as fluid

            dict_size = 10000
            label_dict_len = 7
G
Guo Sheng 已提交
1135
            sequence = fluid.data(
1136
                name='id', shape=[None, 1], lod_level=1, dtype='int64')
G
Guo Sheng 已提交
1137
            embedding = fluid.embedding(
1138 1139
                input=sequence, size=[dict_size, 512])
            hidden = fluid.layers.fc(input=embedding, size=512)
1140 1141
            label = fluid.data(
                name='label', shape=[None, 1], lod_level=1, dtype='int64')
Y
yi.wu 已提交
1142
            crf = fluid.layers.linear_chain_crf(
1143
                input=hidden, label=label, param_attr=fluid.ParamAttr(name="crfw"))
Y
yi.wu 已提交
1144
            crf_decode = fluid.layers.crf_decoding(
1145
                input=hidden, param_attr=fluid.ParamAttr(name="crfw"))
Y
yi.wu 已提交
1146 1147 1148 1149
            fluid.layers.chunk_eval(
                input=crf_decode,
                label=label,
                chunk_scheme="IOB",
1150
                num_chunk_types=int((label_dict_len - 1) / 2))
Y
Yu Yang 已提交
1151
    """
F
fengjiayi 已提交
1152
    helper = LayerHelper("chunk_eval", **locals())
Y
Yu Yang 已提交
1153

1154 1155 1156
    check_variable_and_dtype(input, 'input', ['int64'], 'chunk_eval')
    check_variable_and_dtype(label, 'label', ['int64'], 'chunk_eval')

Y
Yu Yang 已提交
1157
    # prepare output
X
Xin Pan 已提交
1158 1159 1160 1161 1162 1163 1164
    precision = helper.create_variable_for_type_inference(dtype="float32")
    recall = helper.create_variable_for_type_inference(dtype="float32")
    f1_score = helper.create_variable_for_type_inference(dtype="float32")
    num_infer_chunks = helper.create_variable_for_type_inference(dtype="int64")
    num_label_chunks = helper.create_variable_for_type_inference(dtype="int64")
    num_correct_chunks = helper.create_variable_for_type_inference(
        dtype="int64")
Y
Yu Yang 已提交
1165

1166 1167
    this_input = {"Inference": [input], "Label": [label]}

1168
    if seq_length is not None:
1169 1170
        this_input["SeqLength"] = [seq_length]

Y
Yu Yang 已提交
1171 1172
    helper.append_op(
        type="chunk_eval",
1173
        inputs=this_input,
Y
Yu Yang 已提交
1174 1175 1176
        outputs={
            "Precision": [precision],
            "Recall": [recall],
1177 1178 1179 1180
            "F1-Score": [f1_score],
            "NumInferChunks": [num_infer_chunks],
            "NumLabelChunks": [num_label_chunks],
            "NumCorrectChunks": [num_correct_chunks]
Y
Yu Yang 已提交
1181 1182 1183
        },
        attrs={
            "num_chunk_types": num_chunk_types,
G
guosheng 已提交
1184 1185
            "chunk_scheme": chunk_scheme,
            "excluded_chunk_types": excluded_chunk_types or []
Y
Yu Yang 已提交
1186
        })
1187 1188
    return (precision, recall, f1_score, num_infer_chunks, num_label_chunks,
            num_correct_chunks)
Y
Yu Yang 已提交
1189 1190


1191
def softmax(input, use_cudnn=False, name=None, axis=-1):
Y
Yu Yang 已提交
1192
    """
1193
    This operator implements the softmax layer. The calculation process is as follows:
1194

1195
    1. The dimension :attr:`axis` of the ``input`` will be permuted to the last.
1196

1197 1198 1199 1200 1201 1202 1203
    2. Then the input tensor will be logically flattened to a 2-D matrix. The matrix's
    second dimension(row length) is the same as the dimension :attr:`axis` of the input
    tensor, and the first dimension(column length) is the product of all other
    dimensions of the input tensor. For each row of the matrix, the softmax operator
    squashes the K-dimensional(K is the width of the matrix, which is also the size
    of the input tensor's dimension :attr:`axis`) vector of arbitrary real values to a
    K-dimensional vector of real values in the range [0, 1] that add up to 1.
1204

1205
    3. After the softmax operation is completed, the inverse operations of steps 1 and 2
1206
    are performed to restore the two-dimensional matrix to the same dimension as the ``input``.
1207

1208 1209 1210 1211 1212
    It computes the exponential of the given dimension and the sum of exponential
    values of all the other dimensions in the K-dimensional vector input.
    Then the ratio of the exponential of the given dimension and the sum of
    exponential values of all the other dimensions is the output of the softmax
    operator.
1213

1214
    For each row :math:`i` and each column :math:`j` in the matrix, we have:
1215

1216
    .. math::
1217

1218
        Out[i, j] = \\frac{\exp(X[i, j])}{\sum_j(exp(X[i, j])}
1219

1220
    Example:
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264

    .. code-block:: text

        Case 1:
          Input:
            X.shape = [2, 3, 4]
            X.data = [[[2.0, 3.0, 4.0, 5.0],
                       [3.0, 4.0, 5.0, 6.0],
                       [7.0, 8.0, 8.0, 9.0]],
                      [[1.0, 2.0, 3.0, 4.0],
                       [5.0, 6.0, 7.0, 8.0],
                       [6.0, 7.0, 8.0, 9.0]]]

          Attrs:
            axis = -1

          Output:
            Out.shape = [2, 3, 4]
            Out.data = [[[0.0320586 , 0.08714432, 0.23688282, 0.64391426],
                         [0.0320586 , 0.08714432, 0.23688282, 0.64391426],
                         [0.07232949, 0.19661193, 0.19661193, 0.53444665]],
                        [[0.0320586 , 0.08714432, 0.23688282, 0.64391426],
                         [0.0320586 , 0.08714432, 0.23688282, 0.64391426],
                         [0.0320586 , 0.08714432, 0.23688282, 0.64391426]]]

        Case 2:
          Input:
            X.shape = [2, 3, 4]
            X.data = [[[2.0, 3.0, 4.0, 5.0],
                       [3.0, 4.0, 5.0, 6.0],
                       [7.0, 8.0, 8.0, 9.0]],
                      [[1.0, 2.0, 3.0, 4.0],
                       [5.0, 6.0, 7.0, 8.0],
                       [6.0, 7.0, 8.0, 9.0]]]
          Attrs:
            axis = 1

          Output:
            Out.shape = [2, 3, 4]
            Out.data = [[[0.00657326, 0.00657326, 0.01714783, 0.01714783],
                         [0.01786798, 0.01786798, 0.04661262, 0.04661262],
                         [0.97555875, 0.97555875, 0.93623955, 0.93623955]],
                        [[0.00490169, 0.00490169, 0.00490169, 0.00490169],
                         [0.26762315, 0.26762315, 0.26762315, 0.26762315],
1265
                         [0.72747516, 0.72747516, 0.72747516, 0.72747516]]]
1266

Q
qiaolongfei 已提交
1267
    Args:
1268 1269
        input (Variable): The input variable. A multi-dimension ``Tensor`` with type float32 or float64.
        use_cudnn (bool, optional): Use cudnn kernel or not, it is valid only when the cudnn \
T
tianshuo78520a 已提交
1270
            library is installed. To improve numerical stability, set use_cudnn to \
1271 1272
            False by default.
        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` . Default: None.
C
chengduo 已提交
1273
            will be named automatically. Default: None.
1274
        axis (int, optional): The index of dimension to perform softmax calculations, it should
D
dengkaipeng 已提交
1275
            be in range :math:`[-1, rank - 1]`, while :math:`rank` is the rank of
1276
            input variable. Default: -1. -1 means the last dimension.
Q
qiaolongfei 已提交
1277 1278

    Returns:
1279
        Variable: ``Tensor`` indicates the output of softmax. The data type and shape are the same as ``input`` .
Q
qiaolongfei 已提交
1280 1281 1282 1283 1284

    Examples:

        .. code-block:: python

1285 1286
            import paddle.fluid as fluid
            import numpy as np
Q
qiaolongfei 已提交
1287

1288 1289 1290 1291 1292 1293 1294 1295 1296
            data = fluid.data(name="input", shape=[-1, 3],dtype="float32")
            result = fluid.layers.softmax(data,axis=1)
            place = fluid.CPUPlace()
            exe = fluid.Executor(place)
            exe.run(fluid.default_startup_program())
            x = np.random.rand(3, 3).astype("float32")
            output= exe.run(feed={"input": x},
                             fetch_list=[result[0]])
            print(output)
Q
qiaolongfei 已提交
1297
    """
1298 1299

    if in_dygraph_mode():
1300 1301 1302 1303
        return core.ops.softmax(input, 'axis', axis, 'use_cudnn', use_cudnn)

    inputs = {"X": [input]}
    attrs = {"axis": axis, "use_cudnn": use_cudnn}
1304

1305
    helper = LayerHelper('softmax', **locals())
1306 1307
    check_variable_and_dtype(input, 'input/x',
                             ['float16', 'float32', 'float64'], 'softmax')
1308

1309
    dtype = helper.input_dtype()
X
Xin Pan 已提交
1310
    softmax_out = helper.create_variable_for_type_inference(dtype)
1311 1312 1313 1314
    helper.append_op(
        type="softmax",
        inputs={"X": input},
        outputs={"Out": softmax_out},
1315
        attrs=attrs)
1316 1317 1318
    return softmax_out


Y
Yu Yang 已提交
1319 1320 1321
def conv2d(input,
           num_filters,
           filter_size,
C
chengduoZH 已提交
1322 1323
           stride=1,
           padding=0,
1324
           dilation=1,
Y
Yu Yang 已提交
1325 1326 1327
           groups=None,
           param_attr=None,
           bias_attr=None,
C
chengduoZH 已提交
1328
           use_cudnn=True,
1329
           act=None,
L
liym27 已提交
1330 1331
           name=None,
           data_format="NCHW"):
Y
Yu Yang 已提交
1332
    """
1333 1334
    :api_attr: Static Graph

C
chengduoZH 已提交
1335
    The convolution2D layer calculates the output based on the input, filter
T
tensor-tang 已提交
1336
    and strides, paddings, dilations, groups parameters. Input and
L
liym27 已提交
1337
    Output are in NCHW or NHWC format, where N is batch size, C is the number of
1338
    channels, H is the height of the feature, and W is the width of the feature.
T
tensor-tang 已提交
1339 1340 1341 1342 1343 1344
    Filter is in MCHW format, where M is the number of output image channels,
    C is the number of input image channels, H is the height of the filter,
    and W is the width of the filter. If the groups is greater than 1,
    C will equal the number of input image channels divided by the groups.
    Please refer to UFLDL's `convolution
    <http://ufldl.stanford.edu/tutorial/supervised/FeatureExtractionUsingConvolution/>`_
1345
    for more details.
1346 1347 1348
    If bias attribution and activation type are provided, bias is added to the
    output of the convolution, and the corresponding activation function is
    applied to the final result.
C
chengduoZH 已提交
1349

1350
    For each input :math:`X`, the equation is:
C
refine  
chengduoZH 已提交
1351

C
chengduoZH 已提交
1352 1353
    .. math::

C
refine  
chengduoZH 已提交
1354
        Out = \sigma (W \\ast X + b)
C
chengduoZH 已提交
1355

T
tensor-tang 已提交
1356
    Where:
C
chengduoZH 已提交
1357

L
liym27 已提交
1358
    * :math:`X`: Input value, a tensor with NCHW or NHWC format.
1359 1360 1361 1362
    * :math:`W`: Filter value, a tensor with MCHW format.
    * :math:`\\ast`: Convolution operation.
    * :math:`b`: Bias value, a 2-D tensor with shape [M, 1].
    * :math:`\\sigma`: Activation function.
T
tensor-tang 已提交
1363
    * :math:`Out`: Output value, the shape of :math:`Out` and :math:`X` may be different.
C
chengduoZH 已提交
1364 1365 1366

    Example:

1367 1368
        - Input:

W
weixing02 已提交
1369
          Input shape: :math:`(N, C_{in}, H_{in}, W_{in})`
C
refine  
chengduoZH 已提交
1370

W
weixing02 已提交
1371
          Filter shape: :math:`(C_{out}, C_{in}, H_f, W_f)`
C
refine  
chengduoZH 已提交
1372

1373
        - Output:
T
tensor-tang 已提交
1374

W
weixing02 已提交
1375
          Output shape: :math:`(N, C_{out}, H_{out}, W_{out})`
C
refine  
chengduoZH 已提交
1376

C
chengduoZH 已提交
1377
        Where
1378 1379

        .. math::
C
chengduoZH 已提交
1380

W
weixing02 已提交
1381 1382
            H_{out}&= \\frac{(H_{in} + 2 * paddings[0] - (dilations[0] * (H_f - 1) + 1))}{strides[0]} + 1 \\\\
            W_{out}&= \\frac{(W_{in} + 2 * paddings[1] - (dilations[1] * (W_f - 1) + 1))}{strides[1]} + 1
C
chengduoZH 已提交
1383 1384

    Args:
1385
        input (Variable): The input is 4-D Tensor with shape [N, C, H, W], the data type
L
lvmengsi 已提交
1386
            of input is float16 or float32 or float64.
T
tensor-tang 已提交
1387
        num_filters(int): The number of filter. It is as same as the output
1388
            image channel.
1389 1390
        filter_size (int|tuple): The filter size. If filter_size
            is a tuple, it must contain two integers, (filter_size_height,
L
lvmengsi 已提交
1391 1392
            filter_size_width). Otherwise, filter_size_height = filter_size_width =\
            filter_size.
1393 1394
        stride (int|tuple): The stride size. It means the stride in convolution.
            If stride is a tuple, it must contain two integers, (stride_height, stride_width).
L
lvmengsi 已提交
1395 1396
            Otherwise, stride_height = stride_width = stride. Default: stride = 1.
        padding (string|int|list|tuple): The padding size. It means the number of zero-paddings
T
tianshuo78520a 已提交
1397
            on both sides for each dimension.If `padding` is a string, either 'VALID' or
L
liym27 已提交
1398 1399
            'SAME' which is the padding algorithm. If padding size is a tuple or list,
            it could be in three forms: `[pad_height, pad_width]` or
1400 1401
            `[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]`, and when
            `data_format` is `"NCHW"`, `padding` can be in the form `[[0,0], [0,0],
L
lvmengsi 已提交
1402
            [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]`.
L
liym27 已提交
1403 1404 1405
            when `data_format` is `"NHWC"`, `pool_padding` can be in the form
            `[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]`.
            Default: padding = 0.
L
lvmengsi 已提交
1406
        dilation (int|tuple): The dilation size. It means the spacing between the kernel
1407 1408
            points. If dilation is a tuple, it must contain two integers, (dilation_height,
            dilation_width). Otherwise, dilation_height = dilation_width = dilation.
L
lvmengsi 已提交
1409
            Default: dilation = 1.
1410 1411 1412 1413
        groups (int): The groups number of the Conv2d Layer. According to grouped
            convolution in Alex Krizhevsky's Deep CNN paper: when group=2,
            the first half of the filters is only connected to the first half
            of the input channels, while the second half of the filters is only
C
chengduo 已提交
1414 1415 1416 1417 1418
            connected to the second half of the input channels. Default: groups=1.
        param_attr (ParamAttr|None): The parameter attribute for learnable parameters/weights
            of conv2d. If it is set to None or one attribute of ParamAttr, conv2d
            will create ParamAttr as param_attr. If the Initializer of the param_attr
            is not set, the parameter is initialized with :math:`Normal(0.0, std)`,
H
haowang101779990 已提交
1419
            and the :math:`std` is :math:`(\\frac{2.0 }{filter\_elem\_num})^{0.5}`. Default: None.
C
chengduo 已提交
1420 1421 1422 1423 1424
        bias_attr (ParamAttr|bool|None): The parameter attribute for the bias of conv2d.
            If it is set to False, no bias will be added to the output units.
            If it is set to None or one attribute of ParamAttr, conv2d
            will create ParamAttr as bias_attr. If the Initializer of the bias_attr
            is not set, the bias is initialized zero. Default: None.
1425 1426
        use_cudnn (bool): Use cudnn kernel or not, it is valid only when the cudnn
            library is installed. Default: True
C
chengduo 已提交
1427 1428
        act (str): Activation type, if it is set to None, activation is not appended.
            Default: None
1429 1430
        name(str|None): For detailed information, please refer
           to :ref:`api_guide_Name`. Usually name is no need to set and
L
lvmengsi 已提交
1431
           None by default.
1432
        data_format (str, optional): Specify the data format of the input, and the data format of the output
1433
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
L
liym27 已提交
1434 1435
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_height, input_width]`.
C
chengduoZH 已提交
1436 1437

    Returns:
1438 1439 1440
        A Variable holding Tensor representing the conv2d, whose data type is the
        same with input. If act is None, the tensor variable storing the convolution
        result, and if act is not None, the tensor variable storing convolution
L
lvmengsi 已提交
1441
        and non-linearity activation result.
C
refine  
chengduoZH 已提交
1442

1443 1444 1445 1446 1447
    Raises:
        ValueError: If the type of `use_cudnn` is not bool.
        ValueError: If `data_format` is not "NCHW" or "NHWC".
        ValueError: If the channel dimmention of the input is less than or equal to zero.
        ValueError: If `padding` is a string, but not "SAME" or "VALID".
1448
        ValueError: If `padding` is a tuple, but the element corresponding to the input's batch size is not 0
1449 1450 1451 1452 1453 1454 1455
            or the element corresponding to the input's channel is not 0.
        ShapeError: If the input is not 4-D Tensor.
        ShapeError: If the input's dimension size and filter's dimension size not equal.
        ShapeError: If the dimension size of input minus the size of `stride` is not 2.
        ShapeError: If the number of input channels is not equal to filter's channels * groups.
        ShapeError: If the number of output channels is not be divided by groups.

C
chengduoZH 已提交
1456 1457 1458
    Examples:
        .. code-block:: python

1459
          import paddle.fluid as fluid
L
lvmengsi 已提交
1460
          data = fluid.data(name='data', shape=[None, 3, 32, 32], dtype='float32')
1461
          conv2d = fluid.layers.conv2d(input=data, num_filters=2, filter_size=3, act="relu")
Y
Yu Yang 已提交
1462 1463
    """

1464 1465
    check_variable_and_dtype(input, 'input', ['float16', 'float32', 'float64'],
                             'conv2d')
1466
    num_channels = input.shape[1]
L
liym27 已提交
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
    if not isinstance(use_cudnn, bool):
        raise ValueError("Attr(use_cudnn) should be True or False. Received "
                         "Attr(use_cudnn): %s. " % str(use_cudnn))

    if data_format not in ["NCHW", "NHWC"]:
        raise ValueError(
            "Attr(data_format) should be 'NCHW' or 'NHWC'. Received "
            "Attr(data_format): %s." % str(data_format))

    channel_last = (data_format == "NHWC")
    num_channels = input.shape[3] if channel_last else input.shape[1]
    if num_channels < 0:
        raise ValueError(
            "The channel dimmention of the input(%s) should be defined. "
            "Received: %s." % (str(input.shape), str(num_channels)))
C
chengduo 已提交
1482
    assert param_attr is not False, "param_attr should not be False here."
L
liym27 已提交
1483

1484
    l_type = 'conv2d'
X
xzl 已提交
1485 1486
    if (num_channels == groups and num_filters % num_channels == 0 and
            not use_cudnn):
1487
        l_type = 'depthwise_conv2d'
1488 1489 1490 1491

    helper = LayerHelper(l_type, **locals())
    dtype = helper.input_dtype()

Y
Yu Yang 已提交
1492 1493 1494 1495
    if groups is None:
        num_filter_channels = num_channels
    else:
        if num_channels % groups != 0:
L
liym27 已提交
1496
            raise ValueError(
1497 1498 1499
                "the channel of input must be divisible by groups,"
                "received: the channel of input is {}, the shape of input is {}"
                ", the groups is {}".format(num_channels, input.shape, groups))
M
minqiyang 已提交
1500
        num_filter_channels = num_channels // groups
Y
Yu Yang 已提交
1501

C
chengduoZH 已提交
1502 1503
    filter_size = utils.convert_to_list(filter_size, 2, 'filter_size')
    stride = utils.convert_to_list(stride, 2, 'stride')
1504
    dilation = utils.convert_to_list(dilation, 2, 'dilation')
C
chengduoZH 已提交
1505

L
liym27 已提交
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
    # padding
    def _update_padding(padding, data_format):
        def is_list_or_tuple(ele):
            if isinstance(ele, list) or isinstance(ele, tuple):
                return True
            return False

        if is_list_or_tuple(padding) and len(padding) == 4:
            if is_list_or_tuple(padding[0]) and (data_format == "NCHW"):
                if not (padding[0] == [0, 0] and padding[1] == [0, 0]):
                    raise ValueError(
                        "Non-zero padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[2:4]
                padding = [ele for a_list in padding for ele in a_list]
            elif is_list_or_tuple(padding[0]) and (data_format == "NHWC"):
                if not (padding[0] == [0, 0] and padding[3] == [0, 0]):
                    raise ValueError(
                        "Non-zero padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[1:3]
                padding = [ele for a_list in padding for ele in a_list]
            padding = utils.convert_to_list(padding, 4, 'padding')
1529 1530 1531
            if utils._is_symmetric_padding(padding, 2):
                padding = [padding[0], padding[2]]

L
liym27 已提交
1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
        else:
            padding = utils.convert_to_list(padding, 2, 'padding')

        return padding

    padding_algorithm = "EXPLICIT"
    if isinstance(padding, str):
        padding = padding.upper()
        if padding not in ["SAME", "VALID"]:
            raise ValueError(
                "Unknown padding: '%s'. It can only be 'SAME' or 'VALID'." %
                str(padding))
        if padding == "VALID":
            padding_algorithm = "VALID"
1546
            padding = [0, 0]
L
liym27 已提交
1547 1548
        elif padding == "SAME":
            padding_algorithm = "SAME"
1549
            padding = [0, 0]
L
liym27 已提交
1550 1551

    padding = _update_padding(padding, data_format)
Y
Yu Yang 已提交
1552

M
minqiyang 已提交
1553
    filter_shape = [num_filters, int(num_filter_channels)] + filter_size
Y
Yu Yang 已提交
1554 1555

    def _get_default_param_initializer():
C
chengduo 已提交
1556 1557
        filter_elem_num = filter_size[0] * filter_size[1] * num_channels
        std = (2.0 / filter_elem_num)**0.5
Y
Yu Yang 已提交
1558 1559 1560 1561 1562 1563 1564 1565
        return Normal(0.0, std, 0)

    filter_param = helper.create_parameter(
        attr=helper.param_attr,
        shape=filter_shape,
        dtype=dtype,
        default_initializer=_get_default_param_initializer())

X
Xin Pan 已提交
1566
    pre_bias = helper.create_variable_for_type_inference(dtype)
Y
Yu Yang 已提交
1567 1568

    helper.append_op(
1569
        type=l_type,
Y
Yu Yang 已提交
1570 1571 1572 1573 1574
        inputs={
            'Input': input,
            'Filter': filter_param,
        },
        outputs={"Output": pre_bias},
C
chengduoZH 已提交
1575 1576 1577
        attrs={
            'strides': stride,
            'paddings': padding,
1578
            'dilations': dilation,
C
chengduoZH 已提交
1579
            'groups': groups,
1580
            'use_cudnn': use_cudnn,
1581
            'use_mkldnn': False,
L
liym27 已提交
1582 1583 1584
            'fuse_relu_before_depthwise_conv': False,
            "padding_algorithm": padding_algorithm,
            "data_format": data_format,
C
chengduoZH 已提交
1585
        })
Y
Yu Yang 已提交
1586

1587 1588 1589 1590
    if data_format == 'NCHW':
        pre_act = helper.append_bias_op(pre_bias, dim_start=1, dim_end=2)
    else:
        pre_act = helper.append_bias_op(pre_bias, dim_start=3, dim_end=4)
Y
Yu Yang 已提交
1591 1592 1593 1594

    return helper.append_activation(pre_act)


C
chengduoZH 已提交
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
def conv3d(input,
           num_filters,
           filter_size,
           stride=1,
           padding=0,
           dilation=1,
           groups=None,
           param_attr=None,
           bias_attr=None,
           use_cudnn=True,
           act=None,
L
liym27 已提交
1606 1607
           name=None,
           data_format="NCDHW"):
C
chengduoZH 已提交
1608
    """
1609 1610
    :api_attr: Static Graph

C
chengduoZH 已提交
1611 1612
    The convolution3D layer calculates the output based on the input, filter
    and strides, paddings, dilations, groups parameters. Input(Input) and
L
liym27 已提交
1613
    Output(Output) are in NCDHW or NDHWC format. Where N is batch size C is the number of
1614 1615 1616 1617 1618
    channels, D is the depth of the feature, H is the height of the feature,
    and W is the width of the feature. Convlution3D is similar with Convlution2D
    but adds one dimension(depth). If bias attribution and activation type are
    provided, bias is added to the output of the convolution, and the
    corresponding activation function is applied to the final result.
C
chengduoZH 已提交
1619 1620 1621 1622 1623 1624 1625 1626 1627

    For each input :math:`X`, the equation is:

    .. math::

        Out = \sigma (W \\ast X + b)

    In the above equation:

L
liym27 已提交
1628
    * :math:`X`: Input value, a tensor with NCDHW or NDHWC format.
1629
    * :math:`W`: Filter value, a tensor with MCDHW format.
C
chengduoZH 已提交
1630 1631 1632
    * :math:`\\ast`: Convolution operation.
    * :math:`b`: Bias value, a 2-D tensor with shape [M, 1].
    * :math:`\\sigma`: Activation function.
1633
    * :math:`Out`: Output value, the shape of :math:`Out` and :math:`X` may be different.
C
chengduoZH 已提交
1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654

    Example:

        - Input:

          Input shape: :math:`(N, C_{in}, D_{in}, H_{in}, W_{in})`

          Filter shape: :math:`(C_{out}, C_{in}, D_f, H_f, W_f)`

        - Output:
          Output shape: :math:`(N, C_{out}, D_{out}, H_{out}, W_{out})`

        Where

        .. math::

            D_{out}&= \\frac{(D_{in} + 2 * paddings[0] - (dilations[0] * (D_f - 1) + 1))}{strides[0]} + 1 \\\\
            H_{out}&= \\frac{(H_{in} + 2 * paddings[1] - (dilations[1] * (H_f - 1) + 1))}{strides[1]} + 1 \\\\
            W_{out}&= \\frac{(W_{in} + 2 * paddings[2] - (dilations[2] * (W_f - 1) + 1))}{strides[2]} + 1

    Args:
1655
        input (Variable): The input is 5-D Tensor with shape [N, C, D, H, W], the data
L
lvmengsi 已提交
1656
            type of input is float16 or float32 or float64.
1657
        num_filters(int): The number of filter. It is as same as the output
C
chengduoZH 已提交
1658
            image channel.
1659
        filter_size (int|tuple): The filter size. If filter_size is a tuple,
1660
            it must contain three integers, (filter_size_depth, filter_size_height,
1661 1662
            filter_size_width). Otherwise, filter_size_depth = filter_size_height = \
            filter_size_width = filter_size.
1663 1664
        stride (int|tuple): The stride size. It means the stride in convolution. If stride is a
            tuple, it must contain three integers, (stride_depth, stride_height, stride_width).
L
lvmengsi 已提交
1665
            Otherwise, stride_depth = stride_height = stride_width = stride. Default: stride = 1.
1666
        padding (string|int|list|tuple): The padding size. It means the number of zero-paddings
T
tianshuo78520a 已提交
1667
            on both sides for each dimension. If `padding` is a string, either 'VALID' or
L
liym27 已提交
1668 1669 1670 1671 1672 1673 1674 1675
            'SAME' which is the padding algorithm. If padding size is a tuple or list,
            it could be in three forms: `[pad_depth, pad_height, pad_width]` or
            `[pad_depth_front, pad_depth_back, pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]`,
            and when `data_format` is `"NCDHW"`, `pool_padding` can be in the form
            `[[0,0], [0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]`.
            when `data_format` is `"NDHWC"`, `pool_padding` can be in the form
            `[[0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]`.
            Default: padding = 0.
1676
        dilation (int|tuple): The dilation size. It means the spacing between the kernel points.
L
lvmengsi 已提交
1677
            If dilation is a tuple, it must contain three integers, (dilation_depth, dilation_height,
1678
            dilation_width). Otherwise, dilation_depth = dilation_height = dilation_width = dilation.
L
lvmengsi 已提交
1679
            Default: dilation = 1.
C
chengduoZH 已提交
1680 1681 1682 1683 1684
        groups (int): The groups number of the Conv3d Layer. According to grouped
            convolution in Alex Krizhevsky's Deep CNN paper: when group=2,
            the first half of the filters is only connected to the first half
            of the input channels, while the second half of the filters is only
            connected to the second half of the input channels. Default: groups=1
C
chengduo 已提交
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
        param_attr (ParamAttr|None): The parameter attribute for learnable parameters/weights
            of conv3d. If it is set to None or one attribute of ParamAttr, conv3d
            will create ParamAttr as param_attr. If it is set to None, the parameter
            is initialized with :math:`Normal(0.0, std)`, and the :math:`std` is
            :math:`(\\frac{2.0 }{filter\_elem\_num})^{0.5}`. Default: None.
        bias_attr (ParamAttr|bool|None): The parameter attribute for the bias of conv3d.
            If it is set to False, no bias will be added to the output units.
            If it is set to None or one attribute of ParamAttr, conv3d
            will create ParamAttr as bias_attr. If the Initializer of the bias_attr
            is not set, the bias is initialized zero. Default: None.
C
chengduoZH 已提交
1695 1696
        use_cudnn (bool): Use cudnn kernel or not, it is valid only when the cudnn
            library is installed. Default: True
C
chengduo 已提交
1697 1698
        act (str): Activation type, if it is set to None, activation is not appended.
            Default: None.
1699 1700
        name(str|None): For detailed information, please refer
           to :ref:`api_guide_Name`. Usually name is no need to set and
L
lvmengsi 已提交
1701
           None by default.
1702
        data_format (str, optional): Specify the data format of the input, and the data format of the output
1703 1704 1705
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_height, input_width]`.
C
chengduoZH 已提交
1706 1707

    Returns:
1708 1709 1710
        A Variable holding Tensor representing the conv3d, whose data type is
        the same with input. If act is None, the tensor variable storing the
        convolution result, and if act is not None, the tensor variable storing
L
lvmengsi 已提交
1711
        convolution and non-linearity activation result.
C
chengduoZH 已提交
1712

1713 1714 1715 1716 1717
    Raises:
        ValueError: If the type of `use_cudnn` is not bool.
        ValueError: If `data_format` is not "NCDHW" or "NDHWC".
        ValueError: If the channel dimmention of the input is less than or equal to zero.
        ValueError: If `padding` is a string, but not "SAME" or "VALID".
1718
        ValueError: If `padding` is a tuple, but the element corresponding to the input's batch size is not 0
1719 1720 1721 1722 1723 1724 1725
            or the element corresponding to the input's channel is not 0.
        ShapeError: If the input is not 5-D Tensor.
        ShapeError: If the input's dimension size and filter's dimension size not equal.
        ShapeError: If the dimension size of input minus the size of `stride` is not 2.
        ShapeError: If the number of input channels is not equal to filter's channels * groups.
        ShapeError: If the number of output channels is not be divided by groups.

C
chengduoZH 已提交
1726 1727 1728
    Examples:
        .. code-block:: python

1729
          import paddle.fluid as fluid
L
lvmengsi 已提交
1730
          data = fluid.data(name='data', shape=[None, 3, 12, 32, 32], dtype='float32')
1731
          conv3d = fluid.layers.conv3d(input=data, num_filters=2, filter_size=3, act="relu")
C
chengduoZH 已提交
1732 1733 1734
    """

    l_type = 'conv3d'
C
chengduo 已提交
1735
    assert param_attr is not False, "param_attr should not be False here."
C
chengduoZH 已提交
1736 1737 1738
    helper = LayerHelper(l_type, **locals())
    dtype = helper.input_dtype()

L
liym27 已提交
1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753
    if not isinstance(use_cudnn, bool):
        raise ValueError("Attr(use_cudnn) should be True or False. Received "
                         "Attr(use_cudnn): %s. " % str(use_cudnn))

    if data_format not in ["NCDHW", "NDHWC"]:
        raise ValueError(
            "Attr(data_format) should be 'NCDHW' or 'NDHWC'. Received "
            "Attr(data_format): %s." % str(data_format))

    channel_last = (data_format == "NDHWC")
    num_channels = input.shape[4] if channel_last else input.shape[1]
    if num_channels < 0:
        raise ValueError(
            "The channel dimmention of the input(%s) should be defined. "
            "Received: %s." % (str(input.shape), str(num_channels)))
C
chengduoZH 已提交
1754 1755 1756 1757 1758

    if groups is None:
        num_filter_channels = num_channels
    else:
        if num_channels % groups != 0:
L
liym27 已提交
1759 1760 1761 1762
            raise ValueError(
                "The number of input channels must be divisible by Attr(groups). "
                "Received: number of channels(%s), groups(%s)." %
                (str(num_channels), str(groups)))
M
minqiyang 已提交
1763
        num_filter_channels = num_channels // groups
C
chengduoZH 已提交
1764 1765 1766 1767 1768

    filter_size = utils.convert_to_list(filter_size, 3, 'filter_size')
    stride = utils.convert_to_list(stride, 3, 'stride')
    dilation = utils.convert_to_list(dilation, 3, 'dilation')

L
liym27 已提交
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
    def _update_padding(padding, data_format):
        def is_list_or_tuple(ele):
            if isinstance(ele, list) or isinstance(ele, tuple):
                return True
            return False

        if is_list_or_tuple(padding) and len(padding) == 5:
            if is_list_or_tuple(padding[0]) and (data_format == "NCDHW"):
                if not (padding[0] == [0, 0] and padding[1] == [0, 0]):
                    raise ValueError(
                        "Non-zero padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[2:5]
                padding = [ele for a_list in padding for ele in a_list]
            elif is_list_or_tuple(padding[0]) and (data_format == "NDHWC"):
                if not (padding[0] == [0, 0] and padding[4] == [0, 0]):
                    raise ValueError(
                        "Non-zero padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[1:4]
                padding = [ele for a_list in padding for ele in a_list]
            padding = utils.convert_to_list(padding, 6, 'padding')
1791 1792
            if utils._is_symmetric_padding(padding, 3):
                padding = [padding[0], padding[2], padding[4]]
L
liym27 已提交
1793 1794
        elif is_list_or_tuple(padding) and len(padding) == 6:
            padding = utils.convert_to_list(padding, 6, 'padding')
1795 1796
            if utils._is_symmetric_padding(padding, 3):
                padding = [padding[0], padding[2], padding[4]]
L
liym27 已提交
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
        else:
            padding = utils.convert_to_list(padding, 3, 'padding')

        return padding

    padding_algorithm = "EXPLICIT"
    if isinstance(padding, str):
        padding = padding.upper()
        if padding not in ["SAME", "VALID"]:
            raise ValueError(
                "Unknown padding: '%s'. It can only be 'SAME' or 'VALID'." %
                str(padding))
        if padding == "VALID":
            padding_algorithm = "VALID"
1811
            padding = [0, 0, 0]
L
liym27 已提交
1812 1813
        elif padding == "SAME":
            padding_algorithm = "SAME"
1814
            padding = [0, 0, 0]
L
liym27 已提交
1815 1816

    padding = _update_padding(padding, data_format)
C
chengduoZH 已提交
1817 1818 1819 1820 1821

    input_shape = input.shape
    filter_shape = [num_filters, num_filter_channels] + filter_size

    def _get_default_param_initializer():
C
chengduo 已提交
1822 1823 1824
        filter_elem_num = filter_size[0] * filter_size[1] * filter_size[
            2] * num_channels
        std = (2.0 / filter_elem_num)**0.5
C
chengduoZH 已提交
1825 1826 1827 1828 1829 1830 1831 1832
        return Normal(0.0, std, 0)

    filter_param = helper.create_parameter(
        attr=helper.param_attr,
        shape=filter_shape,
        dtype=dtype,
        default_initializer=_get_default_param_initializer())

X
Xin Pan 已提交
1833
    pre_bias = helper.create_variable_for_type_inference(dtype)
C
chengduoZH 已提交
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847

    helper.append_op(
        type=l_type,
        inputs={
            'Input': input,
            'Filter': filter_param,
        },
        outputs={"Output": pre_bias},
        attrs={
            'strides': stride,
            'paddings': padding,
            'dilations': dilation,
            'groups': groups,
            'use_cudnn': use_cudnn,
L
liym27 已提交
1848 1849 1850
            'use_mkldnn': False,
            "padding_algorithm": padding_algorithm,
            "data_format": data_format,
C
chengduoZH 已提交
1851 1852
        })

1853 1854 1855 1856
    if data_format == 'NCDHW':
        pre_act = helper.append_bias_op(pre_bias, dim_start=1, dim_end=2)
    else:
        pre_act = helper.append_bias_op(pre_bias, dim_start=4, dim_end=5)
C
chengduoZH 已提交
1857 1858 1859 1860

    return helper.append_activation(pre_act)


F
fengjiayi 已提交
1861
@templatedoc()
Y
Yu Yang 已提交
1862
def pool2d(input,
C
chengduoZH 已提交
1863 1864
           pool_size=-1,
           pool_type="max",
C
chengduoZH 已提交
1865 1866
           pool_stride=1,
           pool_padding=0,
C
caoying03 已提交
1867
           global_pooling=False,
C
chengduoZH 已提交
1868
           use_cudnn=True,
1869
           ceil_mode=False,
1870
           name=None,
1871 1872
           exclusive=True,
           data_format="NCHW"):
Y
Yu Yang 已提交
1873
    """
1874 1875 1876 1877
    :alias_main: paddle.nn.functional.pool2d
	:alias: paddle.nn.functional.pool2d,paddle.nn.functional.pooling.pool2d
	:old_api: paddle.fluid.layers.pool2d

F
fengjiayi 已提交
1878
    ${comment}
1879 1880

    Args:
K
Kaipeng Deng 已提交
1881 1882 1883 1884 1885
        input (Variable): The input tensor of pooling operator which is a 4-D tensor with
                          shape [N, C, H, W]. The format of input tensor is `"NCHW"` or
                          `"NHWC"`, where `N` is batch size, `C` is the number of channels,
                          `H` is the height of the feature, and `W` is the width of the
                          feature. The data type if float32 or float64.
J
JiabinYang 已提交
1886
        pool_size (int|list|tuple): The pool kernel size. If pool kernel size is a tuple or list,
J
JiabinYang 已提交
1887 1888
            it must contain two integers, (pool_size_Height, pool_size_Width).
            Otherwise, the pool kernel size will be a square of an int.
F
fengjiayi 已提交
1889
        pool_type: ${pooling_type_comment}
J
JiabinYang 已提交
1890 1891 1892
        pool_stride (int|list|tuple): The pool stride size. If pool stride size is a tuple or list,
            it must contain two integers, (pool_stride_Height, pool_stride_Width).
            Otherwise, the pool stride size will be a square of an int.
1893 1894 1895 1896 1897 1898 1899
        pool_padding (string|int|list|tuple): The pool padding. If `pool_padding` is a string, either 'VALID' or
            'SAME' which is the padding algorithm. If pool padding size is a tuple or list,
            it could be in three forms: `[pad_height, pad_width]` or
            `[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]`, and when `data_format` is `"NCHW"`,
            `pool_padding` can be in the form `[[0,0], [0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]`.
            when `data_format` is `"NHWC"`, `pool_padding` can be in the form
            `[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]`.
J
JiabinYang 已提交
1900
            Otherwise, the pool padding size will be a square of an int.
1901 1902 1903
        global_pooling (bool): ${global_pooling_comment}
        use_cudnn (bool): ${use_cudnn_comment}
        ceil_mode (bool): ${ceil_mode_comment}
K
Kaipeng Deng 已提交
1904 1905 1906
        name(str, optional): For detailed information, please refer
                             to :ref:`api_guide_Name`. Usually name is no need to set and
                             None by default.
1907
        exclusive (bool): Whether to exclude padding points in average pooling
1908
                          mode, default is `true`.
1909
        data_format (string): The data format of the input and output data. An optional string from: `"NCHW"`, `"NHWC"`.
1910 1911
                The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
                `[batch_size, input_channels, input_height, input_width]`.
F
fengjiayi 已提交
1912

1913
    Returns:
K
Kaipeng Deng 已提交
1914
        Variable: The output tensor of pooling result. The data type is same as input tensor.
F
fengjiayi 已提交
1915 1916

    Raises:
1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928
        ValueError: If `pool_type` is not "max" nor "avg".
        ValueError: If `global_pooling` is False and `pool_size` is -1.
        TypeError: If `use_cudnn` is not a bool value.
        ValueError: If `data_format` is not "NCHW" or "NHWC".
        ValueError: If `pool_padding` is a string, but not "SAME" or "VALID".
        ValueError: If `pool_padding` is "VALID", but `ceil_mode` is True.
        ValueError: If `pool_padding` is a list or tuple, but the elements in the batch or channel dimensions are non-zero.
        ShapeError: If the input is not a 4-D or 5-D Tensor.
        ShapeError: If the dimension of input minus the size of `pool_stride` is not 2.
        ShapeError: If the size of `pool_size` and `pool_stride` is not equal.
        ShapeError: If the output's shape calculated is not greater than 0.

F
fengjiayi 已提交
1929 1930 1931 1932 1933

    Examples:

        .. code-block:: python

1934
          import paddle.fluid as fluid
1935

K
Kaipeng Deng 已提交
1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960
          data = fluid.data(name='data', shape=[None, 3, 32, 32], dtype='float32')

          # max pool2d
          pool2d = fluid.layers.pool2d(
            input = data,
            pool_size = 2,
            pool_type = "max",
            pool_stride = 1,
            global_pooling=False)

          # average pool2d
          pool2d = fluid.layers.pool2d(
            input = data,
            pool_size = 2,
            pool_type = "avg",
            pool_stride = 1,
            global_pooling=False)

          # global average pool2d
          pool2d = fluid.layers.pool2d(
            input = data,
            pool_size = 2,
            pool_type = "avg",
            pool_stride = 1,
            global_pooling=True)
1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978

          # Attr(pool_padding) is a list with 4 elements, Attr(data_format) is "NCHW".
          out_1 = fluid.layers.pool2d(
            input = data,
            pool_size = 3,
            pool_type = "avg",
            pool_stride = 1,
            pool_padding = [1, 2, 1, 0],
            data_format = "NCHW")

          # Attr(pool_padding) is a string, Attr(data_format) is "NCHW".
          out_2 = fluid.layers.pool2d(
            input = data,
            pool_size = 3,
            pool_type = "avg",
            pool_stride = 1,
            pool_padding = "VALID",
            data_format = "NCHW")
Y
Yu Yang 已提交
1979 1980 1981
    """
    if pool_type not in ["max", "avg"]:
        raise ValueError(
1982
            "Unknown Attr(pool_type): '%s'. It can only be 'max' or 'avg'.",
Y
Yu Yang 已提交
1983
            str(pool_type))
C
chengduoZH 已提交
1984

C
chengduoZH 已提交
1985 1986
    if global_pooling is False and pool_size == -1:
        raise ValueError(
1987 1988 1989 1990
            "When Attr(global_pooling) is False, Attr(pool_size) must be passed "
            "and be a valid value. Received pool_size: %s." % str(pool_size))

    if not isinstance(use_cudnn, bool):
1991 1992
        raise TypeError("Attr(use_cudnn) should be True or False. Received "
                        "Attr(use_cudnn): %s." % str(use_cudnn))
1993 1994 1995 1996 1997

    if data_format not in ["NCHW", "NHWC"]:
        raise ValueError(
            "Attr(data_format) should be 'NCHW' or 'NHWC'. Received "
            "Attr(data_format): %s." % str(data_format))
C
chengduoZH 已提交
1998

C
chengduoZH 已提交
1999 2000 2001
    pool_size = utils.convert_to_list(pool_size, 2, 'pool_size')
    pool_stride = utils.convert_to_list(pool_stride, 2, 'pool_stride')

2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
    def update_padding(padding, data_format):
        def is_list_or_tuple(ele):
            if isinstance(ele, list) or isinstance(ele, tuple):
                return True
            return False

        if is_list_or_tuple(padding) and len(padding) == 4:
            if is_list_or_tuple(padding[0]) and (data_format == "NCHW"):
                if not (padding[0] == [0, 0] and padding[1] == [0, 0]):
                    raise ValueError(
                        "Non-zero pool_padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[2:4]
                padding = [ele for a_list in padding for ele in a_list]
            elif is_list_or_tuple(padding[0]) and (data_format == "NHWC"):
                if not (padding[0] == [0, 0] and padding[3] == [0, 0]):
                    raise ValueError(
                        "Non-zero pool_padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[1:3]
                padding = [ele for a_list in padding for ele in a_list]
            padding = utils.convert_to_list(padding, 4, 'padding')
2024

2025 2026
            if utils._is_symmetric_padding(padding, 2):
                padding = [padding[0], padding[2]]
2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040
        else:
            padding = utils.convert_to_list(padding, 2, 'padding')

        return padding

    padding_algorithm = "EXPLICIT"
    if isinstance(pool_padding, str):
        pool_padding = pool_padding.upper()
        if pool_padding not in ["SAME", "VALID"]:
            raise ValueError(
                "Unknown Attr(pool_padding): '%s'. It can only be 'SAME' or 'VALID'."
                % str(pool_padding))
        if pool_padding == "VALID":
            padding_algorithm = "VALID"
2041
            pool_padding = [0, 0]
2042 2043 2044 2045 2046 2047
            if ceil_mode != False:
                raise ValueError(
                    "When Attr(pool_padding) is \"VALID\", Attr(ceil_mode) must be False. "
                    "Received ceil_mode: True.")
        elif pool_padding == "SAME":
            padding_algorithm = "SAME"
2048
            pool_padding = [0, 0]
2049 2050 2051 2052 2053

    pool_padding = update_padding(pool_padding, data_format)

    op_type = 'pool2d'
    helper = LayerHelper(op_type, **locals())
Y
Yu Yang 已提交
2054
    dtype = helper.input_dtype()
X
Xin Pan 已提交
2055
    pool_out = helper.create_variable_for_type_inference(dtype)
Y
Yu Yang 已提交
2056 2057

    helper.append_op(
2058
        type=op_type,
2059 2060 2061 2062 2063 2064 2065 2066
        inputs={"X": input},
        outputs={"Out": pool_out},
        attrs={
            "pooling_type": pool_type,
            "ksize": pool_size,
            "global_pooling": global_pooling,
            "strides": pool_stride,
            "paddings": pool_padding,
2067
            "padding_algorithm": padding_algorithm,
2068 2069
            "use_cudnn": use_cudnn,
            "ceil_mode": ceil_mode,
2070 2071
            "use_mkldnn": False,
            "exclusive": exclusive,
2072
            "data_format": data_format,
2073 2074 2075 2076 2077
        })

    return pool_out


D
dengkaipeng 已提交
2078
@templatedoc()
2079 2080 2081 2082 2083 2084 2085 2086
def pool3d(input,
           pool_size=-1,
           pool_type="max",
           pool_stride=1,
           pool_padding=0,
           global_pooling=False,
           use_cudnn=True,
           ceil_mode=False,
2087
           name=None,
2088 2089
           exclusive=True,
           data_format="NCDHW"):
2090
    """
2091 2092 2093 2094
    :alias_main: paddle.nn.functional.pool3d
	:alias: paddle.nn.functional.pool3d,paddle.nn.functional.pooling.pool3d
	:old_api: paddle.fluid.layers.pool3d

2095
    ${comment}
2096 2097

    Args:
K
Kaipeng Deng 已提交
2098 2099
        input (Variable): The input tensor of pooling operator, which is a 5-D tensor with
                          shape [N, C, D, H, W]. The format of
2100 2101 2102
                          input tensor is `"NCDHW"` or `"NDHWC"`, where `N` is batch size, `C` is
                          the number of channels, `D` is the depth of the feature,
                          `H` is the height of the feature, and `W` is the width
D
dengkaipeng 已提交
2103
                          of the feature.
2104 2105
        pool_size (int|list|tuple): The pool kernel size. If pool kernel size
            is a tuple or list, it must contain three integers,
D
dengkaipeng 已提交
2106 2107 2108
            (pool_size_Depth, pool_size_Height, pool_size_Width).
            Otherwise, the pool kernel size will be the cube of an int.
        pool_type (string): ${pooling_type_comment}
2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119
        pool_stride (string|int|list|tuple)): The pool padding. If `pool_padding` is a string, either 'VALID' or
            'SAME' which is the padding algorithm. If pool stride size is a tuple or list,
            it must contain three integers, `[stride_Depth, stride_Height, stride_Width]`.
            Otherwise, the pool stride size will be a cube of an int.
        pool_padding (int|list|tuple): The pool padding size. If pool padding size is a tuple or list,
            it could be in three forms: `[pad_depth, pad_height, pad_width]` or
            `[pad_depth_front, pad_depth_back, pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]`,
            and when `data_format` is `"NCDHW"`, `pool_padding` can be in the form
            `[[0,0], [0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]`.
            when `data_format` is `"NDHWC"`, `pool_padding` can be in the form
            `[[0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]`.
2120 2121 2122
        global_pooling (bool): ${global_pooling_comment}
        use_cudnn (bool): ${use_cudnn_comment}
        ceil_mode (bool): ${ceil_mode_comment}
K
Kaipeng Deng 已提交
2123 2124 2125
        name(str, optional): For detailed information, please refer
                             to :ref:`api_guide_Name`. Usually name is no need to set and
                             None by default.
2126
        exclusive (bool): Whether to exclude padding points in average pooling
2127 2128 2129 2130
                          mode, default is true.
        data_format (string): The data format of the input and output data. An optional string from: `"NCDHW"`, `"NDHWC"`.
                The default is `"NCDHW"`. When it is `"NCDHW"`, the data is stored in the order of:
                `[batch_size, input_channels, input_depth, input_height, input_width]`.
2131

2132
    Returns:
K
Kaipeng Deng 已提交
2133
        Variable: The output tensor of pooling result. The data type is same as input tensor.
D
dengkaipeng 已提交
2134

2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
    Raises:
        ValueError: If `pool_type` is not "max" nor "avg".
        ValueError: If `global_pooling` is False and `pool_size` is -1.
        TypeError: If `use_cudnn` is not a bool value.
        ValueError: If `data_format` is not "NCDHW" or "NDHWC".
        ValueError: If `pool_padding` is a string, but not "SAME" or "VALID".
        ValueError: If `pool_padding` is "VALID", but `ceil_mode` is True.
        ValueError: If `pool_padding` is a list or tuple, but the elements in the batch or channel dimensions are non-zero.
        ShapeError: If the input is not a 4-D or 5-D Tensor.
        ShapeError: If the dimension of input minus the size of `pool_stride` is not 2.
        ShapeError: If the size of `pool_size` and `pool_stride` is not equal.
        ShapeError: If the output's shape calculated is not greater than 0.

D
dengkaipeng 已提交
2148 2149 2150 2151
    Examples:

        .. code-block:: python

2152
          import paddle.fluid as fluid
2153

K
Kaipeng Deng 已提交
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178
          data = fluid.data(name='data', shape=[None, 3, 32, 32, 32], dtype='float32')

          # max pool3d
          pool3d = fluid.layers.pool3d(
            input = data,
            pool_size = 2,
            pool_type = "max",
            pool_stride = 1,
            global_pooling=False)

          # average pool3d
          pool3d = fluid.layers.pool3d(
            input = data,
            pool_size = 2,
            pool_type = "avg",
            pool_stride = 1,
            global_pooling=False)

          # global average pool3d
          pool3d = fluid.layers.pool3d(
            input = data,
            pool_size = 2,
            pool_type = "avg",
            pool_stride = 1,
            global_pooling=True)
2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201

          # example 1:
          # Attr(pool_padding) is a list with 6 elements, Attr(data_format) is "NCDHW".
          out_1 = fluid.layers.pool3d(
            input = data,
            pool_size = 2,
            pool_type = "avg",
            pool_stride = 1,
            pool_padding = [1, 2, 1, 0, 1, 2],
            global_pooling = False,
            data_format = "NCDHW")

          # example 2:
          # Attr(pool_padding) is a string, Attr(data_format) is "NCDHW".
          out_2 = fluid.layers.pool3d(
            input = data,
            pool_size = 3,
            pool_type = "avg",
            pool_stride = 1,
            pool_padding = "VALID",
            global_pooling = False,
            data_format = "NCDHW")

Y
Yu Yang 已提交
2202 2203 2204
    """
    if pool_type not in ["max", "avg"]:
        raise ValueError(
2205
            "Unknown Attr(pool_type): '%s'. It can only be 'max' or 'avg'.",
Y
Yu Yang 已提交
2206
            str(pool_type))
C
chengduoZH 已提交
2207

C
chengduoZH 已提交
2208 2209
    if global_pooling is False and pool_size == -1:
        raise ValueError(
2210 2211 2212 2213 2214
            "When Attr(global_pooling) is False, Attr(pool_size) must be passed "
            "and be a valid value. Received Attr(pool_size): %s." %
            str(pool_size))

    if not isinstance(use_cudnn, bool):
2215 2216
        raise TypeError("Attr(use_cudnn) should be True or False. Received "
                        "Attr(use_cudnn): %s. " % str(use_cudnn))
2217 2218 2219 2220 2221

    if data_format not in ["NCDHW", "NDHWC"]:
        raise ValueError(
            "Attr(data_format) should be 'NCDHW' or 'NDHWC'. Received "
            "Attr(data_format): %s" % str(data_format))
C
chengduoZH 已提交
2222

2223 2224
    pool_size = utils.convert_to_list(pool_size, 3, 'pool_size')
    pool_stride = utils.convert_to_list(pool_stride, 3, 'pool_stride')
C
chengduoZH 已提交
2225

2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247
    def update_padding(padding, data_format):
        def is_list_or_tuple(ele):
            if isinstance(ele, (list, tuple)):
                return True
            return False

        if is_list_or_tuple(padding) and len(padding) == 5:
            if is_list_or_tuple(padding[0]) and (data_format == "NCDHW"):
                if not (padding[0] == [0, 0] and padding[1] == [0, 0]):
                    raise ValueError(
                        "Non-zero pool_padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[2:5]
                padding = [ele for a_list in padding for ele in a_list]
            elif is_list_or_tuple(padding[0]) and (data_format == "NDHWC"):
                if not (padding[0] == [0, 0] and padding[4] == [0, 0]):
                    raise ValueError(
                        "Non-zero pool_padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[1:4]
                padding = [ele for a_list in padding for ele in a_list]
            padding = utils.convert_to_list(padding, 6, 'padding')
2248 2249
            if utils._is_symmetric_padding(padding, 3):
                padding = [padding[0], padding[2], padding[4]]
2250 2251 2252

        elif is_list_or_tuple(padding) and len(padding) == 6:
            padding = utils.convert_to_list(padding, 6, 'padding')
2253 2254
            if utils._is_symmetric_padding(padding, 3):
                padding = [padding[0], padding[2], padding[4]]
2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268
        else:
            padding = utils.convert_to_list(padding, 3, 'padding')

        return padding

    padding_algorithm = "EXPLICIT"
    if isinstance(pool_padding, str):
        pool_padding = pool_padding.upper()
        if pool_padding not in ["SAME", "VALID"]:
            raise ValueError(
                "Unknown Attr(pool_padding): '%s'. It can only be 'SAME' or 'VALID'."
                % str(pool_padding))
        if pool_padding == "VALID":
            padding_algorithm = "VALID"
2269
            pool_padding = [0, 0, 0]
2270 2271 2272 2273 2274 2275
            if ceil_mode != False:
                raise ValueError(
                    "When Attr(pool_padding) is \"VALID\", ceil_mode must be False. "
                    "Received ceil_mode: True.")
        elif pool_padding == "SAME":
            padding_algorithm = "SAME"
2276
            pool_padding = [0, 0, 0]
2277 2278 2279 2280 2281

    pool_padding = update_padding(pool_padding, data_format)

    op_type = "pool3d"
    helper = LayerHelper(op_type, **locals())
Y
Yu Yang 已提交
2282
    dtype = helper.input_dtype()
X
Xin Pan 已提交
2283
    pool_out = helper.create_variable_for_type_inference(dtype)
Y
Yu Yang 已提交
2284 2285

    helper.append_op(
2286
        type=op_type,
Y
Yu Yang 已提交
2287 2288 2289 2290 2291 2292 2293
        inputs={"X": input},
        outputs={"Out": pool_out},
        attrs={
            "pooling_type": pool_type,
            "ksize": pool_size,
            "global_pooling": global_pooling,
            "strides": pool_stride,
C
chengduoZH 已提交
2294
            "paddings": pool_padding,
2295
            "padding_algorithm": padding_algorithm,
2296
            "use_cudnn": use_cudnn,
2297
            "ceil_mode": ceil_mode,
2298 2299
            "use_mkldnn": False,
            "exclusive": exclusive,
2300
            "data_format": data_format,
Y
Yu Yang 已提交
2301 2302 2303 2304 2305
        })

    return pool_out


2306 2307 2308 2309 2310 2311 2312
@templatedoc(op_type="pool2d")
def adaptive_pool2d(input,
                    pool_size,
                    pool_type="max",
                    require_index=False,
                    name=None):
    """
2313 2314 2315 2316
    :alias_main: paddle.nn.functional.adaptive_pool2d
	:alias: paddle.nn.functional.adaptive_pool2d,paddle.nn.functional.pooling.adaptive_pool2d
	:old_api: paddle.fluid.layers.adaptive_pool2d

K
Kaipeng Deng 已提交
2317
    This operation calculates the output based on the input, pool_size,
D
dengkaipeng 已提交
2318 2319 2320 2321
    pool_type parameters. Input(X) and output(Out) are in NCHW format, where N is batch
    size, C is the number of channels, H is the height of the feature, and W is
    the width of the feature. Parameters(pool_size) should contain two elements which
    represent height and width, respectively. Also the H and W dimensions of output(Out)
K
Kaipeng Deng 已提交
2322
    is same as Parameter(pool_size). The output tensor shape will be [N, C, pool_size[0], pool_size[1]]
2323

2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336
    For average adaptive pool2d:

    ..  math::

       hstart &= floor(i * H_{in} / H_{out})

       hend &= ceil((i + 1) * H_{in} / H_{out})

       wstart &= floor(j * W_{in} / W_{out})

       wend &= ceil((j + 1) * W_{in} / W_{out})

       Output(i ,j) &= \\frac{sum(Input[hstart:hend, wstart:wend])}{(hend - hstart) * (wend - wstart)}
2337 2338

    Args:
K
Kaipeng Deng 已提交
2339 2340 2341 2342 2343
        input (Variable): The input tensor of pooling operator, which is a 4-D tensor
                          with shape [N, C, H, W].  The format of input tensor is NCHW,
                          where N is batch size, C is the number of channels, H is the
                          height of the feature, and W is the width of the feature.
                          The data type is float32 or float64.
2344 2345 2346
        pool_size (int|list|tuple): The pool kernel size. If pool kernel size is a tuple or list,
            it must contain two integers, (pool_size_Height, pool_size_Width).
        pool_type: ${pooling_type_comment}
D
dengkaipeng 已提交
2347
        require_index (bool): If true, the index of max pooling point will be returned along
K
Kaipeng Deng 已提交
2348 2349 2350 2351
            with outputs. It cannot be set in average pooling type. 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.
2352 2353

    Returns:
2354
        Variable: The output tensor of adaptive pooling result. The data type is same
K
Kaipeng Deng 已提交
2355
                  as input tensor.
2356 2357 2358 2359 2360 2361 2362 2363 2364

    Raises:
        ValueError: 'pool_type' is not 'max' nor 'avg'.
        ValueError: invalid setting 'require_index' true when 'pool_type' is 'avg'.
        ValueError: 'pool_size' should be a list or tuple with length as 2.

    Examples:
        .. code-block:: python

K
Kaipeng Deng 已提交
2365
          # average adaptive pool2d
M
minqiyang 已提交
2366
          # suppose input data in shape of [N, C, H, W], `pool_size` is [m, n],
T
tianshuo78520a 已提交
2367
          # output shape is [N, C, m, n], adaptive pool divide H and W dimensions
M
minqiyang 已提交
2368
          # of input data into m * n grids averagely and performs poolings in each
2369 2370
          # grid to get output.
          # adaptive average pool performs calculations as follow:
M
minqiyang 已提交
2371
          #
2372 2373 2374 2375 2376 2377 2378 2379
          #     for i in range(m):
          #         for j in range(n):
          #             hstart = floor(i * H / m)
          #             hend = ceil((i + 1) * H / m)
          #             wstart = floor(i * W / n)
          #             wend = ceil((i + 1) * W / n)
          #             output[:, :, i, j] = avg(input[:, :, hstart: hend, wstart: wend])
          #
2380
          import paddle.fluid as fluid
K
Kaipeng Deng 已提交
2381
          data = fluid.data(name='data', shape=[None, 3, 32, 32], dtype='float32')
D
dengkaipeng 已提交
2382
          pool_out = fluid.layers.adaptive_pool2d(
2383 2384
                            input=data,
                            pool_size=[3, 3],
2385
                            pool_type='avg')
K
Kaipeng Deng 已提交
2386 2387 2388

          # max adaptive pool2d
          # suppose input data in shape of [N, C, H, W], `pool_size` is [m, n],
T
tianshuo78520a 已提交
2389
          # output shape is [N, C, m, n], adaptive pool divide H and W dimensions
K
Kaipeng Deng 已提交
2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407
          # of input data into m * n grids averagely and performs poolings in each
          # grid to get output.
          # adaptive average pool performs calculations as follow:
          #
          #     for i in range(m):
          #         for j in range(n):
          #             hstart = floor(i * H / m)
          #             hend = ceil((i + 1) * H / m)
          #             wstart = floor(i * W / n)
          #             wend = ceil((i + 1) * W / n)
          #             output[:, :, i, j] = max(input[:, :, hstart: hend, wstart: wend])
          #
          import paddle.fluid as fluid
          data = fluid.data(name='data', shape=[None, 3, 32, 32], dtype='float32')
          pool_out = fluid.layers.adaptive_pool2d(
                            input=data,
                            pool_size=[3, 3],
                            pool_type='max')
2408
    """
2409 2410 2411 2412 2413 2414
    check_variable_and_dtype(
        input, 'input', ['float16', 'float32', 'float64', 'int32', 'int64'],
        'adaptive_pool2d')
    check_type(pool_type, 'pool_type', str, 'adaptive_pool2d')
    check_type(pool_size, 'pool_size', (int, list, tuple), 'adaptive_pool2d')
    check_type(require_index, 'require_index', bool, 'adaptive_pool2d')
2415 2416 2417 2418 2419 2420 2421 2422 2423
    if pool_type not in ["max", "avg"]:
        raise ValueError(
            "Unknown pool_type: '%s'. It can only be 'max' or 'avg'.",
            str(pool_type))

    if pool_type == "avg" and require_index:
        raise ValueError(
            "invalid setting 'require_index' true when 'pool_type' is 'avg'.")

2424
    pool_size = utils.convert_to_list(pool_size, 2, 'pool_size')
2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449

    if pool_type == "max":
        l_type = 'max_pool2d_with_index'
    else:
        l_type = "pool2d"

    helper = LayerHelper(l_type, **locals())
    dtype = helper.input_dtype()
    pool_out = helper.create_variable_for_type_inference(dtype)

    outputs = {"Out": pool_out}
    if pool_type == "max":
        mask = helper.create_variable_for_type_inference(dtype)
        outputs["Mask"] = mask

    helper.append_op(
        type=l_type,
        inputs={"X": input},
        outputs=outputs,
        attrs={
            "pooling_type": pool_type,
            "ksize": pool_size,
            "adaptive": True,
        })

D
dengkaipeng 已提交
2450
    return (pool_out, mask) if require_index else pool_out
2451 2452 2453 2454 2455 2456 2457 2458 2459


@templatedoc(op_type="pool3d")
def adaptive_pool3d(input,
                    pool_size,
                    pool_type="max",
                    require_index=False,
                    name=None):
    """
2460 2461 2462 2463
    :alias_main: paddle.nn.functional.adaptive_pool3d
	:alias: paddle.nn.functional.adaptive_pool3d,paddle.nn.functional.pooling.adaptive_pool3d
	:old_api: paddle.fluid.layers.adaptive_pool3d

K
Kaipeng Deng 已提交
2464
    This operation calculates the output based on the input, pool_size,
D
dengkaipeng 已提交
2465 2466 2467 2468
    pool_type parameters. Input(X) and output(Out) are in NCDHW format, where N is batch
    size, C is the number of channels, D is the depth of the feature, H is the height of
    the feature, and W is the width of the feature. Parameters(pool_size) should contain
    three elements which represent height and width, respectively. Also the D, H and W
K
Kaipeng Deng 已提交
2469 2470
    dimensions of output(Out) is same as Parameter(pool_size). The output tensor shape
    will be [N, C, pool_size[0], pool_size[1], pool_size[2]]
2471

2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488
    For average adaptive pool3d:

    ..  math::

      dstart &= floor(i * D_{in} / D_{out})

      dend &= ceil((i + 1) * D_{in} / D_{out})

      hstart &= floor(j * H_{in} / H_{out})

      hend &= ceil((j + 1) * H_{in} / H_{out})

      wstart &= floor(k * W_{in} / W_{out})

      wend &= ceil((k + 1) * W_{in} / W_{out})

      Output(i ,j, k) &= \\frac{sum(Input[dstart:dend, hstart:hend, wstart:wend])}{(dend - dstart) * (hend - hstart) * (wend - wstart)}
2489 2490

    Args:
2491
        input (Variable): The input tensor of pooling operator, which is a 5-D tensor with
K
Kaipeng Deng 已提交
2492 2493
                          shape [N, C, D, H, W]. The format of input tensor is NCDHW, where
                          N is batch size, C is the number of channels, D is the depth of the feature,
D
dengkaipeng 已提交
2494
                          H is the height of the feature, and W is the width of the feature.
K
Kaipeng Deng 已提交
2495
                          The data type is float32 or float64.
2496
        pool_size (int|list|tuple): The pool kernel size. If pool kernel size is a tuple or list,
D
dengkaipeng 已提交
2497
            it must contain three integers, (Depth, Height, Width).
2498
        pool_type: ${pooling_type_comment}
D
dengkaipeng 已提交
2499
        require_index (bool): If true, the index of max pooling point will be returned along
K
Kaipeng Deng 已提交
2500 2501 2502 2503
            with outputs. It cannot be set in average pooling type. 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.
2504 2505

    Returns:
K
Kaipeng Deng 已提交
2506
        Variable: The output tensor of adaptive pooling result. The data type is same as input tensor.
2507 2508 2509 2510 2511 2512 2513 2514 2515

    Raises:
        ValueError: 'pool_type' is not 'max' nor 'avg'.
        ValueError: invalid setting 'require_index' true when 'pool_type' is 'avg'.
        ValueError: 'pool_size' should be a list or tuple with length as 2.

    Examples:
        .. code-block:: python

K
Kaipeng Deng 已提交
2516
          # average adaptive pool3d
2517
          # suppose input data in shape of [N, C, D, H, W], `pool_size` is [l, m, n],
T
tianshuo78520a 已提交
2518
          # output shape is [N, C, l, m, n], adaptive pool divide D, H and W dimensions
M
minqiyang 已提交
2519
          # of input data into l * m * n grids averagely and performs poolings in each
2520 2521
          # grid to get output.
          # adaptive average pool performs calculations as follow:
M
minqiyang 已提交
2522
          #
2523 2524 2525 2526 2527 2528 2529 2530 2531
          #     for i in range(l):
          #         for j in range(m):
          #             for k in range(n):
          #                 dstart = floor(i * D / l)
          #                 dend = ceil((i + 1) * D / l)
          #                 hstart = floor(j * H / m)
          #                 hend = ceil((j + 1) * H / m)
          #                 wstart = floor(k * W / n)
          #                 wend = ceil((k + 1) * W / n)
M
minqiyang 已提交
2532
          #                 output[:, :, i, j, k] =
2533 2534
          #                     avg(input[:, :, dstart:dend, hstart: hend, wstart: wend])
          #
K
Kaipeng Deng 已提交
2535 2536 2537

          import paddle.fluid as fluid

K
Kaipeng Deng 已提交
2538 2539
          data = fluid.data(
              name='data', shape=[None, 3, 32, 32, 32], dtype='float32')
K
Kaipeng Deng 已提交
2540
          pool_out = fluid.layers.adaptive_pool3d(
2541
                            input=data,
D
dengkaipeng 已提交
2542
                            pool_size=[3, 3, 3],
2543
                            pool_type='avg')
K
Kaipeng Deng 已提交
2544 2545 2546

          # max adaptive pool3d
          # suppose input data in shape of [N, C, D, H, W], `pool_size` is [l, m, n],
T
tianshuo78520a 已提交
2547
          # output shape is [N, C, l, m, n], adaptive pool divide D, H and W dimensions
K
Kaipeng Deng 已提交
2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572
          # of input data into l * m * n grids averagely and performs poolings in each
          # grid to get output.
          # adaptive average pool performs calculations as follow:
          #
          #     for i in range(l):
          #         for j in range(m):
          #             for k in range(n):
          #                 dstart = floor(i * D / l)
          #                 dend = ceil((i + 1) * D / l)
          #                 hstart = floor(j * H / m)
          #                 hend = ceil((j + 1) * H / m)
          #                 wstart = floor(k * W / n)
          #                 wend = ceil((k + 1) * W / n)
          #                 output[:, :, i, j, k] =
          #                     avg(input[:, :, dstart:dend, hstart: hend, wstart: wend])
          #

          import paddle.fluid as fluid

          data = fluid.data(
              name='data', shape=[None, 3, 32, 32, 32], dtype='float32')
          pool_out = fluid.layers.adaptive_pool3d(
                            input=data,
                            pool_size=[3, 3, 3],
                            pool_type='max')
2573
    """
2574 2575 2576 2577 2578 2579
    check_variable_and_dtype(
        input, 'input', ['float16', 'float32', 'float64', 'int32', 'int64'],
        'adaptive_pool3d')
    check_type(pool_type, 'pool_type', str, 'adaptive_pool3d')
    check_type(pool_size, 'pool_size', (int, list, tuple), 'adaptive_pool3d')
    check_type(require_index, 'require_index', bool, 'adaptive_pool3d')
2580 2581 2582 2583 2584 2585 2586 2587 2588
    if pool_type not in ["max", "avg"]:
        raise ValueError(
            "Unknown pool_type: '%s'. It can only be 'max' or 'avg'.",
            str(pool_type))

    if pool_type == "avg" and require_index:
        raise ValueError(
            "invalid setting 'require_index' true when 'pool_type' is 'avg'.")

2589
    pool_size = utils.convert_to_list(pool_size, 3, 'pool_size')
2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614

    if pool_type == "max":
        l_type = 'max_pool3d_with_index'
    else:
        l_type = "pool3d"

    helper = LayerHelper(l_type, **locals())
    dtype = helper.input_dtype()
    pool_out = helper.create_variable_for_type_inference(dtype)

    outputs = {"Out": pool_out}
    if pool_type == "max":
        mask = helper.create_variable_for_type_inference(dtype)
        outputs["Mask"] = mask

    helper.append_op(
        type=l_type,
        inputs={"X": input},
        outputs=outputs,
        attrs={
            "pooling_type": pool_type,
            "ksize": pool_size,
            "adaptive": True,
        })

D
dengkaipeng 已提交
2615
    return (pool_out, mask) if require_index else pool_out
2616 2617


Y
Yu Yang 已提交
2618 2619 2620 2621 2622 2623 2624
def batch_norm(input,
               act=None,
               is_test=False,
               momentum=0.9,
               epsilon=1e-05,
               param_attr=None,
               bias_attr=None,
C
caoying03 已提交
2625
               data_layout='NCHW',
Y
Yang Yang 已提交
2626
               in_place=False,
2627 2628
               name=None,
               moving_mean_name=None,
W
wanghaoshuang 已提交
2629
               moving_variance_name=None,
2630
               do_model_average_for_mean_and_var=True,
2631
               use_global_stats=False):
Y
Yu Yang 已提交
2632
    """
2633 2634
    :api_attr: Static Graph

Q
qiaolongfei 已提交
2635 2636
    **Batch Normalization Layer**

L
lvmengsi 已提交
2637
    Can be used as a normalizer function for convolution or fully_connected operations.
Q
qiaolongfei 已提交
2638
    The required data format for this layer is one of the following:
Q
qiaolongfei 已提交
2639

Q
qiaolongfei 已提交
2640
    1. NHWC `[batch, in_height, in_width, in_channels]`
Q
qiaolongfei 已提交
2641

Q
qiaolongfei 已提交
2642 2643
    2. NCHW `[batch, in_channels, in_height, in_width]`

Q
qiaolongfei 已提交
2644 2645 2646
    Refer to `Batch Normalization: Accelerating Deep Network Training by Reducing
    Internal Covariate Shift <https://arxiv.org/pdf/1502.03167.pdf>`_
    for more details.
Q
qiaolongfei 已提交
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658

    :math:`input` is the input features over a mini-batch.

    ..  math::

        \\mu_{\\beta} &\\gets \\frac{1}{m} \\sum_{i=1}^{m} x_i \\qquad &//\\
        \ mini-batch\ mean \\\\
        \\sigma_{\\beta}^{2} &\\gets \\frac{1}{m} \\sum_{i=1}^{m}(x_i - \\
        \\mu_{\\beta})^2 \\qquad &//\ mini-batch\ variance \\\\
        \\hat{x_i} &\\gets \\frac{x_i - \\mu_\\beta} {\\sqrt{\\
        \\sigma_{\\beta}^{2} + \\epsilon}} \\qquad &//\ normalize \\\\
        y_i &\\gets \\gamma \\hat{x_i} + \\beta \\qquad &//\ scale\ and\ shift
2659

L
lvmengsi 已提交
2660
        moving\_mean = moving\_mean * momentum + mini-batch\_mean * (1. - momentum) \\\\
2661
        moving\_var = moving\_var * momentum + mini-batch\_var * (1. - momentum)
L
lvmengsi 已提交
2662

2663

L
lvmengsi 已提交
2664
    moving_mean is global mean and moving_var is global variance.
2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677

    When use_global_stats = True, the :math:`\\mu_{\\beta}`
    and :math:`\\sigma_{\\beta}^{2}` are not the statistics of one mini-batch.
    They are global (or running) statistics. (It usually got from the
    pre-trained model.)
    The training and testing (or inference) have the same behavior:

    ..  math::

        \\hat{x_i} &\\gets \\frac{x_i - \\mu_\\beta} {\\sqrt{\\
        \\sigma_{\\beta}^{2} + \\epsilon}}  \\\\
        y_i &\\gets \\gamma \\hat{x_i} + \\beta

L
lvmengsi 已提交
2678
    Note:
2679
        if build_strategy.sync_batch_norm=True, the batch_norm in network will use
L
lvmengsi 已提交
2680
        sync_batch_norm automatically.
2681
        `is_test = True` can only be used in test program and inference program, `is_test` CANNOT be set to True in train program, if you want to use global status from pre_train model in train program, please set `use_global_stats = True`.
L
lvmengsi 已提交
2682

2683
    Args:
2684
        input(Variable): The rank of input variable can be 2, 3, 4, 5. The data type
L
lvmengsi 已提交
2685
            is float16 or float32 or float64.
Q
qiaolongfei 已提交
2686
        act(string, Default None): Activation type, linear|relu|prelu|...
Q
qingqing01 已提交
2687 2688
        is_test (bool, Default False): A flag indicating whether it is in
            test phrase or not.
2689 2690 2691
        momentum(float|Variable, Default 0.9): The value used for the moving_mean and
            moving_var computation. This should be a float number or a Variable with
            shape [1] and data type as float32. The updated formula is:
Q
qingqing01 已提交
2692 2693 2694 2695 2696
            :math:`moving\_mean = moving\_mean * momentum + new\_mean * (1. - momentum)`
            :math:`moving\_var = moving\_var * momentum + new\_var * (1. - momentum)`
            Default is 0.9.
        epsilon(float, Default 1e-05): A value added to the denominator for
            numerical stability. Default is 1e-5.
C
chengduo 已提交
2697 2698
        param_attr(ParamAttr|None): The parameter attribute for Parameter `scale`
             of batch_norm. If it is set to None or one attribute of ParamAttr, batch_norm
2699
	     will create ParamAttr as param_attr, the name of scale can be set in ParamAttr.
2700
	     If the Initializer of the param_attr is not set, the parameter is initialized
2701
	     with Xavier. Default: None.
C
chengduo 已提交
2702 2703
        bias_attr(ParamAttr|None): The parameter attribute for the bias of batch_norm.
             If it is set to None or one attribute of ParamAttr, batch_norm
2704 2705
	     will create ParamAttr as bias_attr, the name of bias can be set in ParamAttr.
	     If the Initializer of the bias_attr is not set, the bias is initialized zero.
2706
	     Default: None.
2707
        data_layout (str, optional): Specify the data format of the input, and the data format of the output
K
Kaipeng Deng 已提交
2708 2709 2710
             will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
             The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
             `[batch_size, input_channels, input_height, input_width]`.
2711
        in_place(bool, Default False): Make the input and output of batch norm reuse memory.
2712 2713 2714 2715
        name(str|None): For detailed information, please refer to :ref:`api_guide_Name`.
            Usually name is no need to set and None by default.
        moving_mean_name(str, Default None): The name of moving_mean which store the global Mean. If it
            is set to None, batch_norm will save global mean with a random name, otherwise, batch_norm
2716
            will save global mean with the string.
L
lvmengsi 已提交
2717
        moving_variance_name(str, Default None): The name of the moving_variance which store the global Variance.
2718
            If it is set to None, batch_norm will save global variance with a random name, otherwise, batch_norm
2719
            will save global variance with the string.
2720 2721
        do_model_average_for_mean_and_var(bool, Default True): Whether parameter mean and variance should do model
            average when model average is enabled.
2722 2723 2724 2725 2726
        use_global_stats(bool, Default False): Whether to use global mean and
            variance. In inference or test mode, set use_global_stats to true
            or is_test to true, and the behavior is equivalent.
            In train mode, when setting use_global_stats True, the global mean
            and variance are also used during train period.
2727
    Returns:
2728 2729
        A Variable holding Tensor which is the result after applying batch normalization on the input,
        has same shape and data type with input.
Q
qiaolongfei 已提交
2730 2731 2732 2733 2734

    Examples:

        .. code-block:: python

2735
            import paddle.fluid as fluid
L
lvmengsi 已提交
2736
            x = fluid.data(name='x', shape=[3, 7, 3, 7], dtype='float32')
Q
qiaolongfei 已提交
2737 2738
            hidden1 = fluid.layers.fc(input=x, size=200, param_attr='fc1.w')
            hidden2 = fluid.layers.batch_norm(input=hidden1)
2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765

        .. code-block:: python

            # batch_norm with momentum as Variable
            import paddle.fluid as fluid
            import paddle.fluid.layers.learning_rate_scheduler as lr_scheduler

            def get_decay_momentum(momentum_init, decay_steps, decay_rate):
                global_step = lr_scheduler._decay_step_counter()
                momentum = fluid.layers.create_global_var(
		    shape=[1],
		    value=float(momentum_init),
		    dtype='float32',
		    # set persistable for save checkpoints and resume
		    persistable=True,
		    name="momentum")
                div_res = global_step / decay_steps
                decayed_momentum = momentum_init * (decay_rate**div_res)
                fluid.layers.assign(decayed_momentum, momentum)

                return momentum

            x = fluid.data(name='x', shape=[3, 7, 3, 7], dtype='float32')
            hidden1 = fluid.layers.fc(input=x, size=200, param_attr='fc1.w')
            momentum = get_decay_momentum(0.9, 1e5, 0.9)
            hidden2 = fluid.layers.batch_norm(input=hidden1, momentum=momentum)

Y
Yu Yang 已提交
2766
    """
C
chengduo 已提交
2767
    assert bias_attr is not False, "bias_attr should not be False in batch_norm."
Y
Yu Yang 已提交
2768 2769
    helper = LayerHelper('batch_norm', **locals())

2770 2771
    check_variable_and_dtype(input, 'input', ['float16', 'float32', 'float64'],
                             'batch_norm')
2772
    dtype = helper.input_dtype()
2773 2774 2775 2776 2777 2778 2779

    has_reserve_space = False
    if data_layout == 'NHWC':
        flag = os.environ.get('FLAGS_cudnn_batchnorm_spatial_persistent')
        if flag is not None and flag.lower() in ['true', '1']:
            has_reserve_space = True

W
Wu Yi 已提交
2780 2781 2782 2783
    # use fp32 for bn parameter
    if dtype == core.VarDesc.VarType.FP16:
        dtype = core.VarDesc.VarType.FP32

Y
Yu Yang 已提交
2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801
    input_shape = input.shape
    if data_layout == 'NCHW':
        channel_num = input_shape[1]
    else:
        if data_layout == 'NHWC':
            channel_num = input_shape[-1]
        else:
            raise ValueError("unsupported data layout:" + data_layout)

    param_shape = [channel_num]

    # create parameter
    scale = helper.create_parameter(
        attr=helper.param_attr,
        shape=param_shape,
        dtype=dtype,
        default_initializer=Constant(1.0))
    bias = helper.create_parameter(
2802
        attr=helper.bias_attr, shape=param_shape, dtype=dtype, is_bias=True)
Y
Yu Yang 已提交
2803

2804 2805
    mean = helper.create_parameter(
        attr=ParamAttr(
W
wanghaoshuang 已提交
2806 2807 2808
            name=moving_mean_name,
            initializer=Constant(0.0),
            trainable=False,
W
wanghaoshuang 已提交
2809
            do_model_average=do_model_average_for_mean_and_var),
Q
QI JUN 已提交
2810
        shape=param_shape,
W
Wu Yi 已提交
2811
        dtype=dtype)
2812 2813 2814 2815 2816 2817
    mean.stop_gradient = True

    variance = helper.create_parameter(
        attr=ParamAttr(
            name=moving_variance_name,
            initializer=Constant(1.0),
W
wanghaoshuang 已提交
2818
            trainable=False,
W
wanghaoshuang 已提交
2819
            do_model_average=do_model_average_for_mean_and_var),
Q
QI JUN 已提交
2820
        shape=param_shape,
W
Wu Yi 已提交
2821
        dtype=dtype)
2822
    variance.stop_gradient = True
Y
Yu Yang 已提交
2823 2824 2825 2826 2827 2828

    # create output
    # mean and mean_out share the same memory
    mean_out = mean
    # variance and variance out share the same memory
    variance_out = variance
X
Xin Pan 已提交
2829 2830 2831 2832
    saved_mean = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)
    saved_variance = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)
Y
Yu Yang 已提交
2833

2834 2835 2836 2837 2838
    reserve_space = None
    if has_reserve_space:
        reserve_space = helper.create_variable_for_type_inference(
            dtype=core.VarDesc.VarType.FP16, stop_gradient=True)

K
Kaipeng Deng 已提交
2839 2840
    batch_norm_out = input if in_place else \
            helper.create_variable_for_type_inference(dtype)
Y
Yu Yang 已提交
2841

2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860
    inputs = {
        "X": input,
        "Scale": scale,
        "Bias": bias,
        "Mean": mean,
        "Variance": variance
    }
    attrs = {
        "epsilon": epsilon,
        "is_test": is_test,
        "data_layout": data_layout,
        "use_mkldnn": False,
        "fuse_with_relu": False,
        "use_global_stats": use_global_stats
    }
    if isinstance(momentum, Variable):
        inputs['MomemtumTensor'] = momentum
    else:
        attrs['momentum'] = momentum
2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871

    outputs = {
        "Y": batch_norm_out,
        "MeanOut": mean_out,
        "VarianceOut": variance_out,
        "SavedMean": saved_mean,
        "SavedVariance": saved_variance
    }
    if reserve_space is not None:
        outputs["ReserveSpace"] = reserve_space

Y
Yu Yang 已提交
2872
    helper.append_op(
2873
        type="batch_norm", inputs=inputs, outputs=outputs, attrs=attrs)
Y
Yu Yang 已提交
2874 2875 2876 2877

    return helper.append_activation(batch_norm_out)


K
Kaipeng Deng 已提交
2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893
def inplace_abn(input,
                act=None,
                is_test=False,
                momentum=0.9,
                epsilon=1e-05,
                param_attr=None,
                bias_attr=None,
                data_layout='NCHW',
                name=None,
                moving_mean_name=None,
                moving_variance_name=None,
                do_model_average_for_mean_and_var=True,
                use_global_stats=False,
                act_alpha=1.0):
    """
    **In-place Activation Batch Normalization Layer**
2894

K
Kaipeng Deng 已提交
2895 2896
    This layer calculates batch normalization and activation with in-place memory.
    For batch normalization calculations, see `fluid.layers.batch_norm`.
2897
    For in-place activation batch normalization, see `In-Place Activated BatchNorm for
K
Kaipeng Deng 已提交
2898 2899 2900 2901 2902 2903 2904
    Memory-Optimized Training of DNNs <https://arxiv.org/abs/1712.02616>`_

    `inplace_abn` only support activation type as `None`, `identity`, `leaky_relu`,
    `elu` currently.
    `inplace_abn` only support data type as `float32`, `float64` currently.

    Note:
2905
        if build_strategy.sync_batch_norm=True, the batch_norm in network will use
K
Kaipeng Deng 已提交
2906 2907 2908 2909
        sync_batch_norm automatically.
        `is_test = True` can only be used in test program and inference program, `is_test` CANNOT be set to True in train program, if you want to use global status from pre_train model in train program, please set `use_global_stats = True`.

    Args:
2910
        input(Variable): The rank of input variable can be 2, 3, 4, 5. The data type
K
Kaipeng Deng 已提交
2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923
            is float16 or float32 or float64.
        act(string, Default None): Activation type, linear|relu|prelu|...
        is_test (bool, Default False): A flag indicating whether it is in
            test phrase or not.
        momentum(float|Variable, Default 0.9): The value used for the moving_mean and
            moving_var computation. This should be a float number or a Variable with
            shape [1] and data type as float32. The updated formula is:
            :math:`moving\_mean = moving\_mean * momentum + new\_mean * (1. - momentum)`
            :math:`moving\_var = moving\_var * momentum + new\_var * (1. - momentum)`
            Default is 0.9.
        epsilon(float, Default 1e-05): A value added to the denominator for
            numerical stability. Default is 1e-5.
        param_attr(ParamAttr|None): The parameter attribute for Parameter `scale`
2924
             of inplace_abn. If it is set to None or one attribute of ParamAttr, inplace_abn
K
Kaipeng Deng 已提交
2925
	     will create ParamAttr as param_attr, the name of scale can be set in ParamAttr.
2926
	     If the Initializer of the param_attr is not set, the parameter is initialized
K
Kaipeng Deng 已提交
2927 2928
	     with Xavier. Default: None.
        bias_attr(ParamAttr|None): The parameter attribute for the bias of inplace_abn.
2929 2930 2931
             If it is set to None or one attribute of ParamAttr, inplace_abn
	     will create ParamAttr as bias_attr, the name of bias can be set in ParamAttr.
	     If the Initializer of the bias_attr is not set, the bias is initialized zero.
K
Kaipeng Deng 已提交
2932
	     Default: None.
2933
        data_layout (str, optional): Specify the data format of the input, and the data format of the output
K
Kaipeng Deng 已提交
2934 2935 2936
             will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
             The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
             `[batch_size, input_channels, input_height, input_width]`.
2937 2938 2939 2940
        name(str|None): For detailed information, please refer to :ref:`api_guide_Name`.
            Usually name is no need to set and None by default.
        moving_mean_name(str, Default None): The name of moving_mean which store the global Mean. If it
            is set to None, inplace_abn will save global mean with a random name, otherwise, inplace_abn
K
Kaipeng Deng 已提交
2941 2942
            will save global mean with the string.
        moving_variance_name(str, Default None): The name of the moving_variance which store the global Variance.
2943
            If it is set to None, inplace_abn, will save global variance with a random name, otherwise, inplace_abn
K
Kaipeng Deng 已提交
2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955
            will save global variance with the string.
        do_model_average_for_mean_and_var(bool, Default True): Whether parameter mean and variance should do model
            average when model average is enabled.
        use_global_stats(bool, Default False): Whether to use global mean and
            variance. In inference or test mode, set use_global_stats to true
            or is_test to true, and the behavior is equivalent.
            In train mode, when setting use_global_stats True, the global mean
            and variance are also used during train period.
        act_alpha(float, Default 1.0): when activation is in ['elu', 'identity', 'leaky_relu'],
            inplace activative batch normalization will be used, and alpha parameter for activation
            can be given by this parameter.
    Returns:
2956 2957
        A Variable holding Tensor which is the result after applying batch normalization and activation on the input,
        has same shape and data type with input.
K
Kaipeng Deng 已提交
2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid
            x = fluid.data(name='x', shape=[3, 7, 3, 7], dtype='float32')
            hidden1 = fluid.layers.fc(input=x, size=200, param_attr='fc1.w')
            hidden2 = fluid.layers.inplace_abn(input=hidden1)
            hidden3 = fluid.layers.inplace_abn(input=hidden2, act='leaky_relu', act_alpha=0.2)

    """
    assert act in [None, 'identity', 'leaky_relu', 'elu'], \
        "inplace_abn only support act as None, 'identity', " \
        "'leaky_relu', 'elu' currently"
    assert bias_attr is not False, "bias_attr should not be False in inplace_abn."
    helper = LayerHelper('inplace_abn', **locals())

    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'inplace_abn')
    dtype = helper.input_dtype()

    has_reserve_space = False
    if data_layout == 'NHWC':
        flag = os.environ.get('FLAGS_cudnn_batchnorm_spatial_persistent')
        if flag is not None and flag.lower() in ['true', '1']:
            has_reserve_space = True

    input_shape = input.shape
    if data_layout == 'NCHW':
        channel_num = input_shape[1]
    else:
        if data_layout == 'NHWC':
            channel_num = input_shape[-1]
        else:
            raise ValueError("unsupported data layout:" + data_layout)

    param_shape = [channel_num]

    # create parameter
    scale = helper.create_parameter(
        attr=helper.param_attr,
        shape=param_shape,
        dtype=dtype,
        default_initializer=Constant(1.0))
    bias = helper.create_parameter(
        attr=helper.bias_attr, shape=param_shape, dtype=dtype, is_bias=True)

    mean = helper.create_parameter(
        attr=ParamAttr(
            name=moving_mean_name,
            initializer=Constant(0.0),
            trainable=False,
            do_model_average=do_model_average_for_mean_and_var),
        shape=param_shape,
        dtype=dtype)
    mean.stop_gradient = True

    variance = helper.create_parameter(
        attr=ParamAttr(
            name=moving_variance_name,
            initializer=Constant(1.0),
            trainable=False,
            do_model_average=do_model_average_for_mean_and_var),
        shape=param_shape,
        dtype=dtype)
    variance.stop_gradient = True

    # create output
    # mean and mean_out share the same memory
    mean_out = mean
    # variance and variance out share the same memory
    variance_out = variance
    saved_mean = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)
    saved_variance = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)

    reserve_space = None
    if has_reserve_space:
        reserve_space = helper.create_variable_for_type_inference(
            dtype=core.VarDesc.VarType.FP16, stop_gradient=True)

    batch_norm_out = input

    inputs = {
        "X": input,
        "Scale": scale,
        "Bias": bias,
        "Mean": mean,
        "Variance": variance
    }
    attrs = {
        "epsilon": epsilon,
        "is_test": is_test,
        "data_layout": data_layout,
        "use_mkldnn": False,
        "fuse_with_relu": False,
        "use_global_stats": use_global_stats,
        "activation": act,
        "alpha": act_alpha,
    }
    if isinstance(momentum, Variable):
        inputs['MomemtumTensor'] = momentum
    else:
        attrs['momentum'] = momentum

    outputs = {
        "Y": batch_norm_out,
        "MeanOut": mean_out,
        "VarianceOut": variance_out,
        "SavedMean": saved_mean,
        "SavedVariance": saved_variance
    }
    if reserve_space is not None:
        outputs["ReserveSpace"] = reserve_space

    helper.append_op(
        type="inplace_abn", inputs=inputs, outputs=outputs, attrs=attrs)

    return batch_norm_out


L
lvmengsi 已提交
3081 3082 3083 3084 3085 3086
def instance_norm(input,
                  epsilon=1e-05,
                  param_attr=None,
                  bias_attr=None,
                  name=None):
    """
3087 3088
    :api_attr: Static Graph

L
lvmengsi 已提交
3089 3090
    **Instance Normalization Layer**

L
lvmengsi 已提交
3091
    Can be used as a normalizer function for convolution or fully_connected operations.
L
lvmengsi 已提交
3092 3093 3094 3095
    The required data format for this layer is one of the following:

    DataLayout: NCHW `[batch, in_channels, in_height, in_width]`

3096
    Refer to `Instance Normalization: The Missing Ingredient for
L
lvmengsi 已提交
3097 3098 3099 3100 3101 3102 3103 3104
    Fast Stylization <https://arxiv.org/pdf/1607.08022.pdf>`_
    for more details.

    :math:`input` is the input features over a mini-batch.

    ..  math::

        \\mu_{\\beta} &\\gets \\frac{1}{HW} \\sum_{i=1}^{HW} x_i \\qquad &//\\
L
lvmengsi 已提交
3105
        \\ mean\ of\ one\  feature\ map\ in\ mini-batch \\\\
L
lvmengsi 已提交
3106
        \\sigma_{\\beta}^{2} &\\gets \\frac{1}{HW} \\sum_{i=1}^{HW}(x_i - \\
L
lvmengsi 已提交
3107
        \\mu_{\\beta})^2 \\qquad &//\ variance\ of\ one\ feature\ map\ in\ mini-batch \\\\
L
lvmengsi 已提交
3108 3109 3110 3111
        \\hat{x_i} &\\gets \\frac{x_i - \\mu_\\beta} {\\sqrt{\\
        \\sigma_{\\beta}^{2} + \\epsilon}} \\qquad &//\ normalize \\\\
        y_i &\\gets \\gamma \\hat{x_i} + \\beta \\qquad &//\ scale\ and\ shift

L
lvmengsi 已提交
3112 3113
    Note:
        `H` means height of feature map, `W` means width of feature map.
L
lvmengsi 已提交
3114 3115

    Args:
3116
        input(variable): The rank of input variable can be 2, 3, 4, 5.
L
lvmengsi 已提交
3117
            The data type is float32 or float64.
L
lvmengsi 已提交
3118 3119
        epsilon(float, Default 1e-05): A value added to the denominator for
            numerical stability. Default is 1e-5.
C
ceci3 已提交
3120
        param_attr(ParamAttr|None|bool, optional): The parameter attribute for Parameter `scale`
L
lvmengsi 已提交
3121 3122
             of instance_norm. If it is set to None or one attribute of ParamAttr, instance_norm
	     will create ParamAttr as param_attr, the name of scale can be set in ParamAttr.
3123
	     If the Initializer of the param_attr is not set, the parameter is initialized
C
ceci3 已提交
3124 3125 3126
	     with Xavier. If the param_attr is set to False, instance_norm will not create param_attr.
             Default: None.
        bias_attr(ParamAttr|None|bool, optional): The parameter attribute for the bias of instance_norm.
L
lvmengsi 已提交
3127
             If it is set to None or one attribute of ParamAttr, instance_norm
3128 3129
	     will create ParamAttr as bias_attr, the name of bias can be set in ParamAttr.
	     If the Initializer of the bias_attr is not set, the bias is initialized zero.
C
ceci3 已提交
3130
             If the bias_attr is set to False, instance_norm will not create bias_attr.
L
lvmengsi 已提交
3131 3132 3133 3134 3135
	     Default: None.
        name(string, Default None): A name for this layer(optional). If set None, the layer
            will be named automatically.

    Returns:
3136 3137
        A Variable holding Tensor which is the result after applying instance normalization on the input,
        has same shape and data type with input.
L
lvmengsi 已提交
3138 3139 3140 3141 3142 3143

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid
L
lvmengsi 已提交
3144
            x = fluid.data(name='x', shape=[3, 7, 3, 7], dtype='float32')
L
lvmengsi 已提交
3145 3146 3147
            hidden1 = fluid.layers.fc(input=x, size=200, param_attr='fc1.w')
            hidden2 = fluid.layers.instance_norm(input=hidden1)
    """
3148 3149
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'instance_norm')
C
ceci3 已提交
3150 3151 3152
    if param_attr is False:
        assert bias_attr is False, "param_attr and bias_attr must be set to Fasle at the same time in instance_norm"

L
lvmengsi 已提交
3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164
    helper = LayerHelper('instance_norm', **locals())
    dtype = helper.input_dtype()

    # use fp32 for in parameter
    if dtype == core.VarDesc.VarType.FP16:
        dtype = core.VarDesc.VarType.FP32

    input_shape = input.shape
    channel_num = input_shape[1]

    param_shape = [channel_num]

C
ceci3 已提交
3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177
    if param_attr and bias_attr:
        # create parameter
        scale = helper.create_parameter(
            attr=helper.param_attr,
            shape=param_shape,
            dtype=dtype,
            default_initializer=Constant(1.0))
        bias = helper.create_parameter(
            attr=helper.bias_attr,
            shape=param_shape,
            dtype=dtype,
            is_bias=True,
            default_initializer=Constant(0.0))
L
lvmengsi 已提交
3178 3179 3180 3181 3182 3183 3184 3185 3186

    # create output
    saved_mean = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)
    saved_variance = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)

    instance_norm_out = helper.create_variable_for_type_inference(dtype)

C
ceci3 已提交
3187 3188 3189 3190 3191
    inputs = {"X": input}
    if param_attr and bias_attr:
        inputs["Scale"] = scale
        inputs["Bias"] = bias

L
lvmengsi 已提交
3192 3193
    helper.append_op(
        type="instance_norm",
C
ceci3 已提交
3194
        inputs=inputs,
L
lvmengsi 已提交
3195 3196 3197 3198 3199 3200 3201 3202 3203 3204
        outputs={
            "Y": instance_norm_out,
            "SavedMean": saved_mean,
            "SavedVariance": saved_variance
        },
        attrs={"epsilon": epsilon, })

    return instance_norm_out


H
heqiaozhi 已提交
3205 3206 3207 3208 3209 3210 3211 3212 3213
def data_norm(input,
              act=None,
              epsilon=1e-05,
              param_attr=None,
              data_layout='NCHW',
              in_place=False,
              name=None,
              moving_mean_name=None,
              moving_variance_name=None,
3214
              do_model_average_for_mean_and_var=True,
H
hutuxian 已提交
3215 3216
              slot_dim=-1,
              sync_stats=False,
3217 3218
              summary_decay_rate=0.9999999,
              enable_scale_and_shift=False):
H
heqiaozhi 已提交
3219
    """
3220 3221
    :api_attr: Static Graph

H
heqiaozhi 已提交
3222 3223
    **Data Normalization Layer**

3224
    This op can be used as a normalizer function for conv2d and fully_connected operations.
H
heqiaozhi 已提交
3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247
    The required data format for this layer is one of the following:

    1. NHWC `[batch, in_height, in_width, in_channels]`

    2. NCHW `[batch, in_channels, in_height, in_width]`

    :math:`input` is the input features over a mini-batch.

    ..  math::

        \\mu_{\\beta} &\\gets \\frac{1}{m} \\sum_{i=1}^{m} x_i \\qquad &//\\
        \ mini-batch\ mean \\\\
        \\sigma_{\\beta}^{2} &\\gets \\frac{1}{m} \\sum_{i=1}^{m}(x_i - \\
        \\mu_{\\beta})^2 \\qquad &//\ mini-batch\ variance \\\\
        \\hat{x_i} &\\gets \\frac{x_i - \\mu_\\beta} {\\sqrt{\\
        \\sigma_{\\beta}^{2} + \\epsilon}} \\qquad &//\ normalize \\\\
        y_i &\\gets \\gamma \\hat{x_i} + \\beta \\qquad &//\ scale\ and\ shift

    Args:
        input(variable): The input variable which is a LoDTensor.
        act(string, Default None): Activation type, linear|relu|prelu|...
        epsilon(float, Default 1e-05):
        param_attr(ParamAttr): The parameter attribute for Parameter `scale`.
3248
        data_layout (str, optional): Specify the data format of the input, and the data format of the output
3249 3250 3251
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_height, input_width]`.
H
heqiaozhi 已提交
3252 3253 3254 3255 3256
        in_place(bool, Default False): Make the input and output of batch norm reuse memory.
        name(string, Default None): A name for this layer(optional). If set None, the layer
            will be named automatically.
        moving_mean_name(string, Default None): The name of moving_mean which store the global Mean.
        moving_variance_name(string, Default None): The name of the moving_variance which store the global Variance.
3257 3258
        do_model_average_for_mean_and_var(bool, Default True): Whether parameter mean and variance
            should do model average when model average is enabled.
3259
        slot_dim(int): The embedding dimension of one slot. Slot is a set of one specific feature. In pslib mode, we
3260 3261
            distinguish feature ids by slot and pull their embeddings from parameter server (pslib). The first
            place of the embedding is the historical show number (occurence time of this feature id with a label 0).
3262 3263
            If the input of this op is concated by slot-wise embeddings, and the show number is zero when this slot
            is new or empty, the normalization result may be impractical. To avoid this, we add slot_dim to locate
3264 3265
            the show number and judge if the show number is zero. If so, we choose to skip normalization on this
            embedding.
H
hutuxian 已提交
3266 3267 3268
        sync_stats(bool, Default False): When running with multiple GPU cards, using allreduce to sync the
            summary messages.
        summary_decay_rate(float, Default 0.9999999): The decay rate when updating summary.
3269
        enable_scale_and_shift(bool, Default False): do scale&shift after normalization.
H
heqiaozhi 已提交
3270 3271 3272 3273 3274 3275 3276

    Returns:
        Variable: A tensor variable which is the result after applying data normalization on the input.

    Examples:

        .. code-block:: python
3277

3278
            import paddle.fluid as fluid
H
heqiaozhi 已提交
3279

3280
            hidden1 = fluid.data(name="hidden1", shape=[64, 200])
3281
            hidden2 = fluid.layers.data_norm(name="hidden2", input=hidden1)
H
heqiaozhi 已提交
3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299
    """
    helper = LayerHelper('data_norm', **locals())
    dtype = helper.input_dtype()

    input_shape = input.shape
    if data_layout == 'NCHW':
        channel_num = input_shape[1]
    else:
        if data_layout == 'NHWC':
            channel_num = input_shape[-1]
        else:
            raise ValueError("unsupported data layout:" + data_layout)

    param_shape = [channel_num]

    batch_size_default = 1e4
    batch_sum_default = 0.0
    batch_square_sum_default = 1e4
3300 3301
    scale_w_default = 1.0
    bias_default = 0.0
H
heqiaozhi 已提交
3302 3303 3304 3305 3306

    if param_attr and isinstance(param_attr, dict):
        batch_size_default = param_attr.get("batch_size", 1e4)
        batch_sum_default = param_attr.get("batch_sum", 0.0)
        batch_square_sum_default = param_attr.get("batch_square", 1e4)
3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328
    if enable_scale_and_shift:
        scale_w_default = param_attr.get("scale_w", 1.0)
        bias_default = param_attr.get("bias", 0.0)

    # create scale and shift(bias) when enable_scale_and_shift is True
    if name == None:
        name = "dn"
    if enable_scale_and_shift:
        scale_w = helper.create_parameter(
            attr=ParamAttr(
                name=name + '.scale_w',
                initializer=Constant(value=float(scale_w_default)),
                trainable=True),
            shape=param_shape,
            dtype=input.dtype)
        bias = helper.create_parameter(
            attr=ParamAttr(
                name=name + '.bias',
                initializer=Constant(value=float(bias_default)),
                trainable=True),
            shape=param_shape,
            dtype=input.dtype)
H
heqiaozhi 已提交
3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358
    # create parameter
    batch_size = helper.create_parameter(
        attr=ParamAttr(
            name=name + '.batch_size',
            initializer=Constant(value=float(batch_size_default)),
            trainable=True),
        shape=param_shape,
        dtype=input.dtype)

    batch_sum = helper.create_parameter(
        attr=ParamAttr(
            name=name + '.batch_sum',
            initializer=Constant(value=float(batch_sum_default)),
            trainable=True),
        shape=param_shape,
        dtype=input.dtype)

    batch_square_sum = helper.create_parameter(
        attr=ParamAttr(
            name=name + '.batch_square_sum',
            initializer=Constant(value=float(batch_square_sum_default)),
            trainable=True),
        shape=param_shape,
        dtype=input.dtype)

    means = helper.create_variable(dtype=dtype, stop_gradient=True)
    scales = helper.create_variable(dtype=dtype, stop_gradient=True)

    data_norm_out = input if in_place else helper.create_variable(dtype=dtype)

3359 3360 3361 3362 3363 3364 3365 3366 3367
    inputs = {
        "X": input,
        "BatchSize": batch_size,
        "BatchSum": batch_sum,
        "BatchSquareSum": batch_square_sum
    }
    if enable_scale_and_shift:
        inputs["scale_w"] = scale_w
        inputs["bias"] = bias
H
heqiaozhi 已提交
3368 3369
    helper.append_op(
        type="data_norm",
3370
        inputs=inputs,
H
hutuxian 已提交
3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382
        outputs={
            "Y": data_norm_out,
            "Means": means,
            "Scales": scales,
            "BatchSize": batch_size,
            "BatchSum": batch_sum,
            "BatchSquareSum": batch_square_sum
        },
        attrs={
            "epsilon": epsilon,
            "slot_dim": slot_dim,
            "sync_stats": sync_stats,
3383 3384
            "summary_decay_rate": summary_decay_rate,
            "enable_scale_and_shift": enable_scale_and_shift
H
hutuxian 已提交
3385
        })
H
heqiaozhi 已提交
3386 3387 3388 3389

    return helper.append_activation(data_norm_out)


Y
yuyang18 已提交
3390
@templatedoc()
G
guosheng 已提交
3391 3392 3393 3394 3395 3396 3397 3398 3399 3400
def layer_norm(input,
               scale=True,
               shift=True,
               begin_norm_axis=1,
               epsilon=1e-05,
               param_attr=None,
               bias_attr=None,
               act=None,
               name=None):
    """
3401 3402
    :api_attr: Static Graph

3403 3404 3405 3406
    **Layer Normalization Layer**

    The API implements the function of the Layer Normalization Layer and can be applied to mini-batch input data.
    Refer to `Layer Normalization <https://arxiv.org/pdf/1607.06450v1.pdf>`_
G
guosheng 已提交
3407 3408 3409

    The formula is as follows:

Y
yuyang18 已提交
3410
    ..  math::
G
guosheng 已提交
3411

3412
        \\mu & = \\frac{1}{H}\\sum_{i=1}^{H} x_i
G
guosheng 已提交
3413

3414
        \\sigma & = \\sqrt{\\frac{1}{H}\sum_{i=1}^{H}{(x_i - \\mu)^2} + \\epsilon}
Y
yuyang18 已提交
3415

3416
        y & = f(\\frac{g}{\\sigma}(x - \\mu) + b)
Y
yuyang18 已提交
3417

3418 3419 3420 3421 3422
    - :math:`x`: the vector representation of the summed inputs to the neurons in that layer.
    - :math:`H`: the number of hidden units in a layers
    - :math:`\\epsilon`: the small value added to the variance to prevent division by zero.
    - :math:`g`: the trainable scale parameter.
    - :math:`b`: the trainable bias parameter.
Y
yuyang18 已提交
3423

G
guosheng 已提交
3424
    Args:
3425 3426 3427 3428 3429 3430
        input(Variable): A multi-dimension ``Tensor`` , and the data type is float32 or float64.
        scale(bool, optional): Whether to learn the adaptive gain :math:`g` after
            normalization. Default: True.
        shift(bool, optional): Whether to learn the adaptive bias :math:`b` after
            normalization. Default: True.
        begin_norm_axis(int, optional): The normalization will be performed along
G
guosheng 已提交
3431
            dimensions from :attr:`begin_norm_axis` to :attr:`rank(input)`.
3432 3433 3434 3435
            Default: 1.
        epsilon(float, optional): The small value added to the variance to prevent
            division by zero. Default: 1e-05.
        param_attr(ParamAttr, optional): The parameter attribute for the learnable
S
sneaxiy 已提交
3436 3437
            gain :math:`g`. If :attr:`scale` is False, :attr:`param_attr` is
            omitted. If :attr:`scale` is True and :attr:`param_attr` is None,
3438
            a default :code:`ParamAttr` would be added as scale. The
3439 3440
            :attr:`param_attr` is initialized as 1 if it is added. Default: None.
        bias_attr(ParamAttr, optional): The parameter attribute for the learnable
S
sneaxiy 已提交
3441 3442
            bias :math:`b`. If :attr:`shift` is False, :attr:`bias_attr` is
            omitted. If :attr:`shift` is True and :attr:`param_attr` is None,
3443
            a default :code:`ParamAttr` would be added as bias. The
3444
            :attr:`bias_attr` is initialized as 0 if it is added. Default: None.
T
tianshuo78520a 已提交
3445
        act(str, optional): Activation to be applied to the output of layer normalization.
3446 3447
                  Default: None.
        name(str): 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` .
G
guosheng 已提交
3448 3449

    Returns:
3450
        Variable: ``Tensor``  indicating the normalized result, the data type is the same as  ``input`` , and the return dimension is the same as  ``input`` .
G
guosheng 已提交
3451 3452 3453

    Examples:

3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465
        .. code-block:: python

            import paddle.fluid as fluid
            import numpy as np
            x = fluid.data(name='x', shape=[-1, 32, 32], dtype='float32')
            hidden1 = fluid.layers.layer_norm(input=x, begin_norm_axis=1)
            place = fluid.CPUPlace()
            exe = fluid.Executor(place)
            exe.run(fluid.default_startup_program())
            np_x = np.random.random(size=(8, 3, 32, 32)).astype('float32')
            output = exe.run(feed={"x": np_x}, fetch_list = [hidden1])
            print(output)
G
guosheng 已提交
3466
    """
L
lujun 已提交
3467
    assert in_dygraph_mode(
3468
    ) is not True, "please use LayerNorm instead of layer_norm in dygraph mode!"
G
guosheng 已提交
3469
    helper = LayerHelper('layer_norm', **locals())
3470 3471
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'layer_norm')
G
guosheng 已提交
3472 3473 3474 3475 3476 3477 3478
    dtype = helper.input_dtype()

    # create intput and parameters
    inputs = {'X': input}
    input_shape = input.shape
    param_shape = [reduce(lambda x, y: x * y, input_shape[begin_norm_axis:])]
    if scale:
3479
        assert param_attr is not False, "param_attr should not be False when using scale."
G
guosheng 已提交
3480 3481 3482 3483 3484 3485
        scale = helper.create_parameter(
            attr=helper.param_attr,
            shape=param_shape,
            dtype=dtype,
            default_initializer=Constant(1.0))
        inputs['Scale'] = scale
3486 3487
    else:
        if param_attr:
T
tianshuo78520a 已提交
3488
            warnings.warn("param_attr is only available with scale is True.")
G
guosheng 已提交
3489
    if shift:
3490
        assert bias_attr is not False, "bias_attr should not be False when using shift."
G
guosheng 已提交
3491 3492 3493
        bias = helper.create_parameter(
            attr=helper.bias_attr, shape=param_shape, dtype=dtype, is_bias=True)
        inputs['Bias'] = bias
3494 3495
    else:
        if bias_attr:
T
tianshuo78520a 已提交
3496
            warnings.warn("bias_attr is only available with shift is True.")
G
guosheng 已提交
3497 3498

    # create output
X
Xin Pan 已提交
3499 3500 3501 3502 3503
    mean_out = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)
    variance_out = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)
    layer_norm_out = helper.create_variable_for_type_inference(dtype)
G
guosheng 已提交
3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518

    helper.append_op(
        type="layer_norm",
        inputs=inputs,
        outputs={
            "Y": layer_norm_out,
            "Mean": mean_out,
            "Variance": variance_out,
        },
        attrs={"epsilon": epsilon,
               "begin_norm_axis": begin_norm_axis})

    return helper.append_activation(layer_norm_out)


D
Dun 已提交
3519 3520 3521 3522 3523 3524 3525 3526 3527 3528
@templatedoc()
def group_norm(input,
               groups,
               epsilon=1e-05,
               param_attr=None,
               bias_attr=None,
               act=None,
               data_layout='NCHW',
               name=None):
    """
3529 3530
    :api_attr: Static Graph

D
Dun 已提交
3531 3532
    **Group Normalization Layer**

H
haowang101779990 已提交
3533
    Refer to `Group Normalization <https://arxiv.org/abs/1803.08494>`_ .
D
Dun 已提交
3534

3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548
    Parameters:
        input(Variable): 4-D Tensor, the data type is float32 or float64.
        groups(int): The number of groups that divided from channels, the data type
            is int32.
        epsilon(float, optional): The small value added to the variance to prevent
            division by zero, the data type is float32. Default: 1e-05.
        param_attr(ParamAttr|bool, optional): ParamAttr object that specifies weight parameter
            attribute. If a bool type, only False is supported, which means there is no weight parameter.
            Default: None, the default weight parameter attribute is used. For more information, please
            refer to :ref:`api_guide_ParamAttr` .
        bias_attr(ParamAttr|bool, optional): ParamAttr object that specifies bias parameter
            attribute. If a bool type, only False is supported, which means there is no bias parameter.
            Default: None, the default bias parameter attribute is used. For more information, please
            refer to :ref:`api_guide_ParamAttr` .
T
tianshuo78520a 已提交
3549
        act(str, optional): Activation to be applied to the output of group normalization.
3550
        data_layout(str, optional): Specify the data format of the input, and the data format of the output
3551 3552 3553
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_height, input_width]`.
3554 3555
        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` .
D
Dun 已提交
3556 3557

    Returns:
3558 3559 3560 3561
        Variable: A 4-D Tensor has same data type and data format with `input`.

    Raises:
        ValueError: If `data_layout` is neither 'NCHW' nor 'NHWC'.
3562 3563 3564 3565 3566 3567
        ValueError: If `groups` is greater than the number of input channels.
        ValueError: If `groups` is less than 1.
        ShapeError: If the param_attr(Scale) is not 1-D Tensor.
        ShapeError: If the param_attr(Scale)'s first dimension size is not equal to the input channels.
        ShapeError: If the bias_attr(Bias) is not 1-D Tensor.
        ShapeError: If the bias_attr(Bias)'s first dimension size is not equal to the input channels.
D
Dun 已提交
3568 3569

    Examples:
3570
       .. code-block:: python
D
Dun 已提交
3571

3572 3573 3574
            import paddle.fluid as fluid
            data = fluid.data(name='data', shape=[None, 8, 32, 32], dtype='float32')
            x = fluid.layers.group_norm(input=data, groups=4)
D
Dun 已提交
3575 3576 3577
    """
    helper = LayerHelper('group_norm', **locals())
    dtype = helper.input_dtype()
3578 3579
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'group_norm')
D
Dun 已提交
3580 3581 3582
    # create intput and parameters
    inputs = {'X': input}
    input_shape = input.shape
3583 3584 3585 3586 3587 3588
    if data_layout != 'NCHW' and data_layout != 'NHWC':
        raise ValueError(
            "Param(data_layout) of Op(fluid.layers.group_norm) got wrong value: received "
            + data_layout + " but only NCHW or NHWC supported.")
    channel_num = input_shape[1] if data_layout == 'NCHW' else input_shape[-1]
    param_shape = [channel_num]
D
Dun 已提交
3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601
    if param_attr:
        scale = helper.create_parameter(
            attr=helper.param_attr,
            shape=param_shape,
            dtype=dtype,
            default_initializer=Constant(1.0))
        inputs['Scale'] = scale
    if bias_attr:
        bias = helper.create_parameter(
            attr=helper.bias_attr, shape=param_shape, dtype=dtype, is_bias=True)
        inputs['Bias'] = bias

    # create output
H
heqiaozhi 已提交
3602 3603
    mean_out = helper.create_variable(dtype=dtype, stop_gradient=True)
    variance_out = helper.create_variable(dtype=dtype, stop_gradient=True)
D
dengkaipeng 已提交
3604 3605 3606 3607 3608 3609 3610 3611 3612 3613
    group_norm_out = helper.create_variable(dtype=dtype)

    helper.append_op(
        type="group_norm",
        inputs=inputs,
        outputs={
            "Y": group_norm_out,
            "Mean": mean_out,
            "Variance": variance_out,
        },
3614 3615 3616 3617 3618
        attrs={
            "epsilon": epsilon,
            "groups": groups,
            "data_layout": data_layout
        })
D
dengkaipeng 已提交
3619 3620 3621 3622 3623

    return helper.append_activation(group_norm_out)


@templatedoc()
3624
def spectral_norm(weight, dim=0, power_iters=1, eps=1e-12, name=None):
D
dengkaipeng 已提交
3625
    """
3626 3627
    :api_attr: Static Graph

D
dengkaipeng 已提交
3628 3629
    **Spectral Normalization Layer**

K
Kaipeng Deng 已提交
3630
    This operation calculates the spectral normalization value of weight parameters of
3631
    fc, conv1d, conv2d, conv3d layers which should be 2-D, 3-D, 4-D, 5-D
K
Kaipeng Deng 已提交
3632 3633
    Parameters. Output tensor will be in same shape with input tensor.
    Calculations are showed as follows.
3634

D
dengkaipeng 已提交
3635 3636 3637
    Step 1:
    Generate vector U in shape of [H], and V in shape of [W].
    While H is the :attr:`dim` th dimension of the input weights,
D
dengkaipeng 已提交
3638
    and W is the product result of remaining dimensions.
D
dengkaipeng 已提交
3639 3640

    Step 2:
T
tianshuo78520a 已提交
3641
    :attr:`power_iters` should be a positive integer, do following
K
Kaipeng Deng 已提交
3642 3643
    calculations with U and V for :attr:`power_iters` rounds. Calculations
    as follows:
D
dengkaipeng 已提交
3644

3645
    .. math::
D
dengkaipeng 已提交
3646 3647 3648 3649 3650 3651

        \mathbf{v} := \\frac{\mathbf{W}^{T} \mathbf{u}}{\|\mathbf{W}^{T} \mathbf{u}\|_2}

        \mathbf{u} := \\frac{\mathbf{W}^{T} \mathbf{v}}{\|\mathbf{W}^{T} \mathbf{v}\|_2}

    Step 3:
D
dengkaipeng 已提交
3652
    Calculate :math:`\sigma(\mathbf{W})` and normalize weight values.
D
dengkaipeng 已提交
3653 3654 3655 3656

    .. math::

        \sigma(\mathbf{W}) = \mathbf{u}^{T} \mathbf{W} \mathbf{v}
3657

D
dengkaipeng 已提交
3658
        \mathbf{W} = \\frac{\mathbf{W}}{\sigma(\mathbf{W})}
3659

3660

D
dengkaipeng 已提交
3661 3662 3663 3664
    Refer to `Spectral Normalization <https://arxiv.org/abs/1802.05957>`_ .

    Args:
        weight(${weight_type}): ${weight_comment}
D
dengkaipeng 已提交
3665 3666 3667
        dim(int): ${dim_comment}
        power_iters(int): ${power_iters_comment}
        eps(float): ${eps_comment}
K
Kaipeng Deng 已提交
3668 3669 3670
        name(str, optional): For detailed information, please refer
                             to :ref:`api_guide_Name`. Usually name is no need to set and
                             None by default.
D
dengkaipeng 已提交
3671 3672

    Returns:
D
dengkaipeng 已提交
3673
        Variable: A tensor variable of weight parameters after spectral normalization.
K
Kaipeng Deng 已提交
3674
                  The data type and shape is same as input tensor.
D
dengkaipeng 已提交
3675 3676

    Examples:
K
Kaipeng Deng 已提交
3677
       .. code-block:: python
D
dengkaipeng 已提交
3678

K
Kaipeng Deng 已提交
3679 3680
            import paddle.fluid as fluid

K
Kaipeng Deng 已提交
3681
            weight = fluid.data(name='weight', shape=[2, 8, 32, 32], dtype='float32')
K
Kaipeng Deng 已提交
3682
            x = fluid.layers.spectral_norm(weight=weight, dim=1, power_iters=2)
D
dengkaipeng 已提交
3683 3684
    """
    helper = LayerHelper('spectral_norm', **locals())
3685 3686 3687 3688 3689
    check_variable_and_dtype(weight, 'weight', ['float32', 'float64'],
                             'spectral_norm')
    check_type(dim, 'dim', int, 'spectral_norm')
    check_type(power_iters, 'power_iters', int, 'spectral_norm')
    check_type(eps, 'eps', float, 'spectral_norm')
3690
    dtype = weight.dtype
D
dengkaipeng 已提交
3691 3692 3693

    # create intput and parameters
    inputs = {'Weight': weight}
3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711
    input_shape = weight.shape
    h = input_shape[dim]
    w = np.prod(input_shape) // h

    u = helper.create_parameter(
        attr=ParamAttr(),
        shape=[h],
        dtype=dtype,
        default_initializer=Normal(0., 1.))
    u.stop_gradient = True
    inputs['U'] = u
    v = helper.create_parameter(
        attr=ParamAttr(),
        shape=[w],
        dtype=dtype,
        default_initializer=Normal(0., 1.))
    inputs['V'] = v
    v.stop_gradient = True
D
dengkaipeng 已提交
3712 3713

    # create output
3714
    out = helper.create_variable(dtype=dtype)
D
Dun 已提交
3715 3716

    helper.append_op(
3717
        type="spectral_norm",
D
Dun 已提交
3718
        inputs=inputs,
3719 3720 3721 3722 3723 3724
        outputs={"Out": out, },
        attrs={
            "dim": dim,
            "power_iters": power_iters,
            "eps": eps,
        })
D
Dun 已提交
3725

3726
    return out
D
Dun 已提交
3727 3728


Y
Yu Yang 已提交
3729 3730 3731 3732
def conv2d_transpose(input,
                     num_filters,
                     output_size=None,
                     filter_size=None,
C
chengduoZH 已提交
3733 3734 3735
                     padding=0,
                     stride=1,
                     dilation=1,
3736
                     groups=None,
C
caoying03 已提交
3737
                     param_attr=None,
3738
                     bias_attr=None,
C
chengduoZH 已提交
3739
                     use_cudnn=True,
3740
                     act=None,
3741 3742
                     name=None,
                     data_format='NCHW'):
Y
Yu Yang 已提交
3743
    """
3744 3745
    :api_attr: Static Graph

3746 3747
    The convolution2D transpose layer calculates the output based on the input,
    filter, and dilations, strides, paddings. Input(Input) and output(Output)
3748
    are in NCHW or NHWC format. Where N is batch size, C is the number of channels,
3749 3750 3751
    H is the height of the feature, and W is the width of the feature.
    Parameters(dilations, strides, paddings) are two elements. These two elements
    represent height and width, respectively. The details of convolution transpose
3752
    layer, please refer to the following explanation and references
L
lvmengsi 已提交
3753
    `therein <https://arxiv.org/pdf/1603.07285.pdf>`_.
3754 3755 3756
    If bias attribution and activation type are provided, bias is added to
    the output of the convolution, and the corresponding activation function
    is applied to the final result.
3757 3758 3759 3760 3761

    For each input :math:`X`, the equation is:

    .. math::

3762
        Out = \sigma (W \\ast X + b)
3763

3764
    Where:
3765

3766 3767
    * :math:`X`: Input value, a 4-D Tensor with NCHW or NHWC format.
    * :math:`W`: Filter value, a 4-D Tensor with MCHW format.
3768
    * :math:`\\ast`: Convolution operation.
3769
    * :math:`b`: Bias value, a 2-D Tensor with shape [M, 1].
3770
    * :math:`\\sigma`: Activation function.
3771
    * :math:`Out`: Output value, a 4-D Tensor with data format 'NCHW' or 'NHWC', the shape of :math:`Out` and :math:`X` may be different.
Y
Yu Yang 已提交
3772

3773 3774 3775 3776
    Example:

        - Input:

3777
          Input shape: :math:`(N, C_{in}, H_{in}, W_{in})`
3778

3779
          Filter shape: :math:`(C_{in}, C_{out}, H_f, W_f)`
3780 3781 3782

        - Output:

3783
          Output shape: :math:`(N, C_{out}, H_{out}, W_{out})`
3784 3785

        Where
Y
Yu Yang 已提交
3786

3787 3788
        .. math::

3789 3790
           H^\prime_{out} &= (H_{in} - 1) * strides[0] - pad_height_top - pad_height_bottom + dilations[0] * (H_f - 1) + 1 \\\\
           W^\prime_{out} &= (W_{in} - 1) * strides[1] - pad_width_left - pad_width_right + dilations[1] * (W_f - 1) + 1 \\\\
L
lvmengsi 已提交
3791
           H_{out} &\in [ H^\prime_{out}, H^\prime_{out} + strides[0] ] \\\\
3792 3793
           W_{out} &\in [ W^\prime_{out}, W^\prime_{out} + strides[1] ]

L
lvmengsi 已提交
3794
    Note:
3795 3796
          The conv2d_transpose can be seen as the backward of the conv2d. For conv2d,
          when stride > 1, conv2d maps multiple input shape to the same output shape,
L
lvmengsi 已提交
3797
          so for conv2d_transpose, when stride > 1, input shape maps multiple output shape.
3798 3799 3800 3801
          If output_size is None, :math:`H_{out} = H^\prime_{out}, W_{out} = W^\prime_{out}`;
          else, the :math:`H_{out}` of the output size must between :math:`H^\prime_{out}`
          and :math:`H^\prime_{out} + strides[0]`, and the :math:`W_{out}` of the output size must
          between :math:`W^\prime_{out}` and :math:`W^\prime_{out} + strides[1]`,
L
lvmengsi 已提交
3802
          conv2d_transpose can compute the kernel size automatically.
Y
Yu Yang 已提交
3803 3804

    Args:
3805 3806
        input(Variable): 4-D Tensor with [N, C, H, W] or [N, H, W, C] format,
                         its data type is float32 or float64.
3807 3808
        num_filters(int): The number of the filter. It is as same as the output
            image channel.
3809
        output_size(int|tuple, optional): The output image size. If output size is a
3810
            tuple, it must contain two integers, (image_height, image_width). None if use
3811
            filter_size, padding, and stride to calculate output_size.
L
lvmengsi 已提交
3812
            If output_size and filter_size are specified at the same time, They
3813
            should follow the formula above. Default: None. output_size and filter_size
L
lvmengsi 已提交
3814
            should not be None at the same time.
3815
        filter_size(int|tuple, optional): The filter size. If filter_size is a tuple,
3816
            it must contain two integers, (filter_size_height, filter_size_width).
3817 3818
            Otherwise, filter_size_height = filter_size_width = filter_size. None if
            use output size to calculate filter_size. Default: None. filter_size and
L
lvmengsi 已提交
3819
            output_size should not be None at the same time.
3820 3821
        stride(int|tuple, optional): The stride size. It means the stride in transposed convolution.
            If stride is a tuple, it must contain two integers, (stride_height, stride_width).
L
lvmengsi 已提交
3822 3823 3824
            Otherwise, stride_height = stride_width = stride. Default: stride = 1.
        padding(int|list|str|tuple, optional): The padding size. The padding argument effectively adds
             `dilation * (kernel - 1)` amount of zero-padding on both sides of input. If `padding` is a
3825 3826 3827 3828 3829 3830 3831 3832 3833
             string, either 'VALID' or 'SAME' supported, which is the padding algorithm.
             If `padding` is a tuple or list, it could be in three forms:
             `[pad_height, pad_width]` or
            `[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]`, and
            when `data_format` is `'NCHW'`,
            `padding` can be in the form `[[0,0], [0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]`.
            when `data_format` is `'NHWC'`, `padding` can be in the form
            `[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]`.
            Default: padding = 0.
3834 3835
        dilation(int|tuple, optional): The dilation size. It means the spacing between the kernel points.
            If dilation is a tuple, it must contain two integers, (dilation_height, dilation_width).
L
lvmengsi 已提交
3836 3837 3838
            Otherwise, dilation_height = dilation_width = dilation. Default: dilation = 1.
        filter_size(int|tuple, optional): The filter size. If filter_size is a tuple,
            it must contain two integers, (filter_size_height, filter_size_width).
3839
            Otherwise, filter_size_height = filter_size_width = filter_size. None if
L
lvmengsi 已提交
3840
            use output size to calculate filter_size. Default: None.
3841
        groups(int, optional): The groups number of the Conv2d transpose layer. Inspired by
3842 3843 3844 3845
            grouped convolution in Alex Krizhevsky's Deep CNN paper, in which
            when group=2, the first half of the filters is only connected to the
            first half of the input channels, while the second half of the
            filters is only connected to the second half of the input channels.
C
chengduo 已提交
3846
            Default: groups = 1.
3847
        param_attr (ParamAttr, optional): The parameter attribute for learnable parameters/weights
C
chengduo 已提交
3848 3849 3850
            of conv2d_transpose. If it is set to None or one attribute of ParamAttr, conv2d_transpose
            will create ParamAttr as param_attr. If the Initializer of the param_attr
            is not set, the parameter is initialized with Xavier. Default: None.
3851
        bias_attr (ParamAttr|bool, optional): The parameter attribute for the bias of conv2d_transpose.
C
chengduo 已提交
3852 3853 3854 3855
            If it is set to False, no bias will be added to the output units.
            If it is set to None or one attribute of ParamAttr, conv2d_transpose
            will create ParamAttr as bias_attr. If the Initializer of the bias_attr
            is not set, the bias is initialized zero. Default: None.
3856
        use_cudnn(bool, optional): Use cudnn kernel or not, it is valid only when the cudnn
C
chengduo 已提交
3857
            library is installed. Default: True.
3858
        act (str, optional): Activation type, if it is set to None, activation is not appended.
C
chengduo 已提交
3859
            Default: None.
3860 3861
        name(str, optional): For detailed information, please refer
           to :ref:`api_guide_Name`. Usually name is no need to set and
L
lvmengsi 已提交
3862
           None by default.
3863
        data_format (str, optional): Specify the data format of the input, and the data format of the output
3864 3865 3866
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_height, input_width]`.
Y
Yu Yang 已提交
3867 3868

    Returns:
3869 3870 3871 3872 3873
        A Variable holding Tensor representing the conv2d_transpose, whose
        data type is the same with input and shape is (num_batches, channels, out_h,
        out_w) or (num_batches, out_h, out_w, channels). If act is None, the tensor variable
        storing the transposed convolution result, and if act is not None, the
        tensor variable storing transposed convolution and non-linearity activation
L
lvmengsi 已提交
3874
        result.
3875 3876

    Raises:
3877 3878 3879
        ValueError: If the type of `use_cudnn` is not bool.
        ValueError: If `data_format` is not "NCHW" or "NHWC".
        ValueError: If `padding` is a string, but not "SAME" or "VALID".
3880
        ValueError: If `padding` is a tuple, but the element corresponding to the input's batch size is not 0
3881 3882 3883 3884 3885 3886 3887
            or the element corresponding to the input's channel is not 0.
        ValueError: If `output_size` and filter_size are None at the same time.
        ShapeError: If the input is not 4-D Tensor.
        ShapeError: If the input's dimension size and filter's dimension size not equal.
        ShapeError: If the dimension size of input minus the size of `stride` is not 2.
        ShapeError: If the number of input channels is not equal to filter's channels.
        ShapeError: If the size of `output_size` is not equal to that of `stride`.
3888 3889 3890 3891

    Examples:
       .. code-block:: python

3892
          import paddle.fluid as fluid
L
lvmengsi 已提交
3893
          data = fluid.data(name='data', shape=[None, 3, 32, 32], dtype='float32')
3894
          conv2d_transpose = fluid.layers.conv2d_transpose(input=data, num_filters=2, filter_size=3)
Y
Yu Yang 已提交
3895
    """
C
chengduo 已提交
3896
    assert param_attr is not False, "param_attr should not be False in conv2d_transpose."
3897 3898 3899 3900
    if data_format not in ['NCHW', 'NHWC']:
        raise ValueError(
            "Attr(data_format) of Op(fluid.layers.conv2d_transpose) got wrong value: received "
            + data_format + " but only NCHW or NHWC supported.")
3901

3902
    input_channel = input.shape[1] if data_format == 'NCHW' else input.shape[-1]
3903 3904 3905 3906 3907 3908
    op_type = 'conv2d_transpose'
    if (input_channel == groups and num_filters == input_channel and
            not use_cudnn):
        op_type = 'depthwise_conv2d_transpose'

    helper = LayerHelper(op_type, **locals())
Y
Yu Yang 已提交
3909 3910 3911
    if not isinstance(input, Variable):
        raise TypeError("Input of conv2d_transpose must be Variable")

C
chengduoZH 已提交
3912 3913
    stride = utils.convert_to_list(stride, 2, 'stride')
    dilation = utils.convert_to_list(dilation, 2, 'dilation')
G
guosheng 已提交
3914

C
chengduoZH 已提交
3915 3916
    if not isinstance(use_cudnn, bool):
        raise ValueError("use_cudnn should be True or False")
G
guosheng 已提交
3917

3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960
    def _update_padding(padding, data_format):
        def is_list_or_tuple(ele):
            if isinstance(ele, list) or isinstance(ele, tuple):
                return True
            return False

        if is_list_or_tuple(padding) and len(padding) == 4:
            if is_list_or_tuple(padding[0]) and (data_format == "NCHW"):
                if not (padding[0] == [0, 0] and padding[1] == [0, 0]):
                    raise ValueError(
                        "Non-zero padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[2:4]
                padding = [ele for a_list in padding for ele in a_list]
            elif is_list_or_tuple(padding[0]) and (data_format == "NHWC"):
                if not (padding[0] == [0, 0] and padding[3] == [0, 0]):
                    raise ValueError(
                        "Non-zero padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[1:3]
                padding = [ele for a_list in padding for ele in a_list]
            padding = utils.convert_to_list(padding, 4, 'padding')
        else:
            padding = utils.convert_to_list(padding, 2, 'padding')
            padding = [padding[0], padding[0], padding[1], padding[1]]
        return padding

    padding_algorithm = "EXPLICIT"
    if isinstance(padding, str):
        padding = padding.upper()
        if padding not in ["SAME", "VALID"]:
            raise ValueError(
                "Unknown padding: '%s'. It can only be 'SAME' or 'VALID'." %
                str(padding))
        if padding == "VALID":
            padding_algorithm = "VALID"
            padding = [0, 0, 0, 0]
        elif padding == "SAME":
            padding_algorithm = "SAME"
            padding = [0, 0, 0, 0]

    padding = _update_padding(padding, data_format)

Y
Yu Yang 已提交
3961 3962 3963 3964 3965
    if filter_size is None:
        if output_size is None:
            raise ValueError("output_size must be set when filter_size is None")
        if isinstance(output_size, int):
            output_size = [output_size, output_size]
G
guosheng 已提交
3966

3967 3968
        h_in = input.shape[2] if data_format == 'NCHW' else input.shape[1]
        w_in = input.shape[3] if data_format == 'NCHW' else input.shape[2]
G
guosheng 已提交
3969

3970 3971 3972 3973
        filter_size_h = (output_size[0] - (h_in - 1) * stride[0] + padding[0] +
                         padding[1] - 1) // dilation[0] + 1
        filter_size_w = (output_size[1] - (w_in - 1) * stride[1] + padding[2] +
                         padding[3] - 1) // dilation[1] + 1
Y
Yu Yang 已提交
3974
        filter_size = [filter_size_h, filter_size_w]
C
chengduoZH 已提交
3975 3976 3977
    else:
        filter_size = utils.convert_to_list(filter_size, 2,
                                            'conv2d_transpose.filter_size')
C
chengduo 已提交
3978

3979 3980 3981
    if len(padding) == 4 and utils._is_symmetric_padding(padding, 2):
        padding = [padding[0], padding[2]]

3982 3983
    if output_size is None:
        output_size = []
3984
    elif isinstance(output_size, (list, tuple, int)):
3985 3986
        output_size = utils.convert_to_list(output_size, 2, 'output_size')
    else:
3987
        raise ValueError("output_size should be int, list[int] or tuple[int]")
3988
    groups = 1 if groups is None else groups
M
minqiyang 已提交
3989
    filter_shape = [input_channel, num_filters // groups] + filter_size
C
chengduo 已提交
3990

Y
Yu Yang 已提交
3991 3992 3993
    img_filter = helper.create_parameter(
        dtype=input.dtype, shape=filter_shape, attr=helper.param_attr)

X
Xin Pan 已提交
3994
    pre_bias = helper.create_variable_for_type_inference(dtype=input.dtype)
Y
Yu Yang 已提交
3995
    helper.append_op(
3996
        type=op_type,
Y
Yu Yang 已提交
3997 3998
        inputs={'Input': [input],
                'Filter': [img_filter]},
3999
        outputs={'Output': pre_bias},
C
chengduoZH 已提交
4000
        attrs={
4001
            'output_size': output_size,
4002 4003
            'strides': stride,
            'paddings': padding,
4004
            'padding_algorithm': padding_algorithm,
4005 4006
            'dilations': dilation,
            'groups': groups,
4007 4008
            'use_cudnn': use_cudnn,
            'data_format': data_format
Y
Yu Yang 已提交
4009 4010
        })

4011 4012 4013 4014
    if data_format == 'NCHW':
        pre_act = helper.append_bias_op(pre_bias, dim_start=1, dim_end=2)
    else:
        pre_act = helper.append_bias_op(pre_bias, dim_start=3, dim_end=4)
4015 4016
    out = helper.append_activation(pre_act)
    return out
Y
Yu Yang 已提交
4017 4018


4019
def conv3d_transpose(input,
Y
Yu Yang 已提交
4020 4021 4022
                     num_filters,
                     output_size=None,
                     filter_size=None,
C
chengduoZH 已提交
4023 4024 4025
                     padding=0,
                     stride=1,
                     dilation=1,
4026
                     groups=None,
C
caoying03 已提交
4027
                     param_attr=None,
4028
                     bias_attr=None,
C
chengduoZH 已提交
4029
                     use_cudnn=True,
4030
                     act=None,
4031 4032
                     name=None,
                     data_format='NCDHW'):
Y
Yu Yang 已提交
4033
    """
4034 4035
    :api_attr: Static Graph

4036
    The convolution3D transpose layer calculates the output based on the input,
4037
    filter, and dilations, strides, paddings. Input(Input) and output(Output)
4038
    are in NCDHW or NDHWC format. Where N is batch size, C is the number of channels,
4039 4040 4041 4042
    D is the depth of the feature, H is the height of the feature, and W
    is the width of the feature. Parameters(dilations, strides, paddings) are
    two elements. These two elements represent height and width, respectively.
    The details of convolution transpose layer, please refer to the following
L
lvmengsi 已提交
4043
    explanation and references `therein <https://arxiv.org/pdf/1603.07285.pdf>`_.
4044 4045 4046
    If bias attribution and activation type are provided, bias is added to
    the output of the convolution, and the corresponding activation function
    is applied to the final result.
4047 4048 4049 4050 4051

    For each input :math:`X`, the equation is:

    .. math::

4052
        Out = \sigma (W \\ast X + b)
4053 4054 4055

    In the above equation:

4056 4057
    * :math:`X`: Input value, a Tensor with NCDHW or NDHWC format.
    * :math:`W`: Filter value, a Tensor with MCDHW format.
4058
    * :math:`\\ast`: Convolution operation.
4059
    * :math:`b`: Bias value, a 2-D Tensor with shape [M, 1].
4060 4061
    * :math:`\\sigma`: Activation function.
    * :math:`Out`: Output value, the shape of :math:`Out` and :math:`X` may be different.
Y
Yu Yang 已提交
4062

4063 4064 4065 4066
    Example:

        - Input:

4067
          Input shape: :math:`(N, C_{in}, D_{in}, H_{in}, W_{in})`
4068

4069
          Filter shape: :math:`(C_{in}, C_{out}, D_f, H_f, W_f)`
4070 4071 4072

        - Output:

4073
          Output shape: :math:`(N, C_{out}, D_{out}, H_{out}, W_{out})`
4074 4075

        Where
Y
Yu Yang 已提交
4076

4077 4078
        .. math::

L
lvmengsi 已提交
4079 4080 4081 4082 4083 4084
           D^\prime_{out} &= (D_{in} - 1) * strides[0] - 2 * paddings[0] + dilations[0] * (D_f - 1) + 1 \\\\
           H^\prime_{out} &= (H_{in} - 1) * strides[1] - 2 * paddings[1] + dilations[1] * (H_f - 1) + 1 \\\\
           W^\prime_{out} &= (W_{in} - 1) * strides[2] - 2 * paddings[2] + dilations[2] * (W_f - 1) + 1 \\\\
           D_{out} &\in [ D^\prime_{out}, D^\prime_{out} + strides[0] ] \\\\
           H_{out} &\in [ H^\prime_{out}, H^\prime_{out} + strides[1] ] \\\\
           W_{out} &\in [ W^\prime_{out}, W^\prime_{out} + strides[2] ]
Y
Yu Yang 已提交
4085

L
lvmengsi 已提交
4086
    Note:
4087 4088
          The conv3d_transpose can be seen as the backward of the conv3d. For conv3d,
          when stride > 1, conv3d maps multiple input shape to the same output shape,
L
lvmengsi 已提交
4089 4090
          so for conv3d_transpose, when stride > 1, input shape maps multiple output shape.
          If output_size is None, :math:`H_{out} = H^\prime_{out}, :math:`H_{out} = \
4091 4092 4093 4094 4095
          H^\prime_{out}, W_{out} = W^\prime_{out}`; else, the :math:`D_{out}` of the output
          size must between :math:`D^\prime_{out}` and :math:`D^\prime_{out} + strides[0]`,
          the :math:`H_{out}` of the output size must between :math:`H^\prime_{out}`
          and :math:`H^\prime_{out} + strides[1]`, and the :math:`W_{out}` of the output size must
          between :math:`W^\prime_{out}` and :math:`W^\prime_{out} + strides[2]`,
L
lvmengsi 已提交
4096 4097 4098
          conv3d_transpose can compute the kernel size automatically.

    Args:
4099
        input(Variable): The input is 5-D Tensor with shape [N, C, D, H, W] or [N, D, H, W, C], the data type
L
lvmengsi 已提交
4100
            of input is float32 or float64.
4101 4102
        num_filters(int): The number of the filter. It is as same as the output
            image channel.
4103
        output_size(int|tuple, optional): The output image size. If output size is a
L
lvmengsi 已提交
4104
            tuple, it must contain three integers, (image_depth, image_height, image_width). This
4105 4106
            parameter only works when filter_size is None. If output_size and filter_size are
            specified at the same time, They should follow the formula above. Default: None.
L
lvmengsi 已提交
4107
            Output_size and filter_size should not be None at the same time.
4108
        filter_size(int|tuple, optional): The filter size. If filter_size is a tuple,
L
lvmengsi 已提交
4109
            it must contain three integers, (filter_size_depth, filter_size_height,
4110 4111
            filter_size_width). Otherwise, filter_size_depth = filter_size_height = \
            filter_size_width = filter_size. None if use output size to
4112
            calculate filter_size. Default: None. filter_size and output_size should not be
L
lvmengsi 已提交
4113 4114 4115
            None at the same time.
        padding(int|list|str|tuple, optional): The padding size. The padding argument effectively
             adds `dilation * (kernel - 1)` amount of zero-padding on both sides of input. If `padding` is a string,
4116 4117 4118 4119 4120 4121 4122 4123
             either 'VALID' or 'SAME' supported, which is the padding algorithm. If `padding`
             is a tuple or list, it could be in three forms: `[pad_depth, pad_height, pad_width]` or
            `[pad_depth_front, pad_depth_back, pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]`,
            and when `data_format` is `'NCDHW'`, `padding` can be in the form
            `[[0,0], [0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]`.
            when `data_format` is `'NDHWC'`, `padding` can be in the form
            `[[0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]`.
            Default: padding = 0.
4124 4125 4126
        stride(int|tuple, optional): The stride size. It means the stride in transposed convolution.
            If stride is a tuple, it must contain three integers, (stride_depth, stride_height,
            stride_width). Otherwise, stride_depth = stride_height = stride_width = stride.
L
lvmengsi 已提交
4127
            Default: stride = 1.
4128 4129 4130
        dilation(int|tuple, optional): The dilation size. It means the spacing between the kernel points.
            If dilation is a tuple, it must contain three integers, (dilation_depth, dilation_height,
            dilation_width). Otherwise, dilation_depth = dilation_height = dilation_width = dilation.
L
lvmengsi 已提交
4131
            Default: dilation = 1.
4132
        groups(int, optional): The groups number of the Conv3d transpose layer. Inspired by
4133 4134 4135 4136 4137
            grouped convolution in Alex Krizhevsky's Deep CNN paper, in which
            when group=2, the first half of the filters is only connected to the
            first half of the input channels, while the second half of the
            filters is only connected to the second half of the input channels.
            Default: groups=1
4138
        param_attr (ParamAttr, optional): The parameter attribute for learnable parameters/weights
C
chengduo 已提交
4139 4140 4141
            of conv3d_transpose. If it is set to None or one attribute of ParamAttr, conv3d_transpose
            will create ParamAttr as param_attr. If the Initializer of the param_attr
            is not set, the parameter is initialized with Xavier. Default: None.
4142
        bias_attr (ParamAttr|bool, optional): The parameter attribute for the bias of conv3d_transpose.
C
chengduo 已提交
4143 4144 4145 4146
            If it is set to False, no bias will be added to the output units.
            If it is set to None or one attribute of ParamAttr, conv3d_transpose
            will create ParamAttr as bias_attr. If the Initializer of the bias_attr
            is not set, the bias is initialized zero. Default: None.
4147
        use_cudnn(bool, optional): Use cudnn kernel or not, it is valid only when the cudnn
4148
            library is installed. Default: True
4149
        act (str, optional): Activation type, if it is set to None, activation is not appended.
C
chengduo 已提交
4150
            Default: None.
4151 4152
        name(str, optional): For detailed information, please refer
           to :ref:`api_guide_Name`. Usually name is no need to set and
L
lvmengsi 已提交
4153
           None by default.
4154
        data_format (str, optional): Specify the data format of the input, and the data format of the output
4155 4156 4157
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_height, input_width]`.
Y
Yu Yang 已提交
4158 4159

    Returns:
4160 4161 4162 4163
        A Variable holding Tensor representing the conv3d_transpose, whose data
        type is the same with input and shape is (num_batches, channels, out_d, out_h,
        out_w) or (num_batches, out_d, out_h, out_w, channels). If act is None, the tensor
        variable storing the transposed convolution result, and if act is not None, the tensor
L
lvmengsi 已提交
4164
        variable storing transposed convolution and non-linearity activation result.
4165 4166

    Raises:
4167 4168 4169
        ValueError: If the type of `use_cudnn` is not bool.
        ValueError: If `data_format` is not "NCDHW" or "NDHWC".
        ValueError: If `padding` is a string, but not "SAME" or "VALID".
4170
        ValueError: If `padding` is a tuple, but the element corresponding to the input's batch size is not 0
4171 4172 4173 4174 4175 4176 4177
            or the element corresponding to the input's channel is not 0.
        ValueError: If `output_size` and filter_size are None at the same time.
        ShapeError: If the input is not 5-D Tensor.
        ShapeError: If the input's dimension size and filter's dimension size not equal.
        ShapeError: If the dimension size of input minus the size of `stride` is not 2.
        ShapeError: If the number of input channels is not equal to filter's channels.
        ShapeError: If the size of `output_size` is not equal to that of `stride`.
4178 4179 4180 4181

    Examples:
       .. code-block:: python

4182
          import paddle.fluid as fluid
L
lvmengsi 已提交
4183
          data = fluid.data(name='data', shape=[None, 3, 12, 32, 32], dtype='float32')
4184
          conv3d_transpose = fluid.layers.conv3d_transpose(input=data, num_filters=2, filter_size=3)
Y
Yu Yang 已提交
4185
    """
C
chengduo 已提交
4186
    assert param_attr is not False, "param_attr should not be False in conv3d_transpose."
4187 4188 4189 4190
    if data_format not in ['NCDHW', 'NDHWC']:
        raise ValueError(
            "Param(data_format) of Op(fluid.layers.conv3d_transpose) got wrong value: received "
            + data_format + " but only NCDHW or NDHWC supported.")
4191 4192
    l_type = "conv3d_transpose"
    helper = LayerHelper(l_type, **locals())
Y
Yu Yang 已提交
4193
    if not isinstance(input, Variable):
4194
        raise TypeError("Input of conv3d_transpose must be Variable")
4195 4196
    input_channel = input.shape[1] if data_format == 'NCDHW' else input.shape[
        -1]
Y
Yu Yang 已提交
4197

4198 4199
    stride = utils.convert_to_list(stride, 3, 'stride')
    dilation = utils.convert_to_list(dilation, 3, 'dilation')
C
chengduoZH 已提交
4200

C
chengduoZH 已提交
4201 4202 4203
    if not isinstance(use_cudnn, bool):
        raise ValueError("use_cudnn should be True or False")

4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217
    def _update_padding(padding, data_format):
        def is_list_or_tuple(ele):
            if isinstance(ele, list) or isinstance(ele, tuple):
                return True
            return False

        if is_list_or_tuple(padding) and len(padding) == 5:
            if is_list_or_tuple(padding[0]) and (data_format == "NCDHW"):
                if not (padding[0] == [0, 0] and padding[1] == [0, 0]):
                    raise ValueError(
                        "Non-zero padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[2:5]
                padding = [ele for a_list in padding for ele in a_list]
4218 4219 4220 4221 4222 4223 4224 4225
            elif is_list_or_tuple(padding[0]) and (data_format == "NDHWC"):
                if not (padding[0] == [0, 0] and padding[4] == [0, 0]):
                    raise ValueError(
                        "Non-zero padding(%s) in the batch or channel dimensions "
                        "is not supported." % str(padding))
                padding = padding[1:4]
                padding = [ele for a_list in padding for ele in a_list]
            padding = utils.convert_to_list(padding, 6, 'padding')
G
Guo Sheng 已提交
4226

4227 4228
        elif is_list_or_tuple(padding) and len(padding) == 6:
            padding = utils.convert_to_list(padding, 6, 'padding')
G
Guo Sheng 已提交
4229

4230 4231 4232 4233 4234 4235 4236
        else:
            padding = utils.convert_to_list(padding, 3, 'padding')
            padding = [
                padding[0], padding[0], padding[1], padding[1], padding[2],
                padding[2]
            ]
        return padding
G
Guo Sheng 已提交
4237

4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250
    padding_algorithm = "EXPLICIT"
    if isinstance(padding, str):
        padding = padding.upper()
        if padding not in ["SAME", "VALID"]:
            raise ValueError(
                "Unknown padding: '%s'. It can only be 'SAME' or 'VALID'." %
                str(padding))
        if padding == "VALID":
            padding_algorithm = "VALID"
            padding = [0, 0, 0, 0, 0, 0]
        elif padding == "SAME":
            padding_algorithm = "SAME"
            padding = [0, 0, 0, 0, 0, 0]
G
Guo Sheng 已提交
4251

4252
    padding = _update_padding(padding, data_format)
Y
yangyaming 已提交
4253

4254 4255 4256 4257
    if filter_size is None:
        if output_size is None:
            raise ValueError("output_size must be set when filter_size is None")
        if isinstance(output_size, int):
4258
            output_size = [output_size, output_size, output_size]
Y
yangyaming 已提交
4259

4260 4261 4262
        d_in = input.shape[2] if data_format == 'NCDHW' else input.shape[1]
        h_in = input.shape[3] if data_format == 'NCDHW' else input.shape[2]
        w_in = input.shape[4] if data_format == 'NCDHW' else input.shape[3]
Y
yangyaming 已提交
4263

4264 4265 4266 4267 4268 4269 4270 4271 4272 4273
        filter_size_d = (output_size[0] - (d_in - 1) * stride[0] + padding[0] +
                         padding[1] - 1) // dilation[0] + 1
        filter_size_h = (output_size[1] - (h_in - 1) * stride[1] + padding[2] +
                         padding[3] - 1) // dilation[1] + 1
        filter_size_w = (output_size[2] - (w_in - 1) * stride[2] + padding[4] +
                         padding[5] - 1) // dilation[2] + 1
        filter_size = [filter_size_d, filter_size_h, filter_size_w]
    else:
        filter_size = utils.convert_to_list(filter_size, 3,
                                            'conv3d_transpose.filter_size')
Y
yangyaming 已提交
4274

4275 4276
    if len(padding) == 6 and utils._is_symmetric_padding(padding, 3):
        padding = [padding[0], padding[2], padding[4]]
Y
yangyaming 已提交
4277

4278 4279 4280 4281 4282 4283 4284
    if output_size is None:
        output_size = []
    elif isinstance(output_size, (list, tuple, int)):
        output_size = utils.convert_to_list(output_size, 3, 'output_size')
    else:
        raise ValueError("output_size should be int, list[int] or tuple[int]")

4285 4286 4287 4288
    groups = 1 if groups is None else groups
    filter_shape = [input_channel, num_filters // groups] + filter_size
    img_filter = helper.create_parameter(
        dtype=input.dtype, shape=filter_shape, attr=helper.param_attr)
4289

4290 4291 4292 4293
    if data_format == 'NCDHW':
        data_format = 'NCHW'
    if data_format == 'NDHWC':
        data_format = 'NHWC'
Y
yangyaming 已提交
4294

4295
    pre_bias = helper.create_variable_for_type_inference(dtype=input.dtype)
Y
yangyaming 已提交
4296
    helper.append_op(
4297 4298 4299 4300 4301
        type=l_type,
        inputs={'Input': [input],
                'Filter': [img_filter]},
        outputs={'Output': pre_bias},
        attrs={
4302
            'output_size': output_size,
4303 4304 4305 4306 4307 4308 4309 4310
            'strides': stride,
            'paddings': padding,
            'padding_algorithm': padding_algorithm,
            'dilations': dilation,
            'groups': groups,
            'use_cudnn': use_cudnn,
            'data_format': data_format
        })
Y
yangyaming 已提交
4311

4312 4313 4314 4315 4316 4317
    if data_format == 'NCHW':
        pre_act = helper.append_bias_op(pre_bias, dim_start=1, dim_end=2)
    else:
        pre_act = helper.append_bias_op(pre_bias, dim_start=4, dim_end=5)
    out = helper.append_activation(pre_act)
    return out
G
guosheng 已提交
4318 4319


C
caoying03 已提交
4320
def reduce_sum(input, dim=None, keep_dim=False, name=None):
G
guosheng 已提交
4321
    """
4322 4323 4324 4325
    :alias_main: paddle.reduce_sum
	:alias: paddle.reduce_sum,paddle.tensor.reduce_sum,paddle.tensor.math.reduce_sum
	:old_api: paddle.fluid.layers.reduce_sum

Y
yangyaming 已提交
4326
    Computes the sum of tensor elements over the given dimension.
G
guosheng 已提交
4327 4328

    Args:
4329 4330 4331
        input (Variable): The input variable which is a Tensor, the data type is float32,
            float64, int32, int64.
        dim (list|int, optional): The dimensions along which the sum is performed. If
Y
yangyaming 已提交
4332 4333
            :attr:`None`, sum all elements of :attr:`input` and return a
            Tensor variable with a single element, otherwise must be in the
W
whs 已提交
4334 4335
            range :math:`[-rank(input), rank(input))`. If :math:`dim[i] < 0`,
            the dimension to reduce is :math:`rank + dim[i]`.
4336
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
Y
yangyaming 已提交
4337
            output Tensor. The result tensor will have one fewer dimension
4338 4339 4340 4341
            than the :attr:`input` unless :attr:`keep_dim` is true, default
            value is False.
        name(str, optional): The default value is None.  Normally there is no need for
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
G
guosheng 已提交
4342 4343

    Returns:
4344 4345
        Variable: Tensor, results of summation operation on the specified dim of input tensor,
        it's data type is the same as input's Tensor.
F
fengjiayi 已提交
4346

4347 4348
    Raises:
        TypeError, if out data type is different with the input data type.
4349

G
guosheng 已提交
4350 4351 4352
    Examples:
        .. code-block:: python

4353
            import paddle.fluid as fluid
G
guosheng 已提交
4354 4355 4356
            # x is a Tensor variable with following elements:
            #    [[0.2, 0.3, 0.5, 0.9]
            #     [0.1, 0.2, 0.6, 0.7]]
Q
qiaolongfei 已提交
4357
            # Each example is followed by the corresponding output tensor.
4358
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
G
guosheng 已提交
4359 4360 4361 4362
            fluid.layers.reduce_sum(x)  # [3.5]
            fluid.layers.reduce_sum(x, dim=0)  # [0.3, 0.5, 1.1, 1.6]
            fluid.layers.reduce_sum(x, dim=-1)  # [1.9, 1.6]
            fluid.layers.reduce_sum(x, dim=1, keep_dim=True)  # [[1.9], [1.6]]
W
whs 已提交
4363

4364
            # y is a Tensor variable with shape [2, 2, 2] and elements as below:
W
whs 已提交
4365 4366
            #      [[[1, 2], [3, 4]],
            #      [[5, 6], [7, 8]]]
Q
qiaolongfei 已提交
4367
            # Each example is followed by the corresponding output tensor.
4368
            y = fluid.data(name='y', shape=[2, 2, 2], dtype='float32')
4369 4370
            fluid.layers.reduce_sum(y, dim=[1, 2]) # [10, 26]
            fluid.layers.reduce_sum(y, dim=[0, 1]) # [16, 20]
W
whs 已提交
4371

G
guosheng 已提交
4372
    """
4373 4374
    if dim is not None and not isinstance(dim, list):
        dim = [dim]
4375 4376

    if in_dygraph_mode():
Q
Qinghe JING 已提交
4377 4378
        reduce_all = True if dim == None or dim == [] or len(dim) == len(
            input.shape) else False
4379 4380 4381
        dim = dim if dim != None and dim != [] else [0]
        return core.ops.reduce_sum(input, 'dim', dim, 'keep_dim', keep_dim,
                                   'reduce_all', reduce_all)
4382
    attrs = {
4383
        'dim': dim if dim != None and dim != [] else [0],
4384
        'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4385 4386
        'reduce_all': True
        if dim == None or dim == [] or len(dim) == len(input.shape) else False
4387
    }
4388 4389
    check_variable_and_dtype(
        input, 'input', ['float32', 'float64', 'int32', 'int64'], 'reduce_sum')
4390
    helper = LayerHelper('reduce_sum', **locals())
X
Xin Pan 已提交
4391
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
G
guosheng 已提交
4392 4393 4394 4395
    helper.append_op(
        type='reduce_sum',
        inputs={'X': input},
        outputs={'Out': out},
4396
        attrs=attrs)
G
guosheng 已提交
4397
    return out
G
guosheng 已提交
4398 4399


C
caoying03 已提交
4400
def reduce_mean(input, dim=None, keep_dim=False, name=None):
G
guosheng 已提交
4401
    """
4402 4403 4404 4405
    :alias_main: paddle.reduce_mean
	:alias: paddle.reduce_mean,paddle.tensor.reduce_mean,paddle.tensor.stat.reduce_mean
	:old_api: paddle.fluid.layers.reduce_mean

Y
Yibing Liu 已提交
4406
    Computes the mean of the input tensor's elements along the given dimension.
G
guosheng 已提交
4407 4408

    Args:
4409 4410 4411
        input (Variable): The input variable which is a Tensor, the data type is float32,
            float64, int32, int64.
        dim (list|int, optional): The dimension along which the mean is computed. If
Y
Yibing Liu 已提交
4412 4413
            `None`, compute the mean over all elements of :attr:`input`
            and return a variable with a single element, otherwise it
Y
yangyaming 已提交
4414
            must be in the range :math:`[-rank(input), rank(input))`. If
4415
            :math:`dim[i] < 0`, the dimension to reduce is
Y
Yibing Liu 已提交
4416
            :math:`rank(input) + dim[i]`.
4417
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
Y
yangyaming 已提交
4418
            output Tensor. The result tensor will have one fewer dimension
4419
            than the :attr:`input` unless :attr:`keep_dim` is true, default
4420 4421 4422
            value is False.
        name(str, optional): The default value is None.  Normally there is no need for
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
4423

G
guosheng 已提交
4424
    Returns:
4425 4426
        Variable: Tensor, results of average on the specified dim of input tensor,
        it's data type is the same as input's Tensor.
4427

4428 4429
    Raises:
        TypeError, if out data type is different with the input data type.
4430

G
guosheng 已提交
4431 4432 4433
    Examples:
        .. code-block:: python

4434
            import paddle.fluid as fluid
G
guosheng 已提交
4435 4436 4437
            # x is a Tensor variable with following elements:
            #    [[0.2, 0.3, 0.5, 0.9]
            #     [0.1, 0.2, 0.6, 0.7]]
T
tianshuo78520a 已提交
4438
            # Each example is followed by the corresponding output tensor.
4439
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
G
guosheng 已提交
4440 4441 4442
            fluid.layers.reduce_mean(x)  # [0.4375]
            fluid.layers.reduce_mean(x, dim=0)  # [0.15, 0.25, 0.55, 0.8]
            fluid.layers.reduce_mean(x, dim=-1)  # [0.475, 0.4]
4443
            fluid.layers.reduce_mean(x, dim=1, keep_dim=True)  # [[0.475], [0.4]]
W
whs 已提交
4444

4445
            # y is a Tensor variable with shape [2, 2, 2] and elements as below:
W
whs 已提交
4446 4447
            #      [[[1.0, 2.0], [3.0, 4.0]],
            #      [[5.0, 6.0], [7.0, 8.0]]]
T
tianshuo78520a 已提交
4448
            # Each example is followed by the corresponding output tensor.
4449
            y = fluid.data(name='y', shape=[2, 2, 2], dtype='float32')
4450 4451
            fluid.layers.reduce_mean(y, dim=[1, 2]) # [2.5, 6.5]
            fluid.layers.reduce_mean(y, dim=[0, 1]) # [4.0, 5.0]
G
guosheng 已提交
4452
    """
4453 4454 4455

    if dim is not None and not isinstance(dim, list):
        dim = [dim]
4456 4457

    if in_dygraph_mode():
Q
Qinghe JING 已提交
4458 4459
        reduce_all = True if dim == None or dim == [] or len(dim) == len(
            input.shape) else False
4460 4461 4462
        dim = dim if dim != None and dim != [] else [0]
        return core.ops.reduce_mean(input, 'dim', dim, 'keep_dim', keep_dim,
                                    'reduce_all', reduce_all)
4463
    attrs = {
4464
        'dim': dim if dim != None and dim != [] else [0],
4465
        'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4466 4467
        'reduce_all': True
        if dim == None or dim == [] or len(dim) == len(input.shape) else False
4468
    }
4469 4470
    check_variable_and_dtype(
        input, 'input', ['float32', 'float64', 'int32', 'int64'], 'reduce_mean')
4471
    helper = LayerHelper('reduce_mean', **locals())
X
Xin Pan 已提交
4472
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
G
guosheng 已提交
4473 4474 4475 4476
    helper.append_op(
        type='reduce_mean',
        inputs={'X': input},
        outputs={'Out': out},
4477
        attrs=attrs)
G
guosheng 已提交
4478
    return out
4479 4480


C
caoying03 已提交
4481
def reduce_max(input, dim=None, keep_dim=False, name=None):
4482
    """
4483 4484 4485 4486
    :alias_main: paddle.reduce_max
	:alias: paddle.reduce_max,paddle.tensor.reduce_max,paddle.tensor.math.reduce_max
	:old_api: paddle.fluid.layers.reduce_max

Y
yangyaming 已提交
4487
    Computes the maximum of tensor elements over the given dimension.
4488 4489

    Args:
4490 4491 4492
        input (Variable): The input variable which is a Tensor, the data type is float32,
            float64, int32, int64.
        dim (list|int, optional): The dimension along which the maximum is computed.
Y
yangyaming 已提交
4493 4494 4495
            If :attr:`None`, compute the maximum over all elements of
            :attr:`input` and return a Tensor variable with a single element,
            otherwise must be in the range :math:`[-rank(input), rank(input))`.
W
whs 已提交
4496
            If :math:`dim[i] < 0`, the dimension to reduce is :math:`rank + dim[i]`.
4497
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
Y
yangyaming 已提交
4498
            output Tensor. The result tensor will have one fewer dimension
4499 4500
            than the :attr:`input` unless :attr:`keep_dim` is true, default
            value is False.
4501
        name(str, optional): The default value is None.  Normally there is no need for
4502
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
4503 4504

    Returns:
4505 4506
        Variable: Tensor, results of maximum on the specified dim of input tensor,
        it's data type is the same as input's Tensor.
Y
yangyaming 已提交
4507

4508 4509 4510
    Examples:
        .. code-block:: python

4511
            import paddle.fluid as fluid
4512 4513 4514
            # x is a Tensor variable with following elements:
            #    [[0.2, 0.3, 0.5, 0.9]
            #     [0.1, 0.2, 0.6, 0.7]]
T
tianshuo78520a 已提交
4515
            # Each example is followed by the corresponding output tensor.
4516
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
4517 4518 4519 4520
            fluid.layers.reduce_max(x)  # [0.9]
            fluid.layers.reduce_max(x, dim=0)  # [0.2, 0.3, 0.6, 0.9]
            fluid.layers.reduce_max(x, dim=-1)  # [0.9, 0.7]
            fluid.layers.reduce_max(x, dim=1, keep_dim=True)  # [[0.9], [0.7]]
W
whs 已提交
4521

4522
            # y is a Tensor variable with shape [2, 2, 2] and elements as below:
W
whs 已提交
4523 4524
            #      [[[1.0, 2.0], [3.0, 4.0]],
            #      [[5.0, 6.0], [7.0, 8.0]]]
T
tianshuo78520a 已提交
4525
            # Each example is followed by the corresponding output tensor.
4526
            y = fluid.data(name='y', shape=[2, 2, 2], dtype='float32')
4527 4528
            fluid.layers.reduce_max(y, dim=[1, 2]) # [4.0, 8.0]
            fluid.layers.reduce_max(y, dim=[0, 1]) # [7.0, 8.0]
4529 4530
    """
    helper = LayerHelper('reduce_max', **locals())
X
Xin Pan 已提交
4531
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
W
whs 已提交
4532 4533
    if dim is not None and not isinstance(dim, list):
        dim = [dim]
4534 4535 4536 4537 4538
    helper.append_op(
        type='reduce_max',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={
4539
            'dim': dim if dim != None and dim != [] else [0],
4540
            'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4541 4542
            'reduce_all': True if dim == None or dim == [] or
            len(dim) == len(input.shape) else False
4543 4544 4545 4546
        })
    return out


C
caoying03 已提交
4547
def reduce_min(input, dim=None, keep_dim=False, name=None):
4548
    """
4549 4550 4551 4552
    :alias_main: paddle.reduce_min
	:alias: paddle.reduce_min,paddle.tensor.reduce_min,paddle.tensor.math.reduce_min
	:old_api: paddle.fluid.layers.reduce_min

Y
yangyaming 已提交
4553
    Computes the minimum of tensor elements over the given dimension.
4554 4555

    Args:
4556 4557 4558
        input (Variable): The input variable which is a Tensor, the data type is float32,
            float64, int32, int64.
        dim (list|int, optional): The dimensions along which the minimum is computed.
Y
yangyaming 已提交
4559 4560 4561
            If :attr:`None`, compute the minimum over all elements of
            :attr:`input` and return a Tensor variable with a single element,
            otherwise must be in the range :math:`[-rank(input), rank(input))`.
W
whs 已提交
4562
            If :math:`dim[i] < 0`, the dimension to reduce is :math:`rank + dim[i]`.
4563
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
Y
yangyaming 已提交
4564
            output Tensor. The result tensor will have one fewer dimension
4565 4566
            than the :attr:`input` unless :attr:`keep_dim` is true, default
            value is False.
4567
        name(str, optional): The default value is None.  Normally there is no need for
4568
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
4569 4570

    Returns:
4571 4572
        Variable: Tensor, result of minimum on the specified dim of input tensor,
        it's data type is the same as input's Tensor.
Y
yangyaming 已提交
4573

4574 4575 4576
    Examples:
        .. code-block:: python

4577
            import paddle.fluid as fluid
4578 4579 4580
            # x is a Tensor variable with following elements:
            #    [[0.2, 0.3, 0.5, 0.9]
            #     [0.1, 0.2, 0.6, 0.7]]
T
tianshuo78520a 已提交
4581
            # Each example is followed by the corresponding output tensor.
4582
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
4583 4584 4585 4586
            fluid.layers.reduce_min(x)  # [0.1]
            fluid.layers.reduce_min(x, dim=0)  # [0.1, 0.2, 0.5, 0.7]
            fluid.layers.reduce_min(x, dim=-1)  # [0.2, 0.1]
            fluid.layers.reduce_min(x, dim=1, keep_dim=True)  # [[0.2], [0.1]]
W
whs 已提交
4587

4588
            # y is a Tensor variable with shape [2, 2, 2] and elements as below:
W
whs 已提交
4589 4590
            #      [[[1.0, 2.0], [3.0, 4.0]],
            #      [[5.0, 6.0], [7.0, 8.0]]]
T
tianshuo78520a 已提交
4591
            # Each example is followed by the corresponding output tensor.
4592
            y = fluid.data(name='y', shape=[2, 2, 2], dtype='float32')
4593 4594
            fluid.layers.reduce_min(y, dim=[1, 2]) # [1.0, 5.0]
            fluid.layers.reduce_min(y, dim=[0, 1]) # [1.0, 2.0]
4595 4596
    """
    helper = LayerHelper('reduce_min', **locals())
X
Xin Pan 已提交
4597
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
W
whs 已提交
4598 4599
    if dim is not None and not isinstance(dim, list):
        dim = [dim]
4600 4601 4602 4603 4604
    helper.append_op(
        type='reduce_min',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={
4605
            'dim': dim if dim != None and dim != [] else [0],
4606
            'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4607 4608
            'reduce_all': True if dim == None or dim == [] or
            len(dim) == len(input.shape) else False
4609 4610
        })
    return out
G
guosheng 已提交
4611 4612


4613 4614
def reduce_prod(input, dim=None, keep_dim=False, name=None):
    """
4615 4616 4617 4618
    :alias_main: paddle.reduce_prod
	:alias: paddle.reduce_prod,paddle.tensor.reduce_prod,paddle.tensor.math.reduce_prod
	:old_api: paddle.fluid.layers.reduce_prod

4619 4620 4621
    Computes the product of tensor elements over the given dimension.

    Args:
4622 4623 4624
        input (Variable): The input variable which is a Tensor, the data type is float32,
            float64, int32, int64.
        dim (list|int, optional): The dimensions along which the product is performed. If
T
tianshuo78520a 已提交
4625
            :attr:`None`, multiply all elements of :attr:`input` and return a
4626
            Tensor variable with a single element, otherwise must be in the
W
whs 已提交
4627 4628
            range :math:`[-rank(input), rank(input))`. If :math:`dim[i] < 0`,
            the dimension to reduce is :math:`rank + dim[i]`.
4629
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
4630
            output Tensor. The result tensor will have one fewer dimension
4631 4632
            than the :attr:`input` unless :attr:`keep_dim` is true, default
            value is False.
4633
        name(str, optional): The default value is None.  Normally there is no need for
4634
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
4635 4636

    Returns:
4637 4638
        Variable: Tensor, result of product on the specified dim of input tensor,
        it's data type is the same as input's Tensor.
4639

4640 4641 4642
    Examples:
        .. code-block:: python

4643
            import paddle.fluid as fluid
4644 4645 4646
            # x is a Tensor variable with following elements:
            #    [[0.2, 0.3, 0.5, 0.9]
            #     [0.1, 0.2, 0.6, 0.7]]
T
tianshuo78520a 已提交
4647
            # Each example is followed by the corresponding output tensor.
4648
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
4649 4650 4651
            fluid.layers.reduce_prod(x)  # [0.0002268]
            fluid.layers.reduce_prod(x, dim=0)  # [0.02, 0.06, 0.3, 0.63]
            fluid.layers.reduce_prod(x, dim=-1)  # [0.027, 0.0084]
Y
yangyaming 已提交
4652
            fluid.layers.reduce_prod(x, dim=1,
Z
zhouhanqing 已提交
4653
                                     keep_dim=True)  # [[0.027], [0.0084]]
W
whs 已提交
4654

4655
            # y is a Tensor variable with shape [2, 2, 2] and elements as below:
W
whs 已提交
4656 4657
            #      [[[1.0, 2.0], [3.0, 4.0]],
            #      [[5.0, 6.0], [7.0, 8.0]]]
T
tianshuo78520a 已提交
4658
            # Each example is followed by the corresponding output tensor.
4659
            y = fluid.data(name='y', shape=[2, 2, 2], dtype='float32')
4660 4661
            fluid.layers.reduce_prod(y, dim=[1, 2]) # [24.0, 1680.0]
            fluid.layers.reduce_prod(y, dim=[0, 1]) # [105.0, 384.0]
4662 4663
    """
    helper = LayerHelper('reduce_prod', **locals())
X
Xin Pan 已提交
4664
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
W
whs 已提交
4665 4666
    if dim is not None and not isinstance(dim, list):
        dim = [dim]
4667 4668 4669 4670 4671
    helper.append_op(
        type='reduce_prod',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={
4672
            'dim': dim if dim != None and dim != [] else [0],
4673
            'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4674 4675
            'reduce_all': True if dim == None or dim == [] or
            len(dim) == len(input.shape) else False
4676 4677 4678 4679
        })
    return out


Z
zhoukunsheng 已提交
4680 4681
def reduce_all(input, dim=None, keep_dim=False, name=None):
    """
4682 4683 4684 4685
    :alias_main: paddle.reduce_all
	:alias: paddle.reduce_all,paddle.tensor.reduce_all,paddle.tensor.logic.reduce_all
	:old_api: paddle.fluid.layers.reduce_all

4686
    This OP computes the ``logical and`` of tensor elements over the given dimension, and output the result.
Z
zhoukunsheng 已提交
4687 4688

    Args:
4689 4690
        input (Variable): The input variable which is a Tensor or LoDTensor, the input data type should be `bool`.
        dim (list|int|optional): The dimension along which the logical and is computed.
Z
zhoukunsheng 已提交
4691 4692 4693
            If :attr:`None`, compute the logical and over all elements of
            :attr:`input` and return a Tensor variable with a single element,
            otherwise must be in the range :math:`[-rank(input), rank(input))`.
4694
            If :math:`dim[i] < 0`, the dimension to reduce is :math:`rank + dim[i]`. The default value is None.
Z
zhoukunsheng 已提交
4695 4696
        keep_dim (bool): Whether to reserve the reduced dimension in the
            output Tensor. The result tensor will have one fewer dimension
4697
            than the :attr:`input` unless :attr:`keep_dim` is true. The default value is False.
Z
zhoukunsheng 已提交
4698
        name(str|None): A name for this layer(optional). If set None, the layer
4699
                       will be named automatically. The default value is None.
Z
zhoukunsheng 已提交
4700

4701
    Returns:
4702
        Variable, the output data type is bool. : The reduced tensor variable with ``logical and`` in given dims.
Z
zhoukunsheng 已提交
4703 4704 4705

    Examples:
        .. code-block:: python
4706

4707
            import paddle.fluid as fluid
4708 4709 4710
            import paddle.fluid.layers as layers
            import numpy as np

Z
zhoukunsheng 已提交
4711 4712 4713
            # x is a bool Tensor variable with following elements:
            #    [[True, False]
            #     [True, True]]
4714 4715 4716
            x = layers.assign(np.array([[1, 0], [1, 1]], dtype='int32'))
            x = layers.cast(x, 'bool')

4717
            out = layers.reduce_all(x)  # False
4718 4719
            out = layers.reduce_all(x, dim=0)  # [True, False]
            out = layers.reduce_all(x, dim=-1)  # [False, True]
4720 4721
            # keep_dim=False, x.shape=(2,2), out.shape=(2,)

4722
            out = layers.reduce_all(x, dim=1, keep_dim=True)  # [[False], [True]]
4723
            # keep_dim=True, x.shape=(2,2), out.shape=(2,1)
Z
zhoukunsheng 已提交
4724 4725

    """
4726
    check_variable_and_dtype(input, 'input', ('bool'), 'reduce_all')
Z
zhoukunsheng 已提交
4727 4728 4729 4730 4731 4732 4733 4734 4735
    helper = LayerHelper('reduce_all', **locals())
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
    if dim is not None and not isinstance(dim, list):
        dim = [dim]
    helper.append_op(
        type='reduce_all',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={
4736
            'dim': dim if dim != None and dim != [] else [0],
Z
zhoukunsheng 已提交
4737
            'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4738 4739
            'reduce_all': True if dim == None or dim == [] or
            len(dim) == len(input.shape) else False
Z
zhoukunsheng 已提交
4740 4741 4742 4743 4744 4745
        })
    return out


def reduce_any(input, dim=None, keep_dim=False, name=None):
    """
4746 4747 4748 4749
    :alias_main: paddle.reduce_any
	:alias: paddle.reduce_any,paddle.tensor.reduce_any,paddle.tensor.logic.reduce_any
	:old_api: paddle.fluid.layers.reduce_any

4750
    This OP computes the ``logical or`` of tensor elements over the given dimension, and output the result.
Z
zhoukunsheng 已提交
4751 4752

    Args:
4753 4754 4755
        input (Variable): The input variable which is a Tensor or LoDTensor, the input data type should be `bool`.
        dim (list|int|optional): The dimension along which the logical and is computed.
            If :attr:`None`, compute the logical and over all elements of
Z
zhoukunsheng 已提交
4756 4757
            :attr:`input` and return a Tensor variable with a single element,
            otherwise must be in the range :math:`[-rank(input), rank(input))`.
4758
            If :math:`dim[i] < 0`, the dimension to reduce is :math:`rank + dim[i]`. The default value is None.
Z
zhoukunsheng 已提交
4759 4760
        keep_dim (bool): Whether to reserve the reduced dimension in the
            output Tensor. The result tensor will have one fewer dimension
4761
            than the :attr:`input` unless :attr:`keep_dim` is true. The default value is False.
Z
zhoukunsheng 已提交
4762 4763
        name(str|None): A name for this layer(optional). If set None, the layer

4764
    Returns:
4765
        Variable, the output data type is bool. : The reduced tensor variable with ``logical or`` in given dims.
Z
zhoukunsheng 已提交
4766 4767 4768

    Examples:
        .. code-block:: python
Z
zhoukunsheng 已提交
4769

4770
            import paddle.fluid as fluid
4771 4772 4773
            import paddle.fluid.layers as layers
            import numpy as np

Z
zhoukunsheng 已提交
4774 4775 4776
            # x is a bool Tensor variable with following elements:
            #    [[True, False]
            #     [False, False]]
4777 4778 4779 4780 4781 4782
            x = layers.assign(np.array([[1, 0], [0, 0]], dtype='int32'))
            x = layers.cast(x, 'bool')

            out = layers.reduce_any(x)  # True
            out = layers.reduce_any(x, dim=0)  # [True, False]
            out = layers.reduce_any(x, dim=-1)  # [True, False]
4783 4784
            # keep_dim=False, x.shape=(2,2), out.shape=(2,)

4785
            out = layers.reduce_any(x, dim=1,
Z
zhoukunsheng 已提交
4786
                                     keep_dim=True)  # [[True], [False]]
4787
            # keep_dim=True, x.shape=(2,2), out.shape=(2,1)
Z
zhoukunsheng 已提交
4788 4789

    """
4790
    check_variable_and_dtype(input, 'input', ('bool'), 'reduce_any')
Z
zhoukunsheng 已提交
4791 4792 4793 4794 4795 4796 4797 4798 4799
    helper = LayerHelper('reduce_any', **locals())
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
    if dim is not None and not isinstance(dim, list):
        dim = [dim]
    helper.append_op(
        type='reduce_any',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={
4800
            'dim': dim if dim != None and dim != [] else [0],
Z
zhoukunsheng 已提交
4801
            'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4802 4803
            'reduce_all': True if dim == None or dim == [] or
            len(dim) == len(input.shape) else False
4804 4805 4806 4807
        })
    return out


C
caoying03 已提交
4808
def split(input, num_or_sections, dim=-1, name=None):
G
guosheng 已提交
4809
    """
4810
    Split the input tensor into multiple sub-Tensors.
G
guosheng 已提交
4811 4812

    Args:
4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823
        input (Tensor): A N-D Tensor. The data type is bool, float16, float32, float64, int32 or int64.
        num_or_sections (int|list|tuple): If ``num_or_sections`` is int, then the ``num_or_sections`` 
            indicates the number of equal sized sub-Tensors that the ``input``
            will be divided into. If ``num_or_sections`` is a list or tuple, the length of it 
            indicates the number of sub-Tensors and the elements in it indicate the sizes of sub-Tensors'
            dimension orderly. The length of the list mustn't be larger than the ``input`` 's size of specified dim.
        dim (int|Tensor, optional): The dimension along which to split, it can be a scalar with type ``int`` or
            a ``Tensor`` with shape [1] and data type ``int32`` or ``int64``. If :math:`dim < 0`,
            the dimension to split along is :math:`rank(input) + dim`. Default is -1.
        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` .
G
guosheng 已提交
4824 4825

    Returns:
4826
        list(Tensor): The list of segmented Tensors.
G
guosheng 已提交
4827

4828
    Raises:
4829 4830 4831
        TypeError: The data type of ``input`` must be one of bool, float16, float32, float64, int32, int64.
        TypeError: ``num_or_sections`` is not int, list or tuple.
        TypeError: ``dim`` is not int or Tensor. The data type of ``dim`` must be int32 or int64 when it's a Tensor.
4832

4833
    Example:
G
guosheng 已提交
4834 4835
        .. code-block:: python

4836 4837
            import paddle.fluid as fluid

4838
            # input is a Tensor which shape is [3, 9, 5]
4839
            input = fluid.data(
4840 4841
                 name="input", shape=[3, 9, 5], dtype="float32")

4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862
            out0, out1, out2 = fluid.layers.split(input, num_or_sections=3, dim=1)
            # out0.shape [3, 3, 5]
            # out1.shape [3, 3, 5]
            # out2.shape [3, 3, 5]

            out0, out1, out2 = fluid.layers.split(input, num_or_sections=[2, 3, 4], dim=1)
            # out0.shape [3, 2, 5]
            # out1.shape [3, 3, 5]
            # out2.shape [3, 4, 5]

            out0, out1, out2 = fluid.layers.split(input, num_or_sections=[2, 3, -1], dim=1)
            # out0.shape [3, 2, 5]
            # out1.shape [3, 3, 5]
            # out2.shape [3, 4, 5]
            
            # dim is negative, the real dim is (rank(input) + axis) which real
            # value is 1.
            out0, out1, out2 = fluid.layers.split(input, num_or_sections=3, dim=-2)
            # out0.shape [3, 3, 5]
            # out1.shape [3, 3, 5]
            # out2.shape [3, 3, 5]
4863

G
guosheng 已提交
4864
    """
4865
    if in_dygraph_mode():
4866 4867 4868
        num = None
        attrs = ()

S
songyouwei 已提交
4869 4870 4871 4872
        if isinstance(dim, Variable):
            dim = dim.numpy()
            dim = dim[0]
        dim = (len(input.shape) + dim) if dim < 0 else dim
4873
        attrs += ('axis', dim)
4874 4875 4876

        if isinstance(num_or_sections, int):
            num = num_or_sections
4877
            attrs += ('num', num_or_sections)
L
Leo Chen 已提交
4878
        elif isinstance(num_or_sections, (list, tuple)):
4879
            num = len(num_or_sections)
L
Leo Chen 已提交
4880
            if utils._contain_var(num_or_sections):
4881 4882 4883 4884 4885
                for index, item in enumerate(num_or_sections):
                    if isinstance(item, Variable):
                        num_or_sections[index] = num_or_sections[index].numpy()[
                            0]
                attrs += ('sections', list(num_or_sections))
L
Leo Chen 已提交
4886
            else:
4887
                attrs += ('sections', list(num_or_sections))
4888 4889
        else:
            raise TypeError(
4890
                "The type of 'num_or_sections' in split must be int, list or tuple in imperative mode, but "
4891
                "received %s." % (type(num_or_sections)))
4892
        return core.ops.split(input, num, *attrs)
L
Leo Chen 已提交
4893

4894 4895 4896 4897 4898 4899 4900
    check_variable_and_dtype(
        input, 'input',
        ['bool', 'float16', 'float32', 'float64', 'int32', 'in64'], 'split')
    check_type(num_or_sections, 'num_or_sections', (list, int, tuple), 'split')
    check_type(dim, 'dim', (int, Variable), 'split')
    if isinstance(dim, Variable):
        check_dtype(dim.dtype, 'dim', ['int32', 'int64'], 'split')
4901

G
guosheng 已提交
4902
    helper = LayerHelper('split', **locals())
4903

G
guosheng 已提交
4904
    input_shape = input.shape
4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935
    inputs = {'X': input}
    attrs = {'num': num_or_sections if isinstance(num_or_sections, int) else 0}

    def _get_SectionsTensorList(one_list):
        tensor_list = []
        unk_dim_idx = -1
        for idx, dim_size in enumerate(one_list):
            if isinstance(dim_size, Variable):
                dim_size.stop_gradient = True
                tensor_list.append(dim_size)
            else:
                assert (isinstance(dim_size, int))
                if dim_size == -1:
                    assert unk_dim_idx == -1, (
                        "Only one value of 'num_or_section' in split can "
                        "be -1. But received num_or_section[%d] is also -1." %
                        idx)
                    unk_dim_idx = idx
                temp_out = helper.create_variable_for_type_inference('int32')
                fill_constant(
                    [1], 'int32', dim_size, force_cpu=True, out=temp_out)
                tensor_list.append(temp_out)
        return tensor_list

    if isinstance(dim, Variable):
        dim.stop_gradient = True
        inputs['AxisTensor'] = dim
    else:
        dim = (len(input_shape) + dim) if dim < 0 else dim
        attrs['axis'] = dim

G
guosheng 已提交
4936 4937
    if isinstance(num_or_sections, int):
        assert num_or_sections > 1, 'num_or_sections must be more than 1.'
4938 4939 4940 4941 4942
        if isinstance(dim, int) and input_shape[dim] > 0:
            assert input_shape[dim] % num_or_sections ==0, \
                "The input's size along the split dimension " \
                "must be evenly divisible by Attr(num_or_sections). " \
                "But %d is not evenly divisible by %d. " % (num_or_sections,input_shape[dim])
G
guosheng 已提交
4943 4944
        num = num_or_sections
    else:
4945 4946 4947
        if isinstance(dim, int) and input_shape[dim] > 0:
            assert len(num_or_sections) <= input_shape[
                dim], 'len(num_or_sections) must not be more than input.shape[dim].'
G
guosheng 已提交
4948
        num = len(num_or_sections)
4949 4950 4951
        attrs['sections'] = list(
            map(lambda ele: -1 if isinstance(ele, Variable) else ele,
                num_or_sections))
L
Leo Chen 已提交
4952
        if utils._contain_var(num_or_sections):
4953 4954 4955
            inputs['SectionsTensorList'] = _get_SectionsTensorList(
                num_or_sections)

G
guosheng 已提交
4956
    outs = [
X
Xin Pan 已提交
4957
        helper.create_variable_for_type_inference(dtype=helper.input_dtype())
G
guosheng 已提交
4958 4959 4960
        for i in range(num)
    ]
    helper.append_op(
4961
        type='split', inputs=inputs, outputs={'Out': outs}, attrs=attrs)
G
guosheng 已提交
4962
    return outs
C
caoying03 已提交
4963 4964 4965 4966


def l2_normalize(x, axis, epsilon=1e-12, name=None):
    """
4967 4968 4969 4970
    :alias_main: paddle.nn.functional.l2_normalize
	:alias: paddle.nn.functional.l2_normalize,paddle.nn.functional.norm.l2_normalize
	:old_api: paddle.fluid.layers.l2_normalize

R
ruri 已提交
4971
    This op normalizes `x` along dimension `axis` using an L2
C
caoying03 已提交
4972 4973
    norm. For a 1-D tensor (`dim` is fixed to 0), this layer computes

4974
    .. math::
4975 4976

        y = \\frac{x}{ \sqrt{\sum {x^2} + epsion }}
C
caoying03 已提交
4977 4978 4979 4980 4981

    For `x` with more dimensions, this layer independently normalizes each 1-D
    slice along dimension `axis`.

    Args:
R
ruri 已提交
4982
        x(Variable|list): The input tensor could be N-D tensor, and the input data type could be float32 or float64.
4983
        axis(int): The axis on which to apply normalization. If `axis < 0`, \
4984 4985
            the dimension to normalization is rank(X) + axis. -1 is the
            last dimension.
4986
        epsilon(float): The epsilon value is used to avoid division by zero, \
翟飞跃 已提交
4987
            the default value is 1e-12.
R
ruri 已提交
4988
	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`
4989

C
caoying03 已提交
4990
    Returns:
R
ruri 已提交
4991
        Variable: The output has the same shape and data type with `x`.
C
caoying03 已提交
4992 4993

    Examples:
4994

C
caoying03 已提交
4995
        .. code-block:: python
4996

R
ruri 已提交
4997 4998 4999 5000 5001 5002 5003 5004
	    # declarative mode
	    import paddle.fluid as fluid
	    import numpy as np
	    input = fluid.data(name="input", shape=[2,3])
	    output = fluid.layers.l2_normalize(x=input,axis=0)
	    place = fluid.CPUPlace()
	    exe = fluid.Executor(place)
	    exe.run(fluid.default_startup_program())
5005

R
ruri 已提交
5006 5007
	    input_data = np.random.rand(2,3).astype("float32")
	    print(input_data)
C
caoying03 已提交
5008

R
ruri 已提交
5009 5010
	    # [[0.5171216  0.12704141 0.56018186]
	    # [0.93251234 0.5382788  0.81709313]]
5011

R
ruri 已提交
5012 5013 5014 5015
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
5016

R
ruri 已提交
5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028
	    print(output_data)

	    # [array([[0.48496857, 0.22970329, 0.56545246],
	    # [0.8745316 , 0.9732607 , 0.82478094]], dtype=float32)]

	    # imperative mode
	    import paddle.fluid.dygraph as dg

	    with dg.guard(place) as g:
    		input = dg.to_variable(input_data)
    		output = fluid.layers.l2_normalize(x=input, axis=-1)
    		print(output.numpy())
5029

R
ruri 已提交
5030 5031
		# [[0.66907585 0.16437206 0.7247892 ]
		# [0.6899054  0.3982376  0.6045142 ]]
5032

C
caoying03 已提交
5033 5034
    """

F
fengjiayi 已提交
5035 5036
    if len(x.shape) == 1:
        axis = 0
5037
    check_variable_and_dtype(x, "X", ("float32", "float64"), "norm")
C
caoying03 已提交
5038

5039
    helper = LayerHelper("l2_normalize", **locals())
X
Xin Pan 已提交
5040 5041
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    norm = helper.create_variable_for_type_inference(dtype=x.dtype)
C
caoying03 已提交
5042
    helper.append_op(
5043 5044 5045 5046
        type="norm",
        inputs={"X": x},
        outputs={"Out": out,
                 "Norm": norm},
C
caoying03 已提交
5047
        attrs={
5048 5049
            "axis": 1 if axis is None else axis,
            "epsilon": epsilon,
C
caoying03 已提交
5050 5051
        })
    return out
5052 5053


S
sneaxiy 已提交
5054
def matmul(x, y, transpose_x=False, transpose_y=False, alpha=1.0, name=None):
G
guosheng 已提交
5055
    """
Y
ying 已提交
5056 5057 5058 5059
    Applies matrix multiplication to two tensors.

    Currently, the input tensors' rank can be any, but when the rank of any
    inputs is bigger than 3, this two inputs' rank should be equal.
G
guosheng 已提交
5060

C
chengduoZH 已提交
5061
    The actual behavior depends on the shapes of :math:`x`, :math:`y` and the
5062
    flag values of :attr:`transpose_x`, :attr:`transpose_y`. Specifically:
G
guosheng 已提交
5063

5064 5065 5066 5067 5068
    - If a transpose flag is specified, the last two dimensions of the tensor
      are transposed. If the tensor is rank-1 of shape :math:`[D]`, then for
      :math:`x` it is treated as :math:`[1, D]` in nontransposed form and as
      :math:`[D, 1]` in transposed form, whereas for :math:`y` it is the
      opposite: It is treated as :math:`[D, 1]` in nontransposed form and as
5069
      :math:`[1, D]` in transposed form.
G
guosheng 已提交
5070

C
chengduoZH 已提交
5071
    - After transpose, the two tensors are 2-D or n-D and matrix multiplication
5072
      performs in the following way.
G
guosheng 已提交
5073

5074
      - If both are 2-D, they are multiplied like conventional matrices.
C
chengduoZH 已提交
5075
      - If either is n-D, it is treated as a stack of matrices residing in the
Y
ying 已提交
5076
        last two dimensions and a batched matrix multiply supporting broadcast
5077
        applies on the two tensors.
G
guosheng 已提交
5078

Y
ying 已提交
5079 5080
    Also note that if the raw tensor :math:`x` or :math:`y` is rank-1 and
    nontransposed, the prepended or appended dimension :math:`1` will be
C
chengduoZH 已提交
5081
    removed after matrix multiplication.
G
guosheng 已提交
5082 5083 5084

    Args:
        x (Variable): The input variable which is a Tensor or LoDTensor.
5085 5086 5087
        y (Variable): The input variable which is a Tensor or LoDTensor.
        transpose_x (bool): Whether to transpose :math:`x` before multiplication.
        transpose_y (bool): Whether to transpose :math:`y` before multiplication.
S
sneaxiy 已提交
5088
        alpha (float): The scale of output. Default 1.0.
5089
        name(str|None): A name for this layer(optional). If set None, the layer
5090
            will be named automatically.
G
guosheng 已提交
5091 5092

    Returns:
石晓伟 已提交
5093
        Variable: The product Tensor (or LoDTensor) variable.
G
guosheng 已提交
5094

G
guosheng 已提交
5095 5096 5097
    Examples:
        .. code-block:: python

5098
            # Examples to clarify shapes of the inputs and output
C
chengduoZH 已提交
5099
            # x: [B, ..., M, K], y: [B, ..., K, N]
5100
            # fluid.layers.matmul(x, y)  # out: [B, ..., M, N]
Y
ying 已提交
5101

5102
            # x: [B, M, K], y: [B, K, N]
5103
            # fluid.layers.matmul(x, y)  # out: [B, M, N]
Y
ying 已提交
5104

5105
            # x: [B, M, K], y: [K, N]
5106
            # fluid.layers.matmul(x, y)  # out: [B, M, N]
Y
ying 已提交
5107

5108
            # x: [M, K], y: [K, N]
5109
            # fluid.layers.matmul(x, y)  # out: [M, N]
Y
ying 已提交
5110 5111

            # x: [B, M, K], y: [K]
5112
            # fluid.layers.matmul(x, y)  # out: [B, M]
Y
ying 已提交
5113

5114
            # x: [K], y: [K]
5115
            # fluid.layers.matmul(x, y)  # out: [1]
5116

Y
ying 已提交
5117
            # x: [M], y: [N]
5118 5119
            # fluid.layers.matmul(x, y, True, True)  # out: [M, N]

5120
            import paddle.fluid as fluid
5121 5122 5123
            x = fluid.layers.data(name='x', shape=[2, 3], dtype='float32')
            y = fluid.layers.data(name='y', shape=[3, 2], dtype='float32')
            out = fluid.layers.matmul(x, y, True, True)
G
guosheng 已提交
5124
    """
5125
    return paddle.matmul(x, y, transpose_x, transpose_y, alpha, name)
5126 5127


5128
def topk(input, k, name=None):
Q
qingqing01 已提交
5129
    """
5130 5131 5132 5133
    :alias_main: paddle.topk
	:alias: paddle.topk,paddle.tensor.topk,paddle.tensor.search.topk
	:old_api: paddle.fluid.layers.topk

5134
    This OP is used to find values and indices of the k largest entries
Q
qingqing01 已提交
5135 5136
    for the last dimension.

5137 5138
    If the input is a 1-D Tensor, finds the k largest entries and outputs
    their values and indices.
Q
qingqing01 已提交
5139 5140 5141 5142

    If the input is a Tensor with higher rank, this operator computes the top k
    entries along the last dimension.

F
fengjiayi 已提交
5143 5144
    .. code-block:: text

5145 5146 5147 5148 5149
        Case 1:

          Input:
            input.shape = [3, 4]
            input.data = [[5, 4, 2, 3],
F
fengjiayi 已提交
5150 5151 5152 5153
                     [9, 7, 10, 25],
                     [6, 2, 10, 1]]
            k = 2

5154
          Output:
F
fengjiayi 已提交
5155
            The first output:
5156 5157
            values.shape = [3, 2]
            values.data = [[5, 4],
F
fengjiayi 已提交
5158 5159 5160 5161
                      [10, 25],
                      [6, 10]]

            The second output:
5162 5163
            indices.shape = [3, 2]
            indices.data = [[0, 1],
F
fengjiayi 已提交
5164 5165 5166
                       [2, 3],
                       [0, 2]]

Q
qingqing01 已提交
5167
    Args:
5168 5169 5170 5171
        input(Variable): The input tensor. Support data types: float32, float64.
        k(int | Variable): The number of top elements to look for along the last dimension
                           of input tensor.
        name (str, optional): Please refer to :ref:`api_guide_Name`, Default None.
Q
qingqing01 已提交
5172 5173

    Returns:
5174 5175
        Values (Variable): Input tensor's k largest elements along each last dimensional slice. The dimension is: :math:`input.shape[:-1]+[k]`.
        Indices (Variable): Indices of k largest elements alone the last dimension of input. The dimension is same as values.
Q
qingqing01 已提交
5176

F
fengjiayi 已提交
5177
    Raises:
5178
        ValueError: If :math:`k < 1` or :math:`k > last dimension of input`.
Q
qingqing01 已提交
5179 5180 5181 5182

    Examples:
        .. code-block:: python

5183
            import paddle.fluid as fluid
5184
            import paddle.fluid.layers as layers
5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197
            # set batch size=None
            input = fluid.data(name="input", shape=[None, 13, 11], dtype='float32')
            top5_values, top5_indices = layers.topk(input, k=5) # top5_values.shape[None, 13, 5], top5_indices.shape=[None, 13, 5]

            # 1D Tensor
            input1 = fluid.data(name="input1", shape=[None, 13], dtype='float32')
            top5_values, top5_indices = layers.topk(input1, k=5) #top5_values.shape=[None, 5], top5_indices.shape=[None, 5]

            # k=Variable
            input2 = fluid.data(name="input2", shape=[None, 13, 11], dtype='float32')
            vk = fluid.data(name="vk", shape=[None, 1], dtype='int32') # save k in vk.data[0]
            vk_values, vk_indices = layers.topk(input2, k=vk) #vk_values.shape=[None, 13, k], vk_indices.shape=[None, 13, k]

Q
qingqing01 已提交
5198
    """
5199
    if in_dygraph_mode():
5200 5201 5202 5203 5204
        _k = k.numpy().item(0) if isinstance(k, Variable) else k
        out, indices = core.ops.top_k(input, 'k', _k)
        out.stop_gradient = True
        indices.stop_gradient = True
        return out, indices
5205

5206 5207
    inputs = {"X": [input]}
    attrs = {}
S
songyouwei 已提交
5208 5209 5210 5211 5212
    if isinstance(k, Variable):
        inputs['K'] = [k]
    else:
        attrs = {'k': k}

5213 5214 5215 5216
    helper = LayerHelper("top_k", **locals())
    values = helper.create_variable_for_type_inference(dtype=input.dtype)
    indices = helper.create_variable_for_type_inference(dtype="int64")

Q
qingqing01 已提交
5217 5218
    helper.append_op(
        type="top_k",
W
whs 已提交
5219
        inputs=inputs,
Q
qingqing01 已提交
5220 5221
        outputs={"Out": [values],
                 "Indices": [indices]},
W
whs 已提交
5222
        attrs=attrs)
Q
qingqing01 已提交
5223 5224 5225 5226 5227
    values.stop_gradient = True
    indices.stop_gradient = True
    return values, indices


5228 5229 5230 5231 5232
def ctc_greedy_decoder(input,
                       blank,
                       input_length=None,
                       padding_value=0,
                       name=None):
5233
    """
S
SunGaofeng 已提交
5234
    This op is used to decode sequences by greedy policy by the following steps:
Y
yi.wu 已提交
5235

S
SunGaofeng 已提交
5236
    1. Get the indexes of maximum value for each row in input. a.k.a.
Y
ying 已提交
5237 5238 5239
       numpy.argmax(input, axis=0).
    2. For each sequence in result of step1, merge repeated tokens between two
       blanks and delete all blanks.
5240

S
SunGaofeng 已提交
5241
    This op is implemented in two modes: lod and padding, either of them can be used.
5242
    The input can be either LoDTensor or Tensor, corresponding to lod and padding
S
SunGaofeng 已提交
5243 5244
    mode respectively.

5245 5246 5247 5248 5249
    A simple example as below:

    .. code-block:: text

        Given:
S
SunGaofeng 已提交
5250
        (1) for lod mode:
5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261

        input.data = [[0.6, 0.1, 0.3, 0.1],
                      [0.3, 0.2, 0.4, 0.1],
                      [0.1, 0.5, 0.1, 0.3],
                      [0.5, 0.1, 0.3, 0.1],

                      [0.5, 0.1, 0.3, 0.1],
                      [0.2, 0.2, 0.2, 0.4],
                      [0.2, 0.2, 0.1, 0.5],
                      [0.5, 0.1, 0.3, 0.1]]

5262
        input.lod = [[4, 4]]
M
minqiyang 已提交
5263

W
whs 已提交
5264
        Computation:
5265

W
whs 已提交
5266 5267 5268 5269 5270 5271
        step1: Apply argmax to first input sequence which is input.data[0:4]. Then we get:
               [[0], [2], [1], [0]]
        step2: merge repeated tokens and remove blank which is 0. Then we get first output sequence:
               [[2], [1]]

        Finally:
5272 5273 5274 5275 5276

        output.data = [[2],
                       [1],
                       [3]]

5277
        output.lod = [[2, 1]]
5278

S
SunGaofeng 已提交
5279
        (2) for padding mode:
5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295

         input.data = [[[0.6, 0.1, 0.3, 0.1],
                        [0.3, 0.2, 0.4, 0.1],
                        [0.1, 0.5, 0.1, 0.3],
                        [0.5, 0.1, 0.3, 0.1]],

                       [[0.5, 0.1, 0.3, 0.1],
                        [0.2, 0.2, 0.2, 0.4],
                        [0.2, 0.2, 0.1, 0.5],
                        [0.5, 0.1, 0.3, 0.1]]]

        input_length.data = [[4], [4]]
        input.shape = [2, 4, 4]

        step1: Apply argmax to first input sequence which is input.data[0:4]. Then we get:
               [[0], [2], [1], [0]], for input.data[4:8] is [[0], [3], [3], [0]], shape is [2,4,1]
5296
        step2: Change the argmax result to use padding mode, then argmax result is
5297 5298 5299 5300 5301 5302 5303 5304 5305
                [[0, 2, 1, 0], [0, 3, 3, 0]], shape is [2, 4], lod is [], input_length is [[4], [4]]
        step3: Apply ctc_align to padding argmax result, padding_value is 0

        Finally:
        output.data = [[2, 1, 0, 0],
                       [3, 0, 0, 0]]
        output_length.data = [[2], [1]]


S
SunGaofeng 已提交
5306
    Parameters:
5307

5308 5309
        input(Variable): the probabilities of variable-length sequences. When in lod mode,
                         it is a 2-D LoDTensor with LoD information. It's shape is [Lp, num_classes + 1]
Y
ying 已提交
5310
                         where Lp is the sum of all input sequences' length and
5311 5312
                         num_classes is the true number of classes. When in padding mode,
                         it is a 3-D Tensor with padding, It's shape is [batch_size, N, num_classes + 1].
S
SunGaofeng 已提交
5313
                         (not including the blank label). The data type can be float32 or float64.
Y
ying 已提交
5314
        blank(int): the blank label index of Connectionist Temporal
S
SunGaofeng 已提交
5315
                    Classification (CTC) loss, which is in the half-opened
Y
ying 已提交
5316
                    interval [0, num_classes + 1).
S
SunGaofeng 已提交
5317 5318
        input_length(Variable, optional): 2-D LoDTensor, shape is [batch_size, 1], data type is int64.
                                 It is used for padding mode. In lod mode, input_length is None.
5319
        padding_value(int): padding value.
5320 5321 5322
        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`
5323 5324

    Returns:
S
SunGaofeng 已提交
5325 5326 5327 5328 5329
        For lod mode, returns the result of CTC greedy decoder, 2-D LoDTensor, shape is [Lp, 1], \
        data type is int64. 'Lp' is the sum of all output sequences' length. If all the sequences \
        in result were empty, the result LoDTensor will be [-1] with  empty \
        LoD [[]].

5330
        For padding mode, returns a tuple of (output, output_length), which was described as below:
S
SunGaofeng 已提交
5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341

        output, 2-D Tensor, shape is [batch_size, N], data type is int64.

        output_length, 2-D Tensor, shape is [batch_size, 1], data type is int64. It is the length of \
                           each sequence of output for padding mode.

    Return type:
        For lod mode: Variable

        For padding mode: tuple of two Variables (output, output_length).

5342 5343 5344 5345

    Examples:
        .. code-block:: python

5346
            # for lod mode
S
SunGaofeng 已提交
5347
            import paddle.fluid as fluid
S
SunGaofeng 已提交
5348
            x = fluid.data(name='x', shape=[None, 8], dtype='float32', lod_level=1)
5349
            cost = fluid.layers.ctc_greedy_decoder(input=x, blank=0)
5350 5351

            # for padding mode
S
SunGaofeng 已提交
5352 5353
            x_pad = fluid.data(name='x_pad', shape=[10, 4, 8], dtype='float32')
            x_pad_len = fluid.data(name='x_pad_len', shape=[10, 1], dtype='int64')
5354 5355 5356
            out, out_len = fluid.layers.ctc_greedy_decoder(input=x_pad, blank=0,
                            input_length=x_pad_len)

W
wanghaoshuang 已提交
5357
    """
5358 5359 5360
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'ctc_greedy_decoder')

5361
    helper = LayerHelper("ctc_greedy_decoder", **locals())
Q
qingqing01 已提交
5362
    _, topk_indices = topk(input, k=1)
5363 5364

    # ctc align op
X
Xin Pan 已提交
5365
    ctc_out = helper.create_variable_for_type_inference(dtype="int64")
5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390

    if input_length is None:
        helper.append_op(
            type="ctc_align",
            inputs={"Input": [topk_indices]},
            outputs={"Output": [ctc_out]},
            attrs={"merge_repeated": True,
                   "blank": blank})
        return ctc_out
    else:
        ctc_out_len = helper.create_variable_for_type_inference(dtype="int64")
        ctc_input = squeeze(topk_indices, [2])

        helper.append_op(
            type="ctc_align",
            inputs={"Input": [ctc_input],
                    "InputLength": [input_length]},
            outputs={"Output": [ctc_out],
                     "OutputLength": [ctc_out_len]},
            attrs={
                "merge_repeated": True,
                "blank": blank,
                "padding_value": padding_value
            })
        return ctc_out, ctc_out_len
5391 5392


Y
fix ci.  
ying 已提交
5393
def transpose(x, perm, name=None):
Y
ying 已提交
5394
    """
5395 5396 5397 5398
    :alias_main: paddle.transpose
	:alias: paddle.transpose,paddle.tensor.transpose,paddle.tensor.linalg.transpose,paddle.tensor.manipulation.transpose
	:old_api: paddle.fluid.layers.transpose

5399
    Permute the data dimensions of `input` according to `perm`.
Y
ying 已提交
5400 5401 5402 5403 5404

    The `i`-th dimension  of the returned tensor will correspond to the
    perm[i]-th dimension of `input`.

    Args:
5405
        x (Variable): The input Tensor. It is a N-D Tensor of data types float32, float64, int32.
T
tianshuo78520a 已提交
5406
        perm (list): Permute the input according to the data of perm.
5407
        name (str): The name of this layer. It is optional.
Y
ying 已提交
5408 5409

    Returns:
5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433
        Variable: A transposed n-D Tensor, with data type being float32, float64, int32, int64.

    For Example:

        .. code-block:: text

         x = [[[ 1  2  3  4] [ 5  6  7  8] [ 9 10 11 12]]
             [[13 14 15 16] [17 18 19 20] [21 22 23 24]]]
         shape(x) =  [2,3,4]

         # Example 1
         perm0 = [1,0,2]
         y_perm0 = [[[ 1  2  3  4] [13 14 15 16]]
                   [[ 5  6  7  8]  [17 18 19 20]]
                   [[ 9 10 11 12]  [21 22 23 24]]]
         shape(y_perm0) = [3,2,4]

         # Example 2
         perm1 = [2,1,0]
         y_perm1 = [[[ 1 13] [ 5 17] [ 9 21]]
                   [[ 2 14] [ 6 18] [10 22]]
                   [[ 3 15]  [ 7 19]  [11 23]]
                   [[ 4 16]  [ 8 20]  [12 24]]]
         shape(y_perm1) = [4,3,2]
Y
ying 已提交
5434 5435

    Examples:
5436

Y
ying 已提交
5437 5438
        .. code-block:: python

5439
            # use append_batch_size=False to avoid prepending extra
5440
            # batch size in shape
5441
            import paddle.fluid as fluid
5442
            x = fluid.layers.data(name='x', shape=[2, 3, 4],
5443
                            dtype='float32', append_batch_size=False)
5444
            x_transposed = fluid.layers.transpose(x, perm=[1, 0, 2])
5445 5446
            print x_transposed.shape
            #(3L, 2L, 4L)
Y
ying 已提交
5447

5448
    """
5449
    if in_dygraph_mode():
5450 5451
        out, _ = core.ops.transpose2(x, 'axis', perm)
        return out
5452

5453 5454 5455
    check_variable_and_dtype(
        x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'],
        'transpose')
5456
    check_type(perm, 'perm', list, 'transpose')
5457

Y
fix ci.  
ying 已提交
5458
    if len(perm) != len(x.shape):
Y
ying 已提交
5459
        raise ValueError(
5460 5461 5462 5463
            "Input(perm) is the permutation of dimensions of Input(x), "
            "its length should be equal to dimensions of Input(x), "
            "but received dimension of Input(x) is %s, "
            "the length of Input(perm) is %s." % (len(x.shape), len(perm)))
Y
ying 已提交
5464 5465 5466
    for idx, dim in enumerate(perm):
        if dim >= len(x.shape):
            raise ValueError(
5467 5468 5469
                "Each element in Input(perm) should be less than Input(x)'s dimension, "
                "but %d-th element in Input(perm) is %d which exceeds Input(x)'s "
                "dimension %d." % (idx, perm[idx], len(x.shape)))
Y
ying 已提交
5470 5471

    helper = LayerHelper('transpose', **locals())
X
Xin Pan 已提交
5472 5473
    out = helper.create_variable_for_type_inference(x.dtype)
    x_shape = helper.create_variable_for_type_inference(x.dtype)
Y
ying 已提交
5474
    helper.append_op(
5475
        type='transpose2',
Y
fix ci.  
ying 已提交
5476
        inputs={'X': [x]},
5477 5478
        outputs={'Out': [out],
                 'XShape': [x_shape]},
Y
ying 已提交
5479 5480
        attrs={'axis': perm})
    return out
5481 5482


5483 5484 5485 5486 5487 5488 5489
def im2sequence(input,
                filter_size=1,
                stride=1,
                padding=0,
                input_image_size=None,
                out_stride=1,
                name=None):
5490
    """
5491 5492
    :api_attr: Static Graph

5493
    Extracts image patches from the input tensor to form a tensor of shape
L
Liufang Sang 已提交
5494 5495 5496
    {input.batch_size * output_height * output_width, filter_size_height *
    filter_size_width * input.channels}. This op use filter to scan images
    and convert these images to sequences. After expanding, the number of time step are
5497 5498
    output_height * output_width for an image, in which output_height and
    output_width are calculated by below equation:
5499 5500 5501

    .. math::

L
Liufang Sang 已提交
5502 5503 5504 5505
        output\_height  = 1 + \
            (padding\_up + padding\_down + input\_height  - filter\_size\_height  + stride\_height - 1) / stride\_height \\\\
        output\_width  = 1 + \
            (padding\_left + padding\_right + input\_width  - filter\_size\_width  + stride\_width - 1) / stride\_width
5506

L
Liufang Sang 已提交
5507
    And the dimension of each time step is filter_size_height * filter_size_width * input.channels.
5508

L
Liufang Sang 已提交
5509 5510
    Parameters:
        input (Variable): The input should be a 4-D Tensor in :math:`NCHW` format. The data type is float32.
W
wanghaoshuang 已提交
5511

L
Liufang Sang 已提交
5512 5513 5514
        filter_size(int32 | List[int32]): The filter size. If filter_size is a List,
            it must contain two integers, :math:`[filter\_size\_height, filter\_size\_width]` .
            Otherwise, the filter size will be a square :math:`[filter\_size, filter\_size]` . Default is 1.
5515

L
Liufang Sang 已提交
5516 5517
        stride(int32 | List[int32]): The stride size. If stride is a List, it must
            contain two integers, :math:`[stride\_height, stride\_width]` . Otherwise, the stride size will be a square :math:`[stride\_size, stride\_size]` . Default is 1.
5518

L
Liufang Sang 已提交
5519 5520 5521 5522 5523
        padding(int32 | List[int32]): The padding size. If padding is a List, it can
            contain four integers like :math:`[padding\_up, padding\_left, padding\_down, padding\_right]` to indicate
            paddings of four direction.  Or it can contain two integers :math:`[padding\_height, padding\_width]` which means
            padding_up = padding_down = padding_height and
            padding_left = padding_right = padding_width. Otherwise, a scalar padding means
5524
            padding_up = padding_down = padding_left = padding_right = padding.
L
Liufang Sang 已提交
5525
            Default is 0.
5526

L
Liufang Sang 已提交
5527 5528 5529 5530
        input_image_size(Variable, optional): the input contains image real size.It's dim
            is :math:`[batchsize, 2]` . It is just for batch inference when not None. Default is None.

        out_stride(int32 | List[int32]): The scaling of image through CNN. It is valid only when input_image_size is not None.
T
tianshuo78520a 已提交
5531
            If out_stride is List,  it must contain two integers,
L
Liufang Sang 已提交
5532 5533 5534 5535 5536
            :math:`[out\_stride\_height, out\_stride\_W]` . Otherwise,
            the out_stride_height = out_stride_width = out_stride. Default is 1.

        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` .
5537 5538 5539

    Returns:
            The output is a 2-D LoDTensor with shape {input.batch\_size * output\_height * output\_width, \
L
Liufang Sang 已提交
5540 5541 5542
            filter\_size\_height * filter\_size\_width * input.channels}. The data type is float32.

    Return Type: Variable
5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569

    Examples:

        .. code-block:: text

            Given:

            x = [[[[ 6.  2.  1.]
                   [ 8.  3.  5.]
                   [ 0.  2.  6.]]

                  [[ 2.  4.  4.]
                   [ 6.  3.  0.]
                   [ 6.  4.  7.]]]

                 [[[ 6.  7.  1.]
                   [ 5.  7.  9.]
                   [ 2.  4.  8.]]

                  [[ 1.  2.  1.]
                   [ 1.  3.  5.]
                   [ 9.  0.  8.]]]]

            x.dims = {2, 2, 3, 3}

            And:

W
wanghaoshuang 已提交
5570 5571 5572
            filter = [2, 2]
            stride = [1, 1]
            padding = [0, 0]
5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584

            Then:

            output.data = [[ 6.  2.  8.  3.  2.  4.  6.  3.]
                           [ 2.  1.  3.  5.  4.  4.  3.  0.]
                           [ 8.  3.  0.  2.  6.  3.  6.  4.]
                           [ 3.  5.  2.  6.  3.  0.  4.  7.]
                           [ 6.  7.  5.  7.  1.  2.  1.  3.]
                           [ 7.  1.  7.  9.  2.  1.  3.  5.]
                           [ 5.  7.  2.  4.  1.  3.  9.  0.]
                           [ 7.  9.  4.  8.  3.  5.  0.  8.]]

5585
            output.dims = {8, 8}
5586

5587
            output.lod = [[4, 4]]
5588

T
Tink_Y 已提交
5589
    Examples:
5590 5591 5592

        .. code-block:: python

B
Bai Yifan 已提交
5593
            import paddle.fluid as fluid
L
Liufang Sang 已提交
5594
            data = fluid.data(name='data', shape=[None, 3, 32, 32],
B
Bai Yifan 已提交
5595
                                     dtype='float32')
5596
            output = fluid.layers.im2sequence(
B
Bai Yifan 已提交
5597 5598
                input=data, stride=[1, 1], filter_size=[2, 2])

5599 5600

    """
L
lujun 已提交
5601
    assert not in_dygraph_mode(), (
5602
        "sequence layer is not supported in dygraph mode yet.")
W
wanghaoshuang 已提交
5603

5604 5605
    check_variable_and_dtype(input, 'input', ['float32'], 'im2sequence')

W
wanghaoshuang 已提交
5606 5607 5608 5609 5610 5611 5612 5613 5614
    if isinstance(filter_size, int):
        filter_size = [filter_size, filter_size]
    if isinstance(stride, int):
        stride = [stride, stride]
    if isinstance(padding, int):
        padding = [padding, padding]
    if len(padding) == 2:
        padding.append(padding[0])
        padding.append(padding[1])
5615
    inputs = {"X": input}
5616
    attrs = {"kernels": filter_size, "strides": stride, "paddings": padding}
5617 5618 5619 5620 5621
    if input_image_size:
        if isinstance(out_stride, int):
            out_stride = [out_stride, out_stride]
        inputs["Y"] = input_image_size
        attrs["out_stride"] = out_stride
5622
    helper = LayerHelper('im2sequence', **locals())
X
Xin Pan 已提交
5623
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
5624
    helper.append_op(
5625
        type='im2sequence', inputs=inputs, outputs={'Out': out}, attrs=attrs)
5626
    return out
5627 5628


Y
yuyang18 已提交
5629
@templatedoc()
5630
def row_conv(input, future_context_size, param_attr=None, act=None):
Y
yuyang18 已提交
5631
    """
5632 5633
    :api_attr: Static Graph

Y
yuyang18 已提交
5634
    ${comment}
5635 5636

    Args:
Y
yuyang18 已提交
5637
        input (${x_type}): ${x_comment}.
Y
yangyaming 已提交
5638 5639
        future_context_size (int): Future context size. Please note, the shape
            of convolution kernel is [future_context_size + 1, D].
5640 5641 5642 5643 5644
        param_attr (ParamAttr): Attributes of parameters, including
            name, initializer etc.
        act (str): Non-linear activation to be applied to output variable.

    Returns:
Y
yuyang18 已提交
5645
        ${out_comment}.
5646 5647

    Examples:
D
Double_V 已提交
5648
        >>>  # for LodTensor inputs
Y
yuyang18 已提交
5649
        >>> import paddle.fluid as fluid
D
Double_V 已提交
5650
        >>> x = fluid.data(name='x', shape=[9, 16],
Y
yuyang18 已提交
5651 5652
        >>>                        dtype='float32', lod_level=1)
        >>> out = fluid.layers.row_conv(input=x, future_context_size=2)
D
Double_V 已提交
5653 5654 5655
        >>> # for Tensor inputs
        >>> x = fluid.data(name='x', shape=[9, 4, 16], dtype='float32')
        >>> out = fluid.layers.row_conv(input=x, future_context_size=2)
5656 5657
    """
    helper = LayerHelper('row_conv', **locals())
5658
    check_variable_and_dtype(input, 'input', ['float32'], 'row_conv')
5659
    dtype = helper.input_dtype()
5660
    filter_shape = [future_context_size + 1, input.shape[-1]]
5661 5662
    filter_param = helper.create_parameter(
        attr=helper.param_attr, shape=filter_shape, dtype=dtype)
X
Xin Pan 已提交
5663
    out = helper.create_variable_for_type_inference(dtype)
5664 5665 5666 5667 5668
    helper.append_op(
        type='row_conv',
        inputs={'X': [input],
                'Filter': [filter_param]},
        outputs={'Out': [out]})
Y
yangyaming 已提交
5669
    return helper.append_activation(out)
5670 5671


Y
yuyang18 已提交
5672
@templatedoc()
5673 5674
def multiplex(inputs, index):
    """
Y
yuyang18 已提交
5675

5676
    Based on the given index parameter, the OP selects a specific row from each input Tensor to construct the output Tensor.
L
lujun 已提交
5677

5678
    If the input of this OP contains :math:`m` Tensors, where :math:`I_{i}` means the i-th input Tensor, :math:`i` between :math:`[0,m)` .
L
lujun 已提交
5679

5680
    And :math:`O` means the output, where :math:`O[i]` means the i-th row of the output, then the output satisfies that :math:`O[i] = I_{index[i]}[i]` .
L
lujun 已提交
5681

5682
    For Example:
L
lujun 已提交
5683

5684
            .. code-block:: text
L
lujun 已提交
5685

5686
                Given:
L
lujun 已提交
5687

5688 5689 5690 5691
                inputs = [[[0,0,3,4], [0,1,3,4], [0,2,4,4], [0,3,3,4]],
                          [[1,0,3,4], [1,1,7,8], [1,2,4,2], [1,3,3,4]],
                          [[2,0,3,4], [2,1,7,8], [2,2,4,2], [2,3,3,4]],
                          [[3,0,3,4], [3,1,7,8], [3,2,4,2], [3,3,3,4]]]
L
lujun 已提交
5692

5693
                index = [[3],[0],[1],[2]]
L
lujun 已提交
5694

5695 5696 5697 5698
                out = [[3,0,3,4],    # out[0] = inputs[index[0]][0] = inputs[3][0] = [3,0,3,4]
                       [0,1,3,4],    # out[1] = inputs[index[1]][1] = inputs[0][1] = [0,1,3,4]
                       [1,2,4,2],    # out[2] = inputs[index[2]][2] = inputs[1][2] = [1,2,4,2]
                       [2,3,3,4]]    # out[3] = inputs[index[3]][3] = inputs[2][3] = [2,3,3,4]
L
lujun 已提交
5699 5700


5701 5702 5703
    Args:
       inputs (list): The input Tensor list. The list elements are N-D Tensors of data types float32, float64, int32, int64. All input Tensor shapes should be the same and rank must be at least 2.
       index (Variable): Used to select some rows in the input Tensor to construct an index of the output Tensor. It is a 2-D Tensor with data type int32 or int64 and shape [M, 1], where M is the number of input Tensors.
L
lujun 已提交
5704

5705
    Returns:
5706
        Variable(Tensor): Output of multiplex OP, with data type being float32, float64, int32, int64.
X
xuezhong 已提交
5707 5708

    Examples:
5709

X
xuezhong 已提交
5710 5711
        .. code-block:: python

5712
            import paddle.fluid as fluid
5713
            import numpy as np
5714

5715 5716 5717 5718
            x1 = fluid.data(name='x1', shape=[None, 2], dtype='float32')
            x2 = fluid.data(name='x2', shape=[None, 2], dtype='float32')
            index = fluid.data(name='index', shape=[None, 1], dtype='int32')
            out = fluid.layers.multiplex(inputs=[x1, x2], index=index)
X
xuezhong 已提交
5719

5720 5721 5722 5723 5724 5725 5726 5727 5728
            exe = fluid.Executor(fluid.CPUPlace())
            exe.run(fluid.default_startup_program())

            img1 = np.array([[1, 2], [3, 4]]).astype(np.float32)
            img2 = np.array([[5, 6], [7, 8]]).astype(np.float32)
            index = np.array([[1], [0]]).astype(np.int32)

            res = exe.run(fluid.default_main_program(), feed={'x1':img1, 'x2':img2, 'index':index}, fetch_list=[out])
            print(res) # [array([[5., 6.], [3., 4.]], dtype=float32)]
X
xuezhong 已提交
5729

5730 5731 5732
    """
    helper = LayerHelper('multiplex', **locals())

5733 5734 5735 5736 5737 5738 5739 5740 5741
    check_type(inputs, 'inputs', (list), 'multiplex')
    if len(inputs) < 2:
        raise ValueError(
            "inputs should be a list object with at least 2 elements.")
    for id, x in enumerate(inputs):
        check_variable_and_dtype(x, 'input[' + str(id) + ']',
                                 ['float32', 'float64', 'int32', 'int64'],
                                 'multiplex')
    check_variable_and_dtype(index, "index", ['int32', 'int64'], 'multiplex')
5742 5743

    out = helper.create_variable_for_type_inference(inputs[0].dtype)
5744
    helper.append_op(
5745 5746 5747 5748 5749
        type='multiplex',
        inputs={'X': inputs,
                'Ids': index},
        outputs={'Out': [out]})
    return out
X
xuezhong 已提交
5750 5751


5752 5753
def smooth_l1(x, y, inside_weight=None, outside_weight=None, sigma=None):
    """
5754 5755 5756 5757
    :alias_main: paddle.nn.functional.smooth_l1
	:alias: paddle.nn.functional.smooth_l1,paddle.nn.functional.loss.smooth_l1
	:old_api: paddle.fluid.layers.smooth_l1

Y
Yibing Liu 已提交
5758 5759
    This layer computes the smooth L1 loss for Variable :attr:`x` and :attr:`y`.
    It takes the first dimension of :attr:`x` and :attr:`y` as batch size.
Q
qingqing01 已提交
5760
    For each instance, it computes the smooth L1 loss element by element first
T
tianshuo78520a 已提交
5761
    and then sums all the losses. So the shape of output Variable is
5762
    [batch_size, 1].
5763

5764 5765
    Args:
        x (Variable): A tensor with rank at least 2. The input value of smooth
Q
qingqing01 已提交
5766
            L1 loss op with shape [batch_size, dim1, ..., dimN].
5767
            A LoDTensor or Tensor with type float32.
5768
        y (Variable): A tensor with rank at least 2. The target value of smooth
Y
Yibing Liu 已提交
5769
            L1 loss op with same shape as :attr:`x`.
5770
            A LoDTensor or Tensor with type float32.
5771
        inside_weight (Variable|None):  A tensor with rank at least 2. This
5772 5773
            input is optional and should have same shape with :attr:`x`. If
            provided, the result of (:attr:`x` - :attr:`y`) will be multiplied
Y
Yibing Liu 已提交
5774
            by this tensor element by element.
5775
            A Tensor with type float32.
5776
        outside_weight (Variable|None): A tensor with rank at least 2. This
5777 5778
            input is optional and should have same shape with :attr:`x`. If
            provided, the out smooth L1 loss will be multiplied by this tensor
Y
Yibing Liu 已提交
5779
            element by element.
5780
            A Tensor with type float32.
5781
        sigma (float|None): Hyper parameter of smooth L1 loss layer. A float
5782 5783
           scalar with default value 1.0.

5784
    Returns:
5785
        Variable: The output smooth L1 loss with shape [batch_size, 1].  A Tensor with type float32.
5786 5787 5788 5789

    Examples:
        .. code-block:: python

5790
            import paddle.fluid as fluid
5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802
            import numpy as np
            data = fluid.data(name="x", shape=[-1, 3], dtype="float32")
            label = fluid.data(name="y", shape=[-1, 3], dtype="float32")
            result = fluid.layers.smooth_l1(data,label)
            place = fluid.CPUPlace()
            exe = fluid.Executor(place)
            exe.run(fluid.default_startup_program())
            x = np.random.rand(3,3).astype("float32")
            y = np.random.rand(3,3).astype("float32")
            output= exe.run(feed={"x":x, "y":y},
                             fetch_list=[result])
            print(output)
5803

5804 5805 5806 5807
            #[array([[0.08220536],
            #       [0.36652038],
            #      [0.20541131]], dtype=float32)]

5808
    """
5809 5810
    check_variable_and_dtype(x, 'X', ['float32', 'float64'], 'smooth_l1_loss')
    check_variable_and_dtype(y, 'Y', ['float32', 'float64'], 'smooth_l1_loss')
5811

5812
    helper = LayerHelper('smooth_l1_loss', **locals())
5813

X
Xin Pan 已提交
5814 5815
    diff = helper.create_variable_for_type_inference(dtype=x.dtype)
    loss = helper.create_variable_for_type_inference(dtype=x.dtype)
5816 5817 5818 5819 5820 5821 5822 5823 5824 5825
    helper.append_op(
        type='smooth_l1_loss',
        inputs={
            'X': x,
            'Y': y,
            'InsideWeight': inside_weight,
            'OutsideWeight': outside_weight
        },
        outputs={'Diff': diff,
                 'Out': loss},
5826
        attrs={'sigma': sigma if sigma is not None else 1.0})
5827
    return loss
5828 5829


5830
def one_hot(input, depth, allow_out_of_range=False):
5831
    """
5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869

    **WARING:** This OP requires the last dimension of Tensor shape must be equal to 1.
    This OP will be deprecated in a future release. It is recommended to use fluid. :ref:`api_fluid_one_hot` .

    The operator converts each id in the input to an one-hot vector with a
    :attr:`depth` length. The value in the vector dimension corresponding to the id
    is 1, and the value in the remaining dimension is 0.

    The shape of output Tensor or LoDTensor is generated by adding :attr:`depth` dimension
    behind the last dimension of the input shape.

    .. code-block:: text

        Example 1 (allow_out_of_range=False):

        input:
            X.shape = [4, 1]
            X.data = [[1], [1], [3], [0]]
            depth = 4

        output:
            Out.shape = [4, 4]
            Out.data = [[0., 1., 0., 0.],
                        [0., 1., 0., 0.],
                        [0., 0., 0., 1.],
                        [1., 0., 0., 0.]]

        Example 2 (allow_out_of_range=True):

        input:
            X.shape = [4, 1]
            X.data = [[1], [1], [5], [0]]
            depth = 4
            allow_out_of_range = True

        output:
            Out.shape = [4, 4]
            Out.data = [[0., 1., 0., 0.],
5870
                        [0., 1., 0., 0.],
5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882
                        [0., 0., 0., 0.], # This id is 5, which goes beyond depth, so set it all-zeros data.
                        [1., 0., 0., 0.]]

        Example 3 (allow_out_of_range=False):

        input:
            X.shape = [4, 1]
            X.data = [[1], [1], [5], [0]]
            depth = 4
            allow_out_of_range = False

        output: Throw an exception for Illegal value
5883
            The second dimension in X is 5, which is greater than depth.
5884 5885
            Allow_out_of_range =False means that does not allow the word id to exceed depth,
            so it throws an exception.
5886 5887

    Args:
5888 5889 5890
        input(Variable): Tensor or LoDTensor with shape :math:`[N_1, N_2, ..., N_k, 1]` ,
            which contains at least one dimension and the last dimension must be 1.
            The data type is int32 or int64.
5891
        depth(scalar): An integer defining the :attr:`depth` of the one hot dimension. If input
5892
            is word id, depth is generally the dictionary size.
5893
        allow_out_of_range(bool): A bool value indicating whether the input
5894 5895 5896 5897
            indices could be out of range :math:`[0, depth)` . When input indices are
            out of range, exceptions :code:`Illegal value` is raised if :attr:`allow_out_of_range`
            is False, or zero-filling representations is created if it is set True.
            Default: False.
5898 5899

    Returns:
5900
        Variable: The one-hot representations of input. A Tensor or LoDTensor with type float32.
5901 5902

    Examples:
C
caoying03 已提交
5903
        .. code-block:: python
5904

5905
            import paddle.fluid as fluid
5906 5907 5908
            # Correspond to the first example above, where label.shape is [4, 1] and one_hot_label.shape is [4, 4].
            label = fluid.data(name="label", shape=[4, 1], dtype="int64")
            one_hot_label = fluid.layers.one_hot(input=label, depth=4)
5909
    """
5910
    if in_dygraph_mode():
S
songyouwei 已提交
5911 5912 5913 5914 5915
        if isinstance(depth, Variable):
            depth = depth.numpy()
            assert depth.shape == (
                1, ), "depth of type Variable should have shape [1]"
            depth = depth[0]
5916 5917 5918 5919
        out = core.ops.one_hot(input, 'depth', depth, 'allow_out_of_range',
                               allow_out_of_range)
        out.stop_gradient = True
        return out
5920

5921
    helper = LayerHelper("one_hot", **locals())
5922 5923
    check_variable_and_dtype(input, 'input', ['int32', 'int64'], 'one_hot')
    check_type(depth, 'depth', (six.integer_types, Variable), 'one_hot')
X
Xin Pan 已提交
5924
    one_hot_out = helper.create_variable_for_type_inference(dtype='float32')
5925

5926 5927
    if not isinstance(depth, Variable):
        # user attribute
5928
        inputs = {'X': input}
Y
Yi Liu 已提交
5929
        attrs = {'depth': depth, 'allow_out_of_range': allow_out_of_range}
5930
    else:
5931 5932 5933
        depth.stop_gradient = True
        inputs = {'X': input, 'depth_tensor': depth}
        attrs = {'allow_out_of_range': allow_out_of_range}
5934 5935
    helper.append_op(
        type="one_hot",
5936 5937
        inputs=inputs,
        attrs=attrs,
5938 5939
        outputs={'Out': one_hot_out})
    one_hot_out.stop_gradient = True
5940
    return one_hot_out
Y
Yu Yang 已提交
5941 5942


Y
Yu Yang 已提交
5943
def autoincreased_step_counter(counter_name=None, begin=1, step=1):
Y
Yu Yang 已提交
5944
    """
5945 5946
    :api_attr: Static Graph

5947 5948
    Create an auto-increase variable. which will be automatically increased
    by 1 in every iteration. By default, the first return of this counter is 1,
Y
Yibing Liu 已提交
5949
    and the step size is 1.
Y
Yu Yang 已提交
5950 5951

    Args:
Y
Yibing Liu 已提交
5952 5953 5954
        counter_name(str, optional): The counter name. Default '@STEP_COUNTER@'.
        begin(int, optional): The first return value of this counter. Default 1.
        step(int, optional): The step size. Default 1.
Y
Yu Yang 已提交
5955

5956
    Returns:
Y
Yibing Liu 已提交
5957
        Variable: The auto-increased Variable with data type int64.
Y
yi.wu 已提交
5958 5959 5960 5961

    Examples:
        .. code-block:: python

5962
           import paddle.fluid as fluid
Y
yi.wu 已提交
5963
           global_step = fluid.layers.autoincreased_step_counter(
Y
Yibing Liu 已提交
5964
               counter_name='@LR_DECAY_COUNTER@', begin=0, step=1)
Y
Yu Yang 已提交
5965 5966
    """
    helper = LayerHelper('global_step_counter')
Y
Yu Yang 已提交
5967 5968
    if counter_name is None:
        counter_name = '@STEP_COUNTER@'
Y
Yu Yang 已提交
5969
    counter, is_new_var = helper.create_or_get_global_variable(
H
hong 已提交
5970 5971 5972 5973 5974
        name=counter_name,
        dtype='int64',
        shape=[1],
        persistable=True,
        belong_to_optimizer=True)
Y
Yu Yang 已提交
5975 5976 5977
    if is_new_var:
        helper.set_variable_initializer(
            counter, initializer=Constant(
Y
Yu Yang 已提交
5978
                value=begin - 1, force_cpu=True))
W
Wu Yi 已提交
5979
        helper.main_program.global_block()._prepend_op(
Y
Yu Yang 已提交
5980 5981
            type='increment',
            inputs={'X': [counter]},
Y
Yu Yang 已提交
5982
            outputs={'Out': [counter]},
5983
            attrs={'step': float(step)})
Y
Yu Yang 已提交
5984 5985 5986
        counter.stop_gradient = True

    return counter
Y
yangyaming 已提交
5987 5988


5989
def reshape(x, shape, actual_shape=None, act=None, inplace=False, name=None):
C
caoying03 已提交
5990
    """
5991 5992 5993 5994
    :alias_main: paddle.reshape
	:alias: paddle.reshape,paddle.tensor.reshape,paddle.tensor.manipulation.reshape
	:old_api: paddle.fluid.layers.reshape

5995
    This operator changes the shape of ``x`` without changing its data.
C
caoying03 已提交
5996

5997 5998 5999 6000
    The target shape can be given by ``shape`` or ``actual_shape``.
    When ``shape`` and ``actual_shape`` are set at the same time,
    ``actual_shape`` has a higher priority than ``shape``
    but at this time ``shape`` can only be an integer list or tuple, and ``shape`` still should be set correctly to
T
tianshuo78520a 已提交
6001
    guarantee shape inference in compile-time.
C
caoying03 已提交
6002

6003
    Some tricks exist when specifying the target shape.
C
caoying03 已提交
6004

6005 6006 6007 6008
    1. -1 means the value of this dimension is inferred from the total element
    number of x and remaining dimensions. Thus one and only one dimension can
    be set -1.

6009
    2. 0 means the actual dimension value is going to be copied from the
T
tianshuo78520a 已提交
6010
    corresponding dimension of x. The index of 0s in shape can not exceed
6011
    the dimension of x.
6012 6013

    Here are some examples to explain it.
C
caoying03 已提交
6014 6015

    1. Given a 3-D tensor x with a shape [2, 4, 6], and the target shape
W
wanghaoshuang 已提交
6016
    is [6, 8], the reshape operator will transform x into a 2-D tensor with
6017
    shape [6, 8] and leaving x's data unchanged.
C
caoying03 已提交
6018

6019
    2. Given a 3-D tensor x with a shape [2, 4, 6], and the target shape
6020 6021
    specified is [2, 3, -1, 2], the reshape operator will transform x into a
    4-D tensor with shape [2, 3, 4, 2] and leaving x's data unchanged. In this
W
wanghaoshuang 已提交
6022 6023
    case, one dimension of the target shape is set to -1, the value of this
    dimension is inferred from the total element number of x and remaining
6024
    dimensions.
C
caoying03 已提交
6025

6026
    3. Given a 3-D tensor x with a shape [2, 4, 6], and the target shape
6027 6028 6029 6030
    is [-1, 0, 3, 2], the reshape operator will transform x into a 4-D tensor
    with shape [2, 4, 3, 2] and leaving x's data unchanged. In this case,
    besides -1, 0 means the actual dimension value is going to be copied from
    the corresponding dimension of x.
C
caoying03 已提交
6031

6032 6033
    **Note**:
        The parameter ``actual_shape`` will be deprecated in the future and only use ``shape`` instead to represent the target shape.
6034

C
caoying03 已提交
6035
    Args:
6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052
        x(Variable): A ``Tensor`` or ``LoDTensor`` . The data type is ``float32``, ``float64``, ``int32`` or ``int64``.
        shape(list|tuple|Variable): Define the target shape. At most one dimension of the target shape can be -1.
                        The data type is ``int32`` . If ``shape`` is a list or tuple, the elements of it should be integers or Tensors with shape [1].
                        If ``shape`` is an Variable, it should be an 1-D Tensor .
        actual_shape(variable, optional): An 1-D ``Tensor`` or ``LoDTensor`` . The data type is ``int32`` . If provided, reshape
                                according to this given shape rather than ``shape`` specifying shape.
                                That is to say ``actual_shape`` has a higher priority
                                than ``shape(list|tuple)`` but not ``shape(Variable)``. \
                                This argument ``actual_shape`` will be removed in a future version. \
                                Instructions for updating: ``actual_shape`` will be removed in future versions and replaced by ``shape``.
        act (str, optional): The non-linear activation to be applied to the reshaped input. Default None.
        inplace(bool, optional): If ``inplace`` is True, the input and output of ``layers.reshape``
                       are the same variable. Otherwise, the input and output of
                       ``layers.reshape`` are different variable. Default False. Note that if ``x``
                       is more than one OPs' input, ``inplace`` must be False.
        name(str, optional): The default value is None. Normally there is no need for user to set this property.
                            For more information, please refer to :ref:`api_guide_Name` .
C
caoying03 已提交
6053

6054
    Returns:
6055
        Variable: A ``Tensor`` or ``LoDTensor``. The data type is same as ``x``. It is a new tensor variable if ``inplace`` is ``False``, otherwise it is ``x``. If ``act`` is None, return the reshaped tensor variable, otherwise return the activated tensor variable.
C
caoying03 已提交
6056

X
Xin Pan 已提交
6057
    Raises:
6058 6059 6060 6061
        TypeError: If actual_shape is neither Variable nor None.
        ValueError: If more than one elements of ``shape`` is -1.
        ValueError: If the element of ``shape`` is 0, the corresponding dimension should be less than or equal to the dimension of ``x``.
        ValueError: If the elements in ``shape`` is negative except -1.
X
Xin Pan 已提交
6062

C
caoying03 已提交
6063 6064
    Examples:
        .. code-block:: python
G
guosheng 已提交
6065

6066
            import paddle.fluid as fluid
6067 6068 6069

            # example 1:
            # attr shape is a list which doesn't contain tensor Variable.
6070 6071
            data_1 = fluid.data(
              name='data_1', shape=[2, 4, 6], dtype='float32')
6072
            reshaped_1 = fluid.layers.reshape(
6073 6074
              x=data_1, shape=[-1, 0, 3, 2], inplace=True)
            # the shape of reshaped_1 is [2,4,3,2].
6075 6076 6077 6078 6079 6080

            # example 2:
            # attr shape is a list which contains tensor Variable.
            data_2 = fluid.layers.fill_constant([2,25], "int32", 3)
            dim = fluid.layers.fill_constant([1], "int32", 5)
            reshaped_2 = fluid.layers.reshape(data_2, shape=[dim, 10])
6081
            # the shape of reshaped_2 is [5,10].
M
mapingshuo 已提交
6082 6083 6084 6085 6086 6087

            # example 3:
            data_3 = fluid.data(
              name="data_3", shape=[2,4,6], dtype='float32')
            reshaped_3 = fluid.layers.reshape(x=data_3, shape=[6,8])
            # the shape of reshaped_3 is [6,8].
C
caoying03 已提交
6088
    """
6089
    if in_dygraph_mode():
L
Leo Chen 已提交
6090
        #TODO(zhiqiu): enable inplace in dygraph mode.
6091 6092 6093 6094 6095
        if inplace:
            warnings.warn(
                "Inplace on reshape is not allowed and will be discarded in dygraph mode currently."
            )
        if isinstance(shape, (list, tuple)):
6096 6097 6098 6099 6100 6101
            shape = [
                item.numpy()[0] if isinstance(item, Variable) else item
                for item in shape
            ]
            out, _ = core.ops.reshape2(x, 'shape', shape)
            return dygraph_utils._append_activation_in_dygraph(out, act)
6102

6103 6104
    check_variable_and_dtype(
        x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], 'reshape')
6105 6106
    check_type(shape, 'shape', (list, tuple, Variable), 'reshape')
    check_type(actual_shape, 'actual_shape', (Variable, type(None)), 'reshape')
6107

6108
    helper = LayerHelper("reshape2", **locals())
6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119

    def get_attr_shape(list_shape):
        unk_dim_idx = -1
        attrs_shape = []
        for dim_idx, dim_size in enumerate(list_shape):
            if isinstance(dim_size, Variable):
                attrs_shape.append(-1)
            else:
                attrs_shape.append(dim_size)
                if dim_size == -1:
                    assert unk_dim_idx == -1, (
6120 6121
                        "Only one dimension value of 'shape' in reshape can "
                        "be -1. But received shape[%d] is also -1." % dim_idx)
6122 6123 6124
                    unk_dim_idx = dim_idx
                elif dim_size == 0:
                    assert dim_idx < len(x.shape), (
6125 6126 6127 6128
                        "The index of 0 in `shape` must be less than "
                        "the input tensor X's dimensions. "
                        "But received shape[%d] = 0, X's dimensions = %d." %
                        (dim_idx, len(x.shape)))
6129 6130
                else:
                    assert dim_size > 0, (
6131
                        "Each dimension value of 'shape' in reshape must not "
T
tianshuo78520a 已提交
6132
                        "be negative except one unknown dimension. "
6133 6134
                        "But received shape[%d] = %s." %
                        (dim_idx, str(dim_size)))
6135 6136
        return attrs_shape

6137 6138 6139 6140 6141 6142 6143 6144 6145
    inputs = {"X": x}
    attrs = {}
    if isinstance(shape, Variable):
        shape.stop_gradient = True
        inputs["Shape"] = shape
    elif isinstance(shape, (list, tuple)):
        assert len(shape) > 0, ("The size of 'shape' in reshape can't be zero, "
                                "but received %s." % len(shape))
        attrs["shape"] = get_attr_shape(shape)
L
Leo Chen 已提交
6146
        if utils._contain_var(shape):
6147
            inputs['ShapeTensor'] = utils._convert_to_tensor_list(shape)
6148 6149 6150 6151 6152 6153
        elif isinstance(actual_shape, Variable):
            actual_shape.stop_gradient = True
            inputs["Shape"] = actual_shape

    out = x if inplace else helper.create_variable_for_type_inference(
        dtype=x.dtype)
X
Xin Pan 已提交
6154
    x_shape = helper.create_variable_for_type_inference(dtype=x.dtype)
C
caoying03 已提交
6155
    helper.append_op(
6156
        type="reshape2",
X
Xin Pan 已提交
6157
        inputs=inputs,
6158
        attrs=attrs,
6159 6160
        outputs={"Out": out,
                 "XShape": x_shape})
C
caoying03 已提交
6161

D
dzhwinter 已提交
6162
    return helper.append_activation(out)
6163

6164

6165
def squeeze(input, axes, name=None):
Y
Yibing Liu 已提交
6166
    """
6167 6168 6169
    This OP will squeeze single-dimensional entries of input tensor's shape. If axes is provided, will
    remove the dims by axes, the dims selected by axes should be one. If not provide axes, all dims equal
    to one will be deleted.
M
minqiyang 已提交
6170

H
haowang101779990 已提交
6171

6172
    .. code-block:: text
H
haowang101779990 已提交
6173

6174
        Case1:
H
haowang101779990 已提交
6175

6176
          Input:
H
haowang101779990 已提交
6177 6178
            X.shape = (1, 3, 1, 5)
            axes = [0]
6179
          Output:
H
haowang101779990 已提交
6180 6181
            Out.shape = (3, 1, 5)

6182
        Case2:
H
haowang101779990 已提交
6183

6184
          Input:
H
haowang101779990 已提交
6185 6186
            X.shape = (1, 3, 1, 5)
            axes = []
6187
          Output:
H
haowang101779990 已提交
6188
            Out.shape = (3, 5)
M
minqiyang 已提交
6189

6190 6191 6192 6193 6194 6195 6196 6197
        Case3:

          Input:
            X.shape = [1,3,1,5]
            axes = [-2]
          Output:
            Out.shape = [1,3,5]

Y
Yibing Liu 已提交
6198
    Args:
6199
        input (Variable): The input Tensor. Supported data type: float32, float64, bool, int8, int32, int64.
6200 6201 6202 6203
                          axes (list): One integer or List of integers, indicating the dimensions to be squeezed.
                          Axes range is :math:`[-rank(input), rank(input))`.
                          If axes is negative, :math:`axes=axes+rank(input)`.
        name (str, optional): Please refer to :ref:`api_guide_Name`, Default None.
Y
Yibing Liu 已提交
6204 6205

    Returns:
6206
        Variable: Output squeezed Tensor. Data type is same as input Tensor.
Y
Yibing Liu 已提交
6207 6208 6209 6210

    Examples:
        .. code-block:: python

6211
            import paddle.fluid as fluid
6212
            import paddle.fluid.layers as layers
6213 6214 6215 6216
            # set batch size=None
            x = fluid.data(name='x', shape=[None, 5, 1, 10])
            y = layers.squeeze(input=x, axes=[2]) # y.shape=[None, 5, 10]

Y
Yibing Liu 已提交
6217
    """
L
Leo Chen 已提交
6218 6219 6220 6221
    if in_dygraph_mode():
        out, _ = core.ops.squeeze2(input, 'axes', axes)
        return out

Y
Yibing Liu 已提交
6222
    helper = LayerHelper("squeeze", **locals())
6223 6224
    check_variable_and_dtype(
        input, 'input',
6225 6226 6227
        ['float16', 'float32', 'float64', 'bool', 'int8', 'int32', 'int64'],
        'squeeze')
    check_type(axes, 'axis/axes', (list, tuple), 'squeeze')
X
Xin Pan 已提交
6228 6229
    out = helper.create_variable_for_type_inference(dtype=input.dtype)
    x_shape = helper.create_variable_for_type_inference(dtype=input.dtype)
Y
Yibing Liu 已提交
6230
    helper.append_op(
6231
        type="squeeze2",
6232
        inputs={"X": input},
Y
Yibing Liu 已提交
6233
        attrs={"axes": axes},
6234 6235
        outputs={"Out": out,
                 "XShape": x_shape})
Y
Yibing Liu 已提交
6236

6237 6238 6239
    return out


6240
def unsqueeze(input, axes, name=None):
Y
Yibing Liu 已提交
6241
    """
6242
    Insert single-dimensional entries to the shape of a Tensor. Takes one
M
minqiyang 已提交
6243 6244
    required argument axes, a list of dimensions that will be inserted.
    Dimension indices in axes are as seen in the output tensor.
Y
Yibing Liu 已提交
6245

M
minqiyang 已提交
6246
    For example:
H
haowang101779990 已提交
6247 6248 6249

    .. code-block:: text

M
minqiyang 已提交
6250
      Given a tensor such that tensor with shape [3, 4, 5],
Y
Yibing Liu 已提交
6251
      then Unsqueezed tensor with axes=[0, 4] has shape [1, 3, 4, 5, 1].
M
minqiyang 已提交
6252

Y
Yibing Liu 已提交
6253
    Args:
6254
        input (Variable): The input Tensor to be unsqueezed. Supported data type: float32, float64, bool, int8, int32, int64.
6255
        axes (int|list|tuple|Variable): Indicates the dimensions to be inserted. The data type is ``int32`` . If ``axes`` is a list or tuple, the elements of it should be integers or Tensors with shape [1]. If ``axes`` is an Variable, it should be an 1-D Tensor .
6256
        name (str|None): Name for this layer.
Y
Yibing Liu 已提交
6257 6258

    Returns:
6259
        Variable: Unsqueezed Tensor, with the same data type as input.
Y
Yibing Liu 已提交
6260 6261 6262 6263

    Examples:
        .. code-block:: python

6264 6265 6266
            import paddle.fluid as fluid
            x = fluid.layers.data(name='x', shape=[5, 10])
            y = fluid.layers.unsqueeze(input=x, axes=[1])
6267

Y
Yibing Liu 已提交
6268
    """
6269 6270 6271 6272 6273 6274 6275 6276 6277
    if in_dygraph_mode():
        out, _ = core.ops.unsqueeze2(input, 'axes', axes)
        return out

    check_type(axes, 'axis/axes', (int, list, tuple, Variable), 'unsqueeze')
    check_variable_and_dtype(
        input, 'input',
        ['float16', 'float32', 'float64', 'bool', 'int8', 'int32', 'int64'],
        'unsqueeze')
6278 6279 6280 6281 6282 6283 6284 6285 6286 6287
    helper = LayerHelper("unsqueeze2", **locals())
    inputs = {"X": input}
    attrs = {}

    if isinstance(axes, int):
        axes = [axes]
    if isinstance(axes, Variable):
        axes.stop_gradient = True
        inputs["AxesTensor"] = axes
    elif isinstance(axes, (list, tuple)):
L
Leo Chen 已提交
6288
        if utils._contain_var(axes):
6289
            inputs["AxesTensorList"] = utils._convert_to_tensor_list(axes)
6290 6291 6292
        else:
            attrs["axes"] = axes

X
Xin Pan 已提交
6293 6294
    out = helper.create_variable_for_type_inference(dtype=input.dtype)
    x_shape = helper.create_variable_for_type_inference(dtype=input.dtype)
Y
Yibing Liu 已提交
6295
    helper.append_op(
6296
        type="unsqueeze2",
6297 6298
        inputs=inputs,
        attrs=attrs,
6299 6300
        outputs={"Out": out,
                 "XShape": x_shape})
Y
Yibing Liu 已提交
6301

6302 6303
    return out

6304

Y
yangyaming 已提交
6305
def lod_reset(x, y=None, target_lod=None):
Y
yangyaming 已提交
6306
    """
Y
Yibing Liu 已提交
6307
    Set LoD of :attr:`x` to a new one specified by :attr:`y` or
6308 6309 6310 6311
    :attr:`target_lod`. When :attr:`y` provided, :attr:`y.lod` would be
    considered as target LoD first, otherwise :attr:`y.data` would be
    considered as target LoD. If :attr:`y` is not provided, target LoD should
    be specified by :attr:`target_lod`. If target LoD is specified by
6312
    :attr:`y.data` or :attr:`target_lod`, only one level LoD is supported.
Y
yangyaming 已提交
6313 6314 6315 6316 6317 6318

    .. code-block:: text

        * Example 1:

            Given a 1-level LoDTensor x:
6319
                x.lod =  [[ 2,           3,                   1 ]]
Y
yangyaming 已提交
6320 6321 6322
                x.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                x.dims = [6, 1]

6323
            target_lod: [4, 2]
Y
yangyaming 已提交
6324 6325

            then we get a 1-level LoDTensor:
6326
                out.lod =  [[4,                          2]]
Y
yangyaming 已提交
6327 6328 6329 6330 6331 6332
                out.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                out.dims = [6, 1]

        * Example 2:

            Given a 1-level LoDTensor x:
6333
                x.lod =  [[2,            3,                   1]]
Y
yangyaming 已提交
6334 6335 6336 6337
                x.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                x.dims = [6, 1]

            y is a Tensor:
6338
                y.data = [[2, 4]]
Y
yangyaming 已提交
6339 6340 6341
                y.dims = [1, 3]

            then we get a 1-level LoDTensor:
6342
                out.lod =  [[2,            4]]
Y
yangyaming 已提交
6343 6344 6345 6346 6347 6348
                out.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                out.dims = [6, 1]

        * Example 3:

            Given a 1-level LoDTensor x:
6349
                x.lod =  [[2,            3,                   1]]
Y
yangyaming 已提交
6350 6351 6352 6353
                x.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                x.dims = [6, 1]

            y is a 2-level LoDTensor:
6354
                y.lod =  [[2, 2], [2, 2, 1, 1]]
Y
yangyaming 已提交
6355 6356 6357 6358
                y.data = [[1.1], [2.1], [3.1], [4.1], [5.1], [6.1]]
                y.dims = [6, 1]

            then we get a 2-level LoDTensor:
6359
                out.lod =  [[2, 2], [2, 2, 1, 1]]
Y
yangyaming 已提交
6360 6361 6362 6363
                out.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                out.dims = [6, 1]

    Args:
6364 6365 6366 6367 6368 6369
        x (Variable): Input variable which could be a Tensor or LoDTensor. 
                      The data type should be int32, int64, float32 or float64.
        y (Variable, optional): If provided, output's LoD would be derived from :attr:`y`. 
                                If y's lod level>0, the data type can be any type. 
                                If y's lod level=0, the data type should be int32.
        target_lod (list|tuple, optional): One level LoD which should be considered
Y
Yibing Liu 已提交
6370
                                      as target LoD when :attr:`y` not provided.
Y
yangyaming 已提交
6371 6372

    Returns:
Y
Yibing Liu 已提交
6373
        Variable: Output variable with LoD specified by this layer.
Y
yangyaming 已提交
6374 6375

    Raises:
Y
Yibing Liu 已提交
6376
        ValueError: If :attr:`y` and :attr:`target_lod` are both None.
Y
yangyaming 已提交
6377 6378 6379 6380

    Examples:
        .. code-block:: python

6381
            import paddle.fluid as fluid
6382 6383 6384
            x = fluid.layers.data(name='x', shape=[10])
            y = fluid.layers.data(name='y', shape=[10, 20], lod_level=2)
            out = fluid.layers.lod_reset(x=x, y=y)
Y
yangyaming 已提交
6385
    """
6386 6387
    check_variable_and_dtype(x, 'x', ['float32', 'float64', 'int32', 'int64'],
                             'lod_reset')
Y
yangyaming 已提交
6388
    helper = LayerHelper("lod_reset", **locals())
X
Xin Pan 已提交
6389
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
Y
yangyaming 已提交
6390
    if y is not None:
6391
        check_type(y, 'y', (Variable), 'lod_reset')
G
GaoWei8 已提交
6392
        #TODO: check y.lod_level = 0 dtype
Y
yangyaming 已提交
6393 6394 6395 6396 6397 6398 6399 6400 6401 6402
        helper.append_op(
            type="lod_reset", inputs={'X': x,
                                      'Y': y}, outputs={'Out': out})
    elif target_lod is not None:
        helper.append_op(
            type="lod_reset",
            inputs={'X': x},
            attrs={'target_lod': target_lod},
            outputs={'Out': out})
    else:
6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427
        raise ValueError("y and target_lod should not be both none.")
    return out


def lod_append(x, level):
    """
    Append level to LoD of :attr:`x`.

    .. code-block:: text

        * Example 1:

            given a 1-level LoDTensor x:
                x.lod =  [[ 2,           3,                   1 ]]
                x.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                x.dims = [6, 1]

            level: [1, 1, 1, 1, 1, 1, 1]

            then we get a 2-level LoDTensor:
                x.lod =  [[ 2, 3, 1 ], [1, 1, 1, 1, 1, 1]]
                x.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                x.dims = [6, 1]

    Args:
6428 6429 6430 6431 6432
        x (Variable): Input variable which could be a tensor or LoDTensor. 
                      The data type should be int32, int64, float32 or float64.
        level (list|tuple|Variable, optional): The LoD level to be appended into LoD of x. 
                                               If level is variable and its lod level>0, the data type can be any type.
                                               If level is variable and its lod level=0, the data type should be int32.
6433 6434 6435 6436 6437
    Returns:
        Variable: Output variable with new LoD level.

    Raises:
        ValueError: If :attr:`y` is None or and :attr:`level` is not Iterator.
Y
yangyaming 已提交
6438

6439 6440 6441 6442 6443 6444 6445 6446 6447 6448
    Examples:
        .. code-block:: python

            import paddle.fluid as fluid
            x = fluid.layers.data(name='x', shape=[6, 10], lod_level=1)
            out = fluid.layers.lod_append(x, [1,1,1,1,1,1])
    """
    from collections import Iterable
    if x is None:
        raise ValueError("Input(x) can't be None.")
6449 6450 6451
    if (not isinstance(level, Iterable)) and (not isinstance(level, Variable)):
        raise ValueError("Input(level) must be list, tuple or Variable.")

6452 6453 6454
    check_variable_and_dtype(x, 'x', ['float32', 'float64', 'int32', 'int64'],
                             'lod_append')

6455 6456
    helper = LayerHelper("lod_append", **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
6457 6458 6459 6460 6461 6462

    inputs = {'X': x}
    attrs = {'append': True}

    if isinstance(level, Variable):
        inputs['Y'] = level
G
GaoWei8 已提交
6463
        #TODO: check y.lod_level = 0 dtype
6464 6465
    else:
        attrs['target_lod'] = level
6466
    helper.append_op(
6467
        type="lod_reset", inputs=inputs, attrs=attrs, outputs={'Out': out})
Y
yangyaming 已提交
6468
    return out
D
dragonwarrior 已提交
6469 6470


6471 6472
def lrn(input, n=5, k=1.0, alpha=1e-4, beta=0.75, name=None,
        data_format='NCHW'):
D
dragonwarrior 已提交
6473
    """
6474 6475 6476 6477
    :alias_main: paddle.nn.functional.lrn
	:alias: paddle.nn.functional.lrn,paddle.nn.functional.norm.lrn
	:old_api: paddle.fluid.layers.lrn

6478 6479 6480
    This operator implements the Local Response Normalization Layer.
    This layer performs a type of "lateral inhibition" by normalizing over local input regions.
    For more information, please refer to `ImageNet Classification with Deep Convolutional Neural Networks <https://papers.nips.cc/paper/4824-imagenet-classification-with-deep-convolutional-neural-networks.pdf>`_
D
dragonwarrior 已提交
6481 6482 6483 6484 6485

    The formula is as follows:

    .. math::

6486
        Output(i, x, y) = Input(i, x, y) / \\left(k + \\alpha \\sum\\limits^{\\min(C-1, i + n/2)}_{j = \\max(0, i - n/2)}(Input(j, x, y))^2\\right)^{\\beta}
D
dragonwarrior 已提交
6487 6488 6489

    In the above equation:

6490 6491 6492 6493
    - :math:`n` : The number of channels to sum over.
    - :math:`k` : The offset (avoid being divided by 0).
    - :math:`\\alpha` : The scaling parameter.
    - :math:`\\beta` : The exponent parameter.
D
dragonwarrior 已提交
6494 6495 6496


    Args:
6497 6498
        input (Variable): Input feature, 4D-Tensor with the shape of [N,C,H,W] or [N, H, W, C],
            where N is the batch size, C is the input channel, H is Height, W is weight. The data
6499
            type is float32. The rank of this tensor must be 4, otherwise it will raise ValueError.
6500 6501 6502 6503
        n (int, optional): The number of channels to sum over. Default: 5
        k (float, optional): An offset, positive. Default: 1.0
        alpha (float, optional): The scaling parameter, positive. Default:1e-4
        beta (float, optional): The exponent, positive. Default:0.75
6504 6505 6506
        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`
        data_format (str, optional): Specify the data format of the input, and the data format of the output
6507 6508 6509
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_height, input_width]`.
6510

D
dragonwarrior 已提交
6511
    Returns:
6512 6513
        Variable: A tensor variable storing the transformation result with the same shape and data type as input.

D
dragonwarrior 已提交
6514 6515 6516

    Examples:

6517 6518 6519 6520 6521 6522 6523 6524
    .. code-block:: python

        import paddle.fluid as fluid
        data = fluid.data(
            name="data", shape=[None, 3, 112, 112], dtype="float32")
        lrn = fluid.layers.lrn(input=data)
        print(lrn.shape)  # [-1, 3, 112, 112]
        print(lrn.dtype)  # float32
D
dragonwarrior 已提交
6525 6526
    """
    helper = LayerHelper('lrn', **locals())
6527
    check_variable_and_dtype(input, 'input', ['float32'], 'lrn')
D
dragonwarrior 已提交
6528 6529 6530 6531 6532 6533
    dtype = helper.input_dtype()
    input_shape = input.shape
    dims = len(input_shape)

    if dims != 4:
        raise ValueError(
6534
            "Input's dimension size of Op(lrn) must be 4, but received %d." %
D
dragonwarrior 已提交
6535
            (dims))
6536 6537 6538 6539
    if data_format not in ['NCHW', 'NHWC']:
        raise ValueError(
            "Attr(data_format) of Op(lrn) got wrong value: received " +
            data_format + " but only NCHW or NHWC supported.")
D
dragonwarrior 已提交
6540

X
Xin Pan 已提交
6541 6542 6543
    mid_out = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)
    lrn_out = helper.create_variable_for_type_inference(dtype)
D
dragonwarrior 已提交
6544 6545 6546 6547 6548 6549 6550
    helper.append_op(
        type="lrn",
        inputs={"X": input},
        outputs={
            "Out": lrn_out,
            "MidOut": mid_out,
        },
6551 6552 6553 6554 6555 6556 6557
        attrs={
            "n": n,
            "k": k,
            "alpha": alpha,
            "beta": beta,
            "data_format": data_format
        })
D
dragonwarrior 已提交
6558 6559

    return lrn_out
G
guosheng 已提交
6560 6561 6562 6563


def pad(x, paddings, pad_value=0., name=None):
    """
6564 6565 6566 6567
    :alias_main: paddle.nn.functional.pad
	:alias: paddle.nn.functional.pad,paddle.nn.functional.common.pad
	:old_api: paddle.fluid.layers.pad

S
SunGaofeng 已提交
6568 6569
    This op will pad a tensor with a constant value given by :attr:`pad_value`, and the
    padded shape is specified by :attr:`paddings`.
G
guosheng 已提交
6570

S
SunGaofeng 已提交
6571 6572 6573 6574
    Specifically, the number of values padded before the elements of :attr:`x`
    in dimension :attr:`i` is indicated by :attr:`paddings[2*i]`, and the number
    of values padded after the elements of :attr:`x` in dimension :attr:`i` is
    indicated by :attr:`paddings[2*i+1]`.
G
guosheng 已提交
6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592

    See below for an example.

    .. code-block:: text

        Given:
            x = [[1, 2], [3, 4]]

            paddings = [0, 1, 1, 2]

            pad_value = 0

        Return:
            out = [[0, 1, 2, 0, 0]
                   [0, 3, 4, 0, 0]
                   [0, 0, 0, 0, 0]]

    Args:
S
SunGaofeng 已提交
6593
        x (Variable): Tensor, data type is float32.
G
guosheng 已提交
6594
        paddings (list): A list of integers. Its elements specify the padded
S
SunGaofeng 已提交
6595
                         width before and after each dimension in turn.
6596
                         The length of :attr:`paddings` must be equal to
G
guosheng 已提交
6597 6598
                         :math:`rank(x) \\times 2`.
        pad_value (float): The constant value used to pad.
6599 6600
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
6601
                             For more information, please refer to :ref:`api_guide_Name`
G
guosheng 已提交
6602 6603

    Returns:
S
SunGaofeng 已提交
6604 6605 6606 6607
        The padded tensor, with the same data type and rank as :attr:`x`

    Return Type:
        Variable
G
guosheng 已提交
6608 6609 6610

    Examples:
        .. code-block:: python
G
guosheng 已提交
6611

6612
            # x is a rank 2 tensor variable
S
SunGaofeng 已提交
6613
            import paddle.fluid as fluid
6614 6615
            x = fluid.data(name='data', shape=[300, 300], dtype='float32')
            out = fluid.layers.pad(x=x, paddings=[0, 1, 1, 2], pad_value=0.)
G
guosheng 已提交
6616
    """
6617 6618 6619
    check_variable_and_dtype(
        x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], "pad")

G
guosheng 已提交
6620 6621
    helper = LayerHelper('pad', input=x, **locals())
    dtype = helper.input_dtype()
X
Xin Pan 已提交
6622
    out = helper.create_variable_for_type_inference(dtype)
G
guosheng 已提交
6623 6624 6625 6626 6627 6628 6629
    helper.append_op(
        type='pad',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'paddings': paddings,
               'pad_value': float(pad_value)})
    return out
6630 6631


C
chengduo 已提交
6632 6633
def pad_constant_like(x, y, pad_value=0., name=None):
    """
S
SunGaofeng 已提交
6634
    Pad :attr:`y` with :attr:`pad_value`, the number of values padded to
C
chengduo 已提交
6635
    the edges of each axis is specified by the difference of the shape
S
SunGaofeng 已提交
6636 6637
    of :attr:`x` and :attr:`y` . ((0, shape_x_0 - shape_y_0), ... (0, shape_x_n - shape_y_n))
    specify padding widths for each axis. The input should be a k-D tensor(k > 0 and k < 7).
C
chengduo 已提交
6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655

    See below for an example.

    .. code-block:: text

        Given:
            X = [[[[ 0,  1,  2],
                   [ 3,  4,  5]],
                  [[ 6,  7,  8],
                   [ 9, 10, 11]],
                  [[12, 13, 14],
                   [15, 16, 17]]],
                 [[[18, 19, 20],
                   [21, 22, 23]],
                  [[24, 25, 26],
                   [27, 28, 29]],
                  [[30, 31, 32],
                   [33, 34, 35]]]]
6656

C
chengduo 已提交
6657 6658 6659 6660 6661
            X.shape = (2, 3, 2, 3)

            Y = [[[[35, 36, 37]],
                  [[38, 39, 40]],
                  [[41, 42, 43]]]]
6662

C
chengduo 已提交
6663
            Y.shape = (1, 3, 1, 3)
6664 6665 6666

        And
            pad_value = 0.
C
chengduo 已提交
6667

T
Tink_Y 已提交
6668 6669
        Return:
            Out = [[[[35, 36, 37],
6670
                     [ 0,  0,  0]],
T
Tink_Y 已提交
6671
                    [[38, 39, 40],
6672
                     [ 0,  0,  0]],
T
Tink_Y 已提交
6673
                    [[41, 42, 43],
6674
                     [ 0,  0,  0]]],
6675
                   [[[ 0,  0,  0],
6676
                     [ 0,  0,  0]],
6677
                    [[ 0,  0,  0],
6678
                     [ 0,  0,  0]],
6679
                    [[ 0,  0,  0],
6680 6681 6682 6683
                     [ 0,  0,  0]]]]

            Out.shape = [2, 3, 2, 3]

C
chengduo 已提交
6684 6685

    Args:
T
tianshuo78520a 已提交
6686
        x (Variable): Tensor, its shape specifies the shape of output.
6687
        y (Variable): Tensor, its rank is the same with :attr:`x`, and for each dimension :math:`i` ,
S
SunGaofeng 已提交
6688
                      :math:`y\_shape[i] <= x\_shape[i]` . The data type can be float32 or float64.
C
chengduo 已提交
6689
        pad_value (float): The constant value used to pad.
6690 6691
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
6692
                             For more information, please refer to :ref:`api_guide_Name`
C
chengduo 已提交
6693 6694

    Returns:
S
SunGaofeng 已提交
6695 6696 6697 6698
        The padded tensor, with the same shape as :attr:`x` and the same data type as :attr:`y`

    Return Type:
        Variable
C
chengduo 已提交
6699 6700 6701 6702 6703 6704

    Examples:
        .. code-block:: python

            # x is a rank 4 tensor variable, x.shape = (2, 3, 2, 3)
            # y is a rank 4 tensor variable, y.shape = (1, 3, 1, 3)
S
SunGaofeng 已提交
6705
            import paddle.fluid as fluid
S
SunGaofeng 已提交
6706 6707
            x = fluid.data(name='x', shape=[2,3,2,3], dtype='float32')
            y = fluid.data(name='y', shape=[1,3,1,3], dtype='float32')
C
chengduo 已提交
6708 6709 6710
            out = fluid.layers.pad_constant_like(x=x, y=y, pad_value=0.)
            # out is a rank 4 tensor variable, and out.shape = [2, 3 ,2 , 3]
    """
6711 6712 6713 6714
    check_type(x, 'x', (Variable), 'pad_constant_like')
    check_variable_and_dtype(y, 'y', ['float32', 'float64', 'int32', 'int64'],
                             "pad_constant_like")

C
chengduo 已提交
6715 6716
    helper = LayerHelper('pad_constant_like', input=x, **locals())
    dtype = helper.input_dtype()
X
Xin Pan 已提交
6717
    out = helper.create_variable_for_type_inference(dtype)
C
chengduo 已提交
6718 6719 6720 6721 6722 6723 6724 6725 6726
    helper.append_op(
        type='pad_constant_like',
        inputs={'X': x,
                'Y': y},
        outputs={'Out': out},
        attrs={'pad_value': float(pad_value)})
    return out


6727 6728 6729 6730 6731 6732
def label_smooth(label,
                 prior_dist=None,
                 epsilon=0.1,
                 dtype="float32",
                 name=None):
    """
6733 6734 6735 6736
    :alias_main: paddle.nn.functional.label_smooth
	:alias: paddle.nn.functional.label_smooth,paddle.nn.functional.common.label_smooth
	:old_api: paddle.fluid.layers.label_smooth

6737 6738
    Label smoothing is a mechanism to regularize the classifier layer and is called
    label-smoothing regularization (LSR).
6739

6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756
    Label smoothing is proposed to encourage the model to be less confident,
    since optimizing the log-likelihood of the correct label directly may
    cause overfitting and reduce the ability of the model to adapt. Label
    smoothing replaces the ground-truth label :math:`y` with the weighted sum
    of itself and some fixed distribution :math:`\mu`. For class :math:`k`,
    i.e.

    .. math::

        \\tilde{y_k} = (1 - \epsilon) * y_k + \epsilon * \mu_k,

    where :math:`1 - \epsilon` and :math:`\epsilon` are the weights
    respectively, and :math:`\\tilde{y}_k` is the smoothed label. Usually
    uniform distribution is used for :math:`\mu`.

    See more details about label smoothing in https://arxiv.org/abs/1512.00567.

D
DuYao 已提交
6757
    Parameters:
6758
        label(Variable): The input variable containing the label data. The
6759 6760
                        label data should use one-hot representation. It's
                        a multidimensional tensor with a shape of
6761
                        :math:`[N_1, ..., Depth]`, where Depth is class number. The dtype can be "float32" and "float64".
D
DuYao 已提交
6762 6763 6764 6765 6766
        prior_dist(Variable, optional): The prior distribution to be used to smooth
                        labels. If not provided, an uniform distribution
                        is used. It's a multidimensional tensor with a shape of
                        :math:`[1, class\_num]` . The default value is None.
        epsilon(float, optional): The weight used to mix up the original ground-truth
6767
                        distribution and the fixed distribution. The default value is
D
DuYao 已提交
6768 6769 6770
                        0.1.
        dtype(np.dtype|core.VarDesc.VarType|str, optional): The data type can be set
                        as 'float32', 'float64'. The default value is 'float32'.
6771 6772
        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
D
DuYao 已提交
6773
                        :ref:`api_guide_Name`.
6774 6775 6776 6777 6778 6779

    Returns:
        Variable: The tensor variable containing the smoothed labels.

    Examples:
        .. code-block:: python
6780

6781
            import paddle.fluid as fluid
6782
            import paddle.fluid.layers as layers
6783

6784
            label = layers.data(name="label", shape=[1], dtype="int32")
6785 6786 6787 6788 6789 6790
            one_hot_label = layers.one_hot(input=label, depth=10)
            smooth_label = layers.label_smooth(
                label=one_hot_label, epsilon=0.1, dtype="float32")
    """
    if epsilon > 1. or epsilon < 0.:
        raise ValueError("The value of epsilon must be between 0 and 1.")
6791 6792

    if in_dygraph_mode():
6793 6794
        return core.ops.label_smooth(label, prior_dist, 'epsilon',
                                     float(epsilon))
6795

6796 6797 6798
    check_variable_and_dtype(label, 'label', ['float32', 'float64'],
                             'label_smooth')

6799 6800
    helper = LayerHelper("label_smooth", **locals())
    label.stop_gradient = True
X
Xin Pan 已提交
6801
    smooth_label = helper.create_variable_for_type_inference(dtype)
6802 6803 6804 6805 6806 6807 6808
    helper.append_op(
        type="label_smooth",
        inputs={"X": label,
                "PriorDist": prior_dist} if prior_dist else {"X": label},
        outputs={"Out": smooth_label},
        attrs={"epsilon": float(epsilon)})
    return smooth_label
6809 6810


W
wopeizl 已提交
6811
@templatedoc()
F
FDInSky 已提交
6812 6813 6814 6815 6816 6817
def roi_pool(input,
             rois,
             pooled_height=1,
             pooled_width=1,
             spatial_scale=1.0,
             rois_lod=None):
W
wopeizl 已提交
6818
    """
6819 6820 6821 6822
    :alias_main: paddle.nn.functional.roi_pool
	:alias: paddle.nn.functional.roi_pool,paddle.nn.functional.vision.roi_pool
	:old_api: paddle.fluid.layers.roi_pool

6823
    This operator implements the roi_pooling layer.
6824
    Region of interest pooling (also known as RoI pooling) is to perform max pooling on inputs of nonuniform sizes to obtain fixed-size feature maps (e.g. 7*7).
6825

6826
    The operator has three steps:
6827

6828 6829 6830
        1. Dividing each region proposal into equal-sized sections with the pooled_width and pooled_height;
        2. Finding the largest value in each section;
        3. Copying these max values to the output buffer.
6831

6832
    For more information, please refer to https://stackoverflow.com/questions/43430056/what-is-roi-layer-in-fast-rcnn
6833

W
wopeizl 已提交
6834
    Args:
6835 6836
        input (Variable): Input feature, 4D-Tensor with the shape of [N,C,H,W], where N is the batch size, C is the input channel, H is Height, W is weight. The data type is float32 or float64.
        rois (Variable): ROIs (Regions of Interest) to pool over. 2D-LoDTensor with the shape of [num_rois,4], the lod level is 1. Given as [[x1, y1, x2, y2], ...], (x1, y1) is the top left coordinates, and (x2, y2) is the bottom right coordinates.
F
FDInSky 已提交
6837
        rois_lod (Variable): The lod info of rois. Default: None
6838 6839 6840
        pooled_height (int, optional): The pooled output height, data type is int32. Default: 1
        pooled_width (int, optional): The pooled output height, data type is int32. Default: 1
        spatial_scale (float, optional): Multiplicative spatial scale factor to translate ROI coords from their input scale to the scale used when pooling. Default: 1.0
6841

W
wopeizl 已提交
6842
    Returns:
6843
        Variable: The pooled feature, 4D-Tensor with the shape of [num_rois, C, pooled_height, pooled_width].
6844 6845


W
wopeizl 已提交
6846
    Examples:
6847

6848
    ..  code-block:: python
6849

6850 6851
        import paddle.fluid as fluid
        import numpy as np
6852

6853
        DATATYPE='float32'
6854

6855 6856
        place = fluid.CPUPlace()
        #place = fluid.CUDAPlace(0)
6857

6858 6859
        input_data = np.array([i for i in range(1,17)]).reshape(1,1,4,4).astype(DATATYPE)
        roi_data =fluid.create_lod_tensor(np.array([[1., 1., 2., 2.], [1.5, 1.5, 3., 3.]]).astype(DATATYPE),[[2]], place)
F
FDInSky 已提交
6860 6861
        rois_lod_data = np.array([0, 2])

6862 6863
        x = fluid.data(name='input', shape=[None,1,4,4], dtype=DATATYPE)
        rois = fluid.data(name='roi', shape=[None,4], dtype=DATATYPE)
6864
        rois_lod = fluid.data(name='rois_lod', shape=[None], dtype='int64')
F
FDInSky 已提交
6865

6866
        pool_out = fluid.layers.roi_pool(
6867 6868
                input=x,
                rois=rois,
6869 6870
                pooled_height=1,
                pooled_width=1,
F
FDInSky 已提交
6871 6872
                spatial_scale=1.0,
                rois_lod=rois_lod)
6873

6874
        exe = fluid.Executor(place)
F
FDInSky 已提交
6875
        out, = exe.run(feed={'input':input_data ,'roi':roi_data, 'rois_lod': rois_lod_data}, fetch_list=[pool_out.name])
6876 6877
        print(out)   #array([[[[11.]]], [[[16.]]]], dtype=float32)
        print(np.array(out).shape)  # (2, 1, 1, 1)
W
wopeizl 已提交
6878
    """
6879 6880
    check_variable_and_dtype(input, 'input', ['float32'], 'roi_pool')
    check_variable_and_dtype(rois, 'rois', ['float32'], 'roi_pool')
W
wopeizl 已提交
6881 6882 6883 6884 6885 6886 6887
    helper = LayerHelper('roi_pool', **locals())
    dtype = helper.input_dtype()
    pool_out = helper.create_variable_for_type_inference(dtype)
    argmaxes = helper.create_variable_for_type_inference(dtype='int32')
    helper.append_op(
        type="roi_pool",
        inputs={"X": input,
F
FDInSky 已提交
6888 6889
                "ROIs": rois,
                "RoisLod": rois_lod},
W
wopeizl 已提交
6890 6891 6892 6893 6894 6895 6896 6897
        outputs={"Out": pool_out,
                 "Argmax": argmaxes},
        attrs={
            "pooled_height": pooled_height,
            "pooled_width": pooled_width,
            "spatial_scale": spatial_scale
        })
    return pool_out
W
whs 已提交
6898 6899


J
jerrywgz 已提交
6900 6901 6902 6903 6904 6905
@templatedoc()
def roi_align(input,
              rois,
              pooled_height=1,
              pooled_width=1,
              spatial_scale=1.0,
J
jerrywgz 已提交
6906
              sampling_ratio=-1,
F
FDInSky 已提交
6907 6908
              name=None,
              rois_lod=None):
J
jerrywgz 已提交
6909
    """
6910 6911 6912 6913
    :alias_main: paddle.nn.functional.roi_align
	:alias: paddle.nn.functional.roi_align,paddle.nn.functional.vision.roi_align
	:old_api: paddle.fluid.layers.roi_align

J
jerrywgz 已提交
6914 6915 6916 6917
    ${comment}

    Args:
        input (Variable): ${x_comment}
6918
        rois (Variable): ROIs (Regions of Interest) to pool over.It should be
6919 6920
            a 2-D LoDTensor of shape (num_rois, 4), the lod level is 1. The
            data type is float32 or float64. Given as [[x1, y1, x2, y2], ...],
W
wangguanzhong 已提交
6921
            (x1, y1) is the top left coordinates, and (x2, y2) is the bottom
F
FDInSky 已提交
6922 6923
            right coordinates.
        rois_lod (Variable): The lod info of rois. Default: None
W
wangguanzhong 已提交
6924 6925 6926 6927
        pooled_height (int32, optional): ${pooled_height_comment} Default: 1
        pooled_width (int32, optional): ${pooled_width_comment} Default: 1
        spatial_scale (float32, optional): ${spatial_scale_comment} Default: 1.0
        sampling_ratio(int32, optional): ${sampling_ratio_comment} Default: -1
6928 6929 6930
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name`. Usually name is no need to set and
            None by default.
J
jerrywgz 已提交
6931 6932

    Returns:
W
wangguanzhong 已提交
6933 6934 6935 6936 6937
        Variable:

        Output: ${out_comment}.


J
jerrywgz 已提交
6938 6939 6940
    Examples:
        .. code-block:: python

6941
            import paddle.fluid as fluid
6942 6943 6944 6945
            x = fluid.data(
                name='data', shape=[None, 256, 32, 32], dtype='float32')
            rois = fluid.data(
                name='rois', shape=[None, 4], dtype='float32')
F
FDInSky 已提交
6946
            rois_lod = fluid.data(name='rois_lod', shape=[None], dtype='int64')
6947 6948 6949
            align_out = fluid.layers.roi_align(input=x,
                                               rois=rois,
                                               pooled_height=7,
J
jerrywgz 已提交
6950 6951
                                               pooled_width=7,
                                               spatial_scale=0.5,
F
FDInSky 已提交
6952 6953
                                               sampling_ratio=-1,
                                               rois_lod=rois_lod)
J
jerrywgz 已提交
6954
    """
6955 6956 6957
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'roi_align')
    check_variable_and_dtype(rois, 'rois', ['float32', 'float64'], 'roi_align')
J
jerrywgz 已提交
6958 6959
    helper = LayerHelper('roi_align', **locals())
    dtype = helper.input_dtype()
X
Xin Pan 已提交
6960
    align_out = helper.create_variable_for_type_inference(dtype)
J
jerrywgz 已提交
6961 6962 6963
    helper.append_op(
        type="roi_align",
        inputs={"X": input,
F
FDInSky 已提交
6964 6965
                "ROIs": rois,
                "RoisLod": rois_lod},
J
jerrywgz 已提交
6966 6967 6968 6969 6970 6971 6972 6973 6974 6975
        outputs={"Out": align_out},
        attrs={
            "pooled_height": pooled_height,
            "pooled_width": pooled_width,
            "spatial_scale": spatial_scale,
            "sampling_ratio": sampling_ratio
        })
    return align_out


S
SunGaofeng 已提交
6976
def dice_loss(input, label, epsilon=0.00001, name=None):
W
whs 已提交
6977
    """
6978 6979 6980 6981
    :alias_main: paddle.nn.functional.dice_loss
	:alias: paddle.nn.functional.dice_loss,paddle.nn.functional.loss.dice_loss
	:old_api: paddle.fluid.layers.dice_loss

S
SunGaofeng 已提交
6982 6983 6984 6985
    Dice loss for comparing the similarity between the input predictions and the label.
    This implementation is for binary classification, where the input is sigmoid
    predictions of each pixel, usually used for segmentation task. The dice loss can
    be defined as the following equation:
W
whs 已提交
6986 6987 6988 6989 6990 6991 6992 6993

    .. math::

        dice\_loss &= 1 - \\frac{2 * intersection\_area}{total\_area} \\\\
                  &= \\frac{(total\_area - intersection\_area) - intersection\_area}{total\_area} \\\\
                  &= \\frac{(union\_area - intersection\_area)}{total\_area}


S
SunGaofeng 已提交
6994 6995 6996 6997
    Parameters:
        input (Variable): Tensor, rank>=2, shape is :math:`[N_1, N_2, ..., N_D]`, where :math:`N_1` is
                          the batch_size, :math:`N_D` is 1. It is usually the output predictions of sigmoid activation.
                          The data type can be float32 or float64.
6998
        label (Variable): Tensor, the groud truth with the same rank as input, shape is :math:`[N_1, N_2, ..., N_D]`.
S
SunGaofeng 已提交
6999
                          where :math:`N_1` is the batch_size, :math:`N_D` is 1. The data type can be float32 or float64.
W
whs 已提交
7000 7001 7002
        epsilon (float): The epsilon will be added to the numerator and denominator.
                         If both input and label are empty, it makes sure dice is 1.
                         Default: 0.00001
7003 7004
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
7005
                             For more information, please refer to :ref:`api_guide_Name`
W
whs 已提交
7006 7007

    Returns:
S
SunGaofeng 已提交
7008 7009 7010
        The dice loss with shape [1], data type is the same as `input` .
    Return Type:
        Varaible
W
whs 已提交
7011

S
SunGaofeng 已提交
7012
    Example:
7013 7014
        .. code-block:: python

S
SunGaofeng 已提交
7015
            import paddle.fluid as fluid
S
SunGaofeng 已提交
7016 7017 7018
            x = fluid.data(name='data', shape = [3, 224, 224, 1], dtype='float32')
            label = fluid.data(name='label', shape=[3, 224, 224, 1], dtype='float32')
            predictions = fluid.layers.sigmoid(x)
S
SunGaofeng 已提交
7019
            loss = fluid.layers.dice_loss(input=predictions, label=label)
W
whs 已提交
7020 7021
    """
    label = one_hot(label, depth=input.shape[-1])
7022
    reduce_dim = list(range(1, len(input.shape)))
W
whs 已提交
7023 7024 7025 7026 7027 7028
    inse = reduce_sum(input * label, dim=reduce_dim)
    dice_denominator = reduce_sum(
        input, dim=reduce_dim) + reduce_sum(
            label, dim=reduce_dim)
    dice_score = 1 - inse * 2 / (dice_denominator + epsilon)
    return reduce_mean(dice_score)
7029 7030


7031 7032 7033 7034
def image_resize(input,
                 out_shape=None,
                 scale=None,
                 name=None,
7035
                 resample='BILINEAR',
7036 7037
                 actual_shape=None,
                 align_corners=True,
7038 7039
                 align_mode=1,
                 data_format='NCHW'):
7040
    """
7041 7042 7043 7044
    :alias_main: paddle.nn.functional.image_resize
	:alias: paddle.nn.functional.image_resize,paddle.nn.functional.vision.image_resize
	:old_api: paddle.fluid.layers.image_resize

R
ruri 已提交
7045
    This op resizes a batch of images.
F
stash  
fengjiayi 已提交
7046

7047 7048
    The input must be a 3-D Tensor of the shape (num_batches, channels, in_w)
    or a 4-D Tensor of the shape (num_batches, channels, in_h, in_w)
7049 7050
    or (num_batches, in_h, in_w, channels), or a 5-D Tensor of the shape
    (num_batches, channels, in_d, in_h, in_w) or (num_batches, in_d, in_h, in_w, channels),
T
tianshuo78520a 已提交
7051
    and the resizing only applies on the three dimensions(depth, height and width).
7052

7053
    **Warning:** the parameter :attr:`actual_shape` will be deprecated in the
7054 7055
    future and only use :attr:`out_shape` instead.

7056
    Supporting resample methods:
7057
        'LINEAR' : Linear interpolation 
Q
update  
qiaolongfei 已提交
7058

7059
        'BILINEAR' : Bilinear interpolation
T
Tink_Y 已提交
7060

K
Kaipeng Deng 已提交
7061 7062
        'TRILINEAR' : Trilinear interpolation

7063
        'NEAREST' : Nearest neighbor interpolation
7064 7065
        
        'BICUBIC' : Bicubic interpolation
7066 7067 7068 7069
    
    Linear interpolation is the method of using a line connecting two known quantities 
    to determine the value of an unknown quantity between the two known quantities.
    
7070
    Nearest neighbor interpolation is to perform nearest neighbor interpolation
7071
    in both the 3rd dimension(in height direction) and the 4th dimension(in width
7072
    direction) on input tensor.
7073 7074 7075 7076 7077

    Bilinear interpolation is an extension of linear interpolation for
    interpolating functions of two variables (e.g. H-direction and
    W-direction in this op) on a rectilinear 2D grid. The key idea is
    to perform linear interpolation first in one direction, and then
7078 7079
    again in the other direction.

7080 7081 7082
    Trilinear interpolation is an extension of linear interpolation for
    interpolating functions of three variables (e.g. D-direction,
    H-direction and W-direction in this op) on a rectilinear 3D grid.
K
Kaipeng Deng 已提交
7083
    The linear interpolation is performed on three directions.
7084 7085 7086 7087 7088
    
    Bicubic interpolation is an extension of cubic interpolation for interpolating
    data points on a two-dimensional regular grid. The interpolated surface is
    smoother than corresponding surfaces obtained by bilinear interpolation or
    nearest-neighbor interpolation.
K
Kaipeng Deng 已提交
7089

7090
    Align_corners and align_mode are optional parameters,the calculation method
7091 7092 7093 7094
    of interpolation can be selected by them.

    Example:

T
Tink_Y 已提交
7095
    .. code-block:: text
7096

T
Tink_Y 已提交
7097
        For scale:
7098

T
Tink_Y 已提交
7099
            if align_corners = True && out_size > 1 :
7100

T
Tink_Y 已提交
7101
              scale_factor = (in_size-1.0)/(out_size-1.0)
7102

T
Tink_Y 已提交
7103
            else:
7104

T
Tink_Y 已提交
7105
              scale_factor = float(in_size/out_size)
7106 7107


T
Tink_Y 已提交
7108
        Nearest neighbor interpolation:
7109

T
Tink_Y 已提交
7110 7111
          if:
              align_corners = False
7112

T
Tink_Y 已提交
7113 7114
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7115

T
Tink_Y 已提交
7116 7117
              H_out = floor (H_{in} * scale_{factor})
              W_out = floor (W_{in} * scale_{factor})
7118

T
Tink_Y 已提交
7119 7120
          else:
              align_corners = True
7121

T
Tink_Y 已提交
7122 7123
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7124

T
Tink_Y 已提交
7125 7126
              H_out = round(H_{in} * scale_{factor})
              W_out = round(W_{in} * scale_{factor})
7127

7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144
        linear interpolation:

          if:
              align_corners = False , align_mode = 0

              input : (N,C,W_in)
              output: (N,C,W_out) where:

              W_out = (W_{in}+0.5) * scale_{factor} - 0.5

          else:

              input : (N,C,W_in)
              output: (N,C,H_out,W_out) where:

              W_out = W_{in} * scale_{factor}

T
Tink_Y 已提交
7145 7146 7147 7148
        Bilinear interpolation:

          if:
              align_corners = False , align_mode = 0
7149

T
Tink_Y 已提交
7150 7151
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7152

T
Tink_Y 已提交
7153 7154
              H_out = (H_{in}+0.5) * scale_{factor} - 0.5
              W_out = (W_{in}+0.5) * scale_{factor} - 0.5
7155

T
Tink_Y 已提交
7156
          else:
7157

T
Tink_Y 已提交
7158 7159
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7160

T
Tink_Y 已提交
7161 7162
              H_out = H_{in} * scale_{factor}
              W_out = W_{in} * scale_{factor}
7163

K
Kaipeng Deng 已提交
7164 7165 7166 7167
        Trilinear interpolation:

          if:
              align_corners = False , align_mode = 0
7168

K
Kaipeng Deng 已提交
7169 7170
              input : (N,C,D_in,H_in,W_in)
              output: (N,C,D_out,H_out,W_out) where:
7171

K
Kaipeng Deng 已提交
7172 7173 7174 7175 7176 7177
              D_out = (D_{in}+0.5) * scale_{factor} - 0.5
              H_out = (H_{in}+0.5) * scale_{factor} - 0.5
              W_out = (W_{in}+0.5) * scale_{factor} - 0.5


          else:
7178

K
Kaipeng Deng 已提交
7179 7180 7181 7182
              input : (N,C,D_in,H_in,W_in)
              output: (N,C,D_out,H_out,W_out) where:

              D_out = D_{in} * scale_{factor}
7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195
       
        Trilinear interpolation:
          if:
              align_corners = False , align_mode = 0
              input : (N,C,D_in,H_in,W_in)
              output: (N,C,D_out,H_out,W_out) where:
              D_out = (D_{in}+0.5) * scale_{factor} - 0.5
              H_out = (H_{in}+0.5) * scale_{factor} - 0.5
              W_out = (W_{in}+0.5) * scale_{factor} - 0.5
          else:
              input : (N,C,D_in,H_in,W_in)
              output: (N,C,D_out,H_out,W_out) where:
              D_out = D_{in} * scale_{factor}
K
Kaipeng Deng 已提交
7196 7197
              H_out = H_{in} * scale_{factor}
              W_out = W_{in} * scale_{factor}
7198
        
7199

7200 7201 7202
    For details of linear interpolation, please refer to Wikipedia:
    https://en.wikipedia.org/wiki/Linear_interpolation.
    
7203
    For details of nearest neighbor interpolation, please refer to Wikipedia:
7204
    https://en.wikipedia.org/wiki/Nearest-neighbor_interpolation.
7205
    
7206
    For details of bilinear interpolation, please refer to Wikipedia:
7207
    https://en.wikipedia.org/wiki/Bilinear_interpolation.
7208
    
7209
    For details of trilinear interpolation, please refer to Wikipedia:
K
Kaipeng Deng 已提交
7210
    https://en.wikipedia.org/wiki/Trilinear_interpolation.
7211 7212 7213
    
    For details of bicubic interpolation, please refer to Wikipedia:
    https://en.wikipedia.org/wiki/Bicubic_interpolation
7214

R
ruri 已提交
7215
    Parameters:
7216
        input (Variable): 3-D, 4-D or 5-D Tensor, its data type is float32, float64, or uint8,
7217
                          its data format is specified by :attr:`data_format`.
7218 7219 7220 7221
        out_shape (list|tuple|Variable|None): Output shape of image resize
             layer, the shape is (out_w, ) when input is a 3-D Tensor, the shape is (out_h, out_w) 
             when input is a 4-D Tensor and is (out_d, out_h, out_w) when input is a 5-D Tensor. 
             Default: None. If a list, each element can be an integer or a Tensor Variable of shape: [1].
7222
             If a Tensor Variable, its dimensions size should be a 1.
7223 7224 7225
        scale(float|Variable|None): The multiplier for the input height or width. At
             least one of :attr:`out_shape` or :attr:`scale` must be set.
             And :attr:`out_shape` has a higher priority than :attr:`scale`.
D
dengkaipeng 已提交
7226
             Default: None.
7227 7228
        name(str|None): A name for this layer(optional). If set None, the layer
                        will be named automatically.
7229
        resample(str): The resample method. It supports 'LINEAR', 'BICUBIC', 'BILINEAR', 'TRILINEAR'
K
Kaipeng Deng 已提交
7230
                       and 'NEAREST' currently. Default: 'BILINEAR'
7231 7232 7233
        actual_shape(Variable): An optional input to specify output shape
                                dynamically. If provided, image resize
                                according to this given shape rather than
7234
                                :attr:`out_shape` and :attr:`scale` specifying
7235 7236
                                shape. That is to say actual_shape has the
                                highest priority. It is recommended to use
7237 7238 7239 7240 7241
                                :attr:`out_shape` if you want to specify output
                                shape dynamically, because :attr:`actual_shape`
                                will be deprecated. When using actual_shape to
                                specify output shape, one of :attr:`out_shape`
                                and :attr:`scale` should also be set, otherwise
T
tianshuo78520a 已提交
7242
                                errors would be occurred in graph constructing stage.
7243
                                Default: None
7244 7245
        align_corners(bool) :  An optional bool, If True, the centers of the 4 corner pixels of the
                               input and output tensors are aligned, preserving the values at the
7246 7247
                               corner pixels.
                               Default: True
7248 7249 7250
        align_mode(int)  :  An optional for linear/bilinear/trilinear interpolation. Refer to the fomula in the 
                            the example code above, it can be \'0\' for src_idx = scale*(dst_indx+0.5)-0.5 , 
                            can be \'1\' for src_idx = scale*dst_index.
7251
        data_format (str, optional): Specify the data format of the input, and the data format of the output
7252
            will be consistent with that of the input. An optional string from:`NCW`, `NWC`, `"NCHW"`, `"NHWC"`, `"NCDHW"`,
7253
            `"NDHWC"`. The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
7254
            `[batch_size, input_channels, input_height, input_width]`. When it is `"NCHW"`, the data is stored
7255
            in the order of: `[batch_size, input_channels, input_depth, input_height, input_width]`.
7256 7257

    Returns:
7258
        A 3-D Tensor of the shape (num_batches, channels, out_w) or (num_batches, out_w, channels),
7259 7260
        A 4-D Tensor of the shape (num_batches, channels, out_h, out_w) or (num_batches, out_h, out_w, channels),
        or 5-D Tensor of the shape (num_batches, channels, out_d, out_h, out_w) or (num_batches, out_d, out_h, out_w, channels).
F
stash  
fengjiayi 已提交
7261

7262 7263 7264
    Raises:
        TypeError: out_shape should be a list or tuple or Variable.
        TypeError: actual_shape should either be Variable or None.
7265 7266
        ValueError: The 'resample' of image_resize can only be 'LINEAR', 'BILINEAR',
                    'TRILINEAR', 'BICUBIC' or 'NEAREST' currently.
7267
        ValueError: 'LINEAR' only support 3-D tensor.
7268
        ValueError: 'BICUBIC', 'BILINEAR' and 'NEAREST' only support 4-D tensor.
K
Kaipeng Deng 已提交
7269
        ValueError: 'TRILINEAR' only support 5-D tensor.
7270
        ValueError: One of out_shape and scale must not be None.
7271
        ValueError: out_shape length should be 1 for input 3-D tensor.
K
Kaipeng Deng 已提交
7272 7273
        ValueError: out_shape length should be 2 for input 4-D tensor.
        ValueError: out_shape length should be 3 for input 5-D tensor.
D
dengkaipeng 已提交
7274
        ValueError: scale should be greater than zero.
T
tianshuo78520a 已提交
7275
        TypeError: align_corners should be a bool value
7276
        ValueError: align_mode can only be '0' or '1'
7277
        ValueError: data_format can only be 'NCW', 'NWC', 'NCHW', 'NHWC', 'NCDHW' or 'NDHWC'.
7278

7279 7280
    Examples:
        .. code-block:: python
7281

R
ruri 已提交
7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310
	    #declarative mode
	    import paddle.fluid as fluid
	    import numpy as np
	    input = fluid.data(name="input", shape=[None,3,6,10])

	    #1
	    output = fluid.layers.image_resize(input=input,out_shape=[12,12])

	    #2
	    #x = np.array([2]).astype("int32")
	    #dim1 = fluid.data(name="dim1", shape=[1], dtype="int32")
	    #fluid.layers.assign(input=x, output=dim1)
	    #output = fluid.layers.image_resize(input=input,out_shape=[12,dim1])

	    #3
	    #x = np.array([3,12]).astype("int32")
	    #shape_tensor = fluid.data(name="shape_tensor", shape=[2], dtype="int32")
	    #fluid.layers.assign(input=x, output=shape_tensor)
	    #output = fluid.layers.image_resize(input=input,out_shape=shape_tensor)

	    #4
	    #x = np.array([0.5]).astype("float32")
	    #scale_tensor = fluid.data(name="scale", shape=[1], dtype="float32")
	    #fluid.layers.assign(x,scale_tensor)
	    #output = fluid.layers.image_resize(input=input,scale=scale_tensor)

	    place = fluid.CPUPlace()
	    exe = fluid.Executor(place)
	    exe.run(fluid.default_startup_program())
7311

R
ruri 已提交
7312
	    input_data = np.random.rand(2,3,6,10).astype("float32")
7313

R
ruri 已提交
7314 7315 7316 7317
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
7318

R
ruri 已提交
7319
	    print(output_data[0].shape)
7320

R
ruri 已提交
7321 7322 7323 7324 7325 7326 7327 7328
	    #1
	    # (2, 3, 12, 12)
	    #2
	    # (2, 3, 12, 2)
	    #3
	    # (2, 3, 3, 12)
	    #4
	    # (2, 3, 3, 5)
7329

R
ruri 已提交
7330 7331
	    #imperative mode
	    import paddle.fluid.dygraph as dg
7332

R
ruri 已提交
7333 7334 7335 7336
	    with dg.guard(place) as g:
    		input = dg.to_variable(input_data)
    		output = fluid.layers.image_resize(input=input, out_shape=[12,12])
    		print(output.shape)
7337

R
ruri 已提交
7338
		# [2L, 3L, 12L, 12L]
7339

7340
    """
7341
    resample_methods = {
7342
        'LINEAR': 'linear',
7343
        'BILINEAR': 'bilinear',
K
Kaipeng Deng 已提交
7344
        'TRILINEAR': 'trilinear',
7345
        'NEAREST': 'nearest',
7346
        'LINEAR': 'linear',
7347
    }
7348
    resample = resample.upper()
7349 7350
    if resample not in resample_methods:
        raise ValueError(
7351
            "The 'resample' of image_resize can only be 'LINEAR', 'BILINEAR', 'TRILINEAR' "
K
Kaipeng Deng 已提交
7352
            "or 'NEAREST' currently.")
7353
    resample_type = resample_methods[resample]
7354

7355 7356 7357
    if resample == 'LINEAR' and len(input.shape) != 3:
        raise ValueError("'LINER only support 3-D tensor.")
    elif resample in ['BILINEAR', 'NEAREST'] and len(input.shape) != 4:
K
Kaipeng Deng 已提交
7358
        raise ValueError("'BILINEAR' and 'NEAREST' only support 4-D tensor.")
7359
    elif resample == 'TRILINEAR' and len(input.shape) != 5:
K
Kaipeng Deng 已提交
7360 7361
        raise ValueError("'TRILINEAR'only support 5-D tensor.")

7362 7363 7364 7365 7366
    if not isinstance(align_corners, bool):
        raise TypeError("Attr align_corners should be a bool value")
    if align_mode != 0 and align_mode != 1:
        raise ValueError("align_mode can only be 0 or 1")

7367
    if out_shape is None and scale is None:
7368
        raise ValueError("One of out_shape and scale must not be None.")
7369
    helper = LayerHelper('{}_interp'.format(resample_type), **locals())
7370
    dtype = helper.input_dtype()
7371

7372
    if len(input.shape) == 3 and data_format not in ['NCW', 'NWC']:
7373 7374
        raise ValueError(
            "Got wrong value for param `data_format`: " + data_format +
7375
            " received but only `NCW` or `NWC` supported for 3-D input.")
7376
    elif len(input.shape) == 4 and data_format not in ['NCHW', 'NHWC']:
7377 7378 7379 7380 7381 7382 7383 7384
        raise ValueError(
            "Got wrong value for param `data_format`: " + data_format +
            " received but only `NCHW` or `NHWC` supported for 4-D input.")
    elif len(input.shape) == 5 and data_format not in ['NCDHW', 'NDHWC']:
        raise ValueError(
            "Got wrong value for param `data_format`: " + data_format +
            " received but only `NCDHW` or `NDHWC` supported for 5-D input.")

7385 7386 7387
    def _is_list_or_turple_(data):
        return (isinstance(data, list) or isinstance(data, tuple))

7388
    if data_format == 'NCHW' or data_format == 'NCDHW' or data_format == 'NCW':
7389
        data_layout = 'NCHW'
7390
    if data_format == 'NHWC' or data_format == 'NDHWC' or data_format == 'NWC':
7391 7392
        data_layout = 'NHWC'

7393
    inputs = {"X": input}
D
dengkaipeng 已提交
7394
    attrs = {
7395 7396 7397
        "out_d": -1,
        "out_h": -1,
        "out_w": -1,
D
dengkaipeng 已提交
7398 7399
        "interp_method": resample_type,
        "align_corners": align_corners,
7400 7401
        "align_mode": align_mode,
        "data_layout": data_layout
D
dengkaipeng 已提交
7402 7403
    }

7404
    if out_shape is not None:
7405
        if isinstance(out_shape, Variable):
7406
            out_shape.stop_gradient = True
7407
            inputs['OutSize'] = out_shape
7408 7409
        else:
            if not (_is_list_or_turple_(out_shape)):
D
dengkaipeng 已提交
7410 7411
                raise TypeError(
                    "out_shape should be a list or tuple or Variable.")
7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439
            # Validate the shape
            contain_var = False
            for dim_idx, dim_size in enumerate(out_shape):
                if isinstance(dim_size, Variable):
                    contain_var = True
                    continue
                assert dim_size > 0, (
                    "Each dimension size given in out_shape must be greater than 0."
                )

            if contain_var:
                new_size_tensor = []
                size_list = []
                for dim in out_shape:
                    if isinstance(dim, Variable):
                        dim.stop_gradient = True
                        new_size_tensor.append(dim)
                        size_list.append(-1)
                    else:
                        assert (isinstance(dim, int))
                        temp_out = helper.create_variable_for_type_inference(
                            'int32')
                        fill_constant(
                            [1], 'int32', dim, force_cpu=True, out=temp_out)
                        new_size_tensor.append(temp_out)
                        size_list.append(dim)
                inputs['SizeTensor'] = new_size_tensor

7440 7441 7442 7443 7444 7445 7446 7447 7448 7449
            if len(input.shape) == 3:
                if len(out_shape) != 1:
                    raise ValueError("out_shape length should be 1 for "
                                     "input 3-D tensor.")
                if contain_var:
                    attrs['out_w'] = size_list[0]
                else:
                    out_shape = list(map(int, out_shape))
                    attrs['out_w'] = out_shape[0]
            elif len(input.shape) == 4:
K
Kaipeng Deng 已提交
7450 7451 7452
                if len(out_shape) != 2:
                    raise ValueError("out_shape length should be 2 for "
                                     "input 4-D tensor.")
7453 7454 7455 7456 7457 7458 7459
                if contain_var:
                    attrs['out_h'] = size_list[0]
                    attrs['out_w'] = size_list[1]
                else:
                    out_shape = list(map(int, out_shape))
                    attrs['out_h'] = out_shape[0]
                    attrs['out_w'] = out_shape[1]
K
Kaipeng Deng 已提交
7460 7461 7462 7463
            if len(input.shape) == 5:
                if len(out_shape) != 3:
                    raise ValueError("out_shape length should be 3 for "
                                     "input 5-D tensor.")
7464 7465 7466 7467 7468 7469 7470 7471 7472
                if contain_var:
                    attrs['out_d'] = size_list[0]
                    attrs['out_h'] = size_list[1]
                    attrs['out_w'] = size_list[2]
                else:
                    out_shape = list(map(int, out_shape))
                    attrs['out_d'] = out_shape[0]
                    attrs['out_h'] = out_shape[1]
                    attrs['out_w'] = out_shape[2]
7473

7474
    else:
7475 7476 7477
        if isinstance(scale, Variable):
            scale.stop_gradient = True
            inputs["Scale"] = scale
7478
        elif isinstance(scale, float) or isinstance(scale, int):
7479
            if scale <= 0:
7480
                raise ValueError("Attr(scale) should be greater than zero.")
7481
            attrs['scale'] = float(scale)
7482 7483 7484
        else:
            raise TypeError(
                "Attr(scale)'s type should be float, int or Variable.")
7485

7486
    if isinstance(actual_shape, Variable):
7487 7488 7489 7490 7491
        warnings.warn(
            "actual_shape will be deprecated, it is recommended to use "
            "out_shape instead of actual_shape to specify output shape dynamically."
        )
        actual_shape.stop_gradient = True
7492 7493 7494
        inputs["OutSize"] = actual_shape
    elif actual_shape is not None:
        raise TypeError("actual_shape should either be Variable or None.")
X
Xin Pan 已提交
7495
    out = helper.create_variable_for_type_inference(dtype)
7496
    helper.append_op(
7497
        type='{}_interp'.format(resample_type),
7498
        inputs=inputs,
7499
        outputs={"Out": out},
D
dengkaipeng 已提交
7500
        attrs=attrs)
7501
    return out
F
stash  
fengjiayi 已提交
7502 7503


7504 7505 7506 7507 7508 7509 7510 7511
@templatedoc(op_type="linear_interp")
def resize_linear(input,
                  out_shape=None,
                  scale=None,
                  name=None,
                  actual_shape=None,
                  align_corners=True,
                  align_mode=1,
7512
                  data_format='NCW'):
7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554
    """
    This op resizes the input by performing linear interpolation based on given
    output shape which specified by actual_shape, out_shape and scale
    in priority order.

    **Warning:** the parameter :attr:`actual_shape` will be deprecated in 
    the future and only use :attr:`out_shape` instead.

    Align_corners and align_mode are optional parameters,the calculation 
    method of interpolation can be selected by them.

    Example:

    .. code-block:: text

        For scale:
          
            if align_corners = True && out_size > 1 :

              scale_factor = (in_size-1.0)/(out_size-1.0)
            
            else:
              
              scale_factor = float(in_size/out_size)

        Linear interpolation:

          if:
              align_corners = False , align_mode = 0
              
              input : (N,C,W_in)
              output: (N,C,W_out) where:
              
              W_out = (W_{in}+0.5) * scale_{factor} - 0.5

          else:

              input : (N,C,W_in)
              output: (N,C,W_out) where:
              W_out = W_{in} * scale_{factor}

    Parameters:
7555
        input(Variable): 3-D Tensor(NCW), its data type is float32, float64, or uint8,
7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580
                          its data format is specified by :attr:`data_format`.
        out_shape(list|tuple|Variable|None): Output shape of resize linear
            layer, the shape is (out_w,). Default: None. If a list, each 
            element can be an integer or a Tensor Variable with shape: [1]. If a 
            Tensor Variable, its dimension size should be 1.
        scale(float|Variable|None): The multiplier for the input height or width. At
             least one of :attr:`out_shape` or :attr:`scale` must be set. 
             And :attr:`out_shape` has a higher priority than :attr:`scale`. 
             Default: None.
        actual_shape(Variable): An optional input to specify output shape
                                dynamically. If provided, image resize
                                according to this given shape rather than
                                :attr:`out_shape` and :attr:`scale` specifying
                                shape. That is to say actual_shape has the
                                highest priority. It is recommended to use
                                :attr:`out_shape` if you want to specify output 
                                shape dynamically, because :attr:`actual_shape` 
                                will be deprecated. When using actual_shape to 
                                specify output shape, one of :attr:`out_shape` 
                                and :attr:`scale` should also be set, otherwise 
                                errors would be occurred in graph constructing stage.
                                Default: None
        align_corners(bool): ${align_corners_comment}
        align_mode(bool): ${align_mode_comment}
        data_format (str, optional): Specify the data format of the input, and the data format of the output 
7581 7582 7583 7584 7585
            will be consistent with that of the input. An optional string from: `"NCW"`, `"NWC"`.
            The default is `"NCW"`. When it is `"NCW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_width]`.
        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`
7586 7587

    Returns:
7588
	Variable: 3-D tensor(NCW or NWC).
7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630
    
    Examples:
        .. code-block:: python
	
	    #declarative mode
	    import paddle.fluid as fluid
	    import numpy as np
	    input = fluid.data(name="input", shape=[None,3,100])

	    output = fluid.layers.resize_linear(input=input,out_shape=[50,])

	    place = fluid.CPUPlace()
	    exe = fluid.Executor(place)
	    exe.run(fluid.default_startup_program())
 
	    input_data = np.random.rand(1,3,100).astype("float32")

	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
 
	    print(output_data[0].shape)

	    # (1, 3, 50)

	    #imperative mode
	    import paddle.fluid.dygraph as dg

	    with dg.guard(place) as g:
    		input = dg.to_variable(input_data)
    		output = fluid.layers.resize_linear(input=input, out_shape=[50,])
    		print(output.shape)

		# [1L, 3L, 50L]

    """

    return image_resize(input, out_shape, scale, name, 'LINEAR', actual_shape,
                        align_corners, align_mode, data_format)


7631
@templatedoc(op_type="bilinear_interp")
7632 7633 7634 7635
def resize_bilinear(input,
                    out_shape=None,
                    scale=None,
                    name=None,
7636 7637
                    actual_shape=None,
                    align_corners=True,
7638 7639
                    align_mode=1,
                    data_format='NCHW'):
7640
    """
7641 7642 7643 7644
    :alias_main: paddle.nn.functional.resize_bilinear
	:alias: paddle.nn.functional.resize_bilinear,paddle.nn.functional.vision.resize_bilinear
	:old_api: paddle.fluid.layers.resize_bilinear

R
ruri 已提交
7645
    This op resizes the input by performing bilinear interpolation based on given
7646
    output shape which specified by actual_shape, out_shape and scale
7647 7648
    in priority order.

7649
    **Warning:** the parameter :attr:`actual_shape` will be deprecated in
7650 7651
    the future and only use :attr:`out_shape` instead.

7652 7653 7654 7655
    Bilinear interpolation is an extension of linear interpolation for
    interpolating functions of two variables (e.g. H-direction and
    W-direction in this op) on a rectilinear 2D grid. The key idea is
    to perform linear interpolation first in one direction, and then
7656 7657
    again in the other direction.

7658
    For details of bilinear interpolation, please refer to Wikipedia:
7659
    https://en.wikipedia.org/wiki/Bilinear_interpolation
Y
yuyang18 已提交
7660

7661
    Align_corners and align_mode are optional parameters,the calculation
7662 7663 7664 7665
    method of interpolation can be selected by them.

    Example:

T
Tink_Y 已提交
7666
    .. code-block:: text
7667

T
Tink_Y 已提交
7668
        For scale:
7669

T
Tink_Y 已提交
7670
            if align_corners = True && out_size > 1 :
7671

T
Tink_Y 已提交
7672
              scale_factor = (in_size-1.0)/(out_size-1.0)
7673

T
Tink_Y 已提交
7674
            else:
7675

7676
              scale_factor = float(in_size/out_size)
7677

T
Tink_Y 已提交
7678 7679 7680 7681
        Bilinear interpolation:

          if:
              align_corners = False , align_mode = 0
7682

T
Tink_Y 已提交
7683 7684
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7685

T
Tink_Y 已提交
7686 7687
              H_out = (H_{in}+0.5) * scale_{factor} - 0.5
              W_out = (W_{in}+0.5) * scale_{factor} - 0.5
7688

T
Tink_Y 已提交
7689
          else:
T
tink2123 已提交
7690

T
Tink_Y 已提交
7691 7692 7693 7694
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
              H_out = H_{in} * scale_{factor}
              W_out = W_{in} * scale_{factor}
7695

R
ruri 已提交
7696 7697
    Parameters:
        input(Variable): 4-D Tensor(NCHW), its data type is float32, float64, or uint8,
7698
                          its data format is specified by :attr:`data_format`.
D
dengkaipeng 已提交
7699
        out_shape(list|tuple|Variable|None): Output shape of resize bilinear
7700 7701
            layer, the shape is (out_h, out_w).Default: None. If a list, each
            element can be an integer or a Tensor Variable with shape: [1]. If a
7702
            Tensor Variable, its dimension size should be 1.
7703
        scale(float|Variable|None): The multiplier for the input height or width. At
7704 7705
             least one of :attr:`out_shape` or :attr:`scale` must be set.
             And :attr:`out_shape` has a higher priority than :attr:`scale`.
D
dengkaipeng 已提交
7706
             Default: None.
7707 7708 7709
        actual_shape(Variable): An optional input to specify output shape
                                dynamically. If provided, image resize
                                according to this given shape rather than
7710
                                :attr:`out_shape` and :attr:`scale` specifying
7711 7712
                                shape. That is to say actual_shape has the
                                highest priority. It is recommended to use
7713 7714 7715 7716 7717
                                :attr:`out_shape` if you want to specify output
                                shape dynamically, because :attr:`actual_shape`
                                will be deprecated. When using actual_shape to
                                specify output shape, one of :attr:`out_shape`
                                and :attr:`scale` should also be set, otherwise
T
tianshuo78520a 已提交
7718
                                errors would be occurred in graph constructing stage.
7719
                                Default: None
7720 7721
        align_corners(bool): ${align_corners_comment}
        align_mode(bool): ${align_mode_comment}
7722
        data_format (str, optional): Specify the data format of the input, and the data format of the output
7723 7724 7725
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_height, input_width]`.
R
ruri 已提交
7726
        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`
Y
yuyang18 已提交
7727 7728

    Returns:
R
ruri 已提交
7729
	Variable: 4-D tensor(NCHW or NHWC).
7730

7731 7732
    Examples:
        .. code-block:: python
7733

R
ruri 已提交
7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762
	    #declarative mode
	    import paddle.fluid as fluid
	    import numpy as np
	    input = fluid.data(name="input", shape=[None,3,6,10])

	    #1
	    output = fluid.layers.resize_bilinear(input=input,out_shape=[12,12])

	    #2
	    #x = np.array([2]).astype("int32")
	    #dim1 = fluid.data(name="dim1", shape=[1], dtype="int32")
	    #fluid.layers.assign(input=x, output=dim1)
	    #output = fluid.layers.resize_bilinear(input=input,out_shape=[12,dim1])

	    #3
	    #x = np.array([3,12]).astype("int32")
	    #shape_tensor = fluid.data(name="shape_tensor", shape=[2], dtype="int32")
	    #fluid.layers.assign(input=x, output=shape_tensor)
	    #output = fluid.layers.resize_bilinear(input=input,out_shape=shape_tensor)

	    #4
	    #x = np.array([0.5]).astype("float32")
	    #scale_tensor = fluid.data(name="scale", shape=[1], dtype="float32")
	    #fluid.layers.assign(x,scale_tensor)
	    #output = fluid.layers.resize_bilinear(input=input,scale=scale_tensor)

	    place = fluid.CPUPlace()
	    exe = fluid.Executor(place)
	    exe.run(fluid.default_startup_program())
7763

R
ruri 已提交
7764
	    input_data = np.random.rand(2,3,6,10).astype("float32")
7765

R
ruri 已提交
7766 7767 7768 7769
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
7770

R
ruri 已提交
7771
	    print(output_data[0].shape)
7772

R
ruri 已提交
7773 7774 7775 7776 7777 7778 7779 7780
	    #1
	    # (2, 3, 12, 12)
	    #2
	    # (2, 3, 12, 2)
	    #3
	    # (2, 3, 3, 12)
	    #4
	    # (2, 3, 3, 5)
7781

R
ruri 已提交
7782 7783
	    #imperative mode
	    import paddle.fluid.dygraph as dg
7784

R
ruri 已提交
7785 7786 7787 7788
	    with dg.guard(place) as g:
    		input = dg.to_variable(input_data)
    		output = fluid.layers.resize_bilinear(input=input, out_shape=[12,12])
    		print(output.shape)
7789

R
ruri 已提交
7790
		# [2L, 3L, 12L, 12L]
7791

7792 7793
    """

7794
    return image_resize(input, out_shape, scale, name, 'BILINEAR', actual_shape,
7795
                        align_corners, align_mode, data_format)
7796 7797


K
Kaipeng Deng 已提交
7798 7799 7800 7801 7802 7803 7804
@templatedoc(op_type="trilinear_interp")
def resize_trilinear(input,
                     out_shape=None,
                     scale=None,
                     name=None,
                     actual_shape=None,
                     align_corners=True,
7805 7806
                     align_mode=1,
                     data_format='NCDHW'):
K
Kaipeng Deng 已提交
7807
    """
7808 7809 7810 7811
    :alias_main: paddle.nn.functional.resize_trilinear
	:alias: paddle.nn.functional.resize_trilinear,paddle.nn.functional.vision.resize_trilinear
	:old_api: paddle.fluid.layers.resize_trilinear

R
ruri 已提交
7812
    This op resizes the input by performing trilinear interpolation based on given
K
Kaipeng Deng 已提交
7813 7814 7815
    output shape which specified by actual_shape, out_shape and scale
    in priority order.

7816
    **Warning:** the parameter :attr:`actual_shape` will be deprecated
7817 7818
    in the future and only use :attr:`out_shape` instead.

7819 7820 7821
    Trilinear interpolation is an extension of linear interpolation for
    interpolating functions of three variables (e.g. D-direction,
    H-direction and W-direction in this op) on a rectilinear 3D grid.
K
Kaipeng Deng 已提交
7822 7823 7824 7825 7826
    The linear interpolation is performed on three directions.

    For details of trilinear interpolation, please refer to Wikipedia:
    https://en.wikipedia.org/wiki/Trilinear_interpolation

7827
    Align_corners and align_mode are optional parameters,the calculation
K
Kaipeng Deng 已提交
7828 7829 7830 7831 7832 7833 7834
    method of interpolation can be selected by them.

    Example:

    .. code-block:: text

        For scale:
7835

K
Kaipeng Deng 已提交
7836 7837 7838
            if align_corners = True && out_size > 1 :

              scale_factor = (in_size-1.0)/(out_size-1.0)
7839

K
Kaipeng Deng 已提交
7840
            else:
7841 7842

              scale_factor = float(in_size/out_size)
K
Kaipeng Deng 已提交
7843 7844 7845 7846

        Bilinear interpolation:

          if:
7847

K
Kaipeng Deng 已提交
7848
              align_corners = False , align_mode = 0
7849

K
Kaipeng Deng 已提交
7850 7851
              input : (N,C,D_in,H_in,W_in)
              output: (N,C,D_out,H_out,W_out) where:
7852

K
Kaipeng Deng 已提交
7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865
              D_out = (D_{in}+0.5) * scale_{factor} - 0.5
              H_out = (H_{in}+0.5) * scale_{factor} - 0.5
              W_out = (W_{in}+0.5) * scale_{factor} - 0.5

          else:

              input : (N,C,D_in,H_in,W_in)
              output: (N,C,D_out,H_out,W_out) where:

              D_out = D_{in} * scale_{factor}
              H_out = H_{in} * scale_{factor}
              W_out = W_{in} * scale_{factor}

R
ruri 已提交
7866
    Parameters:
7867 7868
        input(${x_type}): 5-D Tensor, its data type is float32, float64, or uint8,
                          its data format is specified by :attr:`data_format`.
R
ruri 已提交
7869
        out_shape(list|tuple|Variable|None): The output shape of resized tensor, the shape is (out_d, out_h, out_w). Default: None. Every element should be an integer or a Tensor Variable with shape: [1] if it is a list. If it is a Tensor Variable, its dimension size should be 1.
7870
        scale(float|Variable|None): The multiplier for the input depth, height or width.
7871 7872
             At least one of :attr:`out_shape` or :attr:`scale` must be set.
             And :attr:`out_shape` has a higher priority than :attr:`scale`.
K
Kaipeng Deng 已提交
7873
             Default: None.
R
ruri 已提交
7874
        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`
K
Kaipeng Deng 已提交
7875 7876 7877 7878 7879 7880
        actual_shape(Variable): An optional input to specify output shape
                                dynamically. If provided, image resize
                                according to this given shape rather than
                                :attr:`out_shape` and :attr:`scale` specifying
                                shape. That is to say actual_shape has the
                                highest priority. It is recommended to use
7881 7882 7883 7884 7885
                                :attr:`out_shape` if you want to specify output
                                shape dynamically, because :attr:`actual_shape`
                                will be deprecated. When using actual_shape to
                                specify output shape, one of :attr:`out_shape`
                                and :attr:`scale` should also be set, otherwise
T
tianshuo78520a 已提交
7886
                                errors would be occurred in graph constructing stage.
K
Kaipeng Deng 已提交
7887 7888 7889
                                Default: None
        align_corners(bool): ${align_corners_comment}
        align_mode(bool): ${align_mode_comment}
7890
        data_format (str, optional): Specify the data format of the input, and the data format of the output
7891 7892 7893
            will be consistent with that of the input. An optional string from: `"NCDHW"`, `"NDHWC"`.
            The default is `"NCDHW"`. When it is `"NCDHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_depth, input_height, input_width]`.
K
Kaipeng Deng 已提交
7894 7895

    Returns:
7896
        Variable: A 5-D Tensor(NCDHW or NDHWC)
K
Kaipeng Deng 已提交
7897 7898 7899

    Examples:
        .. code-block:: python
7900

R
ruri 已提交
7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929
	    #declarative mode
	    import paddle.fluid as fluid
	    import numpy as np
	    input = fluid.data(name="input", shape=[None,3,6,8,10])

	    #1
	    output = fluid.layers.resize_trilinear(input=input,out_shape=[12,12,12])

	    #2
	    #x = np.array([2]).astype("int32")
	    #dim1 = fluid.data(name="dim1", shape=[1], dtype="int32")
	    #fluid.layers.assign(input=x, output=dim1)
	    #output = fluid.layers.resize_trilinear(input=input,out_shape=[12,dim1,4])

	    #3
	    #x = np.array([3,12,12]).astype("int32")
	    #shape_tensor = fluid.data(name="shape_tensor", shape=[3], dtype="int32")
	    #fluid.layers.assign(input=x, output=shape_tensor)
	    #output = fluid.layers.resize_trilinear(input=input,out_shape=shape_tensor)

	    #4
	    #x = np.array([0.5]).astype("float32")
	    #scale_tensor = fluid.data(name="scale", shape=[1], dtype="float32")
	    #fluid.layers.assign(x,scale_tensor)
	    #output = fluid.layers.resize_trilinear(input=input,scale=scale_tensor)

	    place = fluid.CPUPlace()
	    exe = fluid.Executor(place)
	    exe.run(fluid.default_startup_program())
7930

R
ruri 已提交
7931
	    input_data = np.random.rand(2,3,6,8,10).astype("float32")
K
Kaipeng Deng 已提交
7932

R
ruri 已提交
7933 7934 7935 7936
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
7937

R
ruri 已提交
7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950
	    print(output_data[0].shape)

	    #1
	    # (2, 3, 12, 12, 12)
	    #2
	    # (2, 3, 12, 2, 4)
	    #3
	    # (2, 3, 3, 12, 12)
	    #4
	    # (2, 3, 3, 4, 5)

	    #imperative mode
	    import paddle.fluid.dygraph as dg
7951

R
ruri 已提交
7952 7953 7954 7955
	    with dg.guard(place) as g:
    		input = dg.to_variable(input_data)
    		output = fluid.layers.resize_trilinear(input=input, out_shape=[12,12,12])
    		print(output.shape)
7956

R
ruri 已提交
7957
		# [2L, 3L, 12L, 12L, 12L]
7958 7959 7960



K
Kaipeng Deng 已提交
7961 7962 7963
    """

    return image_resize(input, out_shape, scale, name, 'TRILINEAR',
7964
                        actual_shape, align_corners, align_mode, data_format)
K
Kaipeng Deng 已提交
7965 7966


7967
@templatedoc(op_type="nearest_interp")
7968 7969 7970 7971
def resize_nearest(input,
                   out_shape=None,
                   scale=None,
                   name=None,
7972
                   actual_shape=None,
7973 7974
                   align_corners=True,
                   data_format='NCHW'):
7975
    """
7976 7977 7978 7979
    :alias_main: paddle.nn.functional.resize_nearest
	:alias: paddle.nn.functional.resize_nearest,paddle.nn.functional.vision.resize_nearest
	:old_api: paddle.fluid.layers.resize_nearest

R
ruri 已提交
7980
    This op resizes the input by performing nearest neighbor interpolation in both the
7981
    height direction and the width direction based on given output shape
7982
    which is specified by actual_shape, out_shape and scale in priority order.
7983

7984
    **Warning:** the parameter :attr:`actual_shape` will be deprecated in the
7985 7986
    future and only use :attr:`out_shape` instead.

7987 7988
    Example:

T
Tink_Y 已提交
7989 7990 7991
    .. code-block:: text

        For scale:
7992

T
Tink_Y 已提交
7993 7994
            if align_corners = True && out_size > 1 :
              scale_factor = (in_size-1.0)/(out_size-1.0)
7995

T
Tink_Y 已提交
7996
            else:
7997

T
Tink_Y 已提交
7998
              scale_factor = float(in_size/out_size)
7999

T
Tink_Y 已提交
8000
        Nearest neighbor interpolation:
8001

T
Tink_Y 已提交
8002 8003
          if:
              align_corners = False
8004

T
Tink_Y 已提交
8005 8006
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
8007

T
Tink_Y 已提交
8008 8009
              H_out = floor(H_{in} * scale_{factor})
              W_out = floor(W_{in} * scale_{factor})
8010

T
Tink_Y 已提交
8011 8012
          else:
              align_corners = True
8013

T
Tink_Y 已提交
8014 8015
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
8016

T
Tink_Y 已提交
8017 8018
              H_out = round(H_{in} * scale_{factor})
              W_out = round(W_{in} * scale_{factor})
8019 8020


8021
    For details of nearest neighbor interpolation, please refer to Wikipedia:
8022
    https://en.wikipedia.org/wiki/Nearest-neighbor_interpolation
Y
yuyang18 已提交
8023

R
ruri 已提交
8024
    Parameters:
8025 8026
        input(${x_type}): 4-D Tensor, its data type is float32, float64, or uint8,
                          its data format is specified by :attr:`data_format`.
R
ruri 已提交
8027
        out_shape(list|tuple|Variable|None): The output shape of resized tensor, the shape is (out_h, out_w). Default: None. Every element should be an integer or a tensor Variable with shape: [1] if it is a list. If it is a tensor Variable, its dimension size should be 1.
8028
        scale(float|Variable|None): The multiplier for the input height or width. At
8029 8030 8031
             least one of :attr:`out_shape` or :attr:`scale` must be set.
             And :attr:`out_shape` has a higher priority than :attr:`scale`.
             Default: None.
R
ruri 已提交
8032 8033
        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`
	actual_shape(Variable): An optional input to specify output shape
8034 8035
                                dynamically. If provided, image resize
                                according to this given shape rather than
8036
                                :attr:`out_shape` and :attr:`scale` specifying
8037 8038
                                shape. That is to say actual_shape has the
                                highest priority. It is recommended to use
8039 8040 8041 8042 8043
                                :attr:`out_shape` if you want to specify output
                                shape dynamically, because :attr:`actual_shape`
                                will be deprecated. When using actual_shape to
                                specify output shape, one of :attr:`out_shape`
                                and :attr:`scale` should also be set, otherwise
T
tianshuo78520a 已提交
8044
                                errors would be occurred in graph constructing stage.
8045
                                Default: None
8046
        align_corners(bool): ${align_corners_comment}
8047
        data_format (str, optional): Specify the data format of the input, and the data format of the output
8048 8049 8050
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
            `[batch_size, input_channels, input_height, input_width]`.
Y
yuyang18 已提交
8051 8052

    Returns:
R
ruri 已提交
8053
	Variable: 4-D tensor(NCHW or NHWC).
8054 8055 8056

    Examples:
        .. code-block:: python
8057

R
ruri 已提交
8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086
	    #declarative mode
	    import paddle.fluid as fluid
	    import numpy as np
	    input = fluid.data(name="input", shape=[None,3,6,10])

	    #1
	    output = fluid.layers.resize_nearest(input=input,out_shape=[12,12])

	    #2
	    #x = np.array([2]).astype("int32")
	    #dim1 = fluid.data(name="dim1", shape=[1], dtype="int32")
	    #fluid.layers.assign(input=x, output=dim1)
	    #output = fluid.layers.resize_nearest(input=input,out_shape=[12,dim1])

	    #3
	    #x = np.array([3,12]).astype("int32")
	    #shape_tensor = fluid.data(name="shape_tensor", shape=[2], dtype="int32")
	    #fluid.layers.assign(input=x, output=shape_tensor)
	    #output = fluid.layers.resize_nearest(input=input,out_shape=shape_tensor)

	    #4
	    #x = np.array([0.5]).astype("float32")
	    #scale_tensor = fluid.data(name="scale", shape=[1], dtype="float32")
	    #fluid.layers.assign(x,scale_tensor)
	    #output = fluid.layers.resize_nearest(input=input,scale=scale_tensor)

	    place = fluid.CPUPlace()
	    exe = fluid.Executor(place)
	    exe.run(fluid.default_startup_program())
8087

R
ruri 已提交
8088
	    input_data = np.random.rand(2,3,6,10).astype("float32")
8089

R
ruri 已提交
8090 8091 8092 8093
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
8094

R
ruri 已提交
8095 8096 8097 8098 8099 8100 8101 8102 8103 8104
	    print(output_data[0].shape)

	    #1
	    # (2, 3, 12, 12)
	    #2
	    # (2, 3, 12, 2)
	    #3
	    # (2, 3, 3, 12)
	    #4
	    # (2, 3, 3, 5)
8105

R
ruri 已提交
8106 8107
	    #imperative mode
	    import paddle.fluid.dygraph as dg
8108

R
ruri 已提交
8109 8110 8111 8112 8113 8114
	    with dg.guard(place) as g:
    		input = dg.to_variable(input_data)
    		output = fluid.layers.resize_nearest(input=input, out_shape=[12,12])
    		print(output.shape)

		# [2L, 3L, 12L, 12L]
8115 8116 8117



8118 8119
    """

8120 8121 8122 8123 8124 8125 8126 8127 8128 8129
    return image_resize(
        input,
        out_shape,
        scale,
        name,
        'NEAREST',
        actual_shape,
        align_corners,
        align_mode=1,
        data_format=data_format)
8130 8131 8132 8133


def image_resize_short(input, out_short_len, resample='BILINEAR'):
    """
R
ruri 已提交
8134
    This op resizes a batch of images. The short edge of input images will be
8135 8136
    resized to the given 'out_short_len'. The long edge of input images
    will be resized proportionately to make images' length-width ratio
8137 8138
    constant.

R
ruri 已提交
8139 8140
    Parameters:
        input (Variable): 4-D tensor(NCHW), The input tensor of image resize layer.
8141
        out_short_len(int): The length of output images' short edge.
8142
        resample (str): resample method, default: BILINEAR.
F
fengjiayi 已提交
8143

8144
    Returns:
R
ruri 已提交
8145
        Variable: 4-D tensor(NCHW).
R
ruri 已提交
8146 8147 8148 8149

    Examples:
        .. code-block:: python

8150
            import paddle.fluid as fluid
R
ruri 已提交
8151
            input = fluid.data(name="input", shape=[None,3,6,9], dtype="float32")
R
ruri 已提交
8152
            out = fluid.layers.image_resize_short(input, out_short_len=3)
8153 8154 8155 8156 8157 8158 8159 8160 8161 8162
    """
    in_shape = input.shape
    if len(in_shape) != 4:
        raise ValueError(
            "The rank of input must be 4 (num_batches, channels, in_h, in_w).")
    hw = in_shape[2:4]
    short_idx = hw.index(min(hw))
    long_idx = 1 - short_idx
    out_shape = list(hw)
    out_shape[short_idx] = out_short_len
F
fengjiayi 已提交
8163 8164 8165
    out_shape[long_idx] = int(
        float(out_shape[long_idx]) * (float(out_short_len) / float(hw[
            short_idx])) + 0.5)
8166 8167 8168
    return image_resize(input=input, out_shape=out_shape, resample=resample)


8169
def gather(input, index, overwrite=True):
W
whs 已提交
8170
    """
Q
qiaolongfei 已提交
8171 8172
    **Gather Layer**

8173
    Output is obtained by gathering entries of the outer-most dimension
W
whs 已提交
8174 8175 8176 8177
    of X indexed by `index` and concatenate them together.

    .. math::

8178
        Out = X[Index]
W
whs 已提交
8179 8180 8181 8182 8183 8184 8185


    .. code-block:: text


                Given:

8186 8187
                X = [[1, 2],
                     [3, 4],
W
whs 已提交
8188 8189 8190 8191 8192 8193 8194 8195 8196 8197
                     [5, 6]]

                Index = [1, 2]

                Then:

                Out = [[3, 4],
                       [5, 6]]

    Args:
8198 8199
        input (Variable): The source input tensor with rank>=1. Supported data type is
            int32, int64, float32, float64 and uint8 (only for CPU),
Y
Yibing Liu 已提交
8200 8201 8202
            float16 (only for GPU).
        index (Variable): The index input tensor with rank=1. Data type is int32 or int64.
        overwrite (bool, optional): The mode that updating the grad when has same index.
8203
            If True, use the overwrite mode to update the grad of the same index,
8204
	    if False, use the accumulate mode to update the grad of the same index.
8205
	    Default value is True.
8206

8207

W
whs 已提交
8208 8209 8210 8211 8212

    Returns:
        output (Variable): The output is a tensor with the same rank as input.

    Examples:
W
whs 已提交
8213

W
whs 已提交
8214 8215
        .. code-block:: python

8216
            import paddle.fluid as fluid
Y
Yibing Liu 已提交
8217 8218
            x = fluid.data(name='x', shape=[-1, 5], dtype='float32')
            index = fluid.data(name='index', shape=[-1, 1], dtype='int32')
W
whs 已提交
8219 8220 8221 8222
            output = fluid.layers.gather(x, index)
    """
    helper = LayerHelper('gather', **locals())
    dtype = helper.input_dtype()
X
Xin Pan 已提交
8223
    out = helper.create_variable_for_type_inference(dtype)
W
whs 已提交
8224 8225 8226 8227
    helper.append_op(
        type="gather",
        inputs={"X": input,
                "Index": index},
8228 8229
        outputs={"Out": out},
        attrs={'overwrite': overwrite})
W
whs 已提交
8230 8231 8232
    return out


8233 8234 8235 8236
def gather_nd(input, index, name=None):
    """
    **Gather Nd Layer**

8237 8238 8239 8240
    This function is actually a high-dimensional extension of :code:`gather`
    and supports for simultaneous indexing by multiple axes. :attr:`index` is a
    K-dimensional integer tensor, which is regarded as a (K-1)-dimensional
    tensor of :attr:`index` into :attr:`input`, where each element defines
8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262
    a slice of params:

    .. math::

        output[(i_0, ..., i_{K-2})] = input[index[(i_0, ..., i_{K-2})]]

    Obviously, :code:`index.shape[-1] <= input.rank` . And, the output tensor has
    shape :code:`index.shape[:-1] + input.shape[index.shape[-1]:]` .

    .. code-block:: text

            Given:
                input = [[[ 0,  1,  2,  3],
                          [ 4,  5,  6,  7],
                          [ 8,  9, 10, 11]],
                         [[12, 13, 14, 15],
                          [16, 17, 18, 19],
                          [20, 21, 22, 23]]]
                input.shape = (2, 3, 4)

            * Case 1:
                index = [[1]]
8263 8264 8265

                gather_nd(input, index)
                         = [input[1, :, :]]
8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284
                         = [[12, 13, 14, 15],
                            [16, 17, 18, 19],
                            [20, 21, 22, 23]]

            * Case 2:
                index = [[0,2]]

                gather_nd(input, index)
                         = [input[0, 2, :]]
                         = [8, 9, 10, 11]

            * Case 3:
                index = [[1, 2, 3]]

                gather_nd(input, index)
                         = [input[1, 2, 3]]
                         = [23]

    Args:
8285 8286 8287
        input (Variable): The source input. Its dtype should be int32, int64, float32, float64.
        index (Variable): The index input with rank > 1, index.shape[-1] <= input.rank.
                          Its dtype should be int32, int64.
8288
        name (str|None): A name for this layer(optional). If set None, the
8289
                         layer will be named automatically.
8290 8291 8292 8293 8294 8295 8296 8297 8298

    Returns:
        output (Variable): A tensor with the shape index.shape[:-1] + input.shape[index.shape[-1]:]

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid
8299 8300
            x = fluid.data(name='x', shape=[3, 4, 5], dtype='float32')
            index = fluid.data(name='index', shape=[2, 2], dtype='int32')
8301 8302 8303 8304 8305
            output = fluid.layers.gather_nd(x, index)

    """
    helper = LayerHelper('gather_nd', **locals())
    dtype = helper.input_dtype()
8306
    output = helper.create_variable_for_type_inference(dtype)
8307 8308 8309 8310 8311 8312 8313 8314
    helper.append_op(
        type="gather_nd",
        inputs={"X": input,
                "Index": index},
        outputs={"Out": output})
    return output


8315
def scatter(input, index, updates, name=None, overwrite=True):
8316
    """
8317 8318 8319 8320
    :alias_main: paddle.scatter
	:alias: paddle.scatter,paddle.tensor.scatter,paddle.tensor.manipulation.scatter
	:old_api: paddle.fluid.layers.scatter

8321 8322
    **Scatter Layer**

8323
    Output is obtained by updating the input on selected indices based on updates.
8324

8325 8326
    .. code-block:: python
        import numpy as np
8327

8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348
        #input:
        input = np.array([[1, 1], [2, 2], [3, 3]])
        index = np.array([2, 1, 0, 1])
        # shape of updates should be the same as input
        # shape of updates with dim > 1 should be the same as input
        updates = np.array([[1, 1], [2, 2], [3, 3], [4, 4]])
        overwrite = False

        # calculation:
        if not overwrite:
            for i in range(len(index)):
                input[index[i]] = np.zeros((2))

        for i in range(len(index)):
            if (overwrite):
                input[index[i]] = updates[i]
            else:
                input[index[i]] += updates[i]
        # output:
        out = np.array([[3, 3], [6, 6], [1, 1]])
        out.shape # [3, 2]
8349 8350

    Args:
8351 8352
        input (Variable): The input N-D Tensor with rank>=1. Data type can be float32.
        index (Variable): The index 1-D Tensor. Data type can be int32, int64. The length of index cannot exceed updates's length, and the value in index cannot exceed input's length.
T
tianshuo78520a 已提交
8353
        updates (Variable): update input with updates parameter based on index. shape should be the same as input, and dim value with dim > 1 should be the same as input.
8354 8355
        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` .
        overwrite (bool): The mode that updating the output when there are same indices.
8356
            If True, use the overwrite mode to update the output of the same index,
8357
	    if False, use the accumulate mode to update the output of the same index.
8358
	    Default value is True.
8359 8360

    Returns:
8361
        Variable(Tensor|LoDTensor): The output is a Tensor with the same shape as input.
8362 8363 8364 8365 8366

    Examples:

        .. code-block:: python

8367
            import numpy as np
8368 8369
            import paddle.fluid as fluid

8370 8371 8372
            input = fluid.layers.data(name='data', shape=[3, 2], dtype='float32', append_batch_size=False)
            index = fluid.layers.data(name='index', shape=[4], dtype='int64', append_batch_size=False)
            updates = fluid.layers.data(name='update', shape=[4, 2], dtype='float32', append_batch_size=False)
8373

8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387
            output = fluid.layers.scatter(input, index, updates, overwrite=False)

            exe = fluid.Executor(fluid.CPUPlace())
            exe.run(fluid.default_startup_program())

            in_data = np.array([[1, 1], [2, 2], [3, 3]]).astype(np.float32)
            index_data = np.array([2, 1, 0, 1]).astype(np.int64)
            update_data = np.array([[1, 1], [2, 2], [3, 3], [4, 4]]).astype(np.float32)

            res = exe.run(fluid.default_main_program(), feed={'data':in_data, "index":index_data, "update":update_data}, fetch_list=[output])
            print(res)
            # [array([[3., 3.],
            #   [6., 6.],
            #   [1., 1.]], dtype=float32)]
8388 8389 8390
    """
    helper = LayerHelper('scatter', **locals())
    dtype = helper.input_dtype()
X
Xin Pan 已提交
8391
    out = helper.create_variable_for_type_inference(dtype)
8392 8393 8394 8395 8396
    helper.append_op(
        type="scatter",
        inputs={"X": input,
                "Ids": index,
                "Updates": updates},
8397
        attrs={'overwrite': overwrite},
8398 8399 8400 8401
        outputs={"Out": out})
    return out


8402 8403 8404 8405 8406
def scatter_nd_add(ref, index, updates, name=None):
    """
    **Scatter_nd_add Layer**

    Output is obtained by applying sparse addition to a single value
8407
    or slice in a Variable.
8408

8409 8410 8411
    :attr:`ref` is a Tensor with rank :math:`R`
    and :attr:`index` is a Tensor with rank :math:`K` . Thus, :attr:`index`
    has shape :math:`[i_0, i_1, ..., i_{K-2}, Q]` where :math:`Q \leq R` . :attr:`updates`
8412 8413
    is a Tensor with rank :math:`K - 1 + R - Q` and its
    shape is :math:`index.shape[:-1] + ref.shape[index.shape[-1]:]` .
8414

8415 8416 8417 8418 8419
    According to the :math:`[i_0, i_1, ..., i_{K-2}]` of :attr:`index` ,
    add the corresponding :attr:`updates` slice to the :attr:`ref` slice
    which is obtained by the last one dimension of :attr:`index` .

    .. code-block:: text
8420

8421 8422 8423 8424 8425 8426 8427 8428
        Given:

        * Case 1:
            ref = [0, 1, 2, 3, 4, 5]
            index = [[1], [2], [3], [1]]
            updates = [9, 10, 11, 12]

          we get:
8429

8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441
            output = [0, 22, 12, 14, 4, 5]

        * Case 2:
            ref = [[65, 17], [-14, -25]]
            index = [[], []]
            updates = [[[-1, -2], [1, 2]],
                       [[3, 4], [-3, -4]]]
            ref.shape = (2, 2)
            index.shape = (2, 0)
            updates.shape = (2, 2, 2)

          we get:
8442

8443 8444 8445
            output = [[67, 19], [-16, -27]]

    Args:
S
ShenLiang 已提交
8446
        ref (Variable): The ref input. Its dtype should be float32, float64.
8447 8448
        index (Variable): The index input with rank > 1 and index.shape[-1] <= ref.rank.
                          Its dtype should be int32 or int64 as it is used as indexes.
8449 8450 8451
        updates (Variable): The updated value of scatter_nd_add op, and it must have the same dtype
                            as ref. It must have the shape index.shape[:-1] + ref.shape[index.shape[-1]:].
        name (str|None): The output variable name. If set None, the layer will be named automatically.
8452 8453

    Returns:
8454
        output (Variable): The output is a tensor with the same shape and dtype as ref.
8455 8456 8457 8458 8459 8460 8461

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid

8462 8463 8464
            ref = fluid.data(name='ref', shape=[3, 5, 9, 10], dtype='float32')
            index = fluid.data(name='index', shape=[3, 2], dtype='int32')
            updates = fluid.data(name='update', shape=[3, 9, 10], dtype='float32')
8465 8466 8467 8468 8469 8470 8471

            output = fluid.layers.scatter_nd_add(ref, index, updates)
    """
    if ref.dtype != updates.dtype:
        raise ValueError("ref and updates must have same data type.")

    helper = LayerHelper('scatter_nd_add', **locals())
8472
    dtype = helper.input_dtype(input_param_name='ref')
8473
    output = helper.create_variable_for_type_inference(dtype)
8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486
    helper.append_op(
        type="scatter_nd_add",
        inputs={"X": ref,
                "Index": index,
                "Updates": updates},
        outputs={"Out": output})
    return output


def scatter_nd(index, updates, shape, name=None):
    """
    **Scatter_nd Layer**

8487 8488 8489 8490 8491 8492 8493
    Output is obtained by scattering the :attr:`updates` in a new tensor according
    to :attr:`index` . This op is similar to :code:`scatter_nd_add`, except the
    tensor of :attr:`shape` is zero-initialized. Correspondingly, :code:`scatter_nd(index, updates, shape)`
    is equal to :code:`scatter_nd_add(fluid.layers.zeros(shape, updates.dtype), index, updates)` .
    If :attr:`index` has repeated elements, then the corresponding updates are accumulated.
    Because of the numerical approximation issues, the different order of repeated elements
    in :attr:`index` may cause different results. The specific calculation method can be
8494 8495 8496 8497 8498
    seen :code:`scatter_nd_add` . This op is the inverse of the :code:`gather_nd` op.

    Args:
        index (Variable): The index input with rank > 1 and index.shape[-1] <= len(shape).
                          Its dtype should be int32 or int64 as it is used as indexes.
S
ShenLiang 已提交
8499
        updates (Variable): The updated value of scatter_nd op. Its dtype should be float32, float64.
8500 8501
                            It must have the shape index.shape[:-1] + shape[index.shape[-1]:]
        shape(tuple|list): Shape of output tensor.
8502
        name (str|None): The output variable name. If set None, the layer will be named automatically.
8503 8504 8505 8506 8507 8508 8509 8510 8511 8512

    Returns:
        output (Variable): The output is a tensor with the same type as :attr:`updates` .

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid

8513 8514
            index = fluid.data(name='index', shape=[3, 2], dtype='int64')
            updates = fluid.data(name='update', shape=[3, 9, 10], dtype='float32')
8515 8516 8517 8518 8519 8520 8521
            shape = [3, 5, 9, 10]

            output = fluid.layers.scatter_nd(index, updates, shape)
    """
    return scatter_nd_add(zeros(shape, updates.dtype), index, updates, name)


Y
yuyang18 已提交
8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534
@templatedoc()
def random_crop(x, shape, seed=None):
    """
    ${comment}

    Args:
        x(${x_type}): ${x_comment}
        shape(${shape_type}): ${shape_comment}
        seed(int|${seed_type}|None): ${seed_comment} By default, the seed will
            get from `random.randint(-65536, 65535)`.

    Returns:
        ${out_comment}
8535

8536
    Examples:
Q
qingqing01 已提交
8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549
        .. code-block:: python

            import paddle.fluid as fluid
            img = fluid.data("img", [None, 3, 256, 256])
            # cropped_img is [-1, 3, 224, 224]
            cropped_img = fluid.layers.random_crop(img, shape=[3, 224, 224])

            # cropped_img2 shape: [-1, 2, 224, 224]
            # cropped_img2 = fluid.layers.random_crop(img, shape=[2, 224, 224])

            # cropped_img3 shape: [-1, 3, 128, 224]
            # cropped_img3 = fluid.layers.random_crop(img, shape=[128, 224])

Y
yuyang18 已提交
8550
    """
F
stash  
fengjiayi 已提交
8551
    helper = LayerHelper("random_crop", **locals())
8552 8553 8554 8555
    check_variable_and_dtype(x, 'x',
                             ['float32', 'float64', 'uint8', 'int16', 'int32'],
                             'random_crop')
    check_type(shape, 'shape', (list, Variable), 'random_crop')
F
fengjiayi 已提交
8556
    dtype = x.dtype
X
Xin Pan 已提交
8557
    out = helper.create_variable_for_type_inference(dtype)
Y
yuyang18 已提交
8558
    if seed is None:
8559
        seed = np.random.randint(-65536, 65536)
F
fengjiayi 已提交
8560
    op_attrs = {"shape": shape}
F
stash  
fengjiayi 已提交
8561
    if isinstance(seed, int):
F
fengjiayi 已提交
8562 8563 8564 8565 8566
        op_attrs["startup_seed"] = seed
        seed = helper.create_variable(
            name=unique_name.generate("random_crop_seed"),
            dtype="int64",
            persistable=True)
F
stash  
fengjiayi 已提交
8567 8568 8569 8570
    elif not isinstance(seed, Variable):
        raise ValueError("'seed' must be a Variable or an int.")
    helper.append_op(
        type="random_crop",
F
fix  
fengjiayi 已提交
8571
        inputs={"X": x,
F
stash  
fengjiayi 已提交
8572 8573
                "Seed": seed},
        outputs={"Out": out,
F
fengjiayi 已提交
8574 8575
                 "SeedOut": seed},
        attrs=op_attrs)
F
stash  
fengjiayi 已提交
8576
    return out
W
whs 已提交
8577 8578


8579
def log(x, name=None):
W
wanghaoshuang 已提交
8580
    """
8581 8582 8583 8584
    :alias_main: paddle.log
	:alias: paddle.log,paddle.tensor.log,paddle.tensor.math.log
	:old_api: paddle.fluid.layers.log

W
wanghaoshuang 已提交
8585 8586 8587 8588
    Calculates the natural log of the given input tensor, element-wise.

    .. math::

8589
        Out = \\ln(x)
W
wanghaoshuang 已提交
8590 8591

    Args:
W
Wilber 已提交
8592 8593
        x (Variable): Input LoDTensor or Tensor. Must be one of the following types: float32, float64.
        name (str|None): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`
8594

W
wanghaoshuang 已提交
8595 8596

    Returns:
W
Wilber 已提交
8597
        Variable: The natural log of the input LoDTensor or Tensor computed element-wise.
W
wanghaoshuang 已提交
8598 8599 8600 8601 8602

    Examples:

        .. code-block:: python

8603
            import paddle.fluid as fluid
W
Wilber 已提交
8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616
            import numpy as np

            # Graph Organizing
            x = fluid.layers.data(name="x", shape=[1], dtype="float32")
            res = fluid.layers.log(x)

            # Create an executor using CPU as an example
            exe = fluid.Executor(fluid.CPUPlace())

            # Execute
            x_i = np.array([[1], [2]]).astype(np.float32)
            res_val, = exe.run(fluid.default_main_program(), feed={'x':x_i}, fetch_list=[res])
            print(res_val) # [[0.], [0.6931472]]
W
wanghaoshuang 已提交
8617
    """
8618
    if in_dygraph_mode():
8619
        return core.ops.log(x)
8620

8621
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], "log")
8622
    inputs = {'X': [x]}
W
wanghaoshuang 已提交
8623
    helper = LayerHelper('log', **locals())
W
wanghaoshuang 已提交
8624
    dtype = helper.input_dtype(input_param_name='x')
X
Xin Pan 已提交
8625
    out = helper.create_variable_for_type_inference(dtype)
W
wanghaoshuang 已提交
8626
    helper.append_op(type="log", inputs={"X": x}, outputs={"Out": out})
W
wanghaoshuang 已提交
8627 8628 8629
    return out


Z
zhupengyang 已提交
8630
@templatedoc()
8631
def relu(x, name=None):
W
wanghaoshuang 已提交
8632
    """
Z
zhupengyang 已提交
8633
    ${comment}
W
wanghaoshuang 已提交
8634 8635

    Args:
Z
zhupengyang 已提交
8636 8637 8638 8639
        x(Variable): ${x_comment}
        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`.
W
wanghaoshuang 已提交
8640 8641

    Returns:
Z
zhupengyang 已提交
8642
        Variable: ${out_comment}
W
wanghaoshuang 已提交
8643 8644 8645 8646 8647

    Examples:

        .. code-block:: python

8648
            import paddle.fluid as fluid
Z
zhupengyang 已提交
8649 8650 8651 8652 8653 8654 8655 8656 8657
            import numpy as np
            in1 = np.array([[-1,0],[1,2.6]])
            with fluid.dygraph.guard():
                x1 = fluid.dygraph.to_variable(in1)
                out1 = fluid.layers.relu(x1)
                print(out1.numpy())
                # [[0.  0. ]
                #  [1.  2.6]]
"""
8658
    if in_dygraph_mode():
8659
        return core.ops.relu(x)
8660

8661 8662
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'relu')

8663
    inputs = {'X': [x]}
W
wanghaoshuang 已提交
8664
    helper = LayerHelper('relu', **locals())
W
wanghaoshuang 已提交
8665
    dtype = helper.input_dtype(input_param_name='x')
X
Xin Pan 已提交
8666
    out = helper.create_variable_for_type_inference(dtype)
X
Xin Pan 已提交
8667 8668
    helper.append_op(
        type="relu", inputs={"X": helper.input('x')}, outputs={"Out": out})
W
wanghaoshuang 已提交
8669
    return out
8670 8671


C
chengduo 已提交
8672 8673
def selu(x, scale=None, alpha=None, name=None):
    """
8674 8675 8676 8677
    :alias_main: paddle.nn.functional.selu
	:alias: paddle.nn.functional.selu,paddle.nn.functional.activation.selu
	:old_api: paddle.fluid.layers.selu

8678 8679 8680
    Selu Operator.

    The equation is:
8681

8682 8683 8684 8685 8686 8687
    .. math::
        selu= \\lambda*
        \\begin{cases}
            x                      &\\quad \\text{ if } x>0 \n
            \\alpha * e^x - \\alpha  &\\quad \\text{ if } x<=0
        \\end{cases}
8688

8689 8690 8691

    The input `X` can carry the LoD (Level of Details) information,
    or not. And the output shares the LoD information with input `X`.
C
chengduo 已提交
8692 8693

    Args:
8694 8695
        x (Variable): The input N-D Tensor.
        scale(float, optional): lambda in selu activation function,
C
chengduo 已提交
8696 8697 8698
            the default value is 1.0507009873554804934193349852946.
            For more information about this value, please refer
            to: https://arxiv.org/abs/1706.02515.
8699
        alpha(float, optional): alpha in selu activation function,
C
chengduo 已提交
8700 8701 8702
            the default value is 1.6732632423543772848170429916717.
            For more information about this value, please refer
            to: https://arxiv.org/abs/1706.02515.
8703 8704
        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` .

C
chengduo 已提交
8705 8706

    Returns:
8707
        Variable(Tensor|LoDTensor): The output Tensor or LoDTensor with the same shape and LoD information as input.
C
chengduo 已提交
8708 8709 8710 8711

    Examples:

        .. code-block:: python
8712

8713
            import paddle.fluid as fluid
8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725
            import numpy as np

            inputs = fluid.layers.data(name="x", shape=[2, 2], dtype="float32")
            output = fluid.layers.selu(inputs)

            exe = fluid.Executor(fluid.CPUPlace())
            exe.run(fluid.default_startup_program())

            img = np.array([[0, 1],[2, 3]]).astype(np.float32)

            res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output])
            print(res) # [array([[0.      , 1.050701],[2.101402, 3.152103]], dtype=float32)]
C
chengduo 已提交
8726
    """
8727 8728
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'selu')

C
chengduo 已提交
8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742
    helper = LayerHelper('selu', **locals())
    dtype = helper.input_dtype(input_param_name='x')
    out = helper.create_variable_for_type_inference(dtype)
    attrs = {}
    if scale is not None:
        attrs["scale"] = scale
    if alpha is not None:
        attrs["alpha"] = alpha

    helper.append_op(
        type="selu", inputs={"X": x}, outputs={"Out": out}, attrs=attrs)
    return out


W
whs 已提交
8743 8744 8745
def mean_iou(input, label, num_classes):
    """
    Mean Intersection-Over-Union is a common evaluation metric for
8746 8747 8748 8749
    semantic image segmentation, which first computes the IOU for each
    semantic class and then computes the average over classes.
    IOU is defined as follows:

W
whs 已提交
8750
    .. math::
8751

H
haowang101779990 已提交
8752
        IOU = \\frac{true\_positive}{(true\_positive + false\_positive + false\_negative)}.
W
whs 已提交
8753

8754
    The predictions are accumulated in a confusion matrix and mean-IOU
W
whs 已提交
8755 8756 8757
    is then calculated from it.


L
Liufang Sang 已提交
8758 8759
    Parameters:
        input (Variable): A n-D Tensor of prediction results for semantic labels with type int32 or int64.
8760
        label (Variable): A Tensor of ground truth labels with type int32 or int64.
W
whs 已提交
8761
                           Its shape should be the same as input.
L
Liufang Sang 已提交
8762 8763
        num_classes (int32): The possible number of labels.

8764
    Returns:
L
Liufang Sang 已提交
8765 8766 8767 8768 8769 8770 8771
	Three Variables.

        - mean_iou(Variable) : A 1-D Tensor representing the mean intersection-over-union with shape [1]. \
			    Data type is float32.
        - out_wrong(Variable) : A 1-D Tensor with shape [num_classes]. Data type is int32. \
			     The wrong numbers of each class.
        - out_correct(Variable): A 1-D  Tensor with shape [num_classes]. Data type is int32. The correct numbers of each class.
8772 8773


W
whs 已提交
8774 8775 8776
    Examples:

        .. code-block:: python
8777

B
Bai Yifan 已提交
8778
            import paddle.fluid as fluid
L
Liufang Sang 已提交
8779
            iou_shape = [None, 32, 32]
8780
            num_classes = 5
L
Liufang Sang 已提交
8781 8782 8783
            predict = fluid.data(name='predict', shape=iou_shape, dtype='int64')
            label = fluid.data(name='label', shape=iou_shape, dtype='int64')
            mean_iou, out_wrong, out_correct = fluid.layers.mean_iou(predict, label,
8784
                                                          num_classes)
W
whs 已提交
8785 8786
    """
    helper = LayerHelper('mean_iou', **locals())
8787 8788 8789
    check_variable_and_dtype(input, 'Predictions', ['int32', 'int64'],
                             'mean_iou')
    check_variable_and_dtype(label, 'Labels', ['int32', 'int64'], 'mean_iou')
W
whs 已提交
8790
    dtype = helper.input_dtype()
X
Xin Pan 已提交
8791 8792 8793
    out_mean_iou = helper.create_variable_for_type_inference(dtype='float32')
    out_wrong = helper.create_variable_for_type_inference(dtype='int32')
    out_correct = helper.create_variable_for_type_inference(dtype='int32')
W
whs 已提交
8794 8795
    helper.append_op(
        type="mean_iou",
W
whs 已提交
8796 8797
        inputs={"Predictions": input,
                "Labels": label},
W
whs 已提交
8798
        outputs={
W
whs 已提交
8799 8800 8801
            "OutMeanIou": out_mean_iou,
            "OutWrong": out_wrong,
            "OutCorrect": out_correct
W
whs 已提交
8802 8803 8804
        },
        attrs={"num_classes": num_classes})
    return out_mean_iou, out_wrong, out_correct
8805 8806 8807 8808 8809 8810


def crop(x, shape=None, offsets=None, name=None):
    """
    Crop input into output, as specified by offsets and shape.

S
SunGaofeng 已提交
8811 8812
    **Warning:** THIS OP IS DEPRECATED. It will be removed in the future version.
    Instructions for updating: Use :ref:`api_fluid_layers_crop_tensor` instead.
8813

8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841
    .. code-block:: text

        * Case 1:
            Given
                X = [[0, 1, 2, 0, 0]
                     [0, 3, 4, 0, 0]
                     [0, 0, 0, 0, 0]],
            and
                shape = [2, 2],
                offsets = [0, 1],
            output is:
                Out = [[1, 2],
                       [3, 4]].
        * Case 2:
            Given
                X = [[0, 1, 2, 5, 0]
                     [0, 3, 4, 6, 0]
                     [0, 0, 0, 0, 0]],
            and shape is tensor
                shape = [[0, 0, 0]
                         [0, 0, 0]]
            and
                offsets = [0, 1],

            output is:
                Out = [[1, 2, 5],
                       [3, 4, 6]].

S
SunGaofeng 已提交
8842 8843 8844 8845
    Parameters:
        x (Variable): Tensor, data type can be float32 or float64.
        shape (Variable|list/tuple of integers): The output shape is specified
            by `shape`, which can be a Tensor or a list/tuple of integers.
8846
            If it is a Tensor, it's rank must be the same as `x` , only
S
SunGaofeng 已提交
8847
            it's shape will be used, and the value of it will be ignored. This way
8848
            is suitable for the case that the output shape may be changed each
S
SunGaofeng 已提交
8849
            iteration. If it is a list/tuple of integers, it's length must be the same
8850
            as the rank of `x`
S
SunGaofeng 已提交
8851 8852 8853
        offsets (Variable|list/tuple of integers|None): Specifies the cropping
            offsets at each dimension. It can be a Tensor or a list/tuple
            of integers. If it is a Tensor, it's rank must be the same as `x`.
8854
            This way is suitable for the case that the offsets may be changed
S
SunGaofeng 已提交
8855 8856
            each iteration. If it is a list/tuple of integers, it's length must be the
            same as the rank of `x`. If None, the offsets are 0 at each dimension.
8857 8858 8859
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name` . Usually name is no need to set and
            None by default.
8860 8861

    Returns:
S
SunGaofeng 已提交
8862 8863 8864 8865
        The cropped Tensor, which has the same rank and data type with `x`

    Return Type:
        Variable
8866 8867 8868 8869 8870 8871 8872 8873

    Raises:
        ValueError: If shape is not a list, tuple or Variable.

    Examples:

        .. code-block:: python

S
SunGaofeng 已提交
8874
            import paddle.fluid as fluid
S
SunGaofeng 已提交
8875 8876
            x = fluid.data(name="x", shape=[3, 3, 5], dtype="float32")
            y = fluid.data(name="y", shape=[2, 2, 3], dtype="float32")
8877 8878 8879
            crop = fluid.layers.crop(x, shape=y)

            # or
S
SunGaofeng 已提交
8880 8881
            z = fluid.data(name="z", shape=[3, 3, 5], dtype="float32")
            crop = fluid.layers.crop(z, shape=[2, 2, 3])
8882 8883

    """
8884 8885
    check_variable_and_dtype(x, 'x', ['float32'], 'crop')
    check_type(shape, 'shape', (list, tuple, Variable), 'crop')
8886 8887 8888 8889 8890
    helper = LayerHelper('crop', **locals())

    if offsets is None:
        offsets = [0] * len(x.shape)

X
Xin Pan 已提交
8891
    out = helper.create_variable_for_type_inference(x.dtype)
8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908
    ipts = {'X': x}
    attrs = {}
    if isinstance(shape, Variable):
        ipts['Y'] = shape
    else:
        attrs['shape'] = shape
    if isinstance(offsets, Variable):
        ipts['Offsets'] = offsets
    else:
        attrs['offsets'] = offsets

    helper.append_op(
        type='crop',
        inputs=ipts,
        outputs={'Out': out},
        attrs=None if len(attrs) == 0 else attrs)
    return out
8909 8910


8911 8912
def crop_tensor(x, shape=None, offsets=None, name=None):
    """
8913 8914 8915 8916
    :alias_main: paddle.crop_tensor
	:alias: paddle.crop_tensor,paddle.tensor.crop_tensor,paddle.tensor.creation.crop_tensor
	:old_api: paddle.fluid.layers.crop_tensor

8917 8918 8919 8920
    Crop input into output, as specified by offsets and shape.

    .. code-block:: text

8921 8922
        * Case 1 (input is a 2-D Tensor):
            Input:
8923
                X.shape = [3, 5]
8924 8925 8926 8927 8928 8929 8930
                X.data = [[0, 1, 2, 0, 0],
                          [0, 3, 4, 0, 0],
                          [0, 0, 0, 0, 0]]
            Parameters:
                shape = [2, 2]
                offsets = [0, 1]
            Output:
8931 8932 8933
                Out.shape = [2, 2]
                Out.data = [[1, 2],
                            [3, 4]]
8934 8935 8936 8937 8938 8939 8940 8941 8942 8943
        * Case 2 (input is a 3-D Tensor):
            Input:
                X.shape = [2, 3, 4]
                X.data =  [[[0, 1, 2, 3],
                            [0, 5, 6, 7],
                            [0, 0, 0, 0]],
                           [[0, 3, 4, 5],
                            [0, 6, 7, 8],
                            [0, 0, 0, 0]]]
            Parameters:
8944
                shape = [2, 2, -1]
8945 8946
                offsets = [0, 0, 1]
            Output:
8947 8948 8949 8950 8951
                Out.shape = [2, 2, 3]
                Out.data  = [[[1, 2, 3],
                              [5, 6, 7]],
                             [[3, 4, 5],
                              [6, 7, 8]]]
8952 8953

    Parameters:
8954
        x (Variable): 1-D to 6-D Tensor, the data type is float32, float64, int32 or int64.
8955 8956
        shape (list|tuple|Variable): The output shape is specified
            by `shape`. Its data type is int32. If a list/tuple, it's length must be
T
tianshuo78520a 已提交
8957
            the same as the dimension size of `x`. If a Variable, it should be a 1-D Tensor.
8958
            When it is a list, each element can be an integer or a Tensor of shape: [1].
8959 8960
            If Variable contained, it is suitable for the case that the shape may
            be changed each iteration.
8961 8962
        offsets (list|tuple|Variable, optional): Specifies the cropping
            offsets at each dimension. Its data type is int32. If a list/tuple, it's length
T
tianshuo78520a 已提交
8963
            must be the same as the dimension size of `x`. If a Variable, it should be a 1-D
8964 8965 8966 8967 8968
            Tensor. When it is a list, each element can be an integer or a Tensor of shape: [1].
            If Variable contained, it is suitable for the case that the offsets may be changed
            each iteration. Default: None, the offsets are 0 at each dimension.
        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` .
8969 8970

    Returns:
8971
        Variable: The cropped Tensor has same data type with `x`.
8972 8973

    Raises:
8974 8975 8976 8977 8978 8979
        TypeError: If the data type of `x` is not in: float32, float64, int32, int64.
        TypeError: If `shape` is not a list, tuple or Variable.
        TypeError: If the data type of `shape` is not int32.
        TypeError: If `offsets` is not None and not a list, tuple or Variable.
        TypeError: If the data type of `offsets` is not int32.
        ValueError: If the element in `offsets` is less than zero.
8980 8981 8982 8983 8984 8985

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid
8986
            x = fluid.data(name="x", shape=[None, 3, 5], dtype="float32")
8987 8988
            # x.shape = [-1, 3, 5], where -1 indicates batch size, and it will get the exact value in runtime.

8989 8990
            # shape is a 1-D Tensor
            crop_shape = fluid.data(name="crop_shape", shape=[3], dtype="int32")
8991 8992 8993 8994
            crop0 = fluid.layers.crop_tensor(x, shape=crop_shape)
            # crop0.shape = [-1, -1, -1], it means crop0.shape[0] = x.shape[0] in runtime.

            # or shape is a list in which each element is a constant
8995
            crop1 = fluid.layers.crop_tensor(x, shape=[-1, -1, 3], offsets=[0, 1, 0])
8996 8997
            # crop1.shape = [-1, 2, 3]

8998 8999 9000 9001 9002
            # or shape is a list in which each element is a constant or Variable
            y = fluid.data(name="y", shape=[3, 8, 8], dtype="float32")
            dim1 = fluid.data(name="dim1", shape=[1], dtype="int32")
            crop2 = fluid.layers.crop_tensor(y, shape=[3, dim1, 4])
            # crop2.shape = [3, -1, 4]
9003

9004 9005
            # offsets is a 1-D Tensor
            crop_offsets = fluid.data(name="crop_offsets", shape=[3], dtype="int32")
9006 9007 9008
            crop3 = fluid.layers.crop_tensor(x, shape=[-1, 2, 3], offsets=crop_offsets)
            # crop3.shape = [-1, 2, 3]

9009 9010
            # offsets is a list in which each element is a constant or Variable
            offsets_var =  fluid.data(name="dim1", shape=[1], dtype="int32")
9011 9012 9013 9014 9015
            crop4 = fluid.layers.crop_tensor(x, shape=[-1, 2, 3], offsets=[0, 1, offsets_var])
            # crop4.shape = [-1, 2, 3]

    """
    helper = LayerHelper('crop_tensor', **locals())
9016 9017
    check_variable_and_dtype(x, 'x', ['float32', 'float64', 'int32', 'int64'],
                             'crop_tensor')
9018 9019 9020
    check_type(shape, 'shape', (list, tuple, Variable), 'crop_tensor')
    check_type(offsets, 'offsets', (list, tuple, Variable, type(None)),
               'crop_tensor')
9021 9022 9023 9024 9025 9026 9027 9028

    if offsets is None:
        offsets = [0] * len(x.shape)

    out = helper.create_variable_for_type_inference(x.dtype)
    ipts = {'X': x}
    attrs = {}

9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052
    def _attr_shape_check(shape_val):
        if not isinstance(shape_val, int):
            raise TypeError(
                "Attr(shape)'s dtype of Op(crop_tensor) should be int32, but received: %s."
                % type(shape_val))
        if shape_val == 0:
            raise ValueError(
                "Attr(shape) of Op(crop_tensor) should not be zero, but received: %s."
                % str(shape_val))
        if shape_val < -1:
            raise ValueError(
                "When the element in Attr(shape) of Op(crop_tensor) is negative, only -1 is supported, but received: %s."
                % str(shape_val))

    def _attr_offsets_check(offset_val):
        if not isinstance(offset_val, int):
            raise TypeError(
                "Attr(offsets)'s dtype of Op(crop_tensor) should be int32, but received: %s."
                % type(offset_val))
        if offset_val < 0:
            raise ValueError(
                "Attr(offsets) of Op(crop_tensor) should be greater or equal to zero, but received: %s."
                % str(offset_val))

9053 9054 9055
    if isinstance(offsets, Variable):
        offsets.stop_gradient = True
        ipts['Offsets'] = offsets
9056
        attrs['offsets'] = [-1] * len(x.shape)
L
Leo Chen 已提交
9057
    elif utils._contain_var(offsets):
9058
        new_offsets_tensor = []
9059
        offsets_attr = []
9060 9061 9062 9063
        for dim in offsets:
            if isinstance(dim, Variable):
                dim.stop_gradient = True
                new_offsets_tensor.append(dim)
9064
                offsets_attr.append(-1)
9065
            else:
9066
                _attr_offsets_check(dim)
9067 9068 9069
                temp_out = helper.create_variable_for_type_inference('int32')
                fill_constant([1], 'int32', dim, force_cpu=True, out=temp_out)
                new_offsets_tensor.append(temp_out)
9070
                offsets_attr.append(dim)
9071
        ipts['OffsetsTensor'] = new_offsets_tensor
9072
        attrs['offsets'] = offsets_attr
9073
    else:
9074 9075
        for offset in offsets:
            _attr_offsets_check(offset)
9076 9077 9078 9079 9080
        attrs['offsets'] = offsets

    if isinstance(shape, Variable):
        shape.stop_gradient = True
        ipts['Shape'] = shape
L
Leo Chen 已提交
9081
    elif utils._contain_var(shape):
9082 9083
        new_shape_tensor = []
        shape_attr = []
9084
        for dim_size in shape:
9085 9086 9087
            if isinstance(dim_size, Variable):
                dim_size.stop_gradient = True
                new_shape_tensor.append(dim_size)
9088
                shape_attr.append(0)
9089
            else:
9090
                _attr_shape_check(dim_size)
9091 9092 9093 9094 9095 9096 9097 9098
                temp_out = helper.create_variable_for_type_inference('int32')
                fill_constant(
                    [1], 'int32', dim_size, force_cpu=True, out=temp_out)
                new_shape_tensor.append(temp_out)
                shape_attr.append(dim_size)
        ipts['ShapeTensor'] = new_shape_tensor
        attrs['shape'] = shape_attr
    else:
9099 9100
        for dim_size in shape:
            _attr_shape_check(dim_size)
9101 9102 9103 9104 9105 9106 9107 9108 9109 9110
        attrs['shape'] = shape

    helper.append_op(
        type='crop_tensor',
        inputs=ipts,
        outputs={'Out': out},
        attrs=None if len(attrs) == 0 else attrs)
    return out


W
whs 已提交
9111 9112
def affine_grid(theta, out_shape, name=None):
    """
9113 9114 9115 9116
    :alias_main: paddle.nn.functional.affine_grid
	:alias: paddle.nn.functional.affine_grid,paddle.nn.functional.vision.affine_grid
	:old_api: paddle.fluid.layers.affine_grid

W
whs 已提交
9117 9118 9119 9120 9121 9122
    It generates a grid of (x,y) coordinates using the parameters of
    the affine transformation that correspond to a set of points where
    the input feature map should be sampled to produce the transformed
    output feature map.

    Args:
9123 9124 9125 9126 9127 9128
        theta (Variable) - A Tensor with shape [N, 2, 3]. It contains a batch of affine transform parameters.
                           The data type can be float32 or float64.
        out_shape (Variable | list | tuple): The shape of target output with format [batch_size, channel, height, width].
                                             ``out_shape`` can be a Tensor or a list or tuple. The data
                                             type must be int32.
        name(str|None): The default value is None.  Normally there is no need for user to set this property.  For more information, please refer to :ref:`api_guide_Name`.
W
whs 已提交
9129 9130

    Returns:
9131
        Variable: A Tensor with shape [batch_size, H, W, 2] while 'H' and 'W' are the height and width of feature map in affine transformation. The data type is the same as `theta`.
W
whs 已提交
9132 9133 9134 9135 9136 9137 9138

    Raises:
        ValueError: If the type of arguments is not supported.

    Examples:

        .. code-block:: python
H
haowang101779990 已提交
9139

S
SunGaofeng 已提交
9140
            import paddle.fluid as fluid
9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154
            import numpy as np
            place = fluid.CPUPlace()
            theta = fluid.data(name="x", shape=[None, 2, 3], dtype="float32")
            out_shape = fluid.data(name="y", shape=[4], dtype="int32")
            grid_0 = fluid.layers.affine_grid(theta, out_shape)
            grid_1 = fluid.layers.affine_grid(theta, [5, 3, 28, 28])
            batch_size=2
            exe = fluid.Executor(place)
            exe.run(fluid.default_startup_program())
            output= exe.run(feed={"x": np.random.rand(batch_size,2,3).astype("float32"),
                                  "y": np.array([5, 3, 28, 28]).astype("int32")},
                                  fetch_list=[grid_0.name, grid_1.name])
            print(output[0])
            print(output[1])
W
whs 已提交
9155 9156 9157
    """
    helper = LayerHelper('affine_grid')

9158 9159 9160
    check_variable_and_dtype(theta, 'theta', ['float32', 'float64'],
                             'affine_grid')

W
whs 已提交
9161
    if not (isinstance(out_shape, list) or isinstance(out_shape, tuple) or \
9162
            isinstance(out_shape, Variable)):
W
whs 已提交
9163 9164 9165 9166 9167 9168 9169 9170 9171 9172
        raise ValueError("The out_shape should be a list, tuple or Variable.")

    if not isinstance(theta, Variable):
        raise ValueError("The theta should be a Variable.")

    out = helper.create_variable_for_type_inference(theta.dtype)
    ipts = {'Theta': theta}
    attrs = {}
    if isinstance(out_shape, Variable):
        ipts['OutputShape'] = out_shape
9173 9174
        check_variable_and_dtype(out_shape, 'out_shape', ['int32'],
                                 'affine_grid')
W
whs 已提交
9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185
    else:
        attrs['output_shape'] = out_shape

    helper.append_op(
        type='affine_grid',
        inputs=ipts,
        outputs={'Output': out},
        attrs=None if len(attrs) == 0 else attrs)
    return out


W
whs 已提交
9186 9187 9188 9189 9190 9191 9192
def pad2d(input,
          paddings=[0, 0, 0, 0],
          mode='constant',
          pad_value=0.0,
          data_format="NCHW",
          name=None):
    """
9193 9194 9195 9196
    :alias_main: paddle.nn.functional.pad2d
	:alias: paddle.nn.functional.pad2d,paddle.nn.functional.common.pad2d
	:old_api: paddle.fluid.layers.pad2d

T
tianshuo78520a 已提交
9197
    Pad 2-d images according to 'paddings' and 'mode'.
W
whs 已提交
9198 9199 9200
    If mode is 'reflect', paddings[0] and paddings[1] must be no greater
    than height-1. And the width dimension has the same condition.

L
Liufang Sang 已提交
9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218
    Parameters:
        input (Variable): The input image with [N, C, H, W] format or [N, H, W, C] format, which is a 4-D Tensor with data type float32.
        paddings (Variable | List[int32]): The padding size. If padding is a List, it must
            contain four integers, (padding_top, padding_bottom, padding_left, padding_right).
            Otherwise, it is a 1-D Tensor with shape [4]. Data type is int32.
            Default is [0, 0, 0, 0].
        mode (str): Three modes: 'constant' (default), 'reflect', 'edge' .
        	When in 'constant' mode, this op uses a constant value to pad the input tensor.
        	When in 'reflect' mode, uses reflection of the input boundaries to pad the input tensor.
        	When in 'edge' mode, uses input boundaries to pad the input tensor.
        	Default is 'constant'
        pad_value (float32): The value to fill the padded areas in 'constant' mode . Default is 0.0
        data_format (str): An string from: "NHWC", "NCHW". Specify the data format of
                           the input data.
                           Default is  "NCHW"
        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` .

T
tianshuo78520a 已提交
9219
    Returns: a 4-D Tensor padded according to paddings and mode and data type is same as input.
L
Liufang Sang 已提交
9220 9221 9222 9223 9224

    Return Type: Variable


    Examples:
T
Tink_Y 已提交
9225
        .. code-block:: text
W
whs 已提交
9226

9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250
            Input = [[[[1., 2., 3.],
                       [4., 5., 6.]]]]

            Case 0:
                paddings = [0, 1, 2, 3],
                mode = 'constant'
                pad_value = 0
                Out = [[[[0., 0., 1., 2., 3., 0., 0., 0.],
                         [0., 0., 4., 5., 6., 0., 0., 0.],
                         [0., 0., 0., 0., 0., 0., 0., 0.]]]]

            Case 1:
                paddings = [0, 1, 2, 1],
                mode = 'reflect'
                Out = [[[[3., 2., 1., 2., 3., 2.],
                         [6., 5., 4., 5., 6., 5.],
                         [3., 2., 1., 2., 3., 2.]]]]

            Case 2:
                paddings = [0, 1, 2, 1],
                mode = 'edge'
                Out = [[[[1., 1., 1., 2., 3., 3.],
                         [4., 4., 4., 5., 6., 6.],
                         [4., 4., 4., 5., 6., 6.]]]]
M
minqiyang 已提交
9251

L
Liufang Sang 已提交
9252
    Code Examples:
W
whs 已提交
9253 9254
        .. code-block:: python

9255 9256 9257
            import paddle.fluid as fluid
            data = fluid.data(name='data', shape=[None, 3, 32, 32], dtype='float32')
            result = fluid.layers.pad2d(input=data, paddings=[0, 1, 2, 3], mode='reflect')
W
whs 已提交
9258
    """
9259 9260 9261
    check_variable_and_dtype(
        input, 'input', ['float16', 'float32', 'float64', 'int32', 'int64'],
        "pad2d")
9262 9263 9264 9265 9266 9267 9268

    if in_dygraph_mode():
        _paddings = paddings.numpy().tolist() if isinstance(
            paddings, Variable) else paddings
        return core.ops.pad2d(input, 'mode', mode, 'pad_value', pad_value,
                              'data_format', data_format, 'paddings', _paddings)

9269 9270 9271 9272 9273 9274 9275 9276
    attrs = {'mode': mode, 'pad_value': pad_value, 'data_format': data_format}
    inputs = {'X': [input]}
    if isinstance(paddings, Variable):
        inputs['Paddings'] = [paddings]
        attrs['paddings'] = []
    else:
        attrs['paddings'] = paddings

W
whs 已提交
9277
    helper = LayerHelper('pad2d', **locals())
9278 9279 9280 9281

    assert mode in ['reflect', 'edge', 'constant'
                    ], "mode should be one of constant, reflect, edge."

W
whs 已提交
9282
    dtype = helper.input_dtype(input_param_name='input')
X
Xin Pan 已提交
9283
    out = helper.create_variable_for_type_inference(dtype)
9284

W
whs 已提交
9285
    helper.append_op(
9286
        type='pad2d', inputs=inputs, outputs={"Out": out}, attrs=attrs)
W
whs 已提交
9287 9288 9289 9290

    return out


9291 9292 9293
@templatedoc()
def elu(x, alpha=1.0, name=None):
    """
9294 9295 9296 9297
    :alias_main: paddle.nn.functional.elu
	:alias: paddle.nn.functional.elu,paddle.nn.functional.activation.elu
	:old_api: paddle.fluid.layers.elu

9298 9299 9300 9301
    ${comment}
    Args:
        x(${x_type}): ${x_comment}
        alpha(${alpha_type}|1.0): ${alpha_comment}
9302
        name(str|None): The default value is None. Normally there is no need for user to set this property.
9303
                        For more information, please refer to :ref:`api_guide_Name`.
9304
    Returns:
9305
        ${out_type}: ${out_comment}
Z
ZhenWang 已提交
9306 9307 9308 9309 9310

    Examples:

        .. code-block:: python

9311
            import paddle.fluid as fluid
9312
            import numpy as np
9313

9314 9315 9316 9317 9318 9319 9320
            input_elu = np.array([[-1,6],[1,15.6]])
            with fluid.dygraph.guard():
                x = fluid.dygraph.to_variable(input_elu)
                y = fluid.layers.elu(x, alpha=0.2)
                print(y.numpy())
                # [[-0.12642411  6.        ]
                # [ 1.          15.6       ]]
9321 9322
    """
    helper = LayerHelper('elu', **locals())
9323
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'elu')
X
Xin Pan 已提交
9324
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335
    helper.append_op(
        type='elu',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'alpha': alpha})
    return out


@templatedoc()
def relu6(x, threshold=6.0, name=None):
    """
9336 9337 9338 9339
    :alias_main: paddle.nn.functional.relu6
	:alias: paddle.nn.functional.relu6,paddle.nn.functional.activation.relu6
	:old_api: paddle.fluid.layers.relu6

9340
    ${comment}
Z
zhupengyang 已提交
9341

9342 9343
    Args:
        x(${x_type}): ${x_comment}
Z
zhupengyang 已提交
9344 9345 9346 9347
        threshold(float, optional): ${threshold_comment}
        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`.
9348 9349 9350

    Returns:
        output(${out_type}): ${out_comment}
Z
ZhenWang 已提交
9351 9352 9353 9354 9355

    Examples:

        .. code-block:: python

9356
            import paddle.fluid as fluid
Z
zhupengyang 已提交
9357 9358 9359 9360 9361 9362 9363 9364
            import numpy as np
            in1 = np.array([[-1,0],[2.5,7.8]])
            with fluid.dygraph.guard():
                x1 = fluid.dygraph.to_variable(in1)
                out1 = fluid.layers.relu6(x=x1, threshold=6.0)
                print(out1.numpy())
                # [[0.  0. ]
                #  [2.5 6. ]]
9365
    """
9366 9367
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'relu6')

9368
    helper = LayerHelper('relu6', **locals())
X
Xin Pan 已提交
9369
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9370 9371 9372 9373
    helper.append_op(
        type='relu6',
        inputs={'X': x},
        outputs={'Out': out},
A
Adam 已提交
9374 9375 9376 9377
        attrs={
            'threshold': threshold,
            'use_mkldnn': core.globals()["FLAGS_use_mkldnn"]
        })
9378 9379 9380 9381 9382 9383
    return out


@templatedoc()
def pow(x, factor=1.0, name=None):
    """
9384 9385 9386 9387
    This is Pow Activation Operator.

    :math:`out = x^{factor}`

9388
    Args:
9389 9390 9391
        x(Variable): A ``Tensor`` or ``LoDTensor`` . The data type is ``float32`` or ``float64``.
        factor(float32|Variable, optional): A scalar with type ``float32`` or a ``Tensor`` with shape [1] and type ``float32``.  The exponential factor of Pow. Default 1.0.
        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` .
9392 9393

    Returns:
9394
        Variable: A ``Tensor`` or ``LoDTensor``. The data type is same as ``x``.
Z
ZhenWang 已提交
9395 9396 9397 9398 9399

    Examples:

        .. code-block:: python

9400
            import paddle.fluid as fluid
9401

9402
            x = fluid.data(name="x", shape=[32,32], dtype="float32")
9403 9404 9405

            # example 1: argument factor is float
            y_1 = fluid.layers.pow(x, factor=2.0)
9406
            # y_1 is x^{2.0}
9407 9408 9409 9410

            # example 2: argument factor is Variable
            factor_tensor = fluid.layers.fill_constant([1], "float32", 3.0)
            y_2 = fluid.layers.pow(x, factor=factor_tensor)
9411
            # y_2 is x^{3.0}
9412
    """
9413 9414 9415
    check_variable_and_dtype(x, 'x', ['int32', 'int64', 'float32', 'float64'],
                             'pow')

9416
    helper = LayerHelper('pow', **locals())
9417 9418 9419
    inputs = {'X': x}
    attrs = {}
    if isinstance(factor, Variable):
9420
        check_variable_and_dtype(factor, 'factor', ['float32'], 'pow')
9421 9422 9423 9424 9425
        factor.stop_gradient = True
        inputs['FactorTensor'] = factor
    else:
        attrs['factor'] = factor

X
Xin Pan 已提交
9426
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9427
    helper.append_op(
9428
        type='pow', inputs=inputs, outputs={'Out': out}, attrs=attrs)
9429 9430 9431 9432
    return out


@templatedoc()
9433
def stanh(x, scale_a=0.67, scale_b=1.7159, name=None):
9434
    """
9435 9436 9437 9438
    :alias_main: paddle.stanh
	:alias: paddle.stanh,paddle.tensor.stanh,paddle.tensor.math.stanh
	:old_api: paddle.fluid.layers.stanh

9439 9440 9441 9442 9443 9444 9445 9446 9447
    ${comment}
    Args:
        x(${x_type}): ${x_comment}
        scale_a(${scale_a_type}|2.0 / 3.0): ${scale_a_comment}
        scale_b(${scale_b_type}|1.7159): ${scale_b_comment}
        name(str|None): A name for this layer(optional). If set None, the layer
                        will be named automatically.

    Returns:
9448
        output(${out_type}): ${out_comment}.
Z
ZhenWang 已提交
9449 9450 9451 9452 9453

    Examples:

        .. code-block:: python

9454
            import paddle.fluid as fluid
9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469
            import numpy as np
            data = fluid.data(name="input", shape=[-1, 3])
            result = fluid.layers.stanh(data,scale_a=0.67, scale_b=1.72)
            place = fluid.CPUPlace()
            exe = fluid.Executor(place)
            exe.run(fluid.default_startup_program())
            x = np.random.random(size=(3, 3)).astype('float32')
            output= exe.run(feed={"input": x},
                         fetch_list=[result])
            print(output)

            #[array([[0.626466  , 0.89842904, 0.7501062 ],
            #       [0.25147712, 0.7484996 , 0.22902708],
            #       [0.62705994, 0.23110689, 0.56902856]], dtype=float32)]

9470
    """
9471 9472
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'stanh')

9473
    helper = LayerHelper('stanh', **locals())
X
Xin Pan 已提交
9474
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486
    helper.append_op(
        type='stanh',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'scale_a': scale_a,
               'scale_b': scale_b})
    return out


@templatedoc()
def hard_sigmoid(x, slope=0.2, offset=0.5, name=None):
    """
9487 9488 9489 9490
    :alias_main: paddle.nn.functional.hard_sigmoid
	:alias: paddle.nn.functional.hard_sigmoid,paddle.nn.functional.activation.hard_sigmoid
	:old_api: paddle.fluid.layers.hard_sigmoid

9491
    ${comment}
9492 9493 9494 9495 9496 9497 9498
    Parameters:
        x (${x_type}): ${x_comment}
        slope (float, optional): ${slope_comment}
        offset (float, optional): ${offset_comment}
        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`
9499 9500

    Returns:
9501
        ${out_type}: ${out_comment}
Z
ZhenWang 已提交
9502 9503 9504 9505 9506

    Examples:

        .. code-block:: python

9507
            import paddle.fluid as fluid
9508 9509
            data = fluid.layers.fill_constant(shape=[3, 2], value=0.5, dtype='float32') # [[0.5, 0.5], [0.5, 0.5], [0.5, 0.5]]
            result = fluid.layers.hard_sigmoid(data) # [[0.6, 0.6], [0.6, 0.6], [0.6, 0.6]]
9510
    """
9511 9512 9513
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'],
                             'hard_sigmoid')

9514
    helper = LayerHelper('hard_sigmoid', **locals())
X
Xin Pan 已提交
9515
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527
    helper.append_op(
        type='hard_sigmoid',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'slope': slope,
               'offset': offset})
    return out


@templatedoc()
def swish(x, beta=1.0, name=None):
    """
9528 9529 9530 9531
    :alias_main: paddle.nn.functional.swish
	:alias: paddle.nn.functional.swish,paddle.nn.functional.activation.swish
	:old_api: paddle.fluid.layers.swish

9532
    Elementwise swish activation function. See `Searching for Activation Functions <https://arxiv.org/abs/1710.05941>`_ for more details.
9533

9534 9535 9536 9537
    Equation:

    .. math::
        out = \\frac{x}{1 + e^{- beta * x}}
9538

9539
    Args:
9540
        x(Variable): Tensor or LoDTensor, dtype: float32 or float64, the input of swish activation.
9541

9542
        beta(float): Constant beta of swish operator, default 1.0.
9543

9544
        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`.
9545 9546

    Returns:
9547 9548

        Variable: Output of the swish activation, Tensor or LoDTensor, with the same dtype and shape with the input x.
Z
ZhenWang 已提交
9549 9550 9551 9552

    Examples:

        .. code-block:: python
9553

9554 9555 9556
            # declarative mode
            import numpy as np
            from paddle import fluid
9557

9558
            x = fluid.data(name="x", shape=(-1, 3), dtype="float32")
Z
ZhenWang 已提交
9559
            y = fluid.layers.swish(x, beta=2.0)
9560

9561 9562 9563 9564
            place = fluid.CPUPlace()
            exe = fluid.Executor(place)
            start = fluid.default_startup_program()
            main = fluid.default_main_program()
9565

9566 9567 9568
            data = np.random.randn(2, 3).astype("float32")
            exe.run(start)
            y_np, = exe.run(main, feed={"x": data}, fetch_list=[y])
9569

9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583
            data
            # array([[-1.1239197 ,  1.3391294 ,  0.03921051],
            #        [ 1.1970421 ,  0.02440812,  1.2055548 ]], dtype=float32)
            y_np
            # array([[-0.2756806 ,  1.0610548 ,  0.01998957],
            #        [ 0.9193261 ,  0.01235299,  0.9276883 ]], dtype=float32)


        .. code-block:: python

            # imperative mode
            import numpy as np
            from paddle import fluid
            import paddle.fluid.dygraph as dg
9584

9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596
            data = np.random.randn(2, 3).astype("float32")
            place = fluid.CPUPlace()
            with dg.guard(place) as g:
                x = dg.to_variable(data)
                y = fluid.layers.swish(x)
                y_np = y.numpy()
            data
            # array([[-0.0816701 ,  1.1603649 , -0.88325626],
            #        [ 0.7522361 ,  1.0978601 ,  0.12987892]], dtype=float32)
            y_np
            # array([[-0.03916847,  0.8835007 , -0.25835553],
            #        [ 0.51126915,  0.82324016,  0.06915068]], dtype=float32)
9597
    """
9598 9599
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'swish')

9600
    helper = LayerHelper('swish', **locals())
X
Xin Pan 已提交
9601
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9602 9603 9604 9605 9606 9607 9608 9609
    helper.append_op(
        type='swish',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'slope': beta})
    return out


J
jerrywgz 已提交
9610 9611
def prelu(x, mode, param_attr=None, name=None):
    """
9612 9613
    :api_attr: Static Graph

J
jerrywgz 已提交
9614 9615
    Equation:

H
haowang101779990 已提交
9616 9617
    .. math::
        y = \max(0, x) + \\alpha * \min(0, x)
J
jerrywgz 已提交
9618

J
jerrywgz 已提交
9619 9620 9621 9622 9623 9624 9625 9626
    There are three modes for the activation:

    .. code-block:: text

        all: All elements share same alpha.
        channel: Elements in same channel share same alpha.
        element: All elements do not share alpha. Each element has its own alpha.

J
jerrywgz 已提交
9627
    Args:
W
wangguanzhong 已提交
9628
        x (Variable): The input Tensor or LoDTensor with data type float32.
9629
        mode (str): The mode for weight sharing.
J
jerrywgz 已提交
9630
        param_attr(ParamAttr|None): The parameter attribute for the learnable
W
wangguanzhong 已提交
9631 9632
          weight (alpha), it can be create by ParamAttr. None by default.
          For detailed information, please refer to :ref:`api_fluid_ParamAttr`.
9633 9634 9635
        name(str|None): For detailed information, please refer
          to :ref:`api_guide_Name`. Usually name is no need to set and
          None by default.
J
jerrywgz 已提交
9636 9637

    Returns:
W
wangguanzhong 已提交
9638 9639 9640 9641
        Variable:

        output(Variable): The tensor or LoDTensor with the same shape as input.
        The data type is float32.
J
jerrywgz 已提交
9642 9643 9644 9645 9646

    Examples:

        .. code-block:: python

J
jerrywgz 已提交
9647 9648
            import paddle.fluid as fluid
            from paddle.fluid.param_attr import ParamAttr
9649
            x = fluid.data(name="x", shape=[None,5,10,10], dtype="float32")
J
jerrywgz 已提交
9650
            mode = 'channel'
J
jerrywgz 已提交
9651 9652 9653
            output = fluid.layers.prelu(
                     x,mode,param_attr=ParamAttr(name='alpha'))

J
jerrywgz 已提交
9654
    """
9655 9656
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'prelu')

J
jerrywgz 已提交
9657 9658 9659 9660
    helper = LayerHelper('prelu', **locals())
    if mode not in ['all', 'channel', 'element']:
        raise ValueError('mode should be one of all, channel, element.')
    alpha_shape = [1]
9661 9662
    # NOTE(): The input of this API should be ``N,C,...`` format, 
    # which means x.shape[0] is batch_size and x.shape[0] is channel.
J
jerrywgz 已提交
9663
    if mode == 'channel':
9664 9665 9666 9667 9668
        assert len(
            x.shape
        ) >= 2, "The size of input shape should be equal or larger than 2 in prelu() when mode is 'channel'"
        #NOTE(zhiqiu): The alpha_shape should be [1, channel] + [1] * len(x.shape[2:]).
        # To be consistent with Prelu, it is simplified.
9669 9670
        #NOTE(zhiqiu): Revert shape to [1, channel, 1, 1] for compatibility with saved model of old version.
        alpha_shape = [1, x.shape[1], 1, 1]
J
jerrywgz 已提交
9671
    elif mode == 'element':
9672 9673 9674 9675
        assert len(
            x.shape
        ) >= 1, "The size of input shape should be equal or larger than 1 in prelu() when mode is 'element'"
        alpha_shape = [1] + list(x.shape)[1:]
J
jerrywgz 已提交
9676 9677
    dtype = helper.input_dtype(input_param_name='x')
    alpha = helper.create_parameter(
Q
Qiao Longfei 已提交
9678
        attr=helper.param_attr,
J
jerrywgz 已提交
9679 9680 9681
        shape=alpha_shape,
        dtype='float32',
        is_bias=False,
9682
        default_initializer=Constant(0.25))
X
Xin Pan 已提交
9683
    out = helper.create_variable_for_type_inference(dtype)
J
jerrywgz 已提交
9684 9685 9686 9687 9688 9689 9690 9691 9692
    helper.append_op(
        type="prelu",
        inputs={"X": x,
                'Alpha': alpha},
        attrs={"mode": mode},
        outputs={"Out": out})
    return out


9693 9694 9695
@templatedoc()
def brelu(x, t_min=0.0, t_max=24.0, name=None):
    """
9696 9697 9698 9699
    :alias_main: paddle.nn.functional.brelu
	:alias: paddle.nn.functional.brelu,paddle.nn.functional.activation.brelu
	:old_api: paddle.fluid.layers.brelu

9700 9701 9702 9703 9704
    ${comment}
    Args:
        x(${x_type}): ${x_comment}
        t_min(${t_min_type}|0.0): ${t_min_comment}
        t_max(${t_max_type}|24.0): ${t_max_comment}
9705
        name(str|None): The default value is None. Normally there is no need for user to set this property.
9706
                        For more information, please refer to :ref:`api_guide_Name`.
9707
    Returns:
9708
        ${out_type}: ${out_comment}
9709 9710 9711

    Examples:

9712
    .. code-block:: python
9713

9714
            import paddle.fluid as fluid
9715
            import numpy as np
9716

9717 9718 9719 9720 9721 9722
            input_brelu = np.array([[-1,6],[1,15.6]])
            with fluid.dygraph.guard():
                x = fluid.dygraph.to_variable(input_brelu)
                y = fluid.layers.brelu(x, t_min=1.0, t_max=10.0)
                print(y.numpy())
                #[[ 1.  6.]
9723
                #[ 1. 10.]]
9724
    """
9725 9726
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'brelu')

9727
    helper = LayerHelper('brelu', **locals())
X
Xin Pan 已提交
9728
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740
    helper.append_op(
        type='brelu',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'t_min': t_min,
               't_max': t_max})
    return out


@templatedoc()
def leaky_relu(x, alpha=0.02, name=None):
    """
9741 9742 9743 9744
    :alias_main: paddle.nn.functional.leaky_relu
	:alias: paddle.nn.functional.leaky_relu,paddle.nn.functional.activation.leaky_relu
	:old_api: paddle.fluid.layers.leaky_relu

9745 9746 9747 9748
    ${comment}
    Args:
        x(${x_type}): ${x_comment}
        alpha(${alpha_type}|0.02): ${alpha_comment}
W
Wilber 已提交
9749 9750
        name(str|None): The default value is None. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`

9751
    Returns:
9752
        output(${out_type}): ${out_comment}
9753 9754 9755 9756 9757

    Examples:

        .. code-block:: python

9758
            import paddle.fluid as fluid
W
Wilber 已提交
9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771
            import numpy as np

            # Graph Organizing
            x = fluid.layers.data(name="x", shape=[2], dtype="float32")
            res = fluid.layers.leaky_relu(x, alpha=0.1)

            # Create an executor using CPU as an example
            exe = fluid.Executor(fluid.CPUPlace())

            # Execute
            x_i = np.array([[-1, 2], [3, -4]]).astype(np.float32)
            res_val, = exe.run(fluid.default_main_program(), feed={'x':x_i}, fetch_list=[res])
            print(res_val) # [[-0.1, 2], [3, -0.4]]
9772
    """
9773
    if in_dygraph_mode():
9774
        return core.ops.leaky_relu(x, 'alpha', alpha)
9775

9776 9777 9778
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'],
                             'leaky_relu')

9779 9780
    inputs = {'X': [x]}
    attrs = {'alpha': alpha}
9781
    helper = LayerHelper('leaky_relu', **locals())
X
Xin Pan 已提交
9782
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9783
    helper.append_op(
9784
        type='leaky_relu', inputs=inputs, outputs={'Out': out}, attrs=attrs)
9785 9786 9787 9788 9789
    return out


def soft_relu(x, threshold=40.0, name=None):
    """
9790 9791 9792 9793
    :alias_main: paddle.nn.functional.soft_relu
	:alias: paddle.nn.functional.soft_relu,paddle.nn.functional.activation.soft_relu
	:old_api: paddle.fluid.layers.soft_relu

9794 9795 9796 9797
    SoftRelu Activation Operator.

    $out = \ln(1 + \exp(\max(\min(x, threshold), -threshold)))$

9798
    Args:
9799 9800 9801 9802
        x(Variable): Input of soft_relu operator. Data type can be float32, float64.
        threshold(float, optional): The threshold value of soft_relu, default value being 40.0.
        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` .

9803
    Returns:
9804
        Variable(Tensor|LoDTensor)): Output of soft_relu operator, shape and LoD same as input.
9805 9806 9807

    Examples:

9808 9809
        .. code-block:: python

9810
            import paddle.fluid as fluid
9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822
            import numpy as np

            inputs = fluid.layers.data(name="x", shape=[2, 2], dtype="float32")
            output = fluid.layers.soft_relu(inputs, threshold=20.0)

            exe = fluid.Executor(fluid.CPUPlace())
            exe.run(fluid.default_startup_program())

            img = np.array([[0, 1],[2, 3]]).astype(np.float32)

            res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output])
            print(res) # [array([[0.6931472, 1.3132616], [2.126928 , 3.0485873]], dtype=float32)]
9823
    """
9824 9825 9826
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'],
                             'soft_relu')

9827
    helper = LayerHelper('soft_relu', **locals())
X
Xin Pan 已提交
9828
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9829 9830 9831 9832 9833 9834 9835 9836
    helper.append_op(
        type='soft_relu',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'threshold': threshold})
    return out


9837 9838
def flatten(x, axis=1, name=None):
    """
9839 9840 9841
    **Flatten op**

    Flatten the input tensor into a 2D matrix.
M
minqiyang 已提交
9842

H
haowang101779990 已提交
9843
    For Example:
M
minqiyang 已提交
9844

H
haowang101779990 已提交
9845
    .. code-block:: text
9846

H
haowang101779990 已提交
9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867
        Case 1:

          Given
            X.shape = (3, 100, 100, 4)

          and
            axis = 2

          We get:
            Out.shape = (3 * 100, 4 * 100)

        Case 2:

          Given
            X.shape = (3, 100, 100, 4)

          and
            axis = 0

          We get:
            Out.shape = (1, 3 * 100 * 100 * 4)
9868 9869

    Args:
9870 9871
        x (Variable): A tensor of rank >= axis. A tensor with type float32,
                      float64, int8, int32, int64.
9872 9873
        axis (int): Indicate up to which input dimensions (exclusive) should
                    be flattened to the outer dimension of the output.
9874
                    The value for axis must be in the range [0, R], where R
9875 9876 9877
                    is the rank of the input tensor. Default: 1.
        name(str, Optional): For details, please refer to :ref:`api_guide_Name`.
                        Generally, no setting is required. Default: None.
9878 9879

    Returns:
H
haowang101779990 已提交
9880 9881 9882
        Variable: A 2D tensor with the contents of the input tensor, with input \
                  dimensions up to axis flattened to the outer dimension of \
                  the output and remaining input dimensions flattened into the \
9883
                  inner dimension of the output. A Tensor with type same as input x.
9884 9885 9886

    Raises:
        ValueError: If x is not a variable.
9887
        ValueError: If axis is not in range [0, rank(x)].
9888 9889 9890 9891 9892

    Examples:

        .. code-block:: python

9893
            import paddle.fluid as fluid
B
Bai Yifan 已提交
9894
            x = fluid.data(name="x", shape=[4, 4, 3], dtype="float32")
9895
            # x shape is [4, 4, 3]
9896
            out = fluid.layers.flatten(x=x, axis=2)
9897
            # out shape is [16, 3]
9898
    """
9899 9900
    check_variable_and_dtype(
        x, 'x', ['float32', 'float64', 'int8', 'int32', 'int64'], 'flatten')
9901 9902 9903 9904 9905 9906 9907 9908
    helper = LayerHelper('flatten', **locals())

    if not (isinstance(x, Variable)):
        raise ValueError("The input x should be a Variable")

    if not (isinstance(axis, int)) or axis > len(x.shape) or axis < 0:
        raise ValueError("The axis should be a int, and in range [0, rank(x)]")

X
Xin Pan 已提交
9909 9910
    out = helper.create_variable_for_type_inference(x.dtype)
    x_shape = helper.create_variable_for_type_inference(x.dtype)
9911
    helper.append_op(
9912
        type='flatten2',
9913
        inputs={"X": x},
9914 9915
        outputs={'Out': out,
                 'XShape': x_shape},
9916 9917
        attrs={"axis": axis})
    return out
X
Xin Pan 已提交
9918 9919


L
Leo Chen 已提交
9920
def stack(x, axis=0, name=None):
S
sneaxiy 已提交
9921
    """
9922

9923
    This OP stacks all the inputs :code:`x` along axis.
C
chengduozh 已提交
9924

C
chengduozh 已提交
9925 9926 9927
    .. code-block:: text

        Case 1:
9928

C
chengduozh 已提交
9929
          Input:
9930
            x[0].shape = [1, 2]
C
chengduozh 已提交
9931
            x[0].data = [ [1.0 , 2.0 ] ]
9932
            x[1].shape = [1, 2]
C
chengduozh 已提交
9933
            x[1].data = [ [3.0 , 4.0 ] ]
9934
            x[2].shape = [1, 2]
C
chengduozh 已提交
9935 9936 9937 9938 9939 9940
            x[2].data = [ [5.0 , 6.0 ] ]

          Attrs:
            axis = 0

          Output:
9941
            Out.dims = [3, 1, 2]
C
chengduozh 已提交
9942 9943 9944
            Out.data =[ [ [1.0, 2.0] ],
                        [ [3.0, 4.0] ],
                        [ [5.0, 6.0] ] ]
9945

C
chengduozh 已提交
9946 9947

        Case 2:
9948 9949 9950 9951


          Input:
            x[0].shape = [1, 2]
C
chengduozh 已提交
9952
            x[0].data = [ [1.0 , 2.0 ] ]
9953
            x[1].shape = [1, 2]
C
chengduozh 已提交
9954
            x[1].data = [ [3.0 , 4.0 ] ]
9955
            x[2].shape = [1, 2]
C
chengduozh 已提交
9956
            x[2].data = [ [5.0 , 6.0 ] ]
9957

C
chengduozh 已提交
9958 9959 9960 9961 9962

          Attrs:
            axis = 1 or axis = -2

          Output:
9963
            Out.shape = [1, 3, 2]
C
chengduozh 已提交
9964 9965 9966
            Out.data =[ [ [1.0, 2.0]
                          [3.0, 4.0]
                          [5.0, 6.0] ] ]
9967

C
chengduozh 已提交
9968

S
sneaxiy 已提交
9969
    Args:
9970 9971 9972 9973 9974
        x (Variable|list(Variable)): Input :code:`x` can be a single Tensor, a :code:`list` of Tensors.
                                     If :code:`x` is a :code:`list`, the shapes of all these Tensors
                                     must be the same. Supposing input is N dims
                                     Tensors :math:`[d_0, d_1, ..., d_{n-1}]`, the output is N+1 dims
                                     Tensor :math:`[d_0, d_1, d_{axis-1}, len(x), d_{axis}, ..., d_{n-1}]`.
9975
                                     Supported data types: float32, float64, int32, int64.
9976 9977 9978
        axis (int, optional): The axis along which all inputs are stacked. ``axis`` range is :math:`[-(R+1), R+1)`.
                              R is the first tensor of inputs. If ``axis`` < 0, :math:`axis=axis+rank(x[0])+1`.
                              The default value of axis is 0.
9979

S
sneaxiy 已提交
9980
    Returns:
9981
        Variable: The stacked Tensor, has same data type with input Tensors. Output dim is :math:`rank(x[0])+1`.
9982

9983 9984 9985
    Examples:
        .. code-block:: python

9986
            import paddle.fluid as fluid
9987
            import paddle.fluid.layers as layers
9988 9989 9990 9991 9992 9993 9994 9995 9996 9997
            # set batch size=None
            x1 = fluid.data(name='x1', shape=[None, 1, 2], dtype='int32')
            x2 = fluid.data(name='x2', shape=[None, 1, 2], dtype='int32')
            # stack Tensor list
            data = layers.stack([x1,x2]) # stack according to axis 0, data.shape=[2, None, 1, 2]

            data = layers.stack([x1,x2], axis=1) # stack according to axis 1, data.shape=[None, 2, 1, 2]

            # stack single Tensor
            data = layers.stack(x1)  # stack according to axis 0, data.shape=[1, None, 1, 2]
9998

S
sneaxiy 已提交
9999
    """
X
Xin Pan 已提交
10000 10001 10002
    axis = 0 if axis is None else axis
    if not isinstance(x, list) and not isinstance(x, tuple):
        x = [x]
L
Leo Chen 已提交
10003 10004 10005 10006 10007

    if in_dygraph_mode():
        return core.ops.stack(x, 'axis', axis)

    helper = LayerHelper('stack', **locals())
X
Xin Pan 已提交
10008
    out = helper.create_variable_for_type_inference(x[0].dtype)
L
Leo Chen 已提交
10009
    if x[0].desc.type() == core.VarDesc.VarType.LOD_TENSOR_ARRAY:
10010 10011 10012
        assert len(x) == 1, "If the elements of 'x' in stack are Variable(LoDTensorArray), " \
                            "number of the elements must be 1, but received %s." % len(x)
        out_index = helper.create_variable_for_type_inference(dtype="int32")
X
xujiaqi01 已提交
10013 10014 10015 10016 10017

        for i in x:
            check_variable_and_dtype(i, 'x', \
                ['float16', 'float32', 'float64', 'int32', 'int64'], 'stack')

10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030
        helper.append_op(
            type='tensor_array_to_tensor',
            inputs={'X': x[0]},
            outputs={'Out': [out],
                     'OutIndex': [out_index]},
            attrs={'axis': axis,
                   'use_stack': True})
    else:
        helper.append_op(
            type='stack',
            inputs={'X': x},
            outputs={'Y': out},
            attrs={'axis': axis})
10031

X
Xin Pan 已提交
10032
    return out
D
dzhwinter 已提交
10033 10034


J
Jiawei Wang 已提交
10035
@templatedoc(op_type="filter_by_instag")
Y
yaoxuefeng 已提交
10036
def filter_by_instag(ins, ins_tag, filter_tag, is_lod, out_val_if_empty=0):
J
Jiawei Wang 已提交
10037 10038
    """
    **Filter By Instag Layer**
10039 10040 10041

    This function filter a batch of ins by instag,
    There are multiple ins, and every ins belongs to some tags.
J
Jiawei Wang 已提交
10042 10043
    We can specify some tags we want. So the ins which belongs to that tags
    remains in the output, and others removed.
10044 10045 10046

    For example, one batch has 4 ins. Every ins has its tag list.

J
Jiawei Wang 已提交
10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061
       | Ins   |   Ins_Tag |
       |:-----:|:------:|
       |  0    |   0, 1 |
       |  1    |   1, 3 |
       |  2    |   0, 3 |
       |  3    |   2, 6 |

    And Lod is [1,1,1,1]

    And the filter tags [1]

    From the definition above, ins which has tag 1 can pass the filter
    So Ins 0 and Ins 1 can pass and be seen in the output,
    Ins 2 and 3 cannot pass because they do not has tag 1.

10062
    Actually, if is_lod is false, it is normal tensor that equals to
J
Jiawei Wang 已提交
10063 10064 10065 10066 10067 10068 10069
    lod_tensor with all 1, similar to the example above.

    Args:
        ins (Variable): Input Variable (LoDTensor), usually it is 2D tensor
                        And first dimension can have lod info or not.
        ins_tag (Variable): Input Variable (LoDTensor), usually it is 1D list
                        And split them by lod info
10070
        filter_tag (Variable): Input Variable (1D Tensor/List), usually it is
J
Jiawei Wang 已提交
10071 10072
                        list that holds the tags.
        is_lod (Bool): Boolean value to indicate ins is lod tensor or not.
Y
yaoxuefeng 已提交
10073 10074
        out_val_if_empty(Int64): If the output after filter is empty, this value
                        will be set to Output tensor.
J
Jiawei Wang 已提交
10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086

    Returns:
        Variable: filtered ins (LoDTensor) and loss weight (Tensor)

    Examples:
        .. code-block:: python

          import paddle.fluid.layers as layers
          ins = layers.data(name='Ins', shape=[-1,32], lod_level=0, dtype='float64')
          ins_tag = layers.data(name='Ins_tag', shape=[-1,16], lod_level=0, dtype='int64')
          filter_tag = layers.data(name='Filter_tag', shape=[-1,16], dtype='int64')
          out, loss_weight = layers.filter_by_instag(ins,  ins_tag,  filter_tag, True)
10087

J
Jiawei Wang 已提交
10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101
    """
    helper = LayerHelper('filter_by_instag', **locals())

    out = helper.create_variable_for_type_inference(dtype=ins.dtype)
    loss_weight = helper.create_variable_for_type_inference(dtype=np.float64)
    mmap = helper.create_variable_for_type_inference(dtype=ins_tag.dtype)
    helper.append_op(
        type='filter_by_instag',
        inputs={'Ins': ins,
                'Ins_tag': ins_tag,
                'Filter_tag': filter_tag},
        outputs={'Out': out,
                 'LossWeight': loss_weight,
                 'IndexMap': mmap},
Y
yaoxuefeng 已提交
10102 10103
        attrs={'is_lod': is_lod,
               'out_val_if_empty': out_val_if_empty})
J
Jiawei Wang 已提交
10104 10105 10106 10107

    return [out, loss_weight]


D
dzhwinter 已提交
10108 10109
def unstack(x, axis=0, num=None):
    """
10110 10111 10112 10113
    :alias_main: paddle.unstack
	:alias: paddle.unstack,paddle.tensor.unstack,paddle.tensor.manipulation.unstack
	:old_api: paddle.fluid.layers.unstack

D
dzhwinter 已提交
10114 10115
    **UnStack Layer**

10116
    This layer unstacks input Tensor :code:`x` into several Tensors along :code:`axis`.
M
minqiyang 已提交
10117

D
dzhwinter 已提交
10118 10119 10120
    If :code:`axis` < 0, it would be replaced with :code:`axis+rank(x)`.
    If :code:`num` is None, it would be inferred from :code:`x.shape[axis]`,
    and if :code:`x.shape[axis]` <= 0 or is unknown, :code:`ValueError` is
M
minqiyang 已提交
10121
    raised.
D
dzhwinter 已提交
10122 10123

    Args:
10124
        x (Variable): Input Tensor. It is a N-D Tensors of data types float32, float64, int32, int64.
D
dzhwinter 已提交
10125 10126
        axis (int): The axis along which the input is unstacked.
        num (int|None): The number of output variables.
M
minqiyang 已提交
10127

D
dzhwinter 已提交
10128
    Returns:
10129 10130 10131 10132
        list(Variable): The unstacked Tensors list. The list elements are N-D Tensors of data types float32, float64, int32, int64.

    Raises:
        ValueError: If x.shape[axis] <= 0 or axis is not in range [-D, D).
M
minqiyang 已提交
10133

10134 10135 10136 10137
    Examples:
        .. code-block:: python

            import paddle.fluid as fluid
10138 10139
            x = fluid.layers.data(name='x', shape=[2, 3, 5], dtype='float32')  # create a tensor with shape=[2, 3, 5]
            y = fluid.layers.unstack(x, axis=1)  # unstack with second axis, which results 3 tensors with shape=[2, 5]
D
dzhwinter 已提交
10140

10141
    """
D
dzhwinter 已提交
10142 10143 10144 10145 10146 10147 10148 10149
    helper = LayerHelper('unstack', **locals())
    if num is None:
        if axis is None or x.shape[axis] <= 0:
            raise ValueError('unknown unstack number')
        else:
            num = x.shape[axis]

    outs = []
Y
Yibing Liu 已提交
10150
    for _ in range(num):
X
Xin Pan 已提交
10151
        outs.append(helper.create_variable_for_type_inference(x.dtype))
D
dzhwinter 已提交
10152 10153 10154 10155 10156 10157 10158 10159

    helper.append_op(
        type='unstack',
        inputs={'X': [x]},
        outputs={'Y': outs},
        attrs={'axis': axis,
               'num': num})
    return outs
W
whs 已提交
10160 10161 10162


def expand(x, expand_times, name=None):
10163
    """
10164 10165 10166 10167
    :alias_main: paddle.expand
	:alias: paddle.expand,paddle.tensor.expand,paddle.tensor.manipulation.expand
	:old_api: paddle.fluid.layers.expand

10168 10169 10170
    This operation tiles ``x`` multiple times according to the parameter ``expand_times``.
    The times number for each dimension of ``x`` is set by the parameter ``expand_times``.
    The rank of ``x`` should be less than or equal to 6. Please note that size of ``expand_times`` must be the same
W
whs 已提交
10171 10172 10173 10174 10175 10176
    with X's rank. Following is a using case:


    .. code-block:: text

        Input(X) is a 3-D tensor with shape [2, 3, 1]:
M
minqiyang 已提交
10177

W
whs 已提交
10178 10179 10180 10181
                [
                   [[1], [2], [3]],
                   [[4], [5], [6]]
                ]
M
minqiyang 已提交
10182

W
whs 已提交
10183
        Attr(expand_times):  [1, 2, 2]
M
minqiyang 已提交
10184

W
whs 已提交
10185
        Output(Out) is a 3-D tensor with shape [2, 6, 2]:
M
minqiyang 已提交
10186

W
whs 已提交
10187 10188 10189 10190
                [
                    [[1, 1], [2, 2], [3, 3], [1, 1], [2, 2], [3, 3]],
                    [[4, 4], [5, 5], [6, 6], [4, 4], [5, 5], [6, 6]]
                ]
M
minqiyang 已提交
10191

W
whs 已提交
10192
    Args:
10193 10194 10195 10196 10197
        x (Variable): A ``Tensor`` or ``LoDTensor`` with dimension in [1, 6]. The data type is ``bool``, ``float32``, ``float64`` or ``int32`` .
        expand_times (list|tuple|Variable): The data type is ``int32`` . If ``expand_times`` is a list or tuple, the elements of
                it should be integers or Tensors with shape [1]. If ``expand_times`` is an Variable, it should be an 1-D Tensor.
                Expand times number for each dimension of ``x`` .
        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` .
W
whs 已提交
10198 10199

    Returns:
10200
        Variable: A ``Tensor`` or ``LoDTensor``. The data type is same as ``x``. After expanding, size of each dimension of output is equal to the size of the corresponding dimension of ``x`` multiplying the corresponding value given by ``expand_times`` .
W
whs 已提交
10201

10202 10203 10204
    Raises:
        TypeError: The type of ``expand_times`` must be list, tuple or Variable.
        ValueError: The elements of ``expand_times`` cannot be negative.
W
whs 已提交
10205 10206 10207

    Examples:
        .. code-block:: python
L
liym27 已提交
10208

W
wangchaochaohu 已提交
10209
            import paddle.fluid as fluid
L
liym27 已提交
10210 10211 10212 10213

            # example 1:
            data_1 = fluid.layers.fill_constant(shape=[2, 3, 1], dtype='int32', value=0)
            expanded_1 = fluid.layers.expand(data_1, expand_times=[1, 2, 2])
10214
            # the shape of expanded_1 is [2, 6, 2].
L
liym27 已提交
10215 10216 10217 10218 10219

            # example 2:
            data_2 = fluid.layers.fill_constant(shape=[12, 14], dtype="int32", value=3)
            expand_times = fluid.layers.fill_constant(shape=[2], dtype="int32", value=4)
            expanded_2 = fluid.layers.expand(data_2, expand_times=expand_times)
10220
            # the shape of expanded_2 is [48, 56].
W
whs 已提交
10221
    """
10222 10223
    if in_dygraph_mode():
        if isinstance(expand_times, (list, tuple)):
10224 10225 10226 10227
            expand_times = [
                item.numpy()[0] if isinstance(item, Variable) else item
                for item in expand_times
            ]
10228

10229
            return core.ops.expand(x, 'expand_times', expand_times)
10230

10231 10232
    inputs = {"X": [x]}
    attrs = {}
10233 10234
    check_variable_and_dtype(
        x, 'x', ['bool', 'float32', 'float64', 'int32', 'int64'], 'expand')
10235
    check_type(expand_times, 'expand_times', (list, tuple, Variable), 'expand')
W
wangchaochaohu 已提交
10236 10237 10238
    if convert_dtype(x.dtype) == 'bool' and x.stop_gradient == True:
        raise ValueError(
            "expand op bool date type must set the stop_gradient to be False")
L
liym27 已提交
10239

W
whs 已提交
10240
    helper = LayerHelper('expand', input=x, **locals())
L
liym27 已提交
10241 10242 10243 10244 10245 10246 10247 10248 10249

    def get_attr_expand_times(list_expand_times):
        attrs_expand_times = []
        for idx, times in enumerate(list_expand_times):
            if isinstance(times, Variable):
                attrs_expand_times.append(-1)
            else:
                attrs_expand_times.append(times)
                assert times > 0, (
T
tianshuo78520a 已提交
10250
                    "Each element given in expand_times must not be negative.")
L
liym27 已提交
10251 10252
        return attrs_expand_times

L
Leo Chen 已提交
10253 10254 10255 10256 10257 10258
    if isinstance(expand_times, Variable):
        expand_times.stop_gradient = True
        inputs['ExpandTimes'] = expand_times
    elif isinstance(expand_times, (list, tuple)):
        attrs['expand_times'] = get_attr_expand_times(expand_times)
        if utils._contain_var(expand_times):
10259
            inputs['expand_times_tensor'] = utils._convert_to_tensor_list(
L
Leo Chen 已提交
10260
                expand_times)
10261

L
liym27 已提交
10262 10263
    dtype = helper.input_dtype(input_param_name='x')
    out = helper.create_variable_for_type_inference(dtype)
W
whs 已提交
10264
    helper.append_op(
10265
        type='expand', inputs=inputs, outputs={'Out': out}, attrs=attrs)
W
whs 已提交
10266
    return out
S
sneaxiy 已提交
10267 10268


10269 10270
def expand_as(x, target_tensor, name=None):
    """
10271 10272 10273 10274
    :alias_main: paddle.expand_as
	:alias: paddle.expand_as,paddle.tensor.expand_as,paddle.tensor.manipulation.expand_as
	:old_api: paddle.fluid.layers.expand_as
    
10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289
    expand_as operator tiles to the input by given expand tensor. You should set expand tensor
    for each dimension by providing tensor 'target_tensor'. The rank of X
    should be in [1, 6]. Please note that size of 'target_tensor' must be the same
    with X's rank. Following is a using case:


    .. code-block:: text

        Input(X) is a 3-D tensor with shape [2, 3, 1]:

                [
                   [[1], [2], [3]],
                   [[4], [5], [6]]
                ]

10290
        target_tensor's shape:  [2, 6, 2]
10291 10292 10293 10294 10295 10296 10297

        Output(Out) is a 3-D tensor with shape [2, 6, 2]:

                [
                    [[1, 1], [2, 2], [3, 3], [1, 1], [2, 2], [3, 3]],
                    [[4, 4], [5, 5], [6, 6], [4, 4], [5, 5], [6, 6]]
                ]
10298

10299 10300 10301 10302 10303 10304 10305 10306

    Args:
        x (Variable): A Tensor with dtype float64, float32, int32.
        A tensor with rank in [1, 6].
        target_tensor (Variable): A Tensor with dtype float64, float32, int32.
        target_tensor for expanding to Input(X). Only use target_tensor'shape.

    Returns:
10307 10308
        Variable: A Tensor with dtype float64, float32, int32.
        After expanding, size of each dimension of Output(Out) is equal to the size
10309 10310 10311 10312 10313 10314
        of the corresponding dimension of target_tensor multiplying the corresponding
        value given by target_tensor.


    Examples:
        .. code-block:: python
10315

10316 10317 10318 10319 10320 10321
        import paddle.fluid as fluid
        import numpy as np

        data = fluid.layers.data(name="data", shape=[-1,10], dtype='float64')
        target_tensor = fluid.layers.data(
          name="target_tensor", shape=[-1,20], dtype='float64')
10322
        result = fluid.layers.expand_as(x=data, target_tensor=target_tensor)
10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333
        use_cuda = False
        place = fluid.CUDAPlace(0) if use_cuda else fluid.CPUPlace()
        exe = fluid.Executor(place)
        exe.run(fluid.default_startup_program())
        x = np.random.rand(3,10)
        y = np.random.rand(3,20)
        output= exe.run(feed={"data":x,"target_tensor":y},fetch_list=[result.name])
        print(output[0].shape)
        #(3,20)

    """
10334 10335 10336 10337 10338
    check_variable_and_dtype(
        x, 'x', ['float32', 'float64', 'int32', 'int64', 'bool'], 'expand_as')
    check_variable_and_dtype(target_tensor, 'target_tensor',
                             ['float32', 'float64', 'int32', 'int64', 'bool'],
                             'expand_as')
10339 10340 10341 10342 10343 10344 10345 10346
    helper = LayerHelper('expand_as', input=x, **locals())
    dtype = helper.input_dtype(input_param_name='x')
    out = helper.create_variable_for_type_inference(dtype)
    inputs = {'X': x, 'target_tensor': target_tensor}
    helper.append_op(type='expand_as', inputs=inputs, outputs={'Out': out})
    return out


G
fix  
gongweibao 已提交
10347 10348 10349
from paddle.fluid.framework import convert_np_dtype_to_dtype_


G
gongweibao 已提交
10350
@templatedoc()
G
fix  
gongweibao 已提交
10351 10352 10353 10354 10355 10356 10357 10358 10359
def uniform_random_batch_size_like(input,
                                   shape,
                                   dtype='float32',
                                   input_dim_idx=0,
                                   output_dim_idx=0,
                                   min=-1.0,
                                   max=1.0,
                                   seed=0):
    """
10360 10361 10362 10363 10364 10365
    This OP initializes a variable with random values sampled from a
    uniform distribution in the range [min, max). The input_dim_idx used to get the input dimension value which will be used to resize the output dimension.

    .. code-block:: text

        *Case 1:
G
fix  
gongweibao 已提交
10366

10367 10368 10369 10370 10371
            Given:
                input =[[0.946741  , 0.1357001 , 0.38086128]]    # input.shape=[1,3]
                shape=[2,4]

            result.shape[output_dim_idx] = input.shape[input_dim_idx],
10372
            output_dim_idx = 0,
10373
            input_dim_idx = 0,
10374
            result.shape[0] = input.shape[0],
10375 10376
            then:
                result=[[ 0.3443427 , -0.23056602,  0.3477049 ,  0.06139076]]    # result.shape=[1,4]
10377

10378
       *Case 2:
10379

10380 10381 10382 10383 10384
           Given:
               input =[[0.946741  , 0.1357001 , 0.38086128]]     # input.shape=[1,3]
               shape=[2,4]
               input_dim_idx=1
               output_dim_idx=1
10385

10386
           result.shape[output_dim_idx] = input.shape[input_dim_idx],
10387
           output_dim_idx = 1,
10388
           input_dim_idx = 1,
10389
           result.shape[1] = input.shape[1],
10390 10391 10392
           then:
               result=[[-0.23133647, -0.84195036,  0.21441269],
                       [-0.08774924,  0.25605237, -0.09403259]]    # result.shape=[2,3]
G
fix  
gongweibao 已提交
10393
    Args:
10394 10395
        input (Variable): A Tensor. Supported data types: float32, float64.
        shape (tuple|list): A python list or python tuple. The shape of the output Tensor, the data type is int.
10396
        input_dim_idx (int, optional): An index used to get the input dimension value which will be used to resize the output dimension. Default  0.
10397 10398 10399 10400 10401
        output_dim_idx (int, optional): An index used to indicate the specific dimension that will be replaced by corresponding input dimension value. Default 0.
        min (float, optional): The lower bound on the range of random values to generate, the min is included in the range. Default -1.0.
        max (float, optional): The upper bound on the range of random values to generate, the max is excluded in the range. Default 1.0.
        seed (int, optional):  Random seed used for generating samples. 0 means use a seed generated by the system.Note that if seed is not 0, this operator will always generate the same random numbers every time.
        dtype(np.dtype|core.VarDesc.VarType|str, optional): The data type of output Tensor. Supported data types: float32, float64. Default float32.
G
fix  
gongweibao 已提交
10402
    Returns:
10403
        Variable: A Tensor of the specified shape filled with uniform_random values. The shape of the Tensor is determined by the shape parameter and the specified dimension of the input Tensor.
G
fix  
gongweibao 已提交
10404

10405 10406 10407
    Examples:
        .. code-block:: python

10408
            import paddle.fluid as fluid
10409 10410

            # example 1:
10411 10412
            input = fluid.data(name="input", shape=[1, 3], dtype='float32')
            out_1 = fluid.layers.uniform_random_batch_size_like(input, [2, 4]) # out_1.shape=[1, 4]
10413

10414
            # example 2:
10415 10416
            out_2 = fluid.layers.uniform_random_batch_size_like(input, [2, 4], input_dim_idx=1, output_dim_idx=1) # out_2.shape=[2, 3]

10417

G
fix  
gongweibao 已提交
10418
    """
10419 10420 10421 10422 10423
    check_variable_and_dtype(input, 'Input', ("float32", 'float64'),
                             'uniform_random_batch_size_like')
    check_type(shape, 'shape', (list, tuple), 'uniform_random_batch_size_like')
    check_dtype(dtype, 'dtype', ('float32', 'float64'),
                'uniform_random_batch_size_like')
G
fix  
gongweibao 已提交
10424 10425

    helper = LayerHelper('uniform_random_batch_size_like', **locals())
X
Xin Pan 已提交
10426
    out = helper.create_variable_for_type_inference(dtype)
G
fix  
gongweibao 已提交
10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442
    c_dtype = convert_np_dtype_to_dtype_(dtype)
    helper.append_op(
        type='uniform_random_batch_size_like',
        inputs={'Input': input},
        outputs={'Out': out},
        attrs={
            'shape': shape,
            'input_dim_idx': input_dim_idx,
            'output_dim_idx': output_dim_idx,
            'min': min,
            'max': max,
            'seed': seed,
            'dtype': c_dtype
        })

    return out
G
fix  
gongweibao 已提交
10443 10444


G
gongweibao 已提交
10445
@templatedoc()
10446 10447 10448 10449 10450 10451
def gaussian_random(shape,
                    mean=0.0,
                    std=1.0,
                    seed=0,
                    dtype='float32',
                    name=None):
G
fix  
gongweibao 已提交
10452
    """
10453 10454
    This OP returns a Tensor filled with random values sampled from a Gaussian
    distribution, with ``shape`` and ``dtype``.
G
fix  
gongweibao 已提交
10455 10456

    Args:
10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471
        shape(list|tuple|Tensor): The shape of the output Tensor. If ``shape``
            is a list or tuple, the elements of it should be integers or Tensors
            (with the shape [1], and the data type int32 or int64). If ``shape``
            is a Tensor, it should be a 1-D Tensor(with the data type int32 or
            int64).
        mean(float|int, optional): Mean of the output tensor, default is 0.0.
        std(float|int, optional): Standard deviation of the output tensor, default
            is 1.0.
        seed(int, optional): ${seed_comment}
        dtype(str|np.dtype|core.VarDesc.VarType, optional): The data type of
            the output Tensor. Supported data types: float32, float64.
            Default 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`.
G
fix  
gongweibao 已提交
10472 10473

    Returns:
10474 10475
        Tensor: A Tensor filled with random values sampled from a Gaussian
        distribution, with ``shape`` and ``dtype``.
G
fix  
gongweibao 已提交
10476

10477
    Examples:
10478
       .. code-block:: python
10479

10480 10481 10482
            import paddle.fluid as fluid

            # example 1:
10483
            # attr shape is a list which doesn't contain Tensor.
10484
            result_1 = fluid.layers.gaussian_random(shape=[3, 4])
10485 10486 10487
            # [[-0.31261674,  1.8736548,  -0.6274357,   0.96988016],
            #  [-0.12294637,  0.9554768,   1.5690808,  -1.2894802 ],
            #  [-0.60082096, -0.61138713,  1.5345167,  -0.21834975]]
10488 10489

            # example 2:
10490 10491 10492
            # attr shape is a list which contains Tensor.
            dim_1 = fluid.layers.fill_constant([1], "int64", 2)
            dim_2 = fluid.layers.fill_constant([1], "int32", 3)
10493
            result_2 = fluid.layers.gaussian_random(shape=[dim_1, dim_2])
10494 10495
            # [[ 0.51398206, -0.3389769,   0.23597084],
            #  [ 1.0388143,  -1.2015356,  -1.0499583 ]]
10496 10497

            # example 3:
10498
            # attr shape is a Tensor, the data type must be int64 or int32.
10499 10500
            var_shape = fluid.data(name='var_shape', shape=[2], dtype="int64")
            result_3 = fluid.layers.gaussian_random(var_shape)
10501 10502 10503 10504
            # if var_shape's value is [2, 3]
            # result_3 is:
            # [[-0.12310527,  0.8187662,   1.923219  ]
            #  [ 0.70721835,  0.5210541,  -0.03214082]]
10505 10506 10507 10508
       
       .. code-block:: python
       
           # declarative mode 
10509 10510
           import numpy as np
           from paddle import fluid
10511
   
10512
           x = fluid.layers.gaussian_random((2, 3), std=2., seed=10)
10513
   
10514 10515 10516 10517
           place = fluid.CPUPlace()
           exe = fluid.Executor(place)
           start = fluid.default_startup_program()
           main = fluid.default_main_program()
10518
   
10519 10520
           exe.run(start)
           x_np, = exe.run(main, feed={}, fetch_list=[x])
10521

10522 10523 10524 10525 10526 10527 10528 10529 10530 10531
           x_np
           # array([[2.3060477, 2.676496 , 3.9911983],
           #        [0.9990833, 2.8675377, 2.2279181]], dtype=float32)

       .. code-block:: python

           # imperative mode
           import numpy as np
           from paddle import fluid
           import paddle.fluid.dygraph as dg
10532
    
10533 10534 10535
           place = fluid.CPUPlace()
           with dg.guard(place) as g:
               x = fluid.layers.gaussian_random((2, 4), mean=2., dtype="float32", seed=10)
10536
               x_np = x.numpy()       
10537 10538 10539
           x_np
           # array([[2.3060477 , 2.676496  , 3.9911983 , 0.9990833 ],
           #        [2.8675377 , 2.2279181 , 0.79029655, 2.8447366 ]], dtype=float32)
G
fix  
gongweibao 已提交
10540
    """
10541 10542
    if not isinstance(dtype, core.VarDesc.VarType):
        dtype = convert_np_dtype_to_dtype_(dtype)
10543 10544 10545

    if in_dygraph_mode():
        shape = utils._convert_shape_to_list(shape)
10546 10547 10548 10549
        return core.ops.gaussian_random('shape', shape, 'mean',
                                        float(mean), 'std',
                                        float(std), 'seed', seed, 'dtype',
                                        dtype)
10550 10551 10552

    check_type(shape, 'shape', (list, tuple, Variable), 'gaussian_random/randn')
    check_dtype(dtype, 'dtype', ['float32', 'float64'], 'gaussian_random/randn')
10553 10554

    inputs = {}
10555 10556 10557 10558
    attrs = {
        'mean': mean,
        'std': std,
        'seed': seed,
10559
        'dtype': dtype,
10560 10561 10562
        'use_mkldnn': False
    }
    utils._get_shape_tensor_inputs(
10563 10564 10565 10566
        inputs=inputs,
        attrs=attrs,
        shape=shape,
        op_type='gaussian_random/randn')
10567

10568 10569
    helper = LayerHelper('gaussian_random', **locals())
    out = helper.create_variable_for_type_inference(dtype)
G
fix  
gongweibao 已提交
10570 10571
    helper.append_op(
        type='gaussian_random',
10572
        inputs=inputs,
G
fix  
gongweibao 已提交
10573
        outputs={'Out': out},
10574
        attrs=attrs)
G
fix  
gongweibao 已提交
10575 10576 10577 10578

    return out


G
gongweibao 已提交
10579
@templatedoc()
G
fix  
gongweibao 已提交
10580
def sampling_id(x, min=0.0, max=1.0, seed=0, dtype='float32'):
G
fix  
gongweibao 已提交
10581
    """
R
ruri 已提交
10582
    This op is used for sampling id from multinomial distribution from the input, sampling one id for one sample.
G
fix  
gongweibao 已提交
10583

R
ruri 已提交
10584 10585 10586 10587
    Parameters:
        x (Variable): 2-D tensor, [batch_size, input_feature_dimensions]
        min (Float): minimum , default 0.0.
        max (Float): maximum, default 1.0.
10588
        seed (Float): Random seed, default 0. if seed is not 0, will generate same number every time.
G
fix  
gongweibao 已提交
10589
        dtype(np.dtype|core.VarDesc.VarType|str): The type of output data : float32, float_16, int etc
G
fix  
gongweibao 已提交
10590 10591

    Returns:
R
ruri 已提交
10592
        Variable: sampling tensor.
G
fix  
gongweibao 已提交
10593

10594 10595 10596
    Examples:
        .. code-block:: python

10597
            import paddle.fluid as fluid
R
ruri 已提交
10598
            x = fluid.data(
10599 10600
                name="X",
                shape=[13, 11],
R
ruri 已提交
10601
                dtype='float32')
10602

Y
Yibing Liu 已提交
10603
            out = fluid.layers.sampling_id(x)
G
fix  
gongweibao 已提交
10604 10605 10606
    """

    helper = LayerHelper('sampling_id', **locals())
X
Xin Pan 已提交
10607
    out = helper.create_variable_for_type_inference(dtype)
G
fix  
gongweibao 已提交
10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618
    helper.append_op(
        type='sampling_id',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'min': min,
               'max': max,
               'seed': seed})

    return out


G
gongweibao 已提交
10619
@templatedoc()
G
fix  
gongweibao 已提交
10620 10621 10622 10623 10624 10625 10626 10627 10628
def gaussian_random_batch_size_like(input,
                                    shape,
                                    input_dim_idx=0,
                                    output_dim_idx=0,
                                    mean=0.0,
                                    std=1.0,
                                    seed=0,
                                    dtype='float32'):
    """
G
gongweibao 已提交
10629
    ${comment}
G
fix  
gongweibao 已提交
10630 10631

    Args:
G
gongweibao 已提交
10632 10633
        input (Variable): ${input_comment}
        shape (tuple|list): ${shape_comment}
Y
Yibing Liu 已提交
10634 10635 10636 10637 10638 10639
        input_dim_idx (int): ${input_dim_idx_comment}
        output_dim_idx (int): ${output_dim_idx_comment}
        mean (float): ${mean_comment}
        std (float): ${std_comment}
        seed (int): ${seed_comment}
        dtype(np.dtype|core.VarDesc.VarType|str): The type of output data, float32 or float_64.
G
fix  
gongweibao 已提交
10640 10641

    Returns:
G
gongweibao 已提交
10642
        out (Variable): ${out_comment}
10643 10644 10645 10646

    Examples:
        .. code-block:: python

10647
            import paddle.fluid as fluid
Y
Yibing Liu 已提交
10648
            input = fluid.data(name="input", shape=[13, 11], dtype='float32')
10649

Y
Yibing Liu 已提交
10650
            out = fluid.layers.gaussian_random_batch_size_like(
10651
                input, shape=[-1, 11], mean=1.0, std=2.0)
G
fix  
gongweibao 已提交
10652 10653 10654
    """

    helper = LayerHelper('gaussian_random_batch_size_like', **locals())
10655 10656 10657 10658 10659 10660
    check_type(input, 'input', (Variable),
               'fluid.layers.gaussian_random_batch_size_like')
    check_type(shape, 'shape', (list, tuple),
               'fluid.layers.gaussian_random_batch_size_like')
    check_dtype(dtype, 'dtype', ['float16', 'float32', 'int'],
                'fluid.layers.gaussian_random_batch_size_like')
X
Xin Pan 已提交
10661
    out = helper.create_variable_for_type_inference(dtype)
G
fix  
gongweibao 已提交
10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679
    c_dtype = convert_np_dtype_to_dtype_(dtype)
    helper.append_op(
        type='gaussian_random_batch_size_like',
        inputs={'Input': input},
        outputs={'Out': out},
        attrs={
            'shape': shape,
            'input_dim_idx': input_dim_idx,
            'output_dim_idx': output_dim_idx,
            'mean': mean,
            'std': std,
            'seed': seed,
            'dtype': c_dtype
        })

    return out


G
gongweibao 已提交
10680
@templatedoc()
X
Xin Pan 已提交
10681
def sum(x):
G
fix  
gongweibao 已提交
10682
    """
G
gongweibao 已提交
10683
    ${comment}
10684

10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713
    Case 1:
    ::
        Input:
            Input. Shape = [2, 3]
            Input = [[1, 2, 3],
                     [4, 5, 6]]

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

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

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

        Output:
            The output. Shape = [2, 3]
            Output = [[8, 10, 12],
                      [14, 16, 18]]
G
fix  
gongweibao 已提交
10714 10715

    Args:
10716
        x (Variable|list(Variable)): ${x_comment}
G
fix  
gongweibao 已提交
10717 10718

    Returns:
10719
        Variable: ${out_comment}
10720 10721 10722 10723

    Examples:
        .. code-block:: python

10724
            import paddle.fluid as fluid
10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743

            input0 = fluid.layers.fill_constant(shape=[2, 3], dtype='int64', value=5)
            input1 = fluid.layers.fill_constant(shape=[2, 3], dtype='int64', value=3)
            sum = fluid.layers.sum([input0, input1])

            # You can print out 'sum' via executor.
            out = fluid.layers.Print(sum, message="the sum of input0 and input1: ")
            exe = fluid.Executor(fluid.CPUPlace())
            exe.run(fluid.default_main_program())

            # The printed result is:
            # 1570701754	the sum of input0 and input1: 	The place is:CPUPlace
            # Tensor[sum_0.tmp_0]
            #    shape: [2,3,]
            #    dtype: l
            #    data: 8,8,8,8,8,8,

            # the sum of input0 and input1 is 2-D Tensor with shape [2,3].
            # dtype is the corresponding C++ data type, which may vary in different environments.
10744 10745
            # Eg: if the data type of tensor is int64, then the corresponding C++ data type is int64_t,
            #       so the dtype value is typeid(int64_t).Name(), which is 'x' on MacOS, 'l' on Linux,
10746
            #       and '__int64' on Windows. They both represent 64-bit integer variables.
G
fix  
gongweibao 已提交
10747 10748
    """

10749
    return paddle.elementwise_sum(x)
G
fix  
gongweibao 已提交
10750 10751


G
gongweibao 已提交
10752
@templatedoc()
G
fix  
gongweibao 已提交
10753 10754
def slice(input, axes, starts, ends):
    """
10755 10756 10757 10758
    :alias_main: paddle.slice
	:alias: paddle.slice,paddle.tensor.slice,paddle.tensor.manipulation.slice
	:old_api: paddle.fluid.layers.slice

10759
    This operator produces a slice of ``input`` along multiple axes. Similar to numpy:
10760
    https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html
10761 10762 10763 10764 10765 10766 10767
    Slice uses ``axes``, ``starts`` and ``ends`` attributes to specify the start and
    end dimension for each axis in the list of axes and Slice uses this information
    to slice the input data tensor. If a negative value is passed to
    ``starts`` or ``ends`` such as :math:`-i`,  it represents the reverse position of the
    axis :math:`i-1` (here 0 is the initial position).
    If the value passed to ``starts`` or ``ends`` is greater than n
    (the number of elements in this dimension), it represents n.
10768
    For slicing to the end of a dimension with unknown size, it is recommended
10769
    to pass in INT_MAX. The size of ``axes`` must be equal to ``starts`` and ``ends``.
10770 10771 10772
    Following examples will explain how slice works:

    .. code-block:: text
G
fix  
gongweibao 已提交
10773

10774 10775 10776 10777 10778 10779 10780 10781
        Case1:
            Given:
                data = [ [1, 2, 3, 4], [5, 6, 7, 8], ]
                axes = [0, 1]
                starts = [1, 0]
                ends = [2, 3]
            Then:
                result = [ [5, 6, 7], ]
10782

10783 10784 10785 10786 10787
        Case2:
            Given:
                data = [ [1, 2, 3, 4], [5, 6, 7, 8], ]
                axes = [0, 1]
                starts = [0, 1]
10788
                ends = [-1, 1000]       # -1 denotes the reverse 0th position of dimension 0.
10789
            Then:
10790
                result = [ [2, 3, 4], ] # result = data[0:1, 1:4]
G
fix  
gongweibao 已提交
10791
    Args:
10792 10793 10794 10795 10796 10797 10798 10799 10800
        input (Variable): A ``Tensor`` or ``LoDTensor`` . The data type is ``float16``, ``float32``, ``float64``, ``int32`` or ``int64``.
        axes (list|tuple): The data type is ``int32`` . Axes that `starts` and `ends` apply to.
                            It's optional. If it is not provides, it will be treated as :math:`[0,1,...,len(starts)-1]`.
        starts (list|tuple|Variable): The data type is ``int32`` . If ``starts`` is a list or tuple, the elements of
                it should be integers or Tensors with shape [1]. If ``starts`` is an Variable, it should be an 1-D Tensor.
                It represents starting indices of corresponding axis in ``axes``.
        ends (list|tuple|Variable): The data type is ``int32`` . If ``ends`` is a list or tuple, the elements of
                it should be integers or Tensors with shape [1]. If ``ends`` is an Variable, it should be an 1-D Tensor .
                It represents ending indices of corresponding axis in ``axes``.
G
fix  
gongweibao 已提交
10801 10802

    Returns:
10803 10804 10805 10806 10807
        Variable:  A ``Tensor`` or ``LoDTensor``. The data type is same as ``input``.

    Raises:
        TypeError: The type of ``starts`` must be list, tuple or Variable.
        TypeError: The type of ``ends`` must be list, tuple or Variable.
G
fix  
gongweibao 已提交
10808

10809 10810 10811
    Examples:
        .. code-block:: python

10812
            import paddle.fluid as fluid
10813

10814 10815
            input = fluid.data(
                name="input", shape=[4, 5, 6], dtype='float32')
10816

10817 10818 10819 10820 10821 10822
            # example 1:
            # attr starts is a list which doesn't contain tensor Variable.
            axes = [0, 1, 2]
            starts = [-3, 0, 2]
            ends = [3, 2, 4]
            sliced_1 = fluid.layers.slice(input, axes=axes, starts=starts, ends=ends)
10823
            # sliced_1 is input[0:3, 0:2, 2:4].
10824 10825 10826 10827 10828

            # example 2:
            # attr starts is a list which contain tensor Variable.
            minus_3 = fluid.layers.fill_constant([1], "int32", -3)
            sliced_2 = fluid.layers.slice(input, axes=axes, starts=[minus_3, 0, 2], ends=ends)
10829
            # sliced_2 is input[0:3, 0:2, 2:4].
G
fix  
gongweibao 已提交
10830
    """
10831 10832
    if in_dygraph_mode():
        infer_flags = list(1 for i in range(len(axes)))
10833 10834 10835 10836 10837 10838 10839 10840 10841 10842
        if isinstance(starts, (list, tuple)) and isinstance(ends,
                                                            (list, tuple)):
            starts = [
                item.numpy()[0] if isinstance(item, Variable) else item
                for item in starts
            ]
            ends = [
                item.numpy()[0] if isinstance(item, Variable) else item
                for item in ends
            ]
10843

10844 10845
            return core.ops.slice(input, 'axes', axes, 'starts', starts, 'ends',
                                  ends, 'infer_flags', infer_flags)
10846

10847 10848 10849 10850 10851 10852 10853
    if not isinstance(starts, (list, tuple, Variable)):
        raise ValueError(
            "Input starts must be an Variable, python list or tuple.")
    if not isinstance(ends, (list, tuple, Variable)):
        raise ValueError(
            "Input ends must be an Variable, python list or tuple.")

G
fix  
gongweibao 已提交
10854
    helper = LayerHelper('slice', **locals())
10855 10856 10857 10858 10859

    inputs = {'Input': input}
    attrs = {'axes': axes}
    infer_flags = list(1 for i in range(len(axes)))

10860 10861 10862 10863 10864 10865 10866
    # starts
    if isinstance(starts, Variable):
        starts.stop_gradient = True
        inputs['StartsTensor'] = starts
        infer_flags = list(-1 for i in range(len(axes)))
    elif isinstance(starts, (list, tuple)):
        attrs['starts'] = []
L
Leo Chen 已提交
10867
        if utils._contain_var(starts):
10868
            inputs['StartsTensorList'] = utils._convert_to_tensor_list(starts)
10869 10870 10871 10872 10873 10874
            for i, dim in enumerate(starts):
                if isinstance(dim, Variable):
                    attrs['starts'].append(-1)
                    infer_flags[i] = -1
                else:
                    attrs['starts'].append(dim)
L
Leo Chen 已提交
10875 10876
        else:
            attrs['starts'] = starts
10877 10878 10879 10880 10881 10882 10883 10884

    # ends
    if isinstance(ends, Variable):
        ends.stop_gradient = True
        inputs['EndsTensor'] = ends
        infer_flags = list(-1 for i in range(len(axes)))
    elif isinstance(ends, (list, tuple)):
        attrs['ends'] = []
L
Leo Chen 已提交
10885
        if utils._contain_var(ends):
10886
            inputs['EndsTensorList'] = utils._convert_to_tensor_list(ends)
10887 10888 10889 10890 10891 10892
            for i, dim in enumerate(ends):
                if isinstance(dim, Variable):
                    attrs['ends'].append(-1)
                    infer_flags[i] = -1
                else:
                    attrs['ends'].append(dim)
L
Leo Chen 已提交
10893 10894 10895
        else:
            attrs['ends'] = ends

10896 10897
    # infer_flags
    attrs['infer_flags'] = infer_flags
X
Xin Pan 已提交
10898 10899
    out = helper.create_variable_for_type_inference(
        dtype=helper.input_dtype('input'))
G
fix  
gongweibao 已提交
10900
    helper.append_op(
10901
        type='slice', inputs=inputs, attrs=attrs, outputs={'Out': out})
G
fix  
gongweibao 已提交
10902 10903 10904 10905

    return out


W
wangchaochaohu 已提交
10906 10907 10908
@templatedoc()
def strided_slice(input, axes, starts, ends, strides):
    """
10909 10910 10911 10912
    :alias_main: paddle.strided_slice
	:alias: paddle.strided_slice,paddle.tensor.strided_slice,paddle.tensor.manipulation.strided_slice
	:old_api: paddle.fluid.layers.strided_slice

W
wangchaochaohu 已提交
10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925
    This operator produces a slice of ``input`` along multiple axes. Similar to numpy:
    https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html
    Slice uses ``axes``, ``starts`` and ``ends`` attributes to specify the start and
    end dimension for each axis in the list of axes and Slice uses this information
    to slice the input data tensor. If a negative value is passed to
    ``starts`` or ``ends`` such as :math:`-i`,  it represents the reverse position of the
    axis :math:`i-1` th(here 0 is the initial position). The ``strides`` represents steps of
    slicing and if the ``strides`` is negative, slice operation is in the opposite direction.
    If the value passed to ``starts`` or ``ends`` is greater than n
    (the number of elements in this dimension), it represents n.
    For slicing to the end of a dimension with unknown size, it is recommended
    to pass in INT_MAX. The size of ``axes`` must be equal to ``starts`` , ``ends`` and ``strides``.
    Following examples will explain how strided_slice works:
W
wangchaochaohu 已提交
10926 10927 10928 10929 10930 10931 10932 10933 10934

    .. code-block:: text

        Case1:
            Given:
                data = [ [1, 2, 3, 4], [5, 6, 7, 8], ]
                axes = [0, 1]
                starts = [1, 0]
                ends = [2, 3]
W
wangchaochaohu 已提交
10935
                strides = [1, 1]
W
wangchaochaohu 已提交
10936
            Then:
10937
                result = [ [5, 6, 7], ]
10938

W
wangchaochaohu 已提交
10939 10940 10941 10942
        Case2:
            Given:
                data = [ [1, 2, 3, 4], [5, 6, 7, 8], ]
                axes = [0, 1]
10943
                starts = [0, 1]
W
wangchaochaohu 已提交
10944 10945 10946 10947
                ends = [2, 0]
                strides = [1, -1]
            Then:
                result = [ [8, 7, 6], ]
10948

W
wangchaochaohu 已提交
10949 10950 10951 10952
        Case3:
            Given:
                data = [ [1, 2, 3, 4], [5, 6, 7, 8], ]
                axes = [0, 1]
10953
                starts = [0, 1]
10954 10955
                ends = [-1, 1000]
                strides = [1, 3]
W
wangchaochaohu 已提交
10956
            Then:
10957 10958
                result = [ [2], ]
    Args:
W
wangchaochaohu 已提交
10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970
        input (Variable): An N-D ``Tensor`` or ``LoDTensor`` . The data type is ``float32``, ``float64``, ``int32`` or ``int64``.
        axes (list|tuple): The data type is ``int32`` . Axes that `starts` and `ends` apply to.
                            It's optional. If it is not provides, it will be treated as :math:`[0,1,...,len(starts)-1]`.
        starts (list|tuple|Variable): The data type is ``int32`` . If ``starts`` is a list or tuple, the elements of
                it should be integers or Tensors with shape [1]. If ``starts`` is an Variable, it should be an 1-D Tensor.
                It represents starting indices of corresponding axis in ``axes``.
        ends (list|tuple|Variable): The data type is ``int32`` . If ``ends`` is a list or tuple, the elements of
                it should be integers or Tensors with shape [1]. If ``ends`` is an Variable, it should be an 1-D Tensor .
                It represents ending indices of corresponding axis in ``axes``.
        strides (list|tuple|Variable): The data type is ``int32`` . If ``strides`` is a list or tuple, the elements of
                it should be integers or Tensors with shape [1]. If ``strides`` is an Variable, it should be an 1-D Tensor .
                It represents slice step of corresponding axis in ``axes``.
10971 10972

    Returns:
W
wangchaochaohu 已提交
10973 10974 10975 10976 10977 10978
        Variable:  A ``Tensor`` or ``LoDTensor`` with the same dimension as ``input``. The data type is same as ``input``.

    Raises:
        TypeError: The type of ``starts`` must be list, tuple or Variable.
        TypeError: The type of ``ends`` must be list, tuple or Variable.
        TypeError: The type of ``strides`` must be list, tuple or Variable.
10979

W
wangchaochaohu 已提交
10980 10981 10982 10983 10984
    Examples:
        .. code-block:: python

            import paddle.fluid as fluid

W
wangchaochaohu 已提交
10985
            input = fluid.data(
W
wangchaochaohu 已提交
10986 10987
                name="input", shape=[3, 4, 5, 6], dtype='float32')

10988 10989 10990 10991 10992
            # example 1:
            # attr starts is a list which doesn't contain tensor Variable.
            axes = [0, 1, 2]
            starts = [-3, 0, 2]
            ends = [3, 2, 4]
W
wangchaochaohu 已提交
10993 10994 10995 10996 10997
            strides_1 = [1, 1, 1]
            strides_2 = [1, 1, 2]
            sliced_1 = fluid.layers.strided_slice(input, axes=axes, starts=starts, ends=ends, strides=strides_1)
            # sliced_1 is input[:, 0:3:1, 0:2:1, 2:4:1].

10998 10999 11000 11001

            # example 2:
            # attr starts is a list which contain tensor Variable.
            minus_3 = fluid.layers.fill_constant([1], "int32", -3)
W
wangchaochaohu 已提交
11002 11003
            sliced_2 = fluid.layers.strided_slice(input, axes=axes, starts=[minus_3, 0, 2], ends=ends, strides=strides_2)
            # sliced_2 is input[:, 0:3:1, 0:2:1, 2:4:2].
W
wangchaochaohu 已提交
11004 11005 11006
    """
    helper = LayerHelper('strided_slice', **locals())

11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029
    check_variable_and_dtype(input, 'input',
                             ['float32', 'float64', 'int32', 'int64'],
                             'strided_slice')
    check_type(axes, 'axes', (list, tuple), 'strided_slice')
    check_type(starts, 'starts', (list, tuple, Variable), 'strided_slice')
    check_type(ends, 'ends', (list, tuple, Variable), 'strided_slice')
    check_type(strides, 'strides', (list, tuple, Variable), 'strided_slice')

    def check_list_elements_dtype(list_input, input_name):
        if isinstance(list_input, Variable):
            check_dtype(list_input.dtype, input_name, ['int32'],
                        'strided_slice')
        else:
            for i, var in enumerate(list_input):
                var_name = input_name + '[' + str(i) + ']'
                if isinstance(var, Variable):
                    check_dtype(var.dtype, var_name, ['int32'], 'strided_slice')

    check_list_elements_dtype(axes, 'axes')
    check_list_elements_dtype(starts, 'starts')
    check_list_elements_dtype(ends, 'ends')
    check_list_elements_dtype(strides, 'strides')

11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049
    def get_new_list_tensor(old_list):
        new_list_tensor = []
        for dim in old_list:
            if isinstance(dim, Variable):
                dim.stop_gradient = True
                new_list_tensor.append(dim)
            else:
                assert (isinstance(dim, int))
                temp_out = helper.create_variable_for_type_inference('int32')
                fill_constant([1], 'int32', dim, force_cpu=True, out=temp_out)
                new_list_tensor.append(temp_out)
        return new_list_tensor

    inputs = {'Input': input}
    attrs = {'axes': axes}
    infer_flags = list(1 for i in range(len(axes)))

    if in_dygraph_mode():
        inputs = {'Input': input}
        attrs = {
W
wangchaochaohu 已提交
11050 11051 11052
            'axes': axes,
            'starts': starts,
            'ends': ends,
11053 11054 11055 11056 11057 11058 11059 11060 11061 11062
            'strides': strides,
            'infer_flags': infer_flags
        }
    else:
        # starts
        if isinstance(starts, Variable):
            starts.stop_gradient = True
            inputs['StartsTensor'] = starts
        elif isinstance(starts, (list, tuple)):
            attrs['starts'] = []
L
Leo Chen 已提交
11063
            if utils._contain_var(starts):
11064 11065 11066 11067 11068 11069 11070
                inputs['StartsTensorList'] = get_new_list_tensor(starts)
                for i, dim in enumerate(starts):
                    if isinstance(dim, Variable):
                        attrs['starts'].append(-1)
                        infer_flags[i] = -1
                    else:
                        attrs['starts'].append(dim)
L
Leo Chen 已提交
11071 11072
            else:
                attrs['starts'] = starts
11073 11074 11075 11076 11077 11078 11079

        # ends
        if isinstance(ends, Variable):
            ends.stop_gradient = True
            inputs['EndsTensor'] = ends
        elif isinstance(ends, (list, tuple)):
            attrs['ends'] = []
L
Leo Chen 已提交
11080
            if utils._contain_var(ends):
11081 11082 11083 11084 11085 11086 11087
                inputs['EndsTensorList'] = get_new_list_tensor(ends)
                for i, dim in enumerate(ends):
                    if isinstance(dim, Variable):
                        attrs['ends'].append(-1)
                        infer_flags[i] = -1
                    else:
                        attrs['ends'].append(dim)
L
Leo Chen 已提交
11088 11089 11090
            else:
                attrs['ends'] = ends

11091 11092 11093 11094 11095 11096
        # strides
        if isinstance(strides, Variable):
            strides.stop_gradient = True
            inputs['StridesTensor'] = strides
        elif isinstance(strides, (list, tuple)):
            attrs['strides'] = []
L
Leo Chen 已提交
11097
            if utils._contain_var(strides):
11098 11099 11100 11101 11102 11103 11104
                inputs['StridesTensorList'] = get_new_list_tensor(strides)
                for i, dim in enumerate(strides):
                    if isinstance(dim, Variable):
                        attrs['strides'].append(-1)
                        infer_flags[i] = -1
                    else:
                        attrs['strides'].append(dim)
L
Leo Chen 已提交
11105 11106
            else:
                attrs['strides'] = strides
11107 11108 11109 11110 11111
        attrs['infer_flags'] = infer_flags
    out = helper.create_variable_for_type_inference(
        dtype=helper.input_dtype('input'))
    helper.append_op(
        type='strided_slice', inputs=inputs, attrs=attrs, outputs={'Out': out})
W
wangchaochaohu 已提交
11112 11113 11114 11115

    return out


G
fix  
gongweibao 已提交
11116 11117
def shape(input):
    """
11118 11119 11120 11121
    :alias_main: paddle.shape
	:alias: paddle.shape,paddle.tensor.shape,paddle.tensor.attribute.shape
	:old_api: paddle.fluid.layers.shape

C
chengduozh 已提交
11122 11123
    **Shape Layer**

C
fix doc  
chengduozh 已提交
11124
    Get the shape of the input.
G
fix  
gongweibao 已提交
11125

11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142
    .. code-block:: text

        Case1:
            Given N-D Tensor:
                input = [ [1, 2, 3, 4], [5, 6, 7, 8] ]

            Then:
                input.shape = [2, 4]

        Case2:
            Given SelectedRows:
                input.rows = [0, 4, 19]
                input.height = 20
                input.value = [ [1, 2], [3, 4], [5, 6] ]  # inner tensor
            Then:
                input.shape = [3, 2]

G
fix  
gongweibao 已提交
11143
    Args:
11144
        input (Variable): The input can be N-D Tensor or SelectedRows with data type float16, float32, float64, int32, int64.
11145
                          If input variable is type of SelectedRows, returns the shape of it's inner tensor.
G
fix  
gongweibao 已提交
11146 11147

    Returns:
11148
        Variable (Tensor): The shape of the input variable.
G
fix  
gongweibao 已提交
11149

11150 11151 11152
    Examples:
        .. code-block:: python

11153
            import paddle.fluid as fluid
11154
            import numpy as np
11155

11156
            inputs = fluid.data(name="x", shape=[3, 100, 100], dtype="float32")
11157 11158 11159 11160 11161 11162 11163 11164 11165
            output = fluid.layers.shape(inputs)

            exe = fluid.Executor(fluid.CPUPlace())
            exe.run(fluid.default_startup_program())

            img = np.ones((3, 100, 100)).astype(np.float32)

            res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output])
            print(res) # [array([  3, 100, 100], dtype=int32)]
G
fix  
gongweibao 已提交
11166
    """
11167 11168 11169
    check_variable_and_dtype(
        input, 'input', ['float16', 'float32', 'float64', 'int32', 'int64'],
        'shape')
G
fix  
gongweibao 已提交
11170
    helper = LayerHelper('shape', **locals())
11171
    out = helper.create_variable_for_type_inference(dtype='int32')
G
fix  
gongweibao 已提交
11172
    helper.append_op(
G
fix  
gongweibao 已提交
11173
        type='shape', inputs={'Input': input}, outputs={'Out': out})
G
fix  
gongweibao 已提交
11174 11175

    return out
G
merge  
gongweibao 已提交
11176 11177


Z
zhoukunsheng 已提交
11178 11179
def rank(input):
    """
11180 11181 11182 11183
    :alias_main: paddle.rank
	:alias: paddle.rank,paddle.tensor.rank,paddle.tensor.attribute.rank
	:old_api: paddle.fluid.layers.rank

11184
    The OP returns the number of dimensions for a tensor, which is a 0-D int32 Tensor.
Z
zhoukunsheng 已提交
11185 11186

    Args:
11187
        input (Variable): The input N-D tensor with shape of :math:`[N_1, N_2, ..., N_k]`, the data type is arbitrary.
Z
zhoukunsheng 已提交
11188 11189

    Returns:
11190
        Variable, the output data type is int32.: The 0-D tensor with the dimensions of the input variable.
Z
zhoukunsheng 已提交
11191 11192 11193 11194

    Examples:
        .. code-block:: python

11195 11196
            import paddle.fluid as fluid

11197 11198
            input = fluid.data(name="input", shape=[3, 100, 100], dtype="float32")
            rank = fluid.layers.rank(input) # rank=(3,)
Z
zhoukunsheng 已提交
11199
    """
11200
    check_type(input, 'input', (Variable), 'input')
Z
zhoukunsheng 已提交
11201 11202 11203 11204 11205 11206
    ndims = len(input.shape)
    out = assign(np.array(ndims, 'int32'))

    return out


Z
zhoukunsheng 已提交
11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235
def size(input):
    """
    **Size Layer**

    Returns the number of elements for a tensor, which is a int64 Tensor with shape [1].

    Args:
        input (Variable): The input variable.

    Returns:
        Variable: The number of elements for the input variable.

    Examples:
        .. code-block:: python

            import paddle.fluid.layers as layers

            input = layers.data(
                name="input", shape=[3, 100], dtype="float32", append_batch_size=False)
            rank = layers.size(input) # 300
    """

    helper = LayerHelper('size', **locals())
    out = helper.create_variable_for_type_inference(dtype='int64')
    helper.append_op(type='size', inputs={'Input': input}, outputs={'Out': out})

    return out


S
sneaxiy 已提交
11236 11237 11238 11239
def _elementwise_op(helper):
    op_type = helper.layer_type
    x = helper.kwargs.get('x', None)
    y = helper.kwargs.get('y', None)
X
Xin Pan 已提交
11240

S
sneaxiy 已提交
11241 11242
    assert x is not None, 'x cannot be None in {}'.format(op_type)
    assert y is not None, 'y cannot be None in {}'.format(op_type)
11243 11244 11245 11246
    check_variable_and_dtype(
        x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], op_type)
    check_variable_and_dtype(
        y, 'y', ['float16', 'float32', 'float64', 'int32', 'int64'], op_type)
11247

S
sneaxiy 已提交
11248 11249
    axis = helper.kwargs.get('axis', -1)
    use_mkldnn = helper.kwargs.get('use_mkldnn', False)
S
sneaxiy 已提交
11250
    name = helper.kwargs.get('name', None)
11251
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
S
sneaxiy 已提交
11252

S
sneaxiy 已提交
11253 11254 11255 11256 11257 11258 11259 11260 11261 11262
    helper.append_op(
        type=op_type,
        inputs={'X': x,
                'Y': y},
        outputs={'Out': out},
        attrs={'axis': axis,
               'use_mkldnn': use_mkldnn})
    return helper.append_activation(out)


S
sneaxiy 已提交
11263
def scale(x, scale=1.0, bias=0.0, bias_after_scale=True, act=None, name=None):
S
sneaxiy 已提交
11264
    """
11265 11266 11267 11268
    :alias_main: paddle.scale
	:alias: paddle.scale,paddle.tensor.scale,paddle.tensor.math.scale
	:old_api: paddle.fluid.layers.scale

11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281
    Scale operator.

    Putting scale and bias to the input Tensor as following:

    ``bias_after_scale`` is True:

    .. math::
                            Out=scale*X+bias

    ``bias_after_scale`` is False:

    .. math::
                            Out=scale*(X+bias)
S
sneaxiy 已提交
11282 11283

    Args:
11284
        x(Variable): Input N-D Tensor of scale operator. Data type can be float32, float64, int8, int16, int32, int64, uint8.
11285
        scale(float|Variable): The scale factor of the input, it should be a float number or a Variable with shape [1] and data type as float32.
11286 11287 11288
        bias(float): The bias to be put on the input.
        bias_after_scale(bool): Apply bias addition after or before scaling. It is useful for numeric stability in some circumstances.
        act(str, optional): Activation applied to the output such as tanh, softmax, sigmoid, relu.
11289
        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`
S
sneaxiy 已提交
11290 11291

    Returns:
11292
        Variable(Tensor|LoDTensor): Output tensor of scale operator, with shape and data type same as input.
11293 11294 11295 11296 11297

    Examples:
        .. code-block:: python

            import paddle.fluid as fluid
11298 11299 11300 11301 11302 11303 11304 11305 11306
            import numpy as np

            inputs = fluid.layers.data(name="x", shape=[2, 3], dtype='float32')
            output = fluid.layers.scale(inputs, scale = 2.0, bias = 1.0)

            exe = fluid.Executor(fluid.CPUPlace())
            exe.run(fluid.default_startup_program())

            img = np.array([[1, 2, 3], [4, 5, 6]]).astype(np.float32)
11307

11308 11309
            res = exe.run(fluid.default_main_program(), feed={'x':img}, fetch_list=[output])
            print(res) # [array([[ 3.,  5.,  7.], [ 9., 11., 13.]], dtype=float32)]
11310 11311 11312 11313 11314 11315 11316 11317

        .. code-block:: python

            # scale with parameter scale as Variable
            import paddle.fluid as fluid
            import numpy as np

            inputs = fluid.layers.data(name="x", shape=[2, 3], dtype='float32')
11318
            scale = fluid.layers.data(name="scale", shape=[1], dtype='float32',
11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330
                                      append_batch_size=False)
            output = fluid.layers.scale(inputs, scale = scale, bias = 1.0)

            exe = fluid.Executor(fluid.CPUPlace())
            exe.run(fluid.default_startup_program())

            img = np.array([[1, 2, 3], [4, 5, 6]]).astype(np.float32)
            scale_np = np.array([2.]).astype(np.float32)

            res = exe.run(fluid.default_main_program(), feed={'x':img, 'scale':scale_np}, fetch_list=[output])
            print(res) # [array([[ 3.,  5.,  7.], [ 9., 11., 13.]], dtype=float32)]

S
sneaxiy 已提交
11331
    """
11332 11333 11334 11335 11336 11337 11338 11339

    if in_dygraph_mode():
        _scale = scale.numpy().item(0) if isinstance(scale, Variable) else scale
        out = core.ops.scale(x, 'scale',
                             float(_scale), 'bias',
                             float(bias), 'bias_after_scale', bias_after_scale)
        return dygraph_utils._append_activation_in_dygraph(out)

11340 11341 11342 11343
    check_variable_and_dtype(x, "x", [
        'float16', 'float32', 'float64', 'int8', 'int16', 'int32', 'int64',
        'uint8'
    ], "scale")
11344
    inputs = {'X': [x]}
11345 11346 11347 11348 11349
    attrs = {
        'bias': float(bias),
        'bias_after_scale': bias_after_scale,
    }
    if isinstance(scale, Variable):
11350
        inputs['ScaleTensor'] = [scale]
11351 11352
    else:
        attrs['scale'] = float(scale)
11353
    helper = LayerHelper('scale', **locals())
11354
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
11355

S
sneaxiy 已提交
11356
    helper.append_op(
11357
        type='scale', inputs=inputs, outputs={'Out': out}, attrs=attrs)
S
sneaxiy 已提交
11358
    return helper.append_activation(out)
S
sneaxiy 已提交
11359 11360


X
Xin Pan 已提交
11361
def elementwise_add(x, y, axis=-1, act=None, name=None):
11362
    """
11363 11364 11365 11366
    :alias_main: paddle.elementwise_add
	:alias: paddle.elementwise_add,paddle.tensor.elementwise_add,paddle.tensor.math.elementwise_add
	:old_api: paddle.fluid.layers.elementwise_add

11367 11368 11369 11370 11371 11372 11373 11374 11375
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11376 11377
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11378 11379
            }

11380 11381
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11382
        z = fluid.layers.elementwise_add(x, y)
11383
        # z = x + y
11384 11385 11386 11387 11388 11389

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

11390
        print(z_value) # [3., 8., 6.]
11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403


    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.ones((2, 3, 4, 5)).astype('float32'),
                "y": np.zeros((3, 4)).astype('float32')
            }

11404 11405
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11406
        z = fluid.layers.elementwise_add(x, y, axis=1)
11407
        # z = x + y
11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)

        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value) # z.shape=[2,3,4,5]


    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.random.randint(1, 5, size=[2, 3, 4, 5]).astype('float32'),
                "y": np.random.randint(1, 5, size=[5]).astype('float32')
            }
11428

11429 11430
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[5], dtype='float32')
11431
        z = fluid.layers.elementwise_add(x, y, axis=3)
11432
        # z = x + y
11433 11434 11435 11436 11437 11438 11439 11440 11441

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)

        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])
        print(z_value) # z.shape=[2,3,4,5]

    """
11442 11443 11444 11445
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_add')

S
sneaxiy 已提交
11446 11447 11448
    return _elementwise_op(LayerHelper('elementwise_add', **locals()))


X
Xin Pan 已提交
11449
def elementwise_div(x, y, axis=-1, act=None, name=None):
11450
    """
11451 11452 11453 11454
    :alias_main: paddle.elementwise_div
	:alias: paddle.elementwise_div,paddle.tensor.elementwise_div,paddle.tensor.math.elementwise_div
	:old_api: paddle.fluid.layers.elementwise_div

11455 11456 11457 11458 11459 11460 11461 11462 11463
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11464 11465
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11466 11467
            }

11468 11469
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11470
        z = fluid.layers.elementwise_div(x, y)
11471
        # z = x / y
11472 11473 11474 11475 11476 11477

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

11478
        print(z_value) # [2., 0.6, 2.]
11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491


    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.ones((2, 3, 4, 5)).astype('float32'),
                "y": np.zeros((3, 4)).astype('float32')
            }

11492 11493
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11494
        z = fluid.layers.elementwise_div(x, y, axis=1)
11495
        # z = x / y
11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)

        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value) # z.shape=[2,3,4,5]


    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.random.randint(1, 5, size=[2, 3, 4, 5]).astype('float32'),
                "y": np.random.randint(1, 5, size=[5]).astype('float32')
            }
11516

11517 11518
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[5], dtype='float32')
11519
        z = fluid.layers.elementwise_div(x, y, axis=3)
11520
        # z = x / y
11521 11522 11523

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
11524

11525 11526 11527 11528 11529
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])
        print(z_value) # z.shape=[2,3,4,5]

    """
11530 11531 11532 11533
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_div')

S
sneaxiy 已提交
11534 11535 11536
    return _elementwise_op(LayerHelper('elementwise_div', **locals()))


X
Xin Pan 已提交
11537
def elementwise_sub(x, y, axis=-1, act=None, name=None):
11538
    """
11539 11540 11541 11542
    :alias_main: paddle.elementwise_sub
	:alias: paddle.elementwise_sub,paddle.tensor.elementwise_sub,paddle.tensor.math.elementwise_sub
	:old_api: paddle.fluid.layers.elementwise_sub

11543 11544 11545 11546 11547 11548 11549 11550 11551
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11552 11553
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11554 11555
            }

11556 11557
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11558
        z = fluid.layers.elementwise_sub(x, y)
11559
        # z = x - y
11560 11561 11562 11563 11564 11565

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

11566
        print(z_value) # [1., -2., 2.]
11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579


    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.ones((2, 3, 4, 5)).astype('float32'),
                "y": np.zeros((3, 4)).astype('float32')
            }

11580 11581
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11582
        z = fluid.layers.elementwise_sub(x, y, axis=1)
11583
        # z = x - y
11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)

        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value) # z.shape=[2,3,4,5]


    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.random.randint(1, 5, size=[2, 3, 4, 5]).astype('float32'),
                "y": np.random.randint(1, 5, size=[5]).astype('float32')
            }
11604

11605 11606
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[5], dtype='float32')
11607
        z = fluid.layers.elementwise_sub(x, y, axis=3)
11608
        # z = x - y
11609 11610 11611

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
11612

11613 11614 11615 11616 11617
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])
        print(z_value) # z.shape=[2,3,4,5]

    """
11618 11619 11620 11621
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_sub')

S
sneaxiy 已提交
11622 11623 11624
    return _elementwise_op(LayerHelper('elementwise_sub', **locals()))


11625
@deprecated(since="2.0.0", update_to="paddle.multiply")
X
Xin Pan 已提交
11626
def elementwise_mul(x, y, axis=-1, act=None, name=None):
11627
    """
11628 11629 11630 11631
    :alias_main: paddle.elementwise_mul
	:alias: paddle.elementwise_mul,paddle.tensor.elementwise_mul,paddle.tensor.math.elementwise_mul
	:old_api: paddle.fluid.layers.elementwise_mul

11632 11633 11634 11635 11636 11637 11638 11639 11640
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11641 11642
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11643 11644
            }

11645 11646
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11647
        z = fluid.layers.elementwise_mul(x, y)
11648
        # z = x * y
11649 11650 11651 11652 11653 11654

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

11655
        print(z_value) # [2., 15., 8.]
11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668


    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.ones((2, 3, 4, 5)).astype('float32'),
                "y": np.zeros((3, 4)).astype('float32')
            }

11669 11670
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11671
        z = fluid.layers.elementwise_mul(x, y, axis=1)
11672
        # z = x * y
11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)

        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value) # z.shape=[2,3,4,5]


    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.random.randint(1, 5, size=[2, 3, 4, 5]).astype('float32'),
                "y": np.random.randint(1, 5, size=[5]).astype('float32')
            }
11693

11694 11695
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[5], dtype='float32')
11696
        z = fluid.layers.elementwise_mul(x, y, axis=3)
11697
        # z = x * y
11698 11699 11700

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
11701

11702 11703 11704
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])
        print(z_value) # z.shape=[2,3,4,5]
11705

11706
    """
11707 11708 11709 11710
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_mul')

S
sneaxiy 已提交
11711 11712 11713
    return _elementwise_op(LayerHelper('elementwise_mul', **locals()))


X
Xin Pan 已提交
11714
def elementwise_max(x, y, axis=-1, act=None, name=None):
11715
    """
11716 11717 11718 11719
    :alias_main: paddle.elementwise_max
	:alias: paddle.elementwise_max,paddle.tensor.elementwise_max,paddle.tensor.math.elementwise_max
	:old_api: paddle.fluid.layers.elementwise_max

11720 11721 11722 11723 11724 11725 11726 11727 11728
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11729 11730
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11731 11732
            }

11733 11734
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755
        z = fluid.layers.elementwise_max(x, y)

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value) #[2, 5, 4]


    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.ones((2, 3, 4, 5)).astype('float32'),
                "y": np.zeros((3, 4)).astype('float32')
            }

11756 11757
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768
        z = fluid.layers.elementwise_max(x, y, axis=1)

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)

        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value)#[[[[1., 1., 1., 1., 1.] .... [1., 1., 1., 1., 1.]]]]

    """
11769 11770 11771 11772
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_max')

S
sneaxiy 已提交
11773 11774 11775
    return _elementwise_op(LayerHelper('elementwise_max', **locals()))


X
Xin Pan 已提交
11776
def elementwise_min(x, y, axis=-1, act=None, name=None):
11777
    """
11778 11779 11780 11781
    :alias_main: paddle.elementwise_min
	:alias: paddle.elementwise_min,paddle.tensor.elementwise_min,paddle.tensor.math.elementwise_min
	:old_api: paddle.fluid.layers.elementwise_min

11782 11783 11784 11785 11786 11787 11788 11789 11790
Examples:

    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11791 11792
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11793 11794
            }

11795 11796
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11797
        z = fluid.layers.elementwise_min(x, y)
11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value) #[1, 3, 2]

    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.ones((2, 3, 4, 5)).astype('float32'),
                "y": np.zeros((3, 4)).astype('float32')
            }

11817 11818
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11819
        z = fluid.layers.elementwise_min(x, y, axis=1)
11820 11821 11822 11823 11824 11825 11826 11827 11828

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)

        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value)#[[[[0., 0., 0., 0., 0.] .... [0., 0., 0., 0., 0.]]]]
    """
11829 11830 11831
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_min')
11832

S
sneaxiy 已提交
11833 11834 11835
    return _elementwise_op(LayerHelper('elementwise_min', **locals()))


X
Xin Pan 已提交
11836
def elementwise_pow(x, y, axis=-1, act=None, name=None):
11837
    """
11838 11839 11840 11841
    :alias_main: paddle.elementwise_pow
	:alias: paddle.elementwise_pow,paddle.tensor.elementwise_pow,paddle.tensor.math.elementwise_pow
	:old_api: paddle.fluid.layers.elementwise_pow

11842 11843 11844 11845 11846 11847 11848 11849 11850
Examples:

    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11851 11852
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11853 11854
            }

11855 11856
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11857 11858 11859 11860 11861 11862 11863 11864 11865
        z = fluid.layers.elementwise_pow(x, y)

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value) #[2, 243, 16]
    """
11866 11867 11868
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_pow')
S
sneaxiy 已提交
11869 11870 11871
    return _elementwise_op(LayerHelper('elementwise_pow', **locals()))


11872
def elementwise_mod(x, y, axis=-1, act=None, name=None):
11873
    """
11874 11875 11876 11877
    :alias_main: paddle.elementwise_mod
	:alias: paddle.elementwise_mod,paddle.tensor.elementwise_mod,paddle.tensor.math.elementwise_mod
	:old_api: paddle.fluid.layers.elementwise_mod

11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901
Examples:

    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.array([10, 15, 8]).astype('int32'),
                "y": np.array([3, 6, 5]).astype('int32')
            }

        x = fluid.data(name="x", shape=[3], dtype='int32')
        y = fluid.data(name="y", shape=[3], dtype='int32')
        z = fluid.layers.elementwise_mod(x, y)

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value) #[1, 3, 3]
    """
11902 11903 11904 11905
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_mod')

11906 11907 11908 11909
    return _elementwise_op(LayerHelper('elementwise_mod', **locals()))


def elementwise_floordiv(x, y, axis=-1, act=None, name=None):
11910
    """
11911 11912 11913 11914
    :alias_main: paddle.elementwise_floordiv
	:alias: paddle.elementwise_floordiv,paddle.tensor.elementwise_floordiv,paddle.tensor.math.elementwise_floordiv
	:old_api: paddle.fluid.layers.elementwise_floordiv

11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938
Examples:

    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
                "x": np.array([10, 15, 8]).astype('int32'),
                "y": np.array([3, 7, 5]).astype('int32')
            }

        x = fluid.data(name="x", shape=[3], dtype='int32')
        y = fluid.data(name="y", shape=[3], dtype='int32')
        z = fluid.layers.elementwise_floordiv(x, y)

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

        print(z_value) #[3, 2, 1]
    """
11939 11940 11941 11942
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_floordiv')

11943 11944 11945
    return _elementwise_op(LayerHelper('elementwise_floordiv', **locals()))


S
sneaxiy 已提交
11946
for func in [
11947 11948 11949 11950
        elementwise_add,
        elementwise_div,
        elementwise_sub,
        elementwise_mul,
11951 11952
        elementwise_max,
        elementwise_pow,
11953
        elementwise_min,
11954 11955
        elementwise_mod,
        elementwise_floordiv,
11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969
]:
    op_proto = OpProtoHolder.instance().get_op_proto(func.__name__)
    func.__doc__ = _generate_doc_string_(
        op_proto,
        additional_args_lines=[
            "axis (int32, optional): If X.dimension != Y.dimension, \
            Y.dimension must be a subsequence of x.dimension. \
            And axis is the start dimension index for broadcasting Y onto X. ",
            "act (string, optional): Activation applied to the output. \
            Default is None. Details: :ref:`api_guide_activations_en` ",
            "name (string, optional): Name of the output. \
            Default is None. It's used to print debug info for developers. Details: \
            :ref:`api_guide_Name` "
        ],
11970 11971
        skip_attrs_set={
            "x_data_format", "y_data_format", "axis", "use_quantizer",
11972
            "mkldnn_data_type", "Scale_x", "Scale_y", "Scale_out"
11973
        }) + """\n""" + str(func.__doc__)
11974

11975
for func in []:
S
sneaxiy 已提交
11976 11977 11978 11979
    op_proto = OpProtoHolder.instance().get_op_proto(func.__name__)
    func.__doc__ = _generate_doc_string_(
        op_proto,
        additional_args_lines=[
S
sneaxiy 已提交
11980 11981
            "act (basestring|None): Activation applied to the output.",
            "name (basestring|None): Name of the output."
S
sneaxiy 已提交
11982
        ])
11983 11984 11985 11986
    func.__doc__ = func.__doc__ + """

Examples:
  .. code-block:: python
11987

11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019
    import paddle.fluid as fluid
    # example 1: shape(x) = (2, 3, 4, 5), shape(y) = (2, 3, 4, 5)
    x0 = fluid.layers.data(name="x0", shape=[2, 3, 4, 5], dtype='float32')
    y0 = fluid.layers.data(name="y0", shape=[2, 3, 4, 5], dtype='float32')
    z0 = fluid.layers.%s(x0, y0)

    # example 2: shape(X) = (2, 3, 4, 5), shape(Y) = (5)
    x1 = fluid.layers.data(name="x1", shape=[2, 3, 4, 5], dtype='float32')
    y1 = fluid.layers.data(name="y1", shape=[5], dtype='float32')
    z1 = fluid.layers.%s(x1, y1)

    # example 3: shape(X) = (2, 3, 4, 5), shape(Y) = (4, 5), with axis=-1(default) or axis=2
    x2 = fluid.layers.data(name="x2", shape=[2, 3, 4, 5], dtype='float32')
    y2 = fluid.layers.data(name="y2", shape=[4, 5], dtype='float32')
    z2 = fluid.layers.%s(x2, y2, axis=2)

    # example 4: shape(X) = (2, 3, 4, 5), shape(Y) = (3, 4), with axis=1
    x3 = fluid.layers.data(name="x3", shape=[2, 3, 4, 5], dtype='float32')
    y3 = fluid.layers.data(name="y3", shape=[3, 4], dtype='float32')
    z3 = fluid.layers.%s(x3, y3, axis=1)

    # example 5: shape(X) = (2, 3, 4, 5), shape(Y) = (2), with axis=0
    x4 = fluid.layers.data(name="x4", shape=[2, 3, 4, 5], dtype='float32')
    y4 = fluid.layers.data(name="y4", shape=[2], dtype='float32')
    z4 = fluid.layers.%s(x4, y4, axis=0)

    # example 6: shape(X) = (2, 3, 4, 5), shape(Y) = (2, 1), with axis=0
    x5 = fluid.layers.data(name="x5", shape=[2, 3, 4, 5], dtype='float32')
    y5 = fluid.layers.data(name="y5", shape=[2], dtype='float32')
    z5 = fluid.layers.%s(x5, y5, axis=0)
    """ % (func.__name__, func.__name__, func.__name__, func.__name__,
           func.__name__, func.__name__)
M
minqiyang 已提交
12020 12021


12022
def _logical_op(op_name, x, y, out=None, name=None, binary_op=True):
12023 12024 12025 12026
    check_variable_and_dtype(x, "x", ["bool"], op_name)
    if y is not None:
        check_variable_and_dtype(y, "y", ["bool"], op_name)
    if out is not None:
12027
        check_type(out, "out", Variable, op_name)
12028

M
minqiyang 已提交
12029 12030
    helper = LayerHelper(op_name, **locals())

M
minqiyang 已提交
12031 12032
    if binary_op:
        assert x.dtype == y.dtype
M
minqiyang 已提交
12033 12034

    if out is None:
12035
        out = helper.create_variable_for_type_inference(dtype=x.dtype)
M
minqiyang 已提交
12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047

    if binary_op:
        helper.append_op(
            type=op_name, inputs={"X": x,
                                  "Y": y}, outputs={"Out": out})
    else:
        helper.append_op(type=op_name, inputs={"X": x}, outputs={"Out": out})

    return out


@templatedoc()
12048
def logical_and(x, y, out=None, name=None):
M
minqiyang 已提交
12049
    """
12050
    :alias_main: paddle.logical_and
S
Shibo Tao 已提交
12051 12052
    :alias: paddle.logical_and, paddle.tensor.logical_and, paddle.tensor.logic.logical_and
    :old_api: paddle.fluid.layers.logical_and
12053

S
Shibo Tao 已提交
12054 12055
    ``logical_and`` operator computes element-wise logical AND on ``x`` and ``y``, and returns ``out``. ``x``, ``y`` and ``out`` are N-dim boolean ``Variable``.
    Each element of ``out`` is calculated by
12056

W
Wilber 已提交
12057 12058
    .. math::

S
Shibo Tao 已提交
12059
        out = x \&\& y
M
minqiyang 已提交
12060 12061

    Args:
S
Shibo Tao 已提交
12062 12063 12064 12065
        x(${x_type}): ${x_comment}.
        y(${y_type}): ${y_comment}.
        out(Variable): The ``Variable`` that specifies the output of the operator, which can be any ``Variable`` that has been created in the program. The default value is None, and a new ``Variable`` will be created to save the output.
        name(str|None): The default value is None. Normally there is no need for users to set this property. For more information, please refer to :ref:`api_guide_Name`.
M
minqiyang 已提交
12066 12067

    Returns:
W
Wilber 已提交
12068
        ${out_type}: ${out_comment}
12069 12070 12071 12072

    Examples:
        .. code-block:: python

S
Shibo Tao 已提交
12073
            import paddle
W
Wilber 已提交
12074 12075
            import numpy as np

12076
            paddle.disable_static()
S
Shibo Tao 已提交
12077 12078
            x_data = np.array([True, True, False, False], dtype=np.bool)
            y_data = np.array([True, False, True, False], dtype=np.bool)
12079 12080
            x = paddle.to_variable(x_data)
            y = paddle.to_variable(y_data)
S
Shibo Tao 已提交
12081 12082
            res = paddle.logical_and(x, y)
            print(res.numpy()) # [True False False False]
M
minqiyang 已提交
12083 12084 12085 12086 12087 12088 12089
    """

    return _logical_op(
        op_name="logical_and", x=x, y=y, name=name, out=out, binary_op=True)


@templatedoc()
12090
def logical_or(x, y, out=None, name=None):
M
minqiyang 已提交
12091
    """
12092
    :alias_main: paddle.logical_or
S
Shibo Tao 已提交
12093 12094
    :alias: paddle.logical_or, paddle.tensor.logical_or, paddle.tensor.logic.logical_or
    :old_api: paddle.fluid.layers.logical_or
W
Wilber 已提交
12095

S
Shibo Tao 已提交
12096 12097
    ``logical_or`` operator computes element-wise logical OR on ``x`` and ``y``, and returns ``out``. ``x``, ``y`` and ``out`` are N-dim boolean ``Variable``.
    Each element of ``out`` is calculated by
12098

W
Wilber 已提交
12099 12100
    .. math::

S
Shibo Tao 已提交
12101
        out = x || y
M
minqiyang 已提交
12102 12103

    Args:
S
Shibo Tao 已提交
12104 12105 12106 12107
        x(${x_type}): ${x_comment}.
        y(${y_type}): ${y_comment}.
        out(Variable): The ``Variable`` that specifies the output of the operator, which can be any ``Variable`` that has been created in the program. The default value is None, and a new ``Variable`` will be created to save the output.
        name(str|None): The default value is None. Normally there is no need for users to set this property. For more information, please refer to :ref:`api_guide_Name`.
M
minqiyang 已提交
12108 12109

    Returns:
W
Wilber 已提交
12110
        ${out_type}: ${out_comment}
12111 12112 12113 12114

    Examples:
        .. code-block:: python

S
Shibo Tao 已提交
12115
            import paddle
W
Wilber 已提交
12116 12117
            import numpy as np

12118
            paddle.disable_static()
S
Shibo Tao 已提交
12119 12120
            x_data = np.array([True, True, False, False], dtype=np.bool)
            y_data = np.array([True, False, True, False], dtype=np.bool)
12121 12122
            x = paddle.to_variable(x_data)
            y = paddle.to_variable(y_data)
S
Shibo Tao 已提交
12123 12124
            res = paddle.logical_or(x, y)
            print(res.numpy()) # [True  True  True False]
M
minqiyang 已提交
12125 12126 12127 12128 12129 12130 12131
    """

    return _logical_op(
        op_name="logical_or", x=x, y=y, name=name, out=out, binary_op=True)


@templatedoc()
12132
def logical_xor(x, y, out=None, name=None):
M
minqiyang 已提交
12133
    """
12134
    :alias_main: paddle.logical_xor
S
Shibo Tao 已提交
12135 12136
    :alias: paddle.logical_xor, paddle.tensor.logical_xor, paddle.tensor.logic.logical_xor
    :old_api: paddle.fluid.layers.logical_xor
W
Wilber 已提交
12137

S
Shibo Tao 已提交
12138 12139
    ``logical_xor`` operator computes element-wise logical XOR on ``x`` and ``y``, and returns ``out``. ``x``, ``y`` and ``out`` are N-dim boolean ``Variable``.
    Each element of ``out`` is calculated by
12140

W
Wilber 已提交
12141 12142
    .. math::

S
Shibo Tao 已提交
12143
        out = (x || y) \&\& !(x \&\& y)
M
minqiyang 已提交
12144 12145

    Args:
S
Shibo Tao 已提交
12146 12147 12148 12149
        x(${x_type}): ${x_comment}.
        y(${y_type}): ${y_comment}.
        out(Variable): The ``Variable`` that specifies the output of the operator, which can be any ``Variable`` that has been created in the program. The default value is None, and a new ``Variable`` will be created to save the output.
        name(str|None): The default value is None. Normally there is no need for users to set this property. For more information, please refer to :ref:`api_guide_Name`.
M
minqiyang 已提交
12150 12151

    Returns:
W
Wilber 已提交
12152
        ${out_type}: ${out_comment}
12153 12154 12155 12156

    Examples:
        .. code-block:: python

S
Shibo Tao 已提交
12157
            import paddle
W
Wilber 已提交
12158 12159
            import numpy as np

12160
            paddle.disable_static()
S
Shibo Tao 已提交
12161 12162
            x_data = np.array([True, True, False, False], dtype=np.bool)
            y_data = np.array([True, False, True, False], dtype=np.bool)
12163 12164
            x = paddle.to_variable(x_data)
            y = paddle.to_variable(y_data)
S
Shibo Tao 已提交
12165 12166
            res = paddle.logical_xor(x, y)
            print(res.numpy()) # [False  True  True False]
M
minqiyang 已提交
12167 12168 12169 12170 12171 12172 12173
    """

    return _logical_op(
        op_name="logical_xor", x=x, y=y, name=name, out=out, binary_op=True)


@templatedoc()
12174
def logical_not(x, out=None, name=None):
M
minqiyang 已提交
12175
    """
12176
    :alias_main: paddle.logical_not
S
Shibo Tao 已提交
12177 12178
    :alias: paddle.logical_not, paddle.tensor.logical_not, paddle.tensor.logic.logical_not
    :old_api: paddle.fluid.layers.logical_not
12179

S
Shibo Tao 已提交
12180 12181
    ``logical_not`` operator computes element-wise logical NOT on ``x``, and returns ``out``. ``x`` and ``out`` are N-dim boolean ``Variable``.
    Each element of ``out`` is calculated by
12182

W
Wilber 已提交
12183 12184
    .. math::

S
Shibo Tao 已提交
12185
        out = !x
M
minqiyang 已提交
12186 12187

    Args:
S
Shibo Tao 已提交
12188 12189 12190
        x(${x_type}): ${x_comment}.
        out(Variable): The ``Variable`` that specifies the output of the operator, which can be any ``Variable`` that has been created in the program. The default value is None, and a new ``Variable` will be created to save the output.
        name(str|None): The default value is None. Normally there is no need for users to set this property. For more information, please refer to :ref:`api_guide_Name`.
M
minqiyang 已提交
12191 12192

    Returns:
W
Wilber 已提交
12193
        ${out_type}: ${out_comment}
12194 12195 12196

    Examples:
        .. code-block:: python
S
Shibo Tao 已提交
12197
            import paddle
W
Wilber 已提交
12198 12199
            import numpy as np

12200
            paddle.disable_static()
S
Shibo Tao 已提交
12201
            x_data = np.array([True, False, True, False], dtype=np.bool)
12202
            x = paddle.to_variable(x_data)
S
Shibo Tao 已提交
12203 12204
            res = paddle.logical_not(x)
            print(res.numpy()) # [False  True False  True]
M
minqiyang 已提交
12205 12206 12207 12208
    """

    return _logical_op(
        op_name="logical_not", x=x, y=None, name=name, out=out, binary_op=False)
12209 12210 12211 12212 12213


@templatedoc()
def clip(x, min, max, name=None):
    """
12214 12215 12216 12217
    :alias_main: paddle.nn.clip
	:alias: paddle.nn.clip,paddle.nn.clip.clip
	:old_api: paddle.fluid.layers.clip

12218 12219 12220 12221
    ${comment}

    Args:
        x(${x_type}): ${x_comment}
S
SunGaofeng 已提交
12222 12223
        min(float): ${min_comment}
        max(float): ${max_comment}
12224 12225
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
12226
                             For more information, please refer to :ref:`api_guide_Name`
12227 12228

    Returns:
S
SunGaofeng 已提交
12229 12230 12231 12232
        ${out_comment}

    Return Type:
        ${out_type}
12233 12234 12235 12236

    Examples:
        .. code-block:: python

S
SunGaofeng 已提交
12237
            import paddle.fluid as fluid
S
SunGaofeng 已提交
12238
            input = fluid.data(
12239 12240
                name='data', shape=[1], dtype='float32')
            reward = fluid.layers.clip(x=input, min=-1.0, max=1.0)
12241 12242 12243
    """

    helper = LayerHelper("clip", **locals())
12244
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'clip')
12245 12246

    if name is None:
12247 12248
        name = unique_name.generate_with_ignorable_key(".".join(
            [helper.name, 'tmp']))
S
sneaxiy 已提交
12249 12250 12251

    out = helper.create_variable(
        type=x.type, name=name, dtype=x.dtype, persistable=False)
12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270

    helper.append_op(
        type="clip",
        inputs={"X": x},
        attrs={"min": min,
               "max": max},
        outputs={"Out": out})

    return out


@templatedoc()
def clip_by_norm(x, max_norm, name=None):
    """
    ${comment}

    Args:
        x(${x_type}): ${x_comment}
        max_norm(${max_norm_type}): ${max_norm_comment}
12271 12272 12273
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name`. Usually name is no need to set and
            None by default.
12274 12275

    Returns:
W
wangguanzhong 已提交
12276 12277
        Variable:

12278
        out(${out_type}): ${out_comment}
12279

W
wangguanzhong 已提交
12280

12281 12282 12283
    Examples:
        .. code-block:: python

12284
            import paddle.fluid as fluid
12285 12286
            input = fluid.data(
                name='data', shape=[None, 1], dtype='float32')
12287
            reward = fluid.layers.clip_by_norm(x=input, max_norm=1.0)
12288 12289 12290
    """

    helper = LayerHelper("clip_by_norm", **locals())
12291 12292
    check_variable_and_dtype(x, 'X', ['float32'], 'clip_by_norm')
    check_type(max_norm, 'max_norm', (float), 'clip_by_norm')
12293 12294

    if name is None:
12295 12296
        name = unique_name.generate_with_ignorable_key(".".join(
            [helper.name, 'tmp']))
S
sneaxiy 已提交
12297 12298 12299

    out = helper.create_variable(
        type=x.type, name=name, dtype=x.dtype, persistable=False)
12300 12301 12302 12303 12304 12305 12306 12307

    helper.append_op(
        type="clip_by_norm",
        inputs={"X": x},
        attrs={"max_norm": max_norm},
        outputs={"Out": out})

    return out
X
Xin Pan 已提交
12308 12309 12310 12311 12312


@templatedoc()
def mean(x, name=None):
    """
12313 12314 12315 12316
    :alias_main: paddle.mean
	:alias: paddle.mean,paddle.tensor.mean,paddle.tensor.stat.mean
	:old_api: paddle.fluid.layers.mean

X
Xin Pan 已提交
12317 12318 12319 12320 12321 12322 12323 12324
    ${comment}

    Args:
        x(${x_type}): ${x_comment}
        name(basestring|None): Name of the output.

    Returns:
        out(${out_type}): ${out_comment}
12325 12326 12327 12328

    Examples:
        .. code-block:: python

12329
            import paddle.fluid as fluid
12330 12331 12332
            input = fluid.layers.data(
                name='data', shape=[2, 3], dtype='float32')
            mean = fluid.layers.mean(input)
X
Xin Pan 已提交
12333
    """
12334
    if in_dygraph_mode():
12335
        return core.ops.mean(x)
X
Xin Pan 已提交
12336 12337

    helper = LayerHelper("mean", **locals())
12338
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'mean')
12339
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
X
Xin Pan 已提交
12340 12341 12342 12343 12344 12345 12346

    helper.append_op(
        type="mean", inputs={"X": x}, attrs={}, outputs={"Out": out})

    return out


C
chengduo 已提交
12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357
@templatedoc()
def merge_selected_rows(x, name=None):
    """
    ${comment}

    Args:
        x(${x_type}): ${x_comment}
        name(basestring|None): Name of the output.

    Returns:
        out(${out_type}): ${out_comment}
12358 12359 12360 12361

    Examples:
        .. code-block:: python

12362
            import paddle.fluid as fluid
12363 12364 12365 12366 12367
            b = fluid.default_main_program().global_block()
            var = b.create_var(
                name="X", dtype="float32", persistable=True,
                type=fluid.core.VarDesc.VarType.SELECTED_ROWS)
            y = fluid.layers.merge_selected_rows(var)
C
chengduo 已提交
12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379
    """

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


X
Xin Pan 已提交
12380 12381
def mul(x, y, x_num_col_dims=1, y_num_col_dims=1, name=None):
    """
L
liu zhengxi 已提交
12382 12383 12384 12385 12386 12387 12388 12389
    Mul Operator.
    This operator is used to perform matrix multiplication for input $x$ and $y$.
    The equation is:

    ..  math::
        Out = x * y

    Both the input $x$ and $y$ can carry the LoD (Level of Details) information, or not. But the output only shares the LoD information with input $x$.
X
Xin Pan 已提交
12390 12391

    Args:
L
liu zhengxi 已提交
12392 12393
        x (Variable): The first input Tensor/LoDTensor of mul_op.
        y (Variable): The second input Tensor/LoDTensor of mul_op.
12394 12395 12396
        x_num_col_dims (int, optional): The mul_op can take tensors with more than two dimensions as its inputs. If the input $x$ is a tensor with more than two dimensions, $x$ will be flattened into a two-dimensional matrix first. The flattening rule is: the first `num_col_dims` will be flattened to form the first dimension of the final matrix (the height of the matrix), and the rest `rank(x) - num_col_dims` dimensions are flattened to form the second dimension of the final matrix (the width of the matrix). As a result, height of the flattened matrix is equal to the product of $x$'s first `x_num_col_dims` dimensions' sizes, and width of the flattened matrix is equal to the product of $x$'s last `rank(x) - num_col_dims` dimensions' size. For example, suppose $x$ is a 6-dimensional tensor with the shape [2, 3, 4, 5, 6], and `x_num_col_dims` = 3. Thus, the flattened matrix will have a shape [2 x 3 x 4, 5 x 6] = [24, 30]. Default is 1.
        y_num_col_dims (int, optional): The mul_op can take tensors with more than two dimensions as its inputs. If the input $y$ is a tensor with more than two dimensions, $y$ will be flattened into a two-dimensional matrix first. The attribute `y_num_col_dims` determines how $y$ is flattened. See comments of `x_num_col_dims` for more details. Default is 1.
        name (str, optional): Name of the output. Normally there is no need for user to set this property. For more information, please refer to :ref:`api_guide_Name`. Default is None.
X
Xin Pan 已提交
12397 12398

    Returns:
L
liu zhengxi 已提交
12399
        Variable(Tensor/LoDTensor): The output Tensor/LoDTensor of mul op.
12400 12401

    Examples:
L
liu zhengxi 已提交
12402
        ..  code-block:: python
12403

12404 12405 12406 12407 12408 12409
            import paddle.fluid as fluid
            dataX = fluid.layers.data(name="dataX", append_batch_size = False, shape=[2, 5], dtype="float32")
            dataY = fluid.layers.data(name="dataY", append_batch_size = False, shape=[5, 3], dtype="float32")
            output = fluid.layers.mul(dataX, dataY,
                                      x_num_col_dims = 1,
                                      y_num_col_dims = 1)
12410

12411

X
Xin Pan 已提交
12412
    """
12413
    if in_dygraph_mode():
12414 12415
        return core.ops.mul(x, y, 'x_num_col_dims', x_num_col_dims,
                            'y_num_col_dims', y_num_col_dims)
X
Xin Pan 已提交
12416

12417 12418
    inputs = {"X": [x], "Y": [y]}
    attrs = {"x_num_col_dims": x_num_col_dims, "y_num_col_dims": y_num_col_dims}
X
Xin Pan 已提交
12419
    helper = LayerHelper("mul", **locals())
12420 12421
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'mul')
    check_variable_and_dtype(y, 'y', ['float16', 'float32', 'float64'], 'mul')
12422
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
X
Xin Pan 已提交
12423 12424

    helper.append_op(
12425 12426
        type="mul", inputs={"X": x,
                            "Y": y}, attrs=attrs, outputs={"Out": out})
X
Xin Pan 已提交
12427 12428 12429 12430
    return out


@templatedoc()
12431
def maxout(x, groups, name=None, axis=1):
X
Xin Pan 已提交
12432
    """
12433 12434 12435 12436
    :alias_main: paddle.nn.functional.maxout
	:alias: paddle.nn.functional.maxout,paddle.nn.functional.activation.maxout
	:old_api: paddle.fluid.layers.maxout

X
Xin Pan 已提交
12437 12438 12439 12440
    ${comment}

    Args:
        x(${x_type}): ${x_comment}
12441 12442
        groups(int): ${groups_comment}
        axis(int, optional): ${axis_comment}
12443 12444
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name`. Usually name is no need to set and
W
wangguanzhong 已提交
12445
            None by default.
X
Xin Pan 已提交
12446 12447

    Returns:
12448
        Variable: ${out_comment}
J
jerrywgz 已提交
12449

12450 12451
    Raises:
        ValueError: If `axis` is not 1, -1 or 3.
12452
        ValueError: If the number of input channels can not be divisible by `groups`.
W
wangguanzhong 已提交
12453

J
jerrywgz 已提交
12454 12455 12456
    Examples:
        .. code-block:: python

12457
            import paddle.fluid as fluid
12458
            input = fluid.data(
12459 12460
                name='data',
                shape=[None, 256, 32, 32],
J
jerrywgz 已提交
12461 12462
                dtype='float32')
            out = fluid.layers.maxout(input, groups=2)
X
Xin Pan 已提交
12463
    """
12464 12465
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'maxout')

X
Xin Pan 已提交
12466
    helper = LayerHelper("maxout", **locals())
12467 12468 12469 12470 12471 12472
    if axis not in [1, -1, 3]:
        raise ValueError(
            "Attr(axis) should be 1 when data format is NCHW, -1 or 3 when data format is NHWC. Received "
            "Attr(axis): %s." % str(axis))
    if axis == -1:
        axis = 3
X
Xin Pan 已提交
12473

12474
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
X
Xin Pan 已提交
12475 12476 12477 12478

    helper.append_op(
        type="maxout",
        inputs={"X": x},
12479 12480
        attrs={"groups": groups,
               "axis": axis},
X
Xin Pan 已提交
12481 12482
        outputs={"Out": out})
    return out
12483 12484


J
JiabinYang 已提交
12485
def space_to_depth(x, blocksize, name=None):
J
JiabinYang 已提交
12486
    """
12487 12488 12489 12490
    :alias_main: paddle.nn.functional.space_to_depth
	:alias: paddle.nn.functional.space_to_depth,paddle.nn.functional.vision.space_to_depth
	:old_api: paddle.fluid.layers.space_to_depth

J
JiabinYang 已提交
12491
    Gives a blocksize to space_to_depth the input LoDtensor with Layout: [batch, channel, height, width]
12492

12493 12494 12495
    This op rearranges blocks of spatial data, into depth. More specifically, this op outputs a copy of \
        theinput LoDtensor where values from the height and width dimensions are moved to the channel \
        dimension.
J
JiabinYang 已提交
12496
    The attr blocksize indicates the input block size.
12497

T
tianshuo78520a 已提交
12498
    space_to_depth will reorganize the elements of input with shape[batch, channel, height, width] \
12499 12500
        according to blocksize to construct output with shape \
        [batch, channel * blocksize * blocksize, height/blocksize, width/blocksize]:
J
JiabinYang 已提交
12501

J
JiabinYang 已提交
12502 12503 12504 12505 12506
    - Non-overlapping blocks of size block_size x block size are rearranged into depth at each location.
    - The Y, X coordinates within each block of the input become the high order component of the output channel index
    - channel should be divisible by square of blocksize
    - height, width should be divsible by blocksize

12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523
    This OP is useful for resizing the activations between convolutions \
        (but keeping all data)

    .. code-block:: text

        Given the input x with the shape [1, 1, 4, 4]:
        x.data = [[[[1,   2,  5,  6],
                    [3,   4,  7,  8],
                    [9,  10, 13, 14],
                    [11, 12, 15, 16]]]]
        blocksize = 2

        then get the output with the shape [1, 4, 2, 2]:
        out.data = [[[[1,   2],  [3,  4]],
                     [[5,   6],  [7,  8]],
                     [[9,  10], [11, 12]],
                     [[13, 14], [15, 16]]]]
J
JiabinYang 已提交
12524

J
JiabinYang 已提交
12525
    Args:
12526 12527 12528 12529 12530 12531
        x (Variable): The input, which should be 4 dims Tensor or LodTensor, with the shape \
            [batch, channel, height, width]
        blocksize (int): The blocksize to select the element on each feature map should be > 2
        name(str, optional): For detailed information, please refer \
            to :ref:`api_guide_Name`. Usually name is no need to set and \
            None by default.
J
JiabinYang 已提交
12532

12533 12534 12535 12536
    Returns: The output, which should be 4 dims Tensor or LodTensor, with the shape \
            [batch, channel * blocksize * blocksize, height/blocksize, width/blocksize]

    Return Type: Variable
J
JiabinYang 已提交
12537 12538

    Raises:
12539
        TypeError: blocksize type must be int64.
J
JiabinYang 已提交
12540 12541 12542

    Examples:
        .. code-block:: python
12543

12544 12545
            import paddle.fluid as fluid
            import numpy as np
J
JiabinYang 已提交
12546

12547 12548
            data = fluid.data(
                name='data', shape=[1, 4, 2, 2], dtype='float32')
J
JiabinYang 已提交
12549
            space_to_depthed = fluid.layers.space_to_depth(
J
JiabinYang 已提交
12550
                x=data, blocksize=2)
12551

12552
            exe = fluid.Executor(fluid.CPUPlace())
12553
            data_np = np.arange(0,16).reshape((1,4,2,2)).astype('float32')
12554 12555 12556 12557 12558 12559 12560

            print(data_np)
            #array([[[[ 0.,  1.], [ 2.,  3.]],
            #        [[ 4.,  5.], [ 6.,  7.]],
            #        [[ 8.,  9.], [10., 11.]],
            #        [[12., 13.], [14., 15.]]]], dtype=float32)

12561
            out_main = exe.run(fluid.default_main_program(),
12562 12563 12564 12565 12566 12567 12568 12569
                        feed={'data': data_np},
                        fetch_list=[space_to_depthed])

            print(out_main)
            #[array([[[[ 0.]], [[ 4.]], [[ 1.]], [[ 5.]],
            #         [[ 8.]], [[12.]], [[ 9.]], [[13.]],
            #         [[ 2.]], [[ 6.]], [[ 3.]], [[ 7.]],
            #         [[10.]], [[14.]], [[11.]], [[15.]]]], dtype=float32)]
12570

J
JiabinYang 已提交
12571 12572
    """

J
JiabinYang 已提交
12573
    helper = LayerHelper("space_to_depth", **locals())
J
JiabinYang 已提交
12574

J
JiabinYang 已提交
12575 12576
    if not (isinstance(blocksize, int)):
        raise ValueError("blocksize must be a python Int")
J
JiabinYang 已提交
12577

X
xujiaqi01 已提交
12578 12579 12580
    check_variable_and_dtype(x, 'x', \
        ['float16', 'float32', 'float64', 'int32', 'int64'], 'space_to_depth')

12581
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
J
JiabinYang 已提交
12582 12583

    helper.append_op(
J
JiabinYang 已提交
12584
        type="space_to_depth",
J
JiabinYang 已提交
12585
        inputs={"X": x},
J
JiabinYang 已提交
12586
        attrs={"blocksize": blocksize},
J
JiabinYang 已提交
12587
        outputs={"Out": out})
J
JiabinYang 已提交
12588 12589
    return out

J
JiabinYang 已提交
12590

12591 12592 12593 12594 12595 12596
def affine_channel(x,
                   scale=None,
                   bias=None,
                   data_layout='NCHW',
                   name=None,
                   act=None):
12597
    """
12598 12599 12600 12601
    :alias_main: paddle.nn.functional.affine_channel
	:alias: paddle.nn.functional.affine_channel,paddle.nn.functional.vision.affine_channel
	:old_api: paddle.fluid.layers.affine_channel

12602 12603 12604 12605
    Applies a separate affine transformation to each channel of the input.
    Useful for replacing spatial batch norm with its equivalent fixed
    transformation. The input also can be 2D tensor and applies a affine
    transformation in second dimension.
12606

12607 12608 12609
    Args:
        x (Variable): Feature map input can be a 4D tensor with order NCHW
            or NHWC. It also can be a 2D tensor and the affine transformation
L
LielinJiang 已提交
12610
            is applied in the second dimension.The data type is float32 or float64.
12611 12612
        scale (Variable): 1D input of shape (C), the c-th element is the scale
            factor of the affine transformation for the c-th channel of
L
LielinJiang 已提交
12613
            the input.The data type is float32 or float64.
12614 12615
        bias (Variable): 1D input of shape (C), the c-th element is the bias
            of the affine transformation for the c-th channel of the input.
L
LielinJiang 已提交
12616
            The data type is float32 or float64.
12617
        data_layout (str, optional): Specify the data format of the input, and the data format of the output
12618 12619
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
            The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
12620
            `[batch_size, input_channels, input_height, input_width]`. If input is 2D Tensor, you can ignore
12621
            data_layout.
L
LielinJiang 已提交
12622 12623
        name (str, default None): The name of this layer. For more information,
            please refer to :ref:`api_guide_Name` .
12624
        act (str, default None): Activation to be applied to the output of this layer.
12625 12626

    Returns:
L
LielinJiang 已提交
12627
        Variable: A tensor which has the same shape, data layout and data type with x.
B
Bai Yifan 已提交
12628 12629 12630

    Examples:
        .. code-block:: python
L
LielinJiang 已提交
12631 12632

            import numpy as np
B
Bai Yifan 已提交
12633
            import paddle.fluid as fluid
L
LielinJiang 已提交
12634 12635 12636 12637 12638 12639 12640 12641 12642 12643

            use_gpu = False
            place = fluid.CUDAPlace(0) if use_gpu else fluid.CPUPlace()
            exe = fluid.Executor(place)

            data = fluid.data(name='data', shape=[None, 1, 2, 2], dtype='float32')
            input_scale = fluid.layers.create_parameter(shape=[1], dtype="float32",
                                    default_initializer=fluid.initializer.Constant(2.0))
            input_bias = fluid.layers.create_parameter(shape=[1],dtype="float32",
                                    default_initializer=fluid.initializer.Constant(0.5))
B
Bai Yifan 已提交
12644
            out = fluid.layers.affine_channel(data,scale=input_scale,
L
LielinJiang 已提交
12645 12646 12647 12648 12649 12650 12651 12652 12653 12654
                                    bias=input_bias)

            exe.run(fluid.default_startup_program())
            test_program = fluid.default_main_program().clone(for_test=True)

            [out_array] = exe.run(test_program,
                                  fetch_list=out,
                                  feed={'data': np.ones([1,1,2,2]).astype('float32')})
            # out_array is [[[[2.5, 2.5],
            #                [2.5, 2.5]]]] with shape: [1, 1, 2, 2]
B
Bai Yifan 已提交
12655

12656 12657
    """
    helper = LayerHelper("affine_channel", **locals())
12658 12659 12660
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'affine_channel')
    check_type(scale, 'scale', (Variable, type(None)), 'affine_channel')
    check_type(bias, 'bias', (Variable, type(None)), 'affine_channel')
12661
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
12662 12663 12664 12665 12666 12667 12668 12669

    helper.append_op(
        type="affine_channel",
        inputs={"X": x,
                'Scale': scale,
                'Bias': bias},
        attrs={"data_layout": data_layout},
        outputs={"Out": out})
12670
    return helper.append_activation(out)
12671 12672


B
barrierye 已提交
12673
def similarity_focus(input, axis, indexes, name=None):
12674
    """
B
barrierye 已提交
12675
    SimilarityFocus Operator
B
barrierye 已提交
12676 12677

    Generate a similarity focus mask with the same shape of input using the following method:
M
minqiyang 已提交
12678

12679 12680 12681
    1. Extract the 3-D tensor(here the first dimension is BatchSize) corresponding
       to the axis according to the indexes. For example, if axis=1 and indexes=[a],
       it will get the matrix T=X[:, a, :, :]. In this case, if the shape of input X
B
barrierye 已提交
12682
       is (BatchSize, A, B, C), the shape of tensor T is (BatchSize, B, C).
12683 12684 12685 12686 12687 12688 12689
    2. For each index, find the largest numbers in the tensor T, so that the same
       row and same column has at most one number(what it means is that if the
       largest number has been found in the i-th row and the j-th column, then
       the numbers in the i-th row or j-th column will be skipped. And then the
       next largest number will be selected from the remaining numbers. Obviously
       there will be min(B, C) numbers), and mark the corresponding position of the
       3-D similarity focus mask as 1, otherwise as 0. Do elementwise-or for
B
barrierye 已提交
12690
       each index.
B
barrierye 已提交
12691 12692 12693 12694
    3. Broadcast the 3-D similarity focus mask to the same shape of input X.

    Refer to `Similarity Focus Layer <http://www.aclweb.org/anthology/N16-1108>`_

B
barrierye 已提交
12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743
    .. code-block:: text

        * Example :

            Given a 4-D tensor x with the shape (BatchSize, C, A, B), where C is
            the number of channels and the shape of feature map is (A, B):
                x.shape = (2, 3, 2, 2)
                x.data = [[[[0.8, 0.1],
                            [0.4, 0.5]],

                           [[0.9, 0.7],
                            [0.9, 0.9]],

                           [[0.8, 0.9],
                            [0.1, 0.2]]],


                          [[[0.2, 0.5],
                            [0.3, 0.4]],

                           [[0.9, 0.7],
                            [0.8, 0.4]],

                           [[0.0, 0.2],
                            [0.4, 0.7]]]]

            Given axis: 1 (the axis of the channel)
            Given indexes: [0]

            then we get a 4-D tensor out with the same shape of input x:
                out.shape = (2, 3, 2, 2)
                out.data = [[[[1.0, 0.0],
                              [0.0, 1.0]],

                             [[1.0, 0.0],
                              [0.0, 1.0]],

                             [[1.0, 0.0],
                              [0.0, 1.0]]],

                            [[[0.0, 1.0],
                              [1.0, 0.0]],

                             [[0.0, 1.0],
                              [1.0, 0.0]],

                             [[0.0, 1.0],
                              [1.0, 0.0]]]]

B
barrierye 已提交
12744
    Args:
12745
        input(Variable): The input tensor variable(default float). It should
12746
            be a 4-D tensor with shape [BatchSize, A, B, C]. Data type is
Y
Yibing Liu 已提交
12747
            float32 or float64.
B
barrierye 已提交
12748
        axis(int): Indicating the dimension to be selected. It can only be
B
barrierye 已提交
12749
            1, 2 or 3.
B
barrierye 已提交
12750
        indexes(list): Indicating the indexes of the selected dimension.
B
barrierye 已提交
12751 12752

    Returns:
H
haowang101779990 已提交
12753 12754
        Variable: A tensor variable with the same shape and same type \
                  as the input.
12755

B
barrierye 已提交
12756 12757
    Examples:
        .. code-block:: python
H
haowang101779990 已提交
12758

12759
            import paddle.fluid as fluid
Y
Yibing Liu 已提交
12760
            data = fluid.data(
Y
Yibing Liu 已提交
12761 12762
                name='data', shape=[-1, 3, 2, 2], dtype='float32')
            fluid.layers.similarity_focus(input=data, axis=1, indexes=[0])
B
barrierye 已提交
12763 12764 12765
    """
    helper = LayerHelper('similarity_focus', **locals())
    # check attrs
12766 12767 12768 12769
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             "similarity_focus")
    check_type(axis, 'axis', int, "similarity_focus")
    check_type(indexes, 'indexes', list, "similarity_focus")
B
barrierye 已提交
12770 12771 12772 12773 12774
    if axis != 1 and axis != 2 and axis != 3:
        raise ValueError("axis must be 1, 2 or 3.")
    if len(indexes) == 0:
        raise ValueError("indexes can not be empty.")

12775
    out = helper.create_variable_for_type_inference(dtype=input.dtype)
B
barrierye 已提交
12776 12777 12778 12779 12780 12781 12782
    helper.append_op(
        type='similarity_focus',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={"axis": axis,
               "indexes": indexes})
    return out
B
barrierye 已提交
12783 12784


M
minqiyang 已提交
12785 12786
def hash(input, hash_size, num_hash=1, name=None):
    """
12787 12788 12789 12790
    :alias_main: paddle.nn.functional.hash
	:alias: paddle.nn.functional.hash,paddle.nn.functional.lod.hash
	:old_api: paddle.fluid.layers.hash

Z
zhupengyang 已提交
12791
    This OP hash the input to an integer less than the hash_size.
M
minqiyang 已提交
12792 12793
    The hash algorithm we used was xxHash - Extremely fast hash algorithm
    (https://github.com/Cyan4973/xxHash/tree/v0.6.5)
M
minqiyang 已提交
12794 12795

    Args:
Z
zhupengyang 已提交
12796 12797 12798 12799 12800 12801
        input(Variable): A **Two-Dimensional** LoDTensor with type int32, int64.
             **Only support LoDTensor**.
        num_hash(int, optional): The times of hash, default is 1.
        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`.
M
minqiyang 已提交
12802 12803

    Returns:
Z
zhupengyang 已提交
12804
       Variable: A LoDTensor with the same data type as input.
M
minqiyang 已提交
12805 12806

    Examples:
Z
zhupengyang 已提交
12807
        .. code-block:: python
H
haowang101779990 已提交
12808

12809
            import paddle.fluid as fluid
Z
zhupengyang 已提交
12810
            import numpy as np
12811

Z
zhupengyang 已提交
12812
            place = fluid.core.CPUPlace()
12813

12814 12815
            x = fluid.data(name="x", shape=[2,2], dtype="int32", lod_level=1)
            res = fluid.layers.hash(name="res", input=x, hash_size=1000, num_hash=4)
12816

Z
zhupengyang 已提交
12817 12818 12819 12820
            exe = fluid.Executor(place)
            exe.run(fluid.default_startup_program())
            in1 = np.array([[1,2],[3,4]]).astype("int32")
            print(in1)
12821
            x_i = fluid.create_lod_tensor(in1, [[0, 2]], place)
Z
zhupengyang 已提交
12822 12823 12824 12825 12826 12827 12828 12829 12830 12831
            res = exe.run(fluid.default_main_program(), feed={'x':x_i}, fetch_list=[res], return_numpy=False)
            print(np.array(res[0]))
            # [[[722]
            #   [407]
            #   [337]
            #   [395]]
            #  [[603]
            #   [590]
            #   [386]
            #   [901]]]
M
minqiyang 已提交
12832
    """
12833
    check_variable_and_dtype(input, 'input', ['int32', 'int64'], 'hash')
12834 12835
    check_type(hash_size, 'hash_size', int, 'hash')
    check_type(num_hash, 'num_hash', int, 'hash')
M
minqiyang 已提交
12836
    helper = LayerHelper('hash', **locals())
M
minqiyang 已提交
12837 12838
    out = helper.create_variable_for_type_inference(
        helper.input_dtype(), stop_gradient=True)
M
minqiyang 已提交
12839 12840 12841 12842 12843 12844 12845
    helper.append_op(
        type='hash',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={'num_hash': num_hash,
               'mod_by': hash_size})
    return out
G
gmcather 已提交
12846 12847


D
dengkaipeng 已提交
12848
@templatedoc()
12849 12850
def grid_sampler(x, grid, name=None):
    """
12851 12852 12853 12854
    :alias_main: paddle.nn.functional.grid_sampler
	:alias: paddle.nn.functional.grid_sampler,paddle.nn.functional.vision.grid_sampler
	:old_api: paddle.fluid.layers.grid_sampler

12855
    This operation samples input X by using bilinear interpolation based on
T
tianshuo78520a 已提交
12856
    flow field grid, which is usually generated by :code:`affine_grid` . The grid of
K
Kaipeng Deng 已提交
12857 12858
    shape [N, H, W, 2] is the concatenation of (x, y) coordinates
    with shape [N, H, W] each, where x is indexing the 4th dimension
T
tianshuo78520a 已提交
12859 12860
    (in width dimension) of input data x and y is indexing the 3rd
    dimension (in height dimension), finally results is the bilinear
12861
    interpolation value of 4 nearest corner points. The output tensor
K
Kaipeng Deng 已提交
12862
    shape will be [N, C, H, W].
12863

H
haowang101779990 已提交
12864
    .. code-block:: text
12865

H
haowang101779990 已提交
12866 12867
        Step 1:
        Get (x, y) grid coordinates and scale to [0, H-1/W-1].
12868

K
Kaipeng Deng 已提交
12869 12870 12871 12872
        .. code-block:: text

            grid_x = 0.5 * (grid[:, :, :, 0] + 1) * (W - 1)
            grid_y = 0.5 * (grid[:, :, :, 1] + 1) * (H - 1)
12873

H
haowang101779990 已提交
12874 12875 12876
        Step 2:
        Indices input data X with grid (x, y) in each [H, W] area, and bilinear
        interpolate point value by 4 nearest points.
12877

H
haowang101779990 已提交
12878 12879 12880 12881 12882 12883 12884 12885 12886
          wn ------- y_n ------- en
          |           |           |
          |          d_n          |
          |           |           |
         x_w --d_w-- grid--d_e-- x_e
          |           |           |
          |          d_s          |
          |           |           |
          ws ------- y_s ------- wn
12887

H
haowang101779990 已提交
12888 12889 12890 12891
        x_w = floor(x)              // west side x coord
        x_e = x_w + 1               // east side x coord
        y_n = floor(y)              // north side y coord
        y_s = y_s + 1               // south side y coord
12892

H
haowang101779990 已提交
12893 12894 12895 12896
        d_w = grid_x - x_w          // distance to west side
        d_e = x_e - grid_x          // distance to east side
        d_n = grid_y - y_n          // distance to north side
        d_s = y_s - grid_y          // distance to south side
12897

H
haowang101779990 已提交
12898 12899 12900 12901
        wn = X[:, :, y_n, x_w]      // north-west point value
        en = X[:, :, y_n, x_e]      // north-east point value
        ws = X[:, :, y_s, x_w]      // south-east point value
        es = X[:, :, y_s, x_w]      // north-east point value
12902

H
haowang101779990 已提交
12903 12904
        output = wn * d_e * d_s + en * d_w * d_s
               + ws * d_e * d_n + es * d_w * d_n
D
dengkaipeng 已提交
12905 12906

    Args:
K
Kaipeng Deng 已提交
12907 12908 12909 12910 12911 12912 12913 12914 12915
        x(Variable): The input tensor, which is a 4-D tensor with shape
                     [N, C, H, W], N is the batch size, C is the channel
                     number, H and W is the feature height and width.
                     The data type is float32 or float64.
        grid(Variable): Input grid tensor of shape [N, H, W, 2]. The
                        data type is float32 or float64.
        name(str, optional): For detailed information, please refer
                             to :ref:`api_guide_Name`. Usually name is no need to set and
                             None by default.
D
dengkaipeng 已提交
12916 12917

    Returns:
H
haowang101779990 已提交
12918
        Variable: Output of shape [N, C, H, W] data samples input X
K
Kaipeng Deng 已提交
12919 12920
                  using bilnear interpolation based on input grid.
                  The data type is same as input tensor.
12921

H
haowang101779990 已提交
12922 12923 12924 12925
    Examples:

        .. code-block:: python

K
Kaipeng Deng 已提交
12926 12927
            import paddle.fluid as fluid

K
Kaipeng Deng 已提交
12928 12929
            # use with affine_grid
            x = fluid.data(name='x', shape=[None, 10, 32, 32], dtype='float32')
K
Kaipeng Deng 已提交
12930 12931
            theta = fluid.layers.data(name='theta', shape=[2, 3], dtype='float32')
            grid = fluid.layers.affine_grid(theta=theta, out_shape=[3, 10, 32, 32])
H
haowang101779990 已提交
12932
            out = fluid.layers.grid_sampler(x=x, grid=grid)
12933

D
dengkaipeng 已提交
12934 12935 12936
    """
    helper = LayerHelper("grid_sampler", **locals())

12937 12938 12939
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'grid_sampler')
    check_variable_and_dtype(grid, 'grid', ['float32', 'float64'],
                             'grid_sampler')
D
dengkaipeng 已提交
12940 12941 12942 12943 12944 12945
    if not isinstance(x, Variable):
        return ValueError("The x should be a Variable")

    if not isinstance(grid, Variable):
        return ValueError("The grid should be a Variable")

12946
    out = helper.create_variable_for_type_inference(x.dtype)
D
dengkaipeng 已提交
12947 12948
    ipts = {'X': x, 'Grid': grid}

12949
    helper.append_op(type='grid_sampler', inputs=ipts, outputs={'Output': out})
12950 12951 12952
    return out


G
gmcather 已提交
12953 12954
def log_loss(input, label, epsilon=1e-4, name=None):
    """
12955 12956 12957 12958
    :alias_main: paddle.nn.functional.log_loss
	:alias: paddle.nn.functional.log_loss,paddle.nn.functional.loss.log_loss
	:old_api: paddle.fluid.layers.log_loss

G
gmcather 已提交
12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969
    **Negative Log Loss Layer**

    This layer accepts input predictions and target label and returns the
    negative log loss.

    .. math::

        Out = -label * \\log{(input + \\epsilon)}
              - (1 - label) * \\log{(1 - input + \\epsilon)}

    Args:
Y
Yibing Liu 已提交
12970
        input (Variable|list):  A 2-D tensor with shape [N x 1], where N is the
G
gmcather 已提交
12971
                                batch size. This input is a probability computed
Y
Yibing Liu 已提交
12972 12973
                                by the previous operator. Data type float32.
        label (Variable|list):  The ground truth which is a 2-D tensor with
12974
                                shape [N x 1], where N is the batch size.
Y
Yibing Liu 已提交
12975 12976
                                Data type float32.
        epsilon (float, optional): A small number for numerical stability. Default 1e-4.
12977
        name(str|None): For detailed information, please refer to
Y
Yibing Liu 已提交
12978
            :ref:`api_guide_Name` . Usually name is no need to set and None by default.
G
gmcather 已提交
12979 12980 12981 12982 12983 12984 12985

    Returns:
        Variable: A 2-D tensor with shape [N x 1], the negative log loss.

    Examples:
        .. code-block:: python

12986
          import paddle.fluid as fluid
12987 12988
          label = fluid.data(name='label', shape=[None, 1], dtype='float32')
          prob = fluid.data(name='prob', shape=[None, 1], dtype='float32')
G
gmcather 已提交
12989 12990 12991
          cost = fluid.layers.log_loss(input=prob, label=label)
    """
    helper = LayerHelper('log_loss', **locals())
12992 12993
    check_variable_and_dtype(input, 'input', ['float32'], 'log_loss')
    check_variable_and_dtype(label, 'label', ['float32'], 'log_loss')
G
gmcather 已提交
12994

12995
    loss = helper.create_variable_for_type_inference(dtype=input.dtype)
G
gmcather 已提交
12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007

    helper.append_op(
        type='log_loss',
        inputs={'Predicted': [input],
                'Labels': [label]},
        outputs={'Loss': [loss]},
        attrs={'epsilon': epsilon})
    return loss


def add_position_encoding(input, alpha, beta, name=None):
    """
13008 13009 13010 13011
    :alias_main: paddle.nn.functional.add_position_encoding
	:alias: paddle.nn.functional.add_position_encoding,paddle.nn.functional.extension.add_position_encoding
	:old_api: paddle.fluid.layers.add_position_encoding

G
Guo Sheng 已提交
13012 13013
    This operator performs weighted sum of input feature at each position
    (position in the sequence) and the corresponding position encoding.
G
gmcather 已提交
13014

13015
    For more details of position encoding, please refer to `Attention Is All You
G
Guo Sheng 已提交
13016
    Need <http://arxiv.org/pdf/1706.03762.pdf>`_ .
G
gmcather 已提交
13017

G
Guo Sheng 已提交
13018
    The formula is as follows:
G
gmcather 已提交
13019 13020

    .. math::
H
haowang101779990 已提交
13021 13022 13023
        PE(pos, 2i) &= \\sin{(pos / 10000^{2i / P})}   \\\\
        PE(pos, 2i + 1) &= \\cos{(pos / 10000^{2i / P})}  \\\\
        Out(:, pos, i) &= \\alpha * input(:, pos, i) + \\beta * PE(pos, i)
G
gmcather 已提交
13024 13025

    Where:
G
Guo Sheng 已提交
13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039
      - :math:`PE(pos, 2i)` : the value at even index `2i` for encoding of position `pos`.
      - :math:`PE(pos, 2i + 1)` : the value at odd index `2i+1` for encoding of position `pos`

    Args:
        input(Variable): A Tensor or LoDTensor (lod level is 1). If it is a
            Tensor, the shape should be `[N, M, P]`, where `N` stands for
            batch size, `M` for sequence length, `P` for the size of feature
            dimension. If it is a LoDTensor, the shape should be `[N, P]`,
            where `N` stands for the total sequence lengths in this mini-batch,
            `P` for the size of feature. The data type should be float32 or float64.
        alpha(float): Indicate the weight coefficient for `input` when performing
            weighted sum.
        beta(float): Indicate the weight coefficient for position encoding when
            performing weighted sum.
13040 13041
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name`. Usually name is no need to set and
G
Guo Sheng 已提交
13042
            None by default.
G
gmcather 已提交
13043 13044

    Returns:
G
Guo Sheng 已提交
13045
        Variable: A Tensor or LoDTensor. It has the same shape, data type and lod as `input`.
G
gmcather 已提交
13046 13047 13048 13049

    Examples:
        .. code-block:: python

13050 13051
          import paddle.fluid as fluid

G
Guo Sheng 已提交
13052
          tensor = fluid.data(
13053
              name='tensor',
G
Guo Sheng 已提交
13054 13055
              shape=[None, 64, 512],
              dtype='float32')
13056 13057
          position_tensor = fluid.layers.add_position_encoding(
              input=tensor, alpha=1.0, beta=1.0)
H
haowang101779990 已提交
13058

G
gmcather 已提交
13059 13060
    """
    helper = LayerHelper('add_position_encoding', **locals())
13061 13062
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             "add_position_encoding")
G
gmcather 已提交
13063 13064
    dtype = helper.input_dtype()

13065
    out = helper.create_variable_for_type_inference(dtype=dtype)
G
gmcather 已提交
13066 13067 13068 13069 13070 13071 13072 13073

    helper.append_op(
        type="add_position_encoding",
        inputs={"X": input},
        outputs={"Out": out},
        attrs={"alpha": alpha,
               "beta": beta})
    return out
Q
Qiao Longfei 已提交
13074 13075 13076 13077 13078 13079 13080 13081 13082 13083


def bilinear_tensor_product(x,
                            y,
                            size,
                            act=None,
                            name=None,
                            param_attr=None,
                            bias_attr=None):
    """
13084 13085
    :api_attr: Static Graph

Y
Yibing Liu 已提交
13086
    **Bilinear Tensor Product Layer**
Q
Qiao Longfei 已提交
13087

Q
Qiao Longfei 已提交
13088
    This layer performs bilinear tensor product on two inputs.
Q
Qiao Longfei 已提交
13089 13090 13091
    For example:

    .. math::
H
haowang101779990 已提交
13092
       out_{i} = x * W_{i} * {y^\mathrm{T}}, i=0,1,...,size-1
Q
Qiao Longfei 已提交
13093

Q
Qiao Longfei 已提交
13094
    In this formula:
13095 13096
      - :math:`x`: the first input contains M elements, shape is [batch_size, M].
      - :math:`y`: the second input contains N elements, shape is [batch_size, N].
Y
Yibing Liu 已提交
13097
      - :math:`W_{i}`: the i-th learned weight, shape is [M, N].
H
haowang101779990 已提交
13098
      - :math:`out_{i}`: the i-th element of out, shape is [batch_size, size].
Q
Qiao Longfei 已提交
13099 13100 13101
      - :math:`y^\mathrm{T}`: the transpose of :math:`y_{2}`.

    Args:
13102
        x (Variable): 2-D input tensor with shape [batch_size, M]. Data type
Y
Yibing Liu 已提交
13103
            is float32 or float64.
13104
        y (Variable): 2-D input tensor with shape [batch_size, N]. Data type
Y
Yibing Liu 已提交
13105
            should be same as **x**.
Q
Qiao Longfei 已提交
13106
        size (int): The dimension of this layer.
Y
Yibing Liu 已提交
13107
        act (str|None): Activation to be applied to the output of this layer. Default None.
13108
        name(str|None): For detailed information, please refer to
Y
Yibing Liu 已提交
13109
            :ref:`api_guide_Name` . Usually name is no need to set and None by default.
13110 13111
        param_attr (ParamAttr|None): To specify the weight parameter attribute.
            Default: None, which means the default weight parameter property is
Y
Yibing Liu 已提交
13112
            used. See usage for details in :ref:`api_fluid_ParamAttr` .
13113 13114
        bias_attr (ParamAttr|None): To specify the bias parameter attribute.
            Default: None, which means the default bias parameter property is
Y
Yibing Liu 已提交
13115
            used. See usage for details in :ref:`api_fluid_ParamAttr` .
Q
Qiao Longfei 已提交
13116
    Returns:
Y
Yibing Liu 已提交
13117
        Variable: A 2-D Tensor of shape [batch_size, size]. Data type is the same as input **x**.
Q
Qiao Longfei 已提交
13118 13119 13120 13121

    Examples:
        .. code-block:: python

13122
          import paddle.fluid as fluid
Y
Yibing Liu 已提交
13123 13124
          layer1 = fluid.data("t1", shape=[-1, 5], dtype="float32")
          layer2 = fluid.data("t2", shape=[-1, 4], dtype="float32")
Y
Yibing Liu 已提交
13125
          tensor = fluid.layers.bilinear_tensor_product(x=layer1, y=layer2, size=1000)
Q
Qiao Longfei 已提交
13126 13127
    """
    helper = LayerHelper('bilinear_tensor_product', **locals())
Q
Qiao Longfei 已提交
13128
    dtype = helper.input_dtype('x')
Q
Qiao Longfei 已提交
13129 13130 13131 13132

    param_shape = [size, x.shape[1], y.shape[1]]

    w = helper.create_parameter(
Q
Qiao Longfei 已提交
13133
        attr=helper.param_attr, shape=param_shape, dtype=dtype, is_bias=False)
13134
    out = helper.create_variable_for_type_inference(dtype=dtype)
Q
Qiao Longfei 已提交
13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146

    inputs = {"X": x, "Y": y, "Weight": w}
    if helper.bias_attr:
        bias_size = [1, size]
        bias = helper.create_parameter(
            attr=helper.bias_attr, shape=bias_size, dtype=dtype, is_bias=True)
        inputs["Bias"] = bias
    helper.append_op(
        type="bilinear_tensor_product", inputs=inputs, outputs={"Out": out})

    # add activation
    return helper.append_activation(out)
C
chengduo 已提交
13147 13148 13149 13150 13151


@templatedoc()
def get_tensor_from_selected_rows(x, name=None):
    """
13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167
    This operator gets tensor data from input with SelectedRows type, and outputs a LoDTensor.

    .. code-block:: text

        input x is SelectedRows:
           x.rows = [0, 5, 5, 4, 19]
           x.height = 20
           x.value = [[1, 1] [2, 2] [2, 2] [3, 3] [6, 6]]

        Ouput is LoDTensor:
           out.shape = [5, 2]
           out.data = [[1, 1],
                       [2, 2],
                       [2, 2],
                       [3, 3],
                       [6, 6]]
C
chengduo 已提交
13168 13169

    Args:
13170 13171 13172
        x(SelectedRows): Input with SelectedRows type. The data type is float32, float64, int32 or int64.
        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` .
C
chengduo 已提交
13173 13174

    Returns:
13175
        Variable: LoDTensor transformed from SelectedRows. The data type is same with input.
B
bdzhuxiaoning 已提交
13176 13177 13178

    Examples:
        .. code-block:: python
13179

B
bdzhuxiaoning 已提交
13180 13181 13182 13183
            import paddle.fluid as fluid
            b = fluid.default_main_program().global_block()
            input = b.create_var(name="X", dtype="float32", persistable=True, type=fluid.core.VarDesc.VarType.SELECTED_ROWS)
            out = fluid.layers.get_tensor_from_selected_rows(input)
C
chengduo 已提交
13184 13185
    """

13186 13187 13188 13189 13190
    check_type(x, 'x', Variable, 'get_tensor_from_selected_rows')
    if x.type != core.VarDesc.VarType.SELECTED_ROWS:
        raise TypeError(
            "The type of 'x' in get_tensor_from_selected_rows must be SELECTED_ROWS."
        )
C
chengduo 已提交
13191 13192 13193 13194 13195 13196 13197 13198
    helper = LayerHelper('get_tensor_from_selected_rows', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(
        type='get_tensor_from_selected_rows',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={})
    return out
13199 13200


S
shippingwang 已提交
13201
def shuffle_channel(x, group, name=None):
S
shippingwang 已提交
13202
    """
S
shippingwang 已提交
13203 13204 13205 13206 13207 13208
    This operator shuffles the channels of input x.
    It divide the input channels in each group into :attr:`group` subgroups,
    and obtain a new order by selecting element from every subgroup one by one.

    Please refer to the paper
    https://arxiv.org/pdf/1707.01083.pdf
13209

S
shippingwang 已提交
13210
    .. code-block:: text
13211

S
shippingwang 已提交
13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229
        Given a 4-D tensor input with the shape (N, C, H, W):
            input.shape = (1, 4, 2, 2)
            input.data =[[[[0.1, 0.2],
                           [0.2, 0.3]],

                          [[0.3, 0.4],
                           [0.4, 0.5]],

                          [[0.5, 0.6],
                           [0.6, 0.7]],

                          [[0.7, 0.8],
                           [0.8, 0.9]]]]
            Given group: 2
            then we get a 4-D tensor out whth the same shape of input:
            out.shape = (1, 4, 2, 2)
            out.data = [[[[0.1, 0.2],
                          [0.2, 0.3]],
13230

S
shippingwang 已提交
13231 13232
                         [[0.5, 0.6],
                          [0.6, 0.7]],
13233

S
shippingwang 已提交
13234 13235
                         [[0.3, 0.4],
                          [0.4, 0.5]],
13236

S
shippingwang 已提交
13237 13238
                         [[0.7, 0.8],
                          [0.8, 0.9]]]]
13239 13240

    Args:
S
shippingwang 已提交
13241
        x(Variable): The input tensor variable. It should be a 4-D tensor with shape [N, C, H, W]
T
tianshuo78520a 已提交
13242
        group(int): Indicating the counts of subgroups, It should divide the number of channels.
S
shippingwang 已提交
13243 13244

    Returns:
13245
        out(Variable): the channels shuffling result is a tensor variable with the
S
shippingwang 已提交
13246
        same shape and same type as the input.
S
shippingwang 已提交
13247 13248

    Raises:
S
shippingwang 已提交
13249
        ValueError: If group is not an int type variable.
S
shippingwang 已提交
13250 13251 13252

    Examples:
        .. code-block:: python
13253

13254
            import paddle.fluid as fluid
R
ruri 已提交
13255
            input = fluid.data(name='input', shape=[None,4,2,2], dtype='float32')
S
shippingwang 已提交
13256
            out = fluid.layers.shuffle_channel(x=input, group=2)
S
shippingwang 已提交
13257 13258 13259
    """
    helper = LayerHelper("shuffle_channel", **locals())

S
shippingwang 已提交
13260
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
S
shippingwang 已提交
13261 13262 13263 13264 13265 13266 13267 13268 13269

    if not isinstance(group, int):
        raise TypeError("group must be int type")

    helper.append_op(
        type="shuffle_channel",
        inputs={"X": x},
        outputs={"Out": out},
        attrs={"group": group})
S
shippingwang 已提交
13270
    return out
S
Add  
shippingwang 已提交
13271 13272


13273
@templatedoc()
D
dengkaipeng 已提交
13274
def temporal_shift(x, seg_num, shift_ratio=0.25, name=None):
13275
    """
13276 13277 13278 13279
    :alias_main: paddle.nn.functional.temporal_shift
	:alias: paddle.nn.functional.temporal_shift,paddle.nn.functional.extension.temporal_shift
	:old_api: paddle.fluid.layers.temporal_shift

13280
    **Temporal Shift Operator**
13281

13282
    ${comment}
13283 13284

    Args:
13285 13286
        x(Variable): ${x_comment}
        seg_num(int): ${seg_num_comment}
D
dengkaipeng 已提交
13287
        shift_ratio(float): ${shift_ratio_comment}
K
Kaipeng Deng 已提交
13288 13289 13290
        name(str, optional): For detailed information, please refer
                             to :ref:`api_guide_Name`. Usually name is no need to set and
                             None by default.
13291 13292

    Returns:
13293
        out(Variable): The temporal shifting result is a tensor variable with the
K
Kaipeng Deng 已提交
13294
        same shape and same data type as the input.
13295 13296 13297 13298 13299 13300 13301

    Raises:
        TypeError: seg_num must be int type.

    Examples:
        .. code-block:: python

13302
            import paddle.fluid as fluid
K
Kaipeng Deng 已提交
13303
            input = fluid.data(name='input', shape=[None,4,2,2], dtype='float32')
D
dengkaipeng 已提交
13304
            out = fluid.layers.temporal_shift(x=input, seg_num=2, shift_ratio=0.2)
13305 13306
    """
    helper = LayerHelper("temporal_shift", **locals())
13307 13308 13309
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'temporal_shift')
    check_type(seg_num, 'seg_num', int, 'temporal_shift')
    check_type(shift_ratio, 'shift_ratio', float, 'temporal_shift')
13310 13311 13312 13313 13314 13315 13316 13317 13318 13319

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

    if not isinstance(seg_num, int):
        raise TypeError("seg_num must be int type.")

    helper.append_op(
        type="temporal_shift",
        inputs={"X": x},
        outputs={"Out": out},
D
dengkaipeng 已提交
13320 13321
        attrs={"seg_num": seg_num,
               "shift_ratio": shift_ratio})
13322 13323 13324
    return out


S
sneaxiy 已提交
13325
class PyFuncRegistry(object):
S
sneaxiy 已提交
13326 13327 13328
    _register_funcs = []

    def __init__(self, func):
S
sneaxiy 已提交
13329
        if func is None or not callable(func):
S
sneaxiy 已提交
13330 13331 13332
            raise TypeError('func must be a Python function')

        self._func = func
M
minqiyang 已提交
13333
        # find named args using reflection
S
sneaxiy 已提交
13334 13335 13336 13337 13338 13339 13340
        args = inspect.getargspec(self._func)
        if len(args[0]) == 0 and args[1] is None and args[2] is None:
            # Function with no inputs
            self._named_args = None
        else:
            self._named_args = args[0]
        self._id = core._append_python_callable_object_and_return_id(self)
S
sneaxiy 已提交
13341 13342 13343
        '''
        Why record self here?

M
minqiyang 已提交
13344 13345
        1. For debug usage. Users can call
           :code:`py_func.registered_func(idx)` method
S
sneaxiy 已提交
13346
           to find the registered function corresponding
M
minqiyang 已提交
13347
           to :code:`idx`.
S
sneaxiy 已提交
13348

M
minqiyang 已提交
13349 13350
        2. For increasing reference count of self.
           It seems that to release Python object
S
sneaxiy 已提交
13351
           whose reference count is 1 would cause
M
minqiyang 已提交
13352
           segmentation fault error in C++ side.
S
sneaxiy 已提交
13353 13354
           May be lack of Python GC in C++ side?
        '''
S
sneaxiy 已提交
13355
        PyFuncRegistry._register_funcs.append(self)
S
sneaxiy 已提交
13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369

    @classmethod
    def registered_func(cls, idx):
        return cls._register_funcs[idx]._func

    @classmethod
    def registered_func_num(cls):
        return len(cls._register_funcs)

    @property
    def id(self):
        return self._id

    def __call__(self, *args):
S
sneaxiy 已提交
13370 13371 13372 13373 13374 13375 13376 13377 13378
        if self._named_args is None:
            func_ret = self._func()
        else:
            kwargs = dict()
            idx = 0
            for arg in self._named_args:
                kwargs[arg] = args[idx]
                idx += 1
            func_ret = self._func(*args[idx:], **kwargs)
S
sneaxiy 已提交
13379

S
sneaxiy 已提交
13380 13381
        if not isinstance(func_ret, (list, tuple)):
            func_ret = (func_ret, )
S
sneaxiy 已提交
13382 13383

        ret = []
S
sneaxiy 已提交
13384 13385 13386
        for each_ret in func_ret:
            if each_ret is None or isinstance(each_ret, core.LoDTensor):
                ret.append(each_ret)
S
sneaxiy 已提交
13387 13388
                continue

S
sneaxiy 已提交
13389 13390
            if not isinstance(each_ret, np.ndarray):
                each_ret = np.array(each_ret)
S
sneaxiy 已提交
13391

S
sneaxiy 已提交
13392 13393 13394
            tensor = core.LoDTensor()
            tensor.set(each_ret, core.CPUPlace())
            ret.append(tensor)
S
sneaxiy 已提交
13395

S
sneaxiy 已提交
13396
        return tuple(ret)
S
sneaxiy 已提交
13397 13398


S
sneaxiy 已提交
13399 13400 13401
@templatedoc()
def py_func(func, x, out, backward_func=None, skip_vars_in_backward_input=None):
    """
13402 13403
    :api_attr: Static Graph

13404
    This OP is used to register customized Python OP to Paddle Fluid. The design
13405 13406 13407
    principe of py_func is that LodTensor and numpy array can be converted to each
    other easily. So you can use Python and numpy API to register a python OP.

13408 13409 13410 13411
    The forward  function of the registered OP is ``func`` and the backward function
    of that is  ``backward_func``. Paddle will call ``func`` at forward runtime and
    call ``backward_func`` at backward runtime(if ``backward_func`` is not  None).
    ``x`` is the input of ``func``, whose type must be LoDTensor; ``out`` is
13412
    the output of ``func``, whose type can be either LoDTensor or numpy array.
13413

13414 13415 13416
    The input of the backward function ``backward_func`` is ``x``, ``out`` and
    the gradient of ``out``. If some variables of ``out`` have no gradient, the
    relevant input variable of ``backward_func`` is None. If some variables of
13417 13418
    ``x`` do not have a gradient, the user should return None in ``backward_func``.

13419 13420
    The data type and shape of ``out`` should also be set correctly before this
    API is called, and the data type and shape of the gradient of ``out`` and
13421 13422 13423 13424 13425 13426 13427
    ``x`` will be inferred automatically.

    This API can also be used to debug the neural network by setting the ``func``
    as a function that only print variables.

    Args:
        func (callable): The forward function of the registered OP. When the network
13428 13429
            is running, the forward output ``out`` will be calculated according to this
            function and the forward input ``x``. In ``func`` , it's suggested that we
13430 13431
            actively convert LoDTensor into a numpy array, so that we can use Python and
            numpy API arbitrarily. If not, some operations of numpy may not be compatible.
13432 13433
        x (Variable|tuple(Variale)|list[Variale]): The input of the forward function ``func``.
            It can be Variable|tuple(Variale)|list[Variale], where Variable is LoDTensor or
13434 13435
            Tenosor. In addition, Multiple Variable should be passed in the form of tuple(Variale)
            or list[Variale].
13436
        out (Variable|tuple(Variale)|list[Variale]): The output of the forward function ``func``,
13437
            it can be Variable|tuple(Variale)|list[Variale], where Variable can be either LoDTensor
13438
            or numpy array. Since Paddle cannot automatically infer the shape and type of ``out``,
13439
            you must create ``out`` in advance.
13440 13441 13442
        backward_func (callable, optional): The backward function of the registered OP.
            Its default value is None, which means there is no reverse calculation. If
            it is not None, ``backward_func`` is called to calculate the gradient of
13443
            ``x`` when the network is at backward runtime.
13444 13445 13446 13447 13448
        skip_vars_in_backward_input (Variable, optional): It's used to limit the input
            variable list of ``backward_func``, and it can be Variable|tuple(Variale)|list[Variale].
            It must belong to either ``x`` or ``out``. The default  value is None, which means
            that no variables need to be removed from ``x`` and ``out``. If it is not None,
            these variables will not be the input of ``backward_func``. This parameter is only
13449
            useful when ``backward_func`` is not None.
13450 13451

    Returns:
13452
        Variable|tuple(Variale)|list[Variale]: The output ``out`` of the forward function ``func``.
S
sneaxiy 已提交
13453 13454

    Examples:
13455
        .. code-block:: python
13456

13457
            # example 1:
13458 13459 13460
            import paddle.fluid as fluid
            import six

13461 13462
            # Creates a forward function, LodTensor can be input directly without
            # being converted into numpy array.
13463 13464 13465
            def tanh(x):
                return np.tanh(x)

13466
            # Skip x in backward function and return the gradient of x
13467
            # LodTensor must be actively converted to numpy array, otherwise,
13468
            # operations such as +/- can't be used.
13469 13470
            def tanh_grad(y, dy):
                return np.array(dy) * (1 - np.square(np.array(y)))
13471

13472
            # Creates a forward function for debugging running networks(print value)
13473 13474
            def debug_func(x):
                print(x)
13475

13476 13477 13478
            def create_tmp_var(name, dtype, shape):
                return fluid.default_main_program().current_block().create_var(
                    name=name, dtype=dtype, shape=shape)
13479 13480 13481 13482 13483 13484 13485 13486

            def simple_net(img, label):
                hidden = img
                for idx in six.moves.range(4):
                    hidden = fluid.layers.fc(hidden, size=200)
                    new_hidden = create_tmp_var(name='hidden_{}'.format(idx),
                        dtype=hidden.dtype, shape=hidden.shape)

13487
                    # User-defined forward and backward
13488 13489 13490 13491
                    hidden = fluid.layers.py_func(func=tanh, x=hidden,
                        out=new_hidden, backward_func=tanh_grad,
                        skip_vars_in_backward_input=hidden)

13492
                    # User-defined debug functions that print out the input LodTensor
13493 13494 13495 13496 13497
                    fluid.layers.py_func(func=debug_func, x=hidden, out=None)

                prediction = fluid.layers.fc(hidden, size=10, act='softmax')
                loss = fluid.layers.cross_entropy(input=prediction, label=label)
                return fluid.layers.mean(loss)
13498

13499 13500
            # example 2:
            # This example shows how to turn LoDTensor into numpy array and
13501 13502 13503 13504
            # use numpy API to register an Python OP
            import paddle.fluid as fluid
            import numpy as np

13505 13506
            def element_wise_add(x, y):
                # LodTensor must be actively converted to numpy array, otherwise,
13507
                # numpy.shape can't be used.
13508
                x = np.array(x)
13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531
                y = np.array(y)

                if x.shape != y.shape:
                    raise AssertionError("the shape of inputs must be the same!")

                result = np.zeros(x.shape, dtype='int32')
                for i in range(len(x)):
                    for j in range(len(x[0])):
                        result[i][j] = x[i][j] + y[i][j]

                return result

            def create_tmp_var(name, dtype, shape):
                return fluid.default_main_program().current_block().create_var(
                            name=name, dtype=dtype, shape=shape)

            def py_func_demo():
                start_program = fluid.default_startup_program()
                main_program = fluid.default_main_program()

                # Input of the forward function
                x = fluid.data(name='x', shape=[2,3], dtype='int32')
                y = fluid.data(name='y', shape=[2,3], dtype='int32')
13532

13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544
                # Output of the forward function, name/dtype/shape must be specified
                output = create_tmp_var('output','int32', [3,1])

                # Multiple Variable should be passed in the form of tuple(Variale) or list[Variale]
                fluid.layers.py_func(func=element_wise_add, x=[x,y], out=output)

                exe=fluid.Executor(fluid.CPUPlace())
                exe.run(start_program)

                # Feed numpy array to main_program
                input1 = np.random.randint(1, 10, size=[2,3], dtype='int32')
                input2 = np.random.randint(1, 10, size=[2,3], dtype='int32')
13545
                out = exe.run(main_program,
13546 13547 13548 13549 13550 13551 13552 13553 13554
                            feed={'x':input1, 'y':input2},
                            fetch_list=[output.name])
                print("{0} + {1} = {2}".format(input1, input2, out))

            py_func_demo()

            # Reference output:
            # [[5, 9, 9]   + [[7, 8, 4]  =  [array([[12, 17, 13]
            #  [7, 5, 2]]     [1, 3, 3]]            [8, 8, 5]], dtype=int32)]
S
sneaxiy 已提交
13555
    """
S
sneaxiy 已提交
13556
    helper = LayerHelper('py_func', **locals())
13557
    check_type(x, 'X', (list, tuple, Variable, type(None)), 'py_func')
S
sneaxiy 已提交
13558 13559 13560
    if x is None:
        x = []
    elif isinstance(x, Variable):
S
sneaxiy 已提交
13561
        x = [x]
13562 13563 13564
    elif isinstance(x, tuple):
        x = list(x)
    elif not isinstance(x, (list, tuple, Variable)):
S
sneaxiy 已提交
13565
        raise TypeError('Input must be Variable/list(Variable)/tuple(Variable)')
13566
    check_type(out, 'Out', (list, tuple, Variable, type(None)), 'py_func')
S
sneaxiy 已提交
13567 13568 13569
    if out is None:
        out_list = []
    elif isinstance(out, Variable):
S
sneaxiy 已提交
13570
        out_list = [out]
13571 13572
    elif isinstance(out, tuple):
        out_list = list(out)
13573 13574 13575
    elif isinstance(out, list):
        out_list = out
    else:
S
sneaxiy 已提交
13576 13577
        raise TypeError(
            'Output must be Variable/list(Variable)/tuple(Variable)')
S
sneaxiy 已提交
13578

S
sneaxiy 已提交
13579 13580
    fwd_func_id = PyFuncRegistry(func).id
    bwd_func_id = PyFuncRegistry(
S
sneaxiy 已提交
13581
        backward_func).id if backward_func is not None else -1
S
sneaxiy 已提交
13582 13583

    for each_out in out_list:
S
sneaxiy 已提交
13584 13585
        if len(each_out.shape) == 0:
            raise ValueError(
S
sneaxiy 已提交
13586 13587
                'Output shapes of py_func op should be provided by users manually'
            )
S
sneaxiy 已提交
13588

S
sneaxiy 已提交
13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603
    backward_skip_vars = set()
    if backward_func is not None and skip_vars_in_backward_input is not None:
        if isinstance(skip_vars_in_backward_input, Variable):
            skip_vars_in_backward_input = [skip_vars_in_backward_input]

        fwd_in_out = [v.name for v in x]
        fwd_in_out.extend([v.name for v in out_list])
        fwd_in_out = set(fwd_in_out)
        backward_skip_vars = set()
        for v in skip_vars_in_backward_input:
            if not v.name in fwd_in_out:
                raise ValueError(
                    'Variable {} is not found in forward inputs and outputs'
                    .format(v.name))
            backward_skip_vars.add(v.name)
S
sneaxiy 已提交
13604 13605 13606 13607

    helper.append_op(
        type='py_func',
        inputs={'X': x},
S
sneaxiy 已提交
13608 13609
        outputs={'Out': out_list},
        attrs={
S
sneaxiy 已提交
13610 13611 13612
            'forward_callable_id': fwd_func_id,
            'backward_callable_id': bwd_func_id,
            'backward_skip_vars': list(backward_skip_vars)
S
sneaxiy 已提交
13613
        })
S
sneaxiy 已提交
13614
    return out
S
sneaxiy 已提交
13615 13616 13617


# For debug usage
S
sneaxiy 已提交
13618 13619 13620 13621
py_func.registered_func = PyFuncRegistry.registered_func
py_func.registered_func_num = PyFuncRegistry.registered_func_num


13622 13623 13624 13625 13626 13627 13628 13629 13630
@templatedoc()
def psroi_pool(input,
               rois,
               output_channels,
               spatial_scale,
               pooled_height,
               pooled_width,
               name=None):
    """
13631 13632 13633 13634
    :alias_main: paddle.nn.functional.psroi_pool
	:alias: paddle.nn.functional.psroi_pool,paddle.nn.functional.vision.psroi_pool
	:old_api: paddle.fluid.layers.psroi_pool

13635 13636
    ${comment}

S
SunGaofeng 已提交
13637
    Parameters:
13638
        input (Variable): ${x_comment}
S
SunGaofeng 已提交
13639
        rois (Variable): LoDTensor, ROIs (Regions of Interest) to pool over.It should be
S
SunGaofeng 已提交
13640 13641 13642
                         a 2-D LoDTensor of shape (num_rois, 4), the lod level
                         is 1. Given as [[x1, y1, x2, y2], ...], (x1, y1) is
                         the top left coordinates, and (x2, y2) is the bottom
S
SunGaofeng 已提交
13643 13644
                         right coordinates. The data type is the same as `input`
        output_channels (int): ${output_channels_comment}
13645
        spatial_scale (float): ${spatial_scale_comment} Default: 1.0
S
SunGaofeng 已提交
13646 13647
        pooled_height (int): ${pooled_height_comment} Default: 1
        pooled_width (int): ${pooled_width_comment} Default: 1
13648 13649
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
13650
                             For more information, please refer to :ref:`api_guide_Name`
13651 13652

    Returns:
S
SunGaofeng 已提交
13653 13654 13655 13656
        ${out_comment}.

    Return Type:
        Variable
13657 13658 13659 13660

    Examples:
        .. code-block:: python

S
SunGaofeng 已提交
13661
            import paddle.fluid as fluid
S
SunGaofeng 已提交
13662 13663
            x = fluid.data(name='x', shape=[100, 490, 28, 28], dtype='float32')
            rois = fluid.data(name='rois', shape=[None, 4], lod_level=1, dtype='float32')
S
SunGaofeng 已提交
13664
            pool_out = fluid.layers.psroi_pool(x, rois, 10, 1.0, 7, 7)
13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689
    """
    helper = LayerHelper('psroi_pool', **locals())
    # check attrs
    if not isinstance(output_channels, int):
        raise TypeError("output_channels must be int type")
    if not isinstance(spatial_scale, float):
        raise TypeError("spatial_scale must be float type")
    if not isinstance(pooled_height, int):
        raise TypeError("pooled_height must be int type")
    if not isinstance(pooled_width, int):
        raise TypeError("pooled_width must be int type")
    dtype = helper.input_dtype()
    out = helper.create_variable_for_type_inference(dtype)
    helper.append_op(
        type='psroi_pool',
        inputs={'X': input,
                'ROIs': rois},
        outputs={'Out': out},
        attrs={
            'output_channels': output_channels,
            'spatial_scale': spatial_scale,
            'pooled_height': pooled_height,
            'pooled_width': pooled_width
        })
    return out
13690 13691 13692 13693 13694 13695 13696 13697


@templatedoc()
def prroi_pool(input,
               rois,
               spatial_scale=1.0,
               pooled_height=1,
               pooled_width=1,
13698
               batch_roi_nums=None,
13699 13700
               name=None):
    """
13701 13702 13703 13704
    :alias_main: paddle.nn.functional.prroi_pool
	:alias: paddle.nn.functional.prroi_pool,paddle.nn.functional.vision.prroi_pool
	:old_api: paddle.fluid.layers.prroi_pool

13705
    The precise roi pooling implementation for paddle. Reference: https://arxiv.org/pdf/1807.11590.pdf
13706 13707

    Args:
13708
        input (Variable):The input of precise roi pooliing.The shape of input tensor is
13709 13710 13711
                        [N,C,H,W]. Where N is batch size,C is number of input channels,H
                        is height of the feature, and W is the width of the feature.
        rois (Variable): ROIs (Regions of Interest) to pool over.It should be
13712 13713 13714 13715 13716
                        a 2-D LoDTensor or Tensor of shape (num_rois, 4), the lod level
                        is 1 when it is LoDTensor. The LoD include the rois's batch index
                        information. If rois is Tensor, its batch index information should
                        be provided by batch_index.
                        Given as [[x1, y1, x2, y2], ...], (x1, y1) is
13717 13718 13719 13720 13721 13722
                        the top left coordinates, and (x2, y2) is the bottom
                        right coordinates.
        spatial_scale (float): Ratio of input feature map height (or width) to raw image height (or width).
                             Equals the reciprocal of total stride in convolutional layers, Default: 1.0.
        pooled_height (integer): The pooled output height. Default: 1.
        pooled_width (integer): The pooled output width. Default: 1.
13723 13724
        batch_roi_nums (Variable): The number of roi for each image in batch. It
                         should be 1-D Tensor, with shape [N] and dtype int64,
13725 13726
                         where N is the batch size. Default: None. Be note: The lod of input should be
                         empty when batch_roi_nums has values;
13727 13728 13729
        name (str, default None): The name of this operation.

    Returns:
13730
        Variable(Tensor):The shape of the returned Tensor is (N, C, pooled_height, pooled_width), with value type float32,float16. N, C denote batch_size and channels of input respectively.
13731 13732 13733 13734

    Examples:
        .. code-block:: python

13735
            ## prroi_pool without batch_roi_num
13736
            import paddle.fluid as fluid
13737 13738
            x = fluid.data(name='x', shape=[None, 490, 28, 28], dtype='float32')
            rois = fluid.data(name='rois', shape=[None, 4], lod_level=1, dtype='float32')
13739
            pool_out = fluid.layers.prroi_pool(x, rois, 1.0, 7, 7)
13740

13741 13742 13743 13744 13745 13746 13747 13748
            ## prroi_pool with batch_roi_num
            batchsize=4
            x2 = fluid.data(name='x2', shape=[batchsize, 490, 28, 28], dtype='float32')
            rois2 = fluid.data(name='rois2', shape=[batchsize, 4], dtype='float32')
            batch_rois_num = fluid.data(name='rois_nums', shape=[batchsize], dtype='int64')
            pool_out2 = fluid.layers.prroi_pool(x2, rois2, 1.0, 7, 7, batch_roi_nums=batch_rois_num)


13749
    """
13750 13751
    check_variable_and_dtype(input, 'input', ['float32'], 'prroi_pool')
    check_variable_and_dtype(rois, 'rois', ['float32'], 'prroi_pool')
13752 13753 13754 13755 13756 13757 13758 13759 13760 13761
    helper = LayerHelper('prroi_pool', **locals())
    # check attrs
    if not isinstance(spatial_scale, float):
        raise TypeError("spatial_scale must be float type")
    if not isinstance(pooled_height, int):
        raise TypeError("pooled_height must be int type")
    if not isinstance(pooled_width, int):
        raise TypeError("pooled_width must be int type")
    dtype = helper.input_dtype()
    out = helper.create_variable_for_type_inference(dtype)
13762 13763 13764
    inputs_op = {'X': input, 'ROIs': rois}
    if batch_roi_nums is not None:
        inputs_op['BatchRoINums'] = batch_roi_nums
13765 13766
    helper.append_op(
        type='prroi_pool',
13767
        inputs=inputs_op,
13768 13769 13770 13771 13772 13773 13774
        outputs={'Out': out},
        attrs={
            'spatial_scale': spatial_scale,
            'pooled_height': pooled_height,
            'pooled_width': pooled_width
        })
    return out
13775

M
minqiyang 已提交
13776

R
ruri 已提交
13777 13778 13779
def pixel_shuffle(x, upscale_factor):
    """

R
ruri 已提交
13780
    This op rearranges elements in a tensor of shape [N, C, H, W]
R
ruri 已提交
13781 13782 13783
    to a tensor of shape [N, C/r**2, H*r, W*r].
    This is useful for implementing efficient sub-pixel convolution
    with a stride of 1/r.
13784
    Please refer to the paper: `Real-Time Single Image and Video Super-Resolution
R
ruri 已提交
13785 13786 13787
    Using an Efficient Sub-Pixel Convolutional Neural Network <https://arxiv.org/abs/1609.05158v2>`_ .
    by Shi et. al (2016) for more details.

R
ruri 已提交
13788
    Parameters:
R
ruri 已提交
13789

R
ruri 已提交
13790 13791
        x(Variable): 4-D tensor, the data type should be float32 or float64.
        upscale_factor(int): factor to increase spatial resolution.
R
ruri 已提交
13792 13793

    Returns:
13794
        Out(Variable): Reshaped tensor according to the new dimension.
R
ruri 已提交
13795 13796 13797 13798 13799 13800 13801

    Raises:
        ValueError: If the square of upscale_factor cannot divide the channels of input.

    Examples:
        .. code-block:: python

R
ruri 已提交
13802 13803 13804 13805 13806 13807 13808 13809
	    # declarative mode
	    import paddle.fluid as fluid
	    import numpy as np
	    input = fluid.data(name="input", shape=[2,9,4,4])
	    output = fluid.layers.pixel_shuffle(x=input, upscale_factor=3)
	    place = fluid.CPUPlace()
	    exe = fluid.Executor(place)
	    exe.run(fluid.default_startup_program())
13810

R
ruri 已提交
13811 13812 13813 13814 13815
	    input_data = np.random.rand(2,9,4,4).astype("float32")
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
13816

R
ruri 已提交
13817 13818
 	    # print(output.shape)
	    # (2L, 1L, 12L, 12L)
R
ruri 已提交
13819 13820 13821

    """

R
ruri 已提交
13822
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'pixel_shuffle')
R
ruri 已提交
13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837
    helper = LayerHelper("pixel_shuffle", **locals())

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

    if not isinstance(upscale_factor, int):
        raise TypeError("upscale factor must be int type")

    helper.append_op(
        type="pixel_shuffle",
        inputs={"X": x},
        outputs={"Out": out},
        attrs={"upscale_factor": upscale_factor})
    return out


13838 13839 13840 13841 13842
def fsp_matrix(x, y):
    """

    **FSP matrix op**

13843
    This op is used to calculate the flow of solution procedure (FSP) matrix of two 4-D Tensor feature maps.
13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854
    Given feature map x with shape [x_channel, h, w] and feature map y with shape
    [y_channel, h, w], we can get the fsp matrix of x and y in two steps:

    1. reshape x into matrix with shape [x_channel, h * w] and reshape and
       transpose y into matrix with shape [h * w, y_channel].
    2. multiply x and y to get fsp matrix with shape [x_channel, y_channel].

    The output is a batch of fsp matrices.

    Args:

13855 13856 13857
        x (Variable): A 4-D Tensor feature map with shape [batch_size, x_channel, height, width].
                      A Tensor with type float32, float64.
        y (Variable): A 4-D Tensor feature map with shape [batch_size, y_channel, height, width].
13858
                      The y_channel can be different with the x_channel of Input(X)
13859 13860
                      while the other dimensions must be the same with Input(X)'s. A Tensor with
                      type float32, float64.
13861 13862 13863 13864

    Returns:

        fsp matrix (Variable): The output of FSP op with shape [batch_size, x_channel, y_channel].
13865 13866
        The x_channel is the channel of x and the y_channel is the channel of y. A Tensor with
        type float32, float64.
13867 13868 13869 13870 13871

    Examples:

        .. code-block:: python

B
Bai Yifan 已提交
13872
            import paddle.fluid as fluid
B
Bai Yifan 已提交
13873
            data = fluid.data(name='data', shape=[None, 3, 32, 32])
B
Bai Yifan 已提交
13874 13875 13876 13877
            feature_map_0 = fluid.layers.conv2d(data, num_filters=2,
                                                filter_size=3)
            feature_map_1 = fluid.layers.conv2d(feature_map_0, num_filters=2,
                                                filter_size=1)
13878 13879 13880
            loss = fluid.layers.fsp_matrix(feature_map_0, feature_map_1)

    """
13881 13882
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'fsp_matrix')
    check_variable_and_dtype(y, 'y', ['float32', 'float64'], 'fsp_matrix')
13883 13884 13885 13886 13887
    helper = LayerHelper('fsp_matrix', **locals())
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype(
        input_param_name='x'))
    helper.append_op(type='fsp', inputs={'X': x, 'Y': y}, outputs={'Out': out})
    return out
H
heqiaozhi 已提交
13888 13889 13890 13891


def continuous_value_model(input, cvm, use_cvm=True):
    """
H
fix doc  
heqiaozhi 已提交
13892

H
heqiaozhi 已提交
13893
    **continuous_value_model layers**
H
fix doc  
heqiaozhi 已提交
13894

Z
zhoushiyu 已提交
13895
    Now, this OP is used in CTR project to remove or dispose show and click value in :attr:`input`.
H
fix doc  
heqiaozhi 已提交
13896

Z
zhoushiyu 已提交
13897 13898
    :attr:`input` is an embedding vector including show and click value, whose shape is :math:`[N, D]` (N is batch size. D is `2 + embedding dim` ).
    Show and click at first two dims of embedding vector D.
T
tianshuo78520a 已提交
13899
    If :attr:`use_cvm` is True, it will calculate :math:`log(show)` and :math:`log(click)` , and output shape is :math:`[N, D]` .
Z
zhoushiyu 已提交
13900 13901
    If :attr:`use_cvm` is False, it will remove show and click from :attr:`input` , and output shape is :math:`[N, D - 2]` .
    :attr:`cvm` is show_click info, whose shape is :math:`[N, 2]` .
H
fix doc  
heqiaozhi 已提交
13902

Z
zhoushiyu 已提交
13903 13904 13905 13906 13907 13908 13909
    Args:
        input (Variable): The input variable. A 2-D LoDTensor with shape :math:`[N, D]` , where N is the batch size, D is `2 + the embedding dim` . `lod level = 1` .
        A Tensor with type float32, float64.
        cvm (Variable): Show and click variable. A 2-D Tensor with shape :math:`[N, 2]` , where N is the batch size, 2 is show and click.
        A Tensor with type float32, float64.
        use_cvm  (bool):  Use show_click or not. if use, the output dim is the same as input.
                          if not use, the output dim is `input dim - 2` (remove show and click)
H
fix doc  
heqiaozhi 已提交
13910

H
heqiaozhi 已提交
13911
    Returns:
H
fix doc  
heqiaozhi 已提交
13912

Z
zhoushiyu 已提交
13913 13914
        Variable: A 2-D LodTensor with shape :math:`[N, M]` . if :attr:`use_cvm` = True, M is equal to input dim D. if False, M is equal to `D - 2`. \
        A Tensor with same type as input.
H
fix doc  
heqiaozhi 已提交
13915

H
heqiaozhi 已提交
13916
    Examples:
H
fix doc  
heqiaozhi 已提交
13917

H
heqiaozhi 已提交
13918
        .. code-block:: python
H
fix doc  
heqiaozhi 已提交
13919

13920
          import paddle.fluid as fluid
Z
zhoushiyu 已提交
13921 13922
          input = fluid.data(name="input", shape=[64, 1], dtype="int64")
          label = fluid.data(name="label", shape=[64, 1], dtype="int64")
H
heqiaozhi 已提交
13923 13924 13925 13926 13927 13928 13929 13930
          embed = fluid.layers.embedding(
                            input=input,
                            size=[100, 11],
                            dtype='float32')
          ones = fluid.layers.fill_constant_batch_size_like(input=label, shape=[-1, 1], dtype="int64", value=1)
          show_clk = fluid.layers.cast(fluid.layers.concat([ones, label], axis=1), dtype='float32')
          show_clk.stop_gradient = True
          input_with_cvm = fluid.layers.continuous_value_model(embed, show_clk, True)
H
fix doc  
heqiaozhi 已提交
13931

H
heqiaozhi 已提交
13932 13933 13934
    """
    helper = LayerHelper('cvm', **locals())
    out = helper.create_variable(dtype=input.dtype)
13935 13936
    check_variable_and_dtype(input, 'input', ['float16', 'float32', 'float64'],
                             'cvm')
H
heqiaozhi 已提交
13937 13938 13939 13940 13941 13942
    helper.append_op(
        type='cvm',
        inputs={'X': [input],
                'CVM': [cvm]},
        outputs={'Y': [out]},
        attrs={"use_cvm": use_cvm})
H
heqiaozhi 已提交
13943
    return out
Z
zhoukunsheng 已提交
13944 13945 13946 13947 13948 13949 13950


def where(condition):
    """
    Return an int64 tensor with rank 2, specifying the coordinate of true element in `condition`.

    Args:
13951
        condition(Variable): A bool tensor with rank at least 1, the data type is bool.
Z
zhoukunsheng 已提交
13952 13953

    Returns:
13954
        Variable, the output data type is int64. : The tensor variable storing a 2-D tensor, which involves all coordinate.
Z
zhoukunsheng 已提交
13955 13956 13957 13958

    Examples:
        .. code-block:: python

13959
             import paddle.fluid as fluid
13960 13961 13962
             import paddle.fluid.layers as layers
             import numpy as np

Z
zhoukunsheng 已提交
13963
             # condition is a tensor [True, False, True]
13964 13965 13966
             condition = layers.assign(np.array([1, 0, 1], dtype='int32'))
             condition = layers.cast(condition, 'bool')
             out = layers.where(condition) # [[0], [2]]
Z
zhoukunsheng 已提交
13967 13968

             # condition is a tensor [[True, False], [False, True]]
13969 13970 13971
             condition = layers.assign(np.array([[1, 0], [0, 1]], dtype='int32'))
             condition = layers.cast(condition, 'bool')
             out = layers.where(condition) # [[0, 0], [1, 1]]
Z
zhoukunsheng 已提交
13972 13973

             # condition is a tensor [False, False, False]
13974 13975 13976 13977
             condition = layers.assign(np.array([0, 0, 0], dtype='int32'))
             condition = layers.cast(condition, 'bool')
             out = layers.where(condition) # [[]]

Z
zhoukunsheng 已提交
13978
    """
13979
    helper = LayerHelper("where_index", **locals())
Z
zhoukunsheng 已提交
13980

13981 13982 13983
    if in_dygraph_mode():
        return core.ops.where_index(condition)

Z
zhoukunsheng 已提交
13984 13985 13986 13987
    out = helper.create_variable_for_type_inference(
        dtype=core.VarDesc.VarType.INT64)

    helper.append_op(
13988 13989 13990
        type='where_index',
        inputs={'Condition': condition},
        outputs={'Out': [out]})
Z
zhoukunsheng 已提交
13991
    return out
Z
zhoukunsheng 已提交
13992 13993 13994 13995


def sign(x):
    """
13996 13997 13998 13999
    :alias_main: paddle.sign
	:alias: paddle.sign,paddle.tensor.sign,paddle.tensor.math.sign
	:old_api: paddle.fluid.layers.sign

14000
    This OP returns sign of every element in `x`: 1 for positive, -1 for negative and 0 for zero.
Z
zhoukunsheng 已提交
14001 14002

    Args:
14003 14004
        x(Variable|numpy.ndarray): The input variable could be N-D tensor or N-D numpy array, \
            the input data type is float32 or float64.
Z
zhoukunsheng 已提交
14005 14006

    Returns:
14007
        Variable, the output data type is the same as input data type. : The output sign tensor with identical shape to input :attr:`x`.
Z
zhoukunsheng 已提交
14008 14009 14010 14011

    Examples:
        .. code-block:: python

14012 14013 14014
          import paddle.fluid as fluid
          import numpy as np

14015
          # [1.0, 0.0, -1.0]
14016
          data = fluid.layers.sign(np.array([3.0, 0.0, -2.0], dtype='float32'))
Z
zhoukunsheng 已提交
14017 14018 14019
    """

    helper = LayerHelper("sign", **locals())
14020 14021 14022 14023
    check_type(x, 'x', (Variable, np.ndarray), 'sign')
    if isinstance(x, np.ndarray):
        x = assign(x)
    check_dtype(x.dtype, 'x', ['float16', 'float32', 'float64'], 'sign')
Z
zhoukunsheng 已提交
14024 14025 14026 14027 14028
    out = helper.create_variable_for_type_inference(dtype=x.dtype)

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

    return out
14029 14030


Z
zhoukunsheng 已提交
14031 14032
def unique(x, dtype='int32'):
    """
14033 14034 14035 14036
    :alias_main: paddle.unique
	:alias: paddle.unique,paddle.tensor.unique,paddle.tensor.manipulation.unique
	:old_api: paddle.fluid.layers.unique

14037
    **unique**
Z
zhoukunsheng 已提交
14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053

    Return a unique tensor for `x` and an index tensor pointing to this unique tensor.

    Args:
        x(Variable): A 1-D input tensor.
        dtype(np.dtype|core.VarDesc.VarType|str): The type of index tensor: int32, int64.

    Returns:
        tuple: (out, index). `out` is the unique tensor for `x`, with identical dtype to `x`, and \
            `index` is an index tensor pointing to `out`, by which user can recover the original `x` tensor.

    Examples:
        .. code-block:: python

             import numpy as np
             import paddle.fluid as fluid
W
wawltor 已提交
14054
             x = fluid.layers.assign(np.array([2, 3, 3, 1, 5, 3], dtype='int32'))
Z
zhoukunsheng 已提交
14055 14056 14057
             out, index = fluid.layers.unique(x) # out is [2, 3, 1, 5]; index is [0, 1, 1, 2, 3, 1]
    """

14058 14059
    check_variable_and_dtype(x, "x", ['float32', 'float64', 'int32', 'int64'],
                             "unique")
Z
zhoukunsheng 已提交
14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075
    helper = LayerHelper("unique", **locals())

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

    index = helper.create_variable_for_type_inference(dtype)

    helper.append_op(
        type='unique',
        inputs={'X': x},
        attrs={'dtype': convert_np_dtype_to_dtype_(dtype)},
        outputs={'Out': [out],
                 'Index': [index]})

    return out, index


14076 14077
def unique_with_counts(x, dtype='int32'):
    """
T
tianshuo78520a 已提交
14078
    This OP return a unique tensor for `x` , and count tensor that the count of unique result in raw input, \
14079
    and an index tensor pointing to this unique tensor.
14080

14081
    **NOTICE**: This op support the variable type of Tensor only.
14082 14083

    Args:
14084 14085
        x(Variable): A 1-D input tensor with input shape of :math:`[N]` , the input data type is float32, float64, int32, int64.
        dtype(np.dtype|core.VarDesc.VarType|str): The type of count and index tensor, it could be int32, int64. Defalut value is int32.
14086

14087
    Returns:
14088 14089 14090
        tuple, the variable type in tuple is Tensor, the output :attr:`out` data type is the same as input :attr:`x`, \
        and data type of output :attr:`index` and :attr:`count` will be int32 or int64.: The :attr:`out` is unique tensor for input :attr:`x`,\
        the data shape is :math:`[K]`, the `K` may be different to the `N` in shape of :attr:`x`. :attr:`index` is an index tensor pointing\
T
tianshuo78520a 已提交
14091
        to :attr:`out`, the data shape is :math:`[N]` , the data shape is the same as input :attr:`x`. :attr:`count` is count of unique element in\
14092
        the :attr:`x`, the data shape is :math:`[K]`, the data shape is the same as output :attr:`out`.
14093 14094 14095 14096 14097 14098 14099 14100 14101

    Examples:
        .. code-block:: python

             import numpy as np
             import paddle.fluid as fluid
             x = fluid.layers.assign(np.array([2, 3, 3, 1, 5, 3], dtype='int32'))
             out, index, count = fluid.layers.unique_with_counts(x) # out is [2, 3, 1, 5]; index is [0, 1, 1, 2, 3, 1]
                                                        # count is [1, 3, 1, 1]
14102
            # x.shape=(6,) out.shape=(4,), index.shape=(6,), count.shape=(4,)
14103
    """
14104 14105
    check_variable_and_dtype(x, "x", ['float32', 'float64', 'int32', 'int64'],
                             "unique_with_counts")
14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133
    if not (dtype == 'int32' or dtype == 'int64'):
        raise TypeError(
            "Op unique_with_counts, index dtype must be int32 or int64")

    if x is None or len(x.shape) != 1:
        raise ValueError(
            "Op unique_with_counts, x must not be null and size of dim must be 1"
        )

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

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

    index = helper.create_variable_for_type_inference(dtype)

    count = helper.create_variable_for_type_inference(dtype)

    helper.append_op(
        type='unique_with_counts',
        inputs={'X': x},
        attrs={'dtype': convert_np_dtype_to_dtype_(dtype)},
        outputs={'Out': [out],
                 'Index': [index],
                 'Count': [count]})

    return out, index, count


14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146
def deformable_conv(input,
                    offset,
                    mask,
                    num_filters,
                    filter_size,
                    stride=1,
                    padding=0,
                    dilation=1,
                    groups=None,
                    deformable_groups=None,
                    im2col_step=None,
                    param_attr=None,
                    bias_attr=None,
14147
                    modulated=True,
14148 14149
                    name=None):
    """
14150 14151
    :api_attr: Static Graph

14152
    **Deformable Convolution op**
14153 14154 14155

    Compute 2-D deformable convolution on 4-D input.
    Given input image x, output feature map y, the deformable convolution operation can be expressed as follow:
14156 14157 14158 14159


    Deformable Convolution v2:

14160 14161 14162
    .. math::

        y(p) = \sum_{k=1}^{K}{w_k * x(p + p_k + \Delta p_k) * \Delta m_k}
14163 14164

    Deformable Convolution v1:
14165

14166 14167 14168
    .. math::

        y(p) = \sum_{k=1}^{K}{w_k * x(p + p_k + \Delta p_k)}
14169 14170

    Where :math:`\Delta p_k` and :math:`\Delta m_k` are the learnable offset and modulation scalar for the k-th location,
14171
    Which :math:`\Delta m_k` is one in deformable convolution v1. Please refer to `Deformable ConvNets v2: More Deformable, Better Results
14172
    <https://arxiv.org/abs/1811.11168v2>`_ and `Deformable Convolutional Networks <https://arxiv.org/abs/1703.06211>`_.
14173

14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196
    Example:
        - Input:

          Input shape: :math:`(N, C_{in}, H_{in}, W_{in})`

          Filter shape: :math:`(C_{out}, C_{in}, H_f, W_f)`

          Offset shape: :math:`(N, 2 * deformable\_groups * H_f * H_w, H_{in}, W_{in})`

          Mask shape: :math:`(N, deformable\_groups * H_f * H_w, H_{in}, W_{in})`

        - Output:

          Output shape: :math:`(N, C_{out}, H_{out}, W_{out})`

        Where

        .. math::

            H_{out}&= \\frac{(H_{in} + 2 * paddings[0] - (dilations[0] * (H_f - 1) + 1))}{strides[0]} + 1 \\\\
            W_{out}&= \\frac{(W_{in} + 2 * paddings[1] - (dilations[1] * (W_f - 1) + 1))}{strides[1]} + 1

    Args:
14197 14198
        input (Variable): The input image with [N, C, H, W] format. A Tensor with type
            float32, float64.
14199
        offset (Variable): The input coordinate offset of deformable convolution layer.
14200
            A Tensor with type float32, float64.
14201 14202 14203
        Mask (Variable, Optional): The input mask of deformable convolution layer.
            A Tensor with type float32, float64. It should be None when you use
            deformable convolution v1.
14204 14205
        num_filters(int): The number of filter. It is as same as the output
            image channel.
14206
        filter_size (int|tuple): The filter size. If filter_size is a tuple,
14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224
            it must contain two integers, (filter_size_H, filter_size_W).
            Otherwise, the filter will be a square.
        stride (int|tuple): The stride size. If stride is a tuple, it must
            contain two integers, (stride_H, stride_W). Otherwise, the
            stride_H = stride_W = stride. Default: stride = 1.
        padding (int|tuple): The padding size. If padding is a tuple, it must
            contain two integers, (padding_H, padding_W). Otherwise, the
            padding_H = padding_W = padding. Default: padding = 0.
        dilation (int|tuple): The dilation size. If dilation is a tuple, it must
            contain two integers, (dilation_H, dilation_W). Otherwise, the
            dilation_H = dilation_W = dilation. Default: dilation = 1.
        groups (int): The groups number of the deformable conv layer. According to
            grouped convolution in Alex Krizhevsky's Deep CNN paper: when group=2,
            the first half of the filters is only connected to the first half
            of the input channels, while the second half of the filters is only
            connected to the second half of the input channels. Default: groups=1.
        deformable_groups (int): The number of deformable group partitions.
            Default: deformable_groups = 1.
14225
        im2col_step (int): Maximum number of images per im2col computation;
T
tianshuo78520a 已提交
14226
            The total batch size should be devisable by this value or smaller
14227 14228 14229
            than this value; if you face out of memory problem, you can try
            to use a smaller value here.
            Default: im2col_step = 64.
14230
        param_attr (ParamAttr, Optional): The parameter attribute for learnable parameters/weights
14231 14232 14233
            of deformable conv. If it is set to None or one attribute of ParamAttr,
            deformable conv will create ParamAttr as param_attr.
            If the Initializer of the param_attr is not set, the parameter is
14234
            initialized with :math:`Normal(0.0, std)`, and the
14235
            :math:`std` is :math:`(\\frac{2.0 }{filter\_elem\_num})^{0.5}`. Default: None.
14236
        bias_attr (ParamAttr|bool, Optional): The parameter attribute for the bias of
14237 14238 14239 14240
            deformable conv layer. If it is set to False, no bias will be added
            to the output units. If it is set to None or one attribute of ParamAttr, conv2d
            will create ParamAttr as bias_attr. If the Initializer of the bias_attr
            is not set, the bias is initialized zero. Default: None.
14241 14242
        modulated (bool): Make sure which version should be used between v1 and v2, where v2 is \
            used while True. Default: True.
14243 14244
        name(str, Optional): For details, please refer to :ref:`api_guide_Name`.
                        Generally, no setting is required. Default: None.
14245 14246
    Returns:
        Variable: The tensor variable storing the deformable convolution \
14247
                  result. A Tensor with type float32, float64.
14248 14249 14250 14251 14252 14253
    Raises:
        ValueError: If the shapes of input, filter_size, stride, padding and
                    groups mismatch.
    Examples:
        .. code-block:: python

14254
          #deformable conv v2:
14255

14256
          import paddle.fluid as fluid
14257 14258
          C_in, H_in, W_in = 3, 32, 32
          filter_size, deformable_groups = 3, 1
B
Bai Yifan 已提交
14259 14260 14261
          data = fluid.data(name='data', shape=[None, C_in, H_in, W_in], dtype='float32')
          offset = fluid.data(name='offset', shape=[None, 2*deformable_groups*filter_size**2, H_in, W_in], dtype='float32')
          mask = fluid.data(name='mask', shape=[None, deformable_groups*filter_size**2, H_in, W_in], dtype='float32')
14262
          out = fluid.layers.deformable_conv(input=data, offset=offset, mask=mask,
14263
                                             num_filters=2, filter_size=filter_size, padding=1, modulated=True)
14264 14265 14266 14267

          #deformable conv v1:

          import paddle.fluid as fluid
14268 14269
          C_in, H_in, W_in = 3, 32, 32
          filter_size, deformable_groups = 3, 1
B
Bai Yifan 已提交
14270 14271
          data = fluid.data(name='data', shape=[None, C_in, H_in, W_in], dtype='float32')
          offset = fluid.data(name='offset', shape=[None, 2*deformable_groups*filter_size**2, H_in, W_in], dtype='float32')
14272
          out = fluid.layers.deformable_conv(input=data, offset=offset, mask=None,
14273
                                             num_filters=2, filter_size=filter_size, padding=1, modulated=False)
14274 14275
    """

14276 14277 14278 14279 14280 14281
    check_variable_and_dtype(input, "input", ['float32', 'float64'],
                             'deformable_conv')
    check_variable_and_dtype(offset, "offset", ['float32', 'float64'],
                             'deformable_conv')
    check_type(mask, 'mask', (Variable, type(None)), 'deformable_conv')

14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320
    num_channels = input.shape[1]
    assert param_attr is not False, "param_attr should not be False here."

    helper = LayerHelper('deformable_conv', **locals())
    dtype = helper.input_dtype()

    if not isinstance(input, Variable):
        raise TypeError("Input of deformable_conv must be Variable")
    if not isinstance(offset, Variable):
        raise TypeError("Input Offset of deformable_conv must be Variable")

    if groups is None:
        num_filter_channels = num_channels
    else:
        if num_channels % groups != 0:
            raise ValueError("num_channels must be divisible by groups.")
        num_filter_channels = num_channels // groups

    filter_size = utils.convert_to_list(filter_size, 2, 'filter_size')
    stride = utils.convert_to_list(stride, 2, 'stride')
    padding = utils.convert_to_list(padding, 2, 'padding')
    dilation = utils.convert_to_list(dilation, 2, 'dilation')

    input_shape = input.shape
    filter_shape = [num_filters, int(num_filter_channels)] + filter_size

    def _get_default_param_initializer():
        filter_elem_num = filter_size[0] * filter_size[1] * num_channels
        std = (2.0 / filter_elem_num)**0.5
        return Normal(0.0, std, 0)

    filter_param = helper.create_parameter(
        attr=helper.param_attr,
        shape=filter_shape,
        dtype=dtype,
        default_initializer=_get_default_param_initializer())

    pre_bias = helper.create_variable_for_type_inference(dtype)

14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356
    if modulated:
        helper.append_op(
            type='deformable_conv',
            inputs={
                'Input': input,
                'Filter': filter_param,
                'Offset': offset,
                'Mask': mask,
            },
            outputs={"Output": pre_bias},
            attrs={
                'strides': stride,
                'paddings': padding,
                'dilations': dilation,
                'groups': groups,
                'deformable_groups': deformable_groups,
                'im2col_step': im2col_step,
            })

    else:
        helper.append_op(
            type='deformable_conv_v1',
            inputs={
                'Input': input,
                'Filter': filter_param,
                'Offset': offset,
            },
            outputs={"Output": pre_bias},
            attrs={
                'strides': stride,
                'paddings': padding,
                'dilations': dilation,
                'groups': groups,
                'deformable_groups': deformable_groups,
                'im2col_step': im2col_step,
            })
14357 14358 14359

    output = helper.append_bias_op(pre_bias, dim_start=1, dim_end=2)
    return output
14360 14361 14362 14363


def unfold(x, kernel_sizes, strides=1, paddings=0, dilations=1, name=None):
    """
14364 14365 14366
    :alias_main: paddle.nn.functional.unfold
	:alias: paddle.nn.functional.unfold,paddle.nn.functional.common.unfold
	:old_api: paddle.fluid.layers.unfold
14367

S
SunGaofeng 已提交
14368
    This op returns a col buffer of sliding local blocks of input x, also known
14369
    as im2col for batched 2D image tensors. For each block under the convolution filter,
T
tianshuo78520a 已提交
14370
    all element will be rearranged as a column. While the convolution filter sliding over
14371 14372
    the input feature map, a series of such columns will be formed.

S
SunGaofeng 已提交
14373
    For each input :math:`x` with shape [N, C, H, W], the output shape [N, Cout, Lout]
14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390
    can be calculated as following.

    .. math::

        dkernel[0] &= dilations[0] \\times (kernel\_sizes[0] - 1) + 1

        dkernel[1] &= dilations[1] \\times (kernel\_sizes[1] - 1) + 1

        hout &= \\frac{H + paddings[0] + paddings[2] - dkernel[0]}{strides[0]} + 1

        wout &= \\frac{W + paddings[1] + paddings[3] - dkernel[1]}{strides[1]} + 1

        Cout &= C \\times kernel\_sizes[0] \\times kernel\_sizes[1]

        Lout &= hout \\times wout


S
SunGaofeng 已提交
14391
    Parameters:
14392
        x(Varaible):              4-D Tensor, input tensor of format [N, C, H, W],
S
SunGaofeng 已提交
14393
                                  data type can be float32 or float64
14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405
        kernel_sizes(int|list):   The size of convolution kernel, should be [k_h, k_w]
                                  or an integer k treated as [k, k].
        strides(int|list):        The strides, should be [stride_h, stride_w]
                                  or an integer stride treated as [sride, stride].
                                  For default, strides will be [1, 1].
        paddings(int|list):       The paddings of each dimension, should be
                                  [padding_top, padding_left, padding_bottom, padding_right]
                                  or [padding_h, padding_w] or an integer padding.
                                  If [padding_h, padding_w] was given, it will expanded to
                                  [padding_h, padding_w, padding_h, padding_w]. If an integer
                                  padding was given, [padding, padding, padding, padding] will
                                  be used. For default, paddings will be [0, 0, 0, 0]
T
tianshuo78520a 已提交
14406
        dilations(int|list):      the dilations of convolution kernel, should be
T
tianshuo78520a 已提交
14407
                                  [dilation_h, dilation_w], or an integer dilation treated as
14408
                                  [dilation, dilation]. For default, it will be [1, 1].
14409 14410
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
14411
                             For more information, please refer to :ref:`api_guide_Name`
14412

14413

14414
    Returns:
14415 14416 14417 14418
        The tensor variable corresponding to the sliding local blocks.
        The output shape is [N, Cout, Lout] as decriabled above.
        Cout is the  total number of values within each block,
        and Lout is the total number of such blocks.
S
SunGaofeng 已提交
14419 14420 14421 14422
        The data type of output is the same as the input :math:`x`

    Return Type:
        Variable
14423 14424 14425 14426 14427 14428

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid
S
SunGaofeng 已提交
14429
            x = fluid.data(name = 'data', shape = [100, 3, 224, 224], dtype = 'float32')
14430 14431 14432 14433 14434
            y = fluid.layers.unfold(x, [3, 3], 1, 1, 1)
    """

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

14435 14436
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'unfold')

14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485
    assert len(x.shape) == 4, \
            "input should be the format of [N, C, H, W]"

    if isinstance(kernel_sizes, int):
        kernel_sizes = [kernel_sizes, kernel_sizes]
    else:
        assert isinstance(kernel_sizes, list) and (len(kernel_sizes) == 2), \
            "kernel_sizes should either be an integer or a list of two integers"

    if isinstance(strides, int):
        strides = [strides, strides]
    else:
        assert isinstance(strides, list) and (len(strides) == 2), \
            "strides should either be an integer or a list of two integers"

    if isinstance(dilations, int):
        dilations = [dilations, dilations]
    else:
        assert isinstance(dilations, list) and (len(dilations) == 2), \
            "dilations should either be an integer or a list of two integers"

    if isinstance(paddings, int):
        paddings = [paddings] * 4
    elif isinstance(paddings, list):
        if len(paddings) == 2:
            paddings = paddings * 2
        elif len(paddings) == 4:
            pass
        else:
            raise ValueError(
                "paddings should either be an integer or a list of 2 or 4 integers"
            )
    else:
        raise ValueError(
            "Unexpected type of paddings, it should be either an integer or a list"
            "of 2 or 4 integers")

    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(
        type="unfold",
        inputs={"X": x},
        outputs={"Y": out},
        attrs={
            "kernel_sizes": kernel_sizes,
            "strides": strides,
            "paddings": paddings,
            "dilations": dilations
        })
    return out
C
cjt222 已提交
14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501


def deformable_roi_pooling(input,
                           rois,
                           trans,
                           no_trans=False,
                           spatial_scale=1.0,
                           group_size=[1, 1],
                           pooled_height=1,
                           pooled_width=1,
                           part_size=None,
                           sample_per_part=1,
                           trans_std=0.1,
                           position_sensitive=False,
                           name=None):
    """
14502 14503 14504 14505
    :alias_main: paddle.nn.functional.deformable_roi_pooling
	:alias: paddle.nn.functional.deformable_roi_pooling,paddle.nn.functional.vision.deformable_roi_pooling
	:old_api: paddle.fluid.layers.deformable_roi_pooling

14506
    Deformable ROI Pooling Layer
14507

14508
    Performs deformable region-of-interest pooling on inputs. As described
14509
    in `Deformable Convolutional Networks <https://arxiv.org/abs/1703.06211>`_, it will get offset for each bin after
14510
    roi pooling so that pooling at correct region. Batch_size will change to the number of region bounding boxes after deformable_roi_pooling.
14511

14512
    The operation has three steps:
14513

14514
    1. Dividing each region proposal into equal-sized sections with the pooled_width and pooled_height.
14515

14516 14517
    2. Add offset to pixel in ROI to get new location and the new value which are computed directly through
       bilinear interpolation with four nearest pixel.
14518

14519
    3. Sample several points in each bin to get average values as output.
14520 14521


14522 14523 14524 14525 14526 14527 14528 14529 14530
    Args:
        input (Variable):The input of deformable roi pooling and it is tensor which value type is float32. The shape of input is
                         [N, C, H, W]. Where N is batch size, C is number of input channels,
                         H is height of the feature, and W is the width of the feature.
        rois (Variable): ROIs (Regions of Interest) with type float32 to pool over. It should be
                         a 2-D LoDTensor of shape (num_rois, 4), and the lod level
                         is 1. Given as [[x1, y1, x2, y2], ...], (x1, y1) is
                         the top left coordinates, and (x2, y2) is the bottom
                         right coordinates, which value type is float32.
14531 14532 14533
        trans (Variable): Offset of features on ROIs while pooling which value type is float32. The format is [N, C, H, W], where
                          N is number of ROIs, C is number of channels, which indicate the offset distance
                          in the x and y directions, H is pooled height, and W is pooled width.
14534 14535 14536 14537
        no_trans (bool): Whether to add offset to get new value or not while roi pooling, which value with type bool is True or False.
                         If value is True, no offset will be added in operation. Default: False.
        spatial_scale (float): Ratio of input feature map height (or width) to raw image height (or width), which value type is float32.
                         Equals the reciprocal of total stride in convolutional layers, Default: 1.0.
14538
        group_size (list|tuple): The number of groups which input channels are divided and the input is list or tuple, which value type is int32. (eg.number of input channels
14539
                          is k1 * k2 * (C + 1), which k1 and k2 are group width and height and C+1 is number of output
T
tianshuo78520a 已提交
14540
                          channels.) eg.(4, 6), which 4 is height of group and 6 is width of group. Default: [1, 1].
14541 14542 14543 14544 14545 14546 14547
        pooled_height (int): The pooled output height which value type is int32. Default: 1.
        pooled_width (int): The pooled output width which value type is int32. Default: 1.
        part_size (list|tuple): The height and width of offset which values in list or tuple is int32, eg.(4, 6), which height is 4 and width is 6, and values always equal to pooled_height \
                         and pooled_width. Default: if None, default value is [pooled_height, pooled_width].
        sample_per_part (int): The number of samples in each bin which value type is int32. If value is bigger, it will consume more performance. Default: 1.
        trans_std (float): Coefficient of offset which value type is float32. It controls weight of offset. Default: 0.1.
        position_sensitive (bool): Whether to choose deformable psroi pooling mode or not, and value type is bool(True or False). If value is False, input dimension equals to output dimension. \
T
tianshuo78520a 已提交
14548
                                   If value is True, input dimension should be output dimension * pooled_height * pooled_width. Default: False.
14549 14550 14551 14552
        name (str|None): Name of layer. Default: None.
    Returns:
        Variable: Output of deformable roi pooling is that, if position sensitive is False, input dimension equals to output dimension. If position sensitive is True,\
                  input dimension should be the result of output dimension divided by pooled height and pooled width.
C
cjt222 已提交
14553 14554 14555 14556

    Examples:
      .. code-block:: python

14557 14558
        # position_sensitive=True
        import paddle.fluid as fluid
C
chengjuntao 已提交
14559
        input = fluid.data(name="input",
14560 14561
                           shape=[2, 192, 64, 64],
                           dtype='float32')
C
chengjuntao 已提交
14562 14563
        rois = fluid.data(name="rois",
                          shape=[-1, 4],
14564
                          dtype='float32',
C
chengjuntao 已提交
14565 14566
                          lod_level=1)
        trans = fluid.data(name="trans",
14567 14568 14569 14570 14571
                           shape=[2, 384, 64, 64],
                           dtype='float32')
        x = fluid.layers.deformable_roi_pooling(input=input,
                                                rois=rois,
                                                trans=trans,
C
chengjuntao 已提交
14572
                                                no_trans=False,
14573
                                                spatial_scale=1.0,
C
chengjuntao 已提交
14574 14575 14576 14577
                                                group_size=(1, 1),
                                                pooled_height=8,
                                                pooled_width=8,
                                                part_size=(8, 8),
14578
                                                sample_per_part=4,
C
chengjuntao 已提交
14579 14580
                                                trans_std=0.1,
                                                position_sensitive=True)
14581

14582
        # position_sensitive=False
14583
        import paddle.fluid as fluid
C
chengjuntao 已提交
14584
        input = fluid.data(name="input",
14585 14586
                           shape=[2, 192, 64, 64],
                           dtype='float32')
C
chengjuntao 已提交
14587 14588
        rois = fluid.data(name="rois",
                          shape=[-1, 4],
14589
                          dtype='float32',
C
chengjuntao 已提交
14590 14591
                          lod_level=1)
        trans = fluid.data(name="trans",
14592 14593 14594 14595 14596
                           shape=[2, 384, 64, 64],
                           dtype='float32')
        x = fluid.layers.deformable_roi_pooling(input=input,
                                                rois=rois,
                                                trans=trans,
C
chengjuntao 已提交
14597
                                                no_trans=False,
14598
                                                spatial_scale=1.0,
C
chengjuntao 已提交
14599 14600 14601 14602
                                                group_size=(1, 1),
                                                pooled_height=8,
                                                pooled_width=8,
                                                part_size=(8, 8),
14603
                                                sample_per_part=4,
C
chengjuntao 已提交
14604 14605
                                                trans_std=0.1,
                                                position_sensitive=False)
C
cjt222 已提交
14606 14607
    """

14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'deformable_roi_pooling')
    check_variable_and_dtype(rois, 'rois', ['float32', 'float64'],
                             'deformable_roi_pooling')
    check_variable_and_dtype(trans, 'trans', ['float32', 'float64'],
                             'deformable_roi_pooling')
    check_type(group_size, 'group_size', (list, tuple),
               'deformable_roi_pooling')
    if part_size is not None:
        check_type(part_size, 'part_size', (list, tuple),
                   'deformable_roi_pooling')

C
cjt222 已提交
14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654
    input_channels = input.shape[1]
    if position_sensitive == False:
        output_channels = input_channels
    else:
        output_channels = input_channels / pooled_height / pooled_width

    if part_size is None:
        part_height = pooled_height
        part_width = pooled_width
        part_size = [part_height, part_width]
    part_size = utils.convert_to_list(part_size, 2, 'part_size')
    group_size = utils.convert_to_list(group_size, 2, 'group_size')
    helper = LayerHelper('deformable_psroi_pooling', **locals())
    dtype = helper.input_dtype()
    output = helper.create_variable_for_type_inference(dtype)
    top_count = helper.create_variable_for_type_inference(dtype='int32')
    helper.append_op(
        type="deformable_psroi_pooling",
        inputs={"Input": input,
                "ROIs": rois,
                "Trans": trans},
        outputs={"Output": output,
                 "TopCount": top_count},
        attrs={
            "no_trans": no_trans,
            "spatial_scale": spatial_scale,
            "output_dim": output_channels,
            "group_size": group_size,
            "pooled_height": pooled_height,
            "pooled_width": pooled_width,
            "part_size": part_size,
            "sample_per_part": sample_per_part,
            "trans_std": trans_std
        })
    return output
14655 14656 14657 14658


def shard_index(input, index_num, nshards, shard_id, ignore_value=-1):
    """
14659
    This operator recomputes the `input` indices according to the offset of the
14660 14661 14662 14663
    shard. The length of the indices is evenly divided into N shards, and if
    the `shard_id` matches the shard with the input index inside, the index is
    recomputed on the basis of the shard offset, elsewise it is set to
    `ignore_value`. The detail is as follows:
14664 14665
    ::

14666 14667
        shard_size = (index_num + nshards - 1) // nshards
        y = x % shard_size if x // shard_size == shard_id else ignore_value
14668

14669 14670
    NOTE: If the length of indices cannot be evely divided by the shard number,
    the size of the last shard will be less than the calculated `shard_size`
14671 14672

    Examples:
14673
    ::
14674

14675
        Input:
14676 14677
          X.shape = [4, 1]
          X.data = [[1], [6], [12], [19]]
14678 14679 14680
          index_num = 20
          nshards = 2
          ignore_value = -1
14681

14682
        if shard_id == 0, we get:
14683 14684
          Out.shape = [4, 1]
          Out.data = [[1], [6], [-1], [-1]]
14685

14686
        if shard_id == 1, we get:
14687 14688
          Out.shape = [4, 1]
          Out.data = [[-1], [-1], [2], [9]]
14689

14690
    Args:
14691
        - **input** (Variable): Input indices, last dimension must be 1.
T
tianshuo78520a 已提交
14692
        - **index_num** (scalar): An integer defining the range of the index.
14693 14694
        - **nshards** (scalar): The number of shards
        - **shard_id** (scalar): The index of the current shard
T
tianshuo78520a 已提交
14695
        - **ignore_value** (scalar): An integer value out of sharded index range
14696 14697

    Returns:
14698
        Variable: The sharded index of input.
14699 14700 14701 14702 14703

    Examples:
        .. code-block:: python

            import paddle.fluid as fluid
14704 14705
            batch_size = 32
            label = fluid.data(name="label", shape=[batch_size, 1], dtype="int64")
14706 14707 14708 14709 14710
            shard_label = fluid.layers.shard_index(input=label,
                                                   index_num=20,
                                                   nshards=2,
                                                   shard_id=0)
    """
14711
    check_variable_and_dtype(input, 'input', ['int64'], 'shard_index')
14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730
    op_type = 'shard_index'
    helper = LayerHelper(op_type, **locals())
    if shard_id < 0 or shard_id >= nshards:
        raise ValueError('The shard_id(%d) should be in [0, %d)' %
                         (shard_id, nshards))

    out = helper.create_variable_for_type_inference(dtype=input.dtype)
    helper.append_op(
        type=op_type,
        inputs={'X': [input]},
        outputs={'Out': out},
        attrs={
            'index_num': index_num,
            'nshards': nshards,
            'shard_id': shard_id,
            'ignore_value': ignore_value
        },
        stop_gradient=True)
    return out
H
huangjun12 已提交
14731 14732 14733 14734 14735


@templatedoc()
def hard_swish(x, threshold=6.0, scale=6.0, offset=3.0, name=None):
    """
14736 14737 14738 14739
    :alias_main: paddle.nn.functional.hard_swish
	:alias: paddle.nn.functional.hard_swish,paddle.nn.functional.activation.hard_swish
	:old_api: paddle.fluid.layers.hard_swish

14740 14741 14742
    This operator implements the hard_swish activation function.
    Hard_swish is proposed in MobileNetV3, and performs better in computational stability and efficiency compared to swish function.
    For more details please refer to: https://arxiv.org/pdf/1905.02244.pdf
H
huangjun12 已提交
14743

14744
    The formula is as follows:
H
huangjun12 已提交
14745

14746
    .. math::
H
huangjun12 已提交
14747

14748
        out = \\frac{x * (min(max(0, x+offset), threshold))}{scale}
H
huangjun12 已提交
14749

14750 14751 14752 14753 14754 14755 14756 14757 14758
    In the above equation:

    ``threshold`` and ``scale`` should be positive, ``offset`` can be positive or negative. It is recommended to use default parameters.

    Args:
        x (Variable): Input feature, multi-dimensional Tensor. The data type should be float32 or float64.
        threshold (float, optional): The threshold in Relu function. Default: 6.0
        scale (float, optional): The scale factor. Default: 6.0
        offset (float, optional): The offset factor. Default: 3.0
14759 14760
        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`

14761 14762
    Returns:
        Variable: The output tensor with the same shape and data type as input.
14763 14764


14765
    Examples:
14766

14767
    .. code-block:: python
14768

14769 14770
        import paddle.fluid as fluid
        import numpy as np
14771

14772
        DATATYPE='float32'
14773

14774
        x_data = np.array([i for i in range(1,5)]).reshape([1,1,4]).astype(DATATYPE)
14775

14776 14777
        x = fluid.data(name="x", shape=[None,1,4], dtype=DATATYPE)
        y = fluid.layers.hard_swish(x)
14778

14779 14780 14781 14782 14783
        place = fluid.CPUPlace()
        #place = fluid.CUDAPlace(0)
        exe = fluid.Executor(place)
        out, = exe.run(feed={'x':x_data}, fetch_list=[y.name])
        print(out)  # [[0.66666667, 1.66666667,3., 4.]]
H
huangjun12 已提交
14784
    """
14785 14786 14787
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'],
                             'hard_swish')

H
huangjun12 已提交
14788 14789 14790 14791 14792 14793 14794 14795 14796 14797
    helper = LayerHelper('hard_swish', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(
        type='hard_swish',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'threshold': threshold,
               'scale': scale,
               'offset': offset})
    return out
R
ruri 已提交
14798 14799


K
Kaipeng Deng 已提交
14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874
@templatedoc()
def mish(x, threshold=20, name=None):
    """
    This operator implements the mish activation function.
    Refer to `Mish: A Self Regularized Non-Monotonic Neural
    Activation Function <https://arxiv.org/abs/1908.08681>`_


    The formula is as follows if :attr:`threshold` is :code:`None` or negative:

    .. math::

        out = x * \\tanh(\\ln(1 + e^{x}))

    The formula is as follows if :attr:`threshold` is set as positive value:

    .. math::

	out = \\begin{cases}
		x \\ast \\tanh(x), \\text{if } x > \\text{threshold} \\\\
		x \\ast \\tanh(e^{x}), \\text{if } x < -\\text{threshold} \\\\
		x \\ast \\tanh(\\ln(1 + e^{x})),  \\text{otherwise}
	      \\end{cases}

    Args:
        x (Variable): Input feature, multi-dimensional Tensor. The data type
                      should be float16, float32 or float64.
        threshold (float|None): threshold for softplus in Mish operator.
                Approximate value of softplus will be used if absolute value
                of input is greater than :attr:threshold and :attr:threshold
                is set as positive value. For none or negative threshold,
                approximate value is not used. Default 20.
        name (str, optional): The default value is None. Normally there is no
                need for user to set this property. For more information, please
                refer to :ref:`api_guide_Name`

    Returns:
        Variable: The output tensor with the same shape and data type as input.


    Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        DATATYPE='float32'

        x_data = np.array([i for i in range(1,5)]).reshape([1,1,4]).astype(DATATYPE)

        x = fluid.data(name="x", shape=[None,1,4], dtype=DATATYPE)
        y = fluid.layers.mish(x)

        place = fluid.CPUPlace()
        # place = fluid.CUDAPlace(0)
        exe = fluid.Executor(place)
        out, = exe.run(feed={'x':x_data}, fetch_list=[y.name])
        print(out)  # [[0.66666667, 1.66666667, 3., 4.]]
    """
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'mish')
    check_type(threshold, 'threshold', (float, int), 'mish')
    assert threshold > 0, "threshold of mish should be greater than 0, " \
                          "but got {}".format(threshold)

    helper = LayerHelper('mish', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(
        type='mish',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'threshold': threshold or -1})
    return out


G
Guo Sheng 已提交
14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900
def gather_tree(ids, parents):
    """
    To be used after beam search. After beam search, we get selected ids at
    each time step and the corresponding parents in the search tree. Both ids
    and parents have the layout :attr:`[max_time, batch_size, beam_size]`. Then
    :attr:`gather_tree` is used to backtrace from the last time step and
    generate the full sequences by collecting selected ids.

    Here is an example:

    .. code-block:: text

            Given:
                ids = [[[2 2]
                        [6 1]]
                       [[3 9]
                        [6 1]]
                       [[0 1]
                        [9 0]]]
                parents = [[[0 0]
                            [1 1]]
                           [[1 0]
                            [1 0]]
                           [[0 0]
                            [0 1]]]

14901 14902
            Then:
                gather_tree(ids, parents)
G
Guo Sheng 已提交
14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938
                         = [[[2 2]
                             [1 6]]
                            [[3 3]
                             [6 1]]
                            [[0 1]
                             [9 0]]]

    Args:
        ids(Variable): A Tensor with shape :attr:`[length, batch_size, beam_size]`
            and data type :attr:`int32` or :attr:`int64`. It contains the selected
            ids of all time steps.
        parents(Variable): A Tensor with the same shape and data type as :attr:`ids`,
            It contains the parents corresponding to selected ids when searching
            among beams.

    Returns:
        Variable: A Tensor with the same shape and data type as :attr:`ids`. \
            It contains the full sequences. The sequences are collected from \
            :attr:`ids` by backtracing according to :attr:`parents`.

    Examples:
        .. code-block:: python

            import paddle.fluid as fluid

            ids = fluid.layers.data(name='ids',
                                    shape=[5, 2, 2],
                                    dtype='int64',
                                    append_batch_size=False)
            parents = fluid.layers.data(name='parents',
                                        shape=[5, 2, 2],
                                        dtype='int64',
                                        append_batch_size=False)
            final_sequences = fluid.layers.gather_tree(ids, parents)
    """
    helper = LayerHelper('gather_tree', **locals())
X
Xing Wu 已提交
14939 14940 14941
    check_variable_and_dtype(ids, 'ids', ['int32', 'int64'], 'gather_tree')
    check_variable_and_dtype(parents, 'parents', ['int32', 'int64'],
                             'gather_tree')
G
Guo Sheng 已提交
14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952
    out = helper.create_variable_for_type_inference(dtype=ids.dtype)

    helper.append_op(
        type="gather_tree",
        inputs={"Ids": ids,
                "Parents": parents},
        outputs={"Out": out})

    return out


14953
@templatedoc()
14954 14955
def uniform_random(shape, dtype='float32', min=-1.0, max=1.0, seed=0,
                   name=None):
14956
    """
14957 14958
    This OP returns a Tensor filled with random values sampled from a uniform
    distribution in the range [``min``, ``max``), with ``shape`` and ``dtype``.
14959 14960 14961

    Examples:
    ::
14962

14963 14964
        Input:
          shape = [1, 2]
14965

14966 14967 14968 14969
        Output:
          result=[[0.8505902, 0.8397286]]

    Args:
14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982
        shape(list|tuple|Tensor): The shape of the output Tensor. If ``shape``
            is a list or tuple, the elements of it should be integers or Tensors
            (with the shape [1], and the data type int32 or int64). If ``shape``
            is a Tensor, it should be a 1-D Tensor(with the data type int32 or
            int64).
        dtype(str|np.dtype|core.VarDesc.VarType, optional): The data type of
            the output Tensor. Supported data types: float32, float64.
            Default is float32.
        min(float|int, optional): The lower bound on the range of random values
            to generate, ``min`` is included in the range. Default is -1.0.
        max(float|int, optional): The upper bound on the range of random values
            to generate, ``max`` is excluded in the range. Default is 1.0.
        seed(int, optional): Random seed used for generating samples. 0 means
14983 14984
            use a seed generated by the system. Note that if seed is not 0,
            this operator will always generate the same random numbers every
14985
            time. Default is 0.
14986 14987 14988
        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`.
14989

14990
    Returns:
14991 14992
        Tensor: A Tensor filled with random values sampled from a uniform
        distribution in the range [``min``, ``max``), with ``shape`` and ``dtype``.
14993

14994
    Raises:
14995 14996
        TypeError: If ``shape`` is not list, tuple, Tensor.
        TypeError: If ``dtype`` is not float32, float64.
14997

14998 14999 15000 15001 15002 15003
    Examples:
        .. code-block:: python

            import paddle.fluid as fluid

            # example 1:
15004
            # attr shape is a list which doesn't contain Tensor.
15005
            result_1 = fluid.layers.uniform_random(shape=[3, 4])
15006 15007 15008
            # [[ 0.84524226,  0.6921872,   0.56528175,  0.71690357],
            #  [-0.34646994, -0.45116323, -0.09902662, -0.11397249],
            #  [ 0.433519,    0.39483607, -0.8660099,   0.83664286]]
15009 15010

            # example 2:
15011 15012 15013
            # attr shape is a list which contains Tensor.
            dim_1 = fluid.layers.fill_constant([1], "int64", 2)
            dim_2 = fluid.layers.fill_constant([1], "int32", 3)
15014
            result_2 = fluid.layers.uniform_random(shape=[dim_1, dim_2])
15015 15016
            # [[-0.9951253,   0.30757582, 0.9899647 ],
            #  [ 0.5864527,   0.6607096,  -0.8886161 ]]
15017 15018

            # example 3:
15019
            # attr shape is a Tensor, the data type must be int64 or int32.
15020
            var_shape = fluid.data(name='var_shape', shape=[2], dtype="int64")
15021
            result_3 = fluid.layers.uniform_random(var_shape)
15022 15023 15024 15025
            # if var_shape's value is [2, 3]
            # result_3 is:
            # [[-0.8517412,  -0.4006908,   0.2551912 ],
            #  [ 0.3364414,   0.36278176, -0.16085452]]
15026

15027 15028 15029
    """
    if not isinstance(dtype, core.VarDesc.VarType):
        dtype = convert_np_dtype_to_dtype_(dtype)
15030

15031 15032 15033 15034 15035
    if in_dygraph_mode():
        shape = utils._convert_shape_to_list(shape)
        return core.ops.uniform_random('shape', shape, 'min',
                                       float(min), 'max',
                                       float(max), 'seed', seed, 'dtype', dtype)
15036

15037 15038
    check_type(shape, 'shape', (list, tuple, Variable), 'uniform_random/rand')
    check_dtype(dtype, 'dtype', ('float32', 'float64'), 'uniform_random/rand')
15039 15040

    inputs = dict()
15041
    attrs = {'seed': seed, 'min': min, 'max': max, 'dtype': dtype}
15042
    utils._get_shape_tensor_inputs(
15043
        inputs=inputs, attrs=attrs, shape=shape, op_type='uniform_random/rand')
15044

15045
    helper = LayerHelper("uniform_random", **locals())
15046 15047 15048 15049
    out = helper.create_variable_for_type_inference(dtype)
    helper.append_op(
        type="uniform_random", inputs=inputs, attrs=attrs,
        outputs={"Out": out})
15050
    return out
myq406450149's avatar
myq406450149 已提交
15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104


def unbind(input, axis=0):
    """
    Removes a tensor dimension, then split the input tensor into multiple sub-Tensors.
    Args:
        input (Variable): The input variable which is an N-D Tensor, data type being float32, float64, int32 or int64.
       
        axis (int32|int64, optional): A scalar with type ``int32|int64`` shape [1]. The dimension along which to unbind. If :math:`axis < 0`, the
            dimension to unbind along is :math:`rank(input) + axis`. Default is 0.
    Returns:
        list(Variable): The list of segmented Tensor variables.

    Example:
        .. code-block:: python
            import paddle
            # input is a variable which shape is [3, 4, 5]
            input = paddle.fluid.data(
                 name="input", shape=[3, 4, 5], dtype="float32")
            [x0, x1, x2] = paddle.tensor.unbind(input, axis=0)
            # x0.shape [4, 5]
            # x1.shape [4, 5]
            # x2.shape [4, 5]
            [x0, x1, x2, x3] = paddle.tensor.unbind(input, axis=1)
            # x0.shape [3, 5]
            # x1.shape [3, 5]
            # x2.shape [3, 5]
            # x3.shape [3, 5]

    """
    helper = LayerHelper("unbind", **locals())
    check_type(input, 'input', (Variable), 'unbind')
    dtype = helper.input_dtype()
    check_dtype(dtype, 'unbind', ['float32', 'float64', 'int32', 'int64'],
                'unbind')
    if not isinstance(axis, (int)):
        raise TypeError("The type of 'axis'  must be int, but received %s." %
                        (type(axis)))
    if isinstance(axis, np.generic):
        axis = np.asscalar(axis)
    input_shape = input.shape
    axis_ = axis if axis >= 0 else len(input_shape) + axis
    num = input_shape[axis_]
    outs = [
        helper.create_variable_for_type_inference(dtype=helper.input_dtype())
        for i in range(num)
    ]

    helper.append_op(
        type="unbind",
        inputs={"X": input},
        outputs={"Out": outs},
        attrs={"axis": axis})
    return outs