nn.py 587.0 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, _varbase_creator, static_only
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 ...utils import deprecated
39
from ..data_feeder import convert_dtype, check_variable_and_dtype, check_type, check_dtype
40
import paddle
41
from paddle.utils import deprecated
Y
Yu Yang 已提交
42 43

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


197 198 199 200 201 202 203 204
@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)
205
    out = op(x, y, 'axis', axis, 'use_mkldnn', use_mkldnn)
206

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


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

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

223 224 225
    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,
226
    which represents a fully connected weight matrix from each input unit to
227 228 229 230
    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`
231
    is not None, a bias variable will be created and added to the output.
232
    Finally, if :attr:`act` is not None, it will be applied to the output as well.
C
caoying03 已提交
233

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

236 237 238 239
    .. math::

        Out = Act({XW + b})

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

    .. math::

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

    In the above equation:

248 249 250
    * :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 已提交
251
    * :math:`b`: The bias parameter created by this layer (if needed).
252
    * :math:`Act`: The activation function.
253
    * :math:`Out`: The output Tensor.
254 255 256

    .. code-block:: text

257 258 259 260 261 262 263 264 265 266 267 268 269 270
        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:
271 272 273 274 275 276 277 278 279 280 281 282 283
            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 已提交
284
    Args:
285 286 287
        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 已提交
288
        size(int): The number of output units in this layer, which also means the feature size of output
289 290
            Tensor(or LoDTensor).
        num_flatten_dims (int): The fc layer can accept an input Tensor with more than
R
ranqiu 已提交
291
            two dimensions. If this happens, the multidimensional tensor will first be flattened
292 293
            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 已提交
294
            dimensions will be flatten to form the first dimension of the final matrix (height of
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
            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.
310 311

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

    Examples:
        .. code-block:: python

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

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

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

    if len(mul_results) == 1:
        pre_bias = mul_results[0]
359
    else:
X
Xin Pan 已提交
360
        pre_bias = helper.create_variable_for_type_inference(dtype)
361
        helper.append_op(
362 363 364
            type="sum",
            inputs={"X": mul_results},
            outputs={"Out": pre_bias},
X
Xin Pan 已提交
365
            attrs={"use_mkldnn": False})
366 367 368 369
    # 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 已提交
370 371


T
tangwei12 已提交
372
@deprecated(since="2.0.0", update_to="paddle.nn.functional.embedding")
373 374 375
def embedding(input,
              size,
              is_sparse=False,
376
              is_distributed=False,
377 378 379
              padding_idx=None,
              param_attr=None,
              dtype='float32'):
380
    r"""
381
    :api_attr: Static Graph
382

383 384 385 386 387 388 389 390 391 392 393 394
    **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.

395
    **Note:** The id in :attr:`input` must satisfy :math:`0 =< id < size[0]` ,
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
    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]],
413

414 415 416 417
                        [[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.
418

419
        Case 2:
420

421 422 423 424 425 426 427 428 429 430 431 432 433 434
        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 已提交
435 436

    Args:
437 438 439 440 441 442
        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
443
            affects the performance of the backwards gradient update. It is recommended to set
444
            True because sparse update is faster. But some optimizer does not support sparse update,
445
            such as :ref:`api_fluid_optimizer_AdadeltaOptimizer` , :ref:`api_fluid_optimizer_AdamaxOptimizer` ,
446 447 448 449 450
            :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.
451
        padding_idx(int|long|None): padding_idx needs to be in the interval [-vocab_size, vocab_size).
452 453 454 455 456 457
            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,
458
            user-defined or pre-trained word vectors can be loaded with the :attr:`param_attr` parameter.
459
            The local word vector needs to be transformed into numpy format, and the shape of local word
T
tianshuo78520a 已提交
460
            vector should be consistent with :attr:`size` . Then :ref:`api_fluid_initializer_NumpyArrayInitializer`
461 462 463
            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 已提交
464

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

468 469
    Examples:
        .. code-block:: python
Y
Yu Yang 已提交
470

B
bdzhuxiaoning 已提交
471
          import paddle.fluid as fluid
472
          import numpy as np
473 474 475
          import paddle
          paddle.enable_static()
          
476 477
          data = fluid.data(name='x', shape=[None, 1], dtype='int64')

T
tianshuo78520a 已提交
478
          # example 1
479 480 481 482 483 484 485 486 487
          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)
488
          emb_2 = fluid.layers.embedding(input=data, size=(128, 100), param_attr=w_param_attrs, dtype='float32')
Y
Yu Yang 已提交
489 490 491
    """

    helper = LayerHelper('embedding', **locals())
492 493
    check_variable_and_dtype(input, 'input', ['int64'],
                             'fluid.layers.embedding')
494 495
    check_dtype(dtype, 'dtype', ['float16', 'float32', 'float64'],
                'fluid.layers.embedding')
496 497 498 499 500 501 502 503 504

    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 已提交
505 506
    w = helper.create_parameter(
        attr=helper.param_attr, shape=size, dtype=dtype, is_bias=False)
X
Xin Pan 已提交
507
    tmp = helper.create_variable_for_type_inference(dtype)
508 509
    padding_idx = -1 if padding_idx is None else padding_idx if padding_idx >= 0 else (
        size[0] + padding_idx)
Y
Yu Yang 已提交
510 511 512 513 514
    helper.append_op(
        type='lookup_table',
        inputs={'Ids': input,
                'W': w},
        outputs={'Out': tmp},
515 516 517
        attrs={
            'is_sparse': is_sparse,
            'is_distributed': is_distributed,
Q
Qiao Longfei 已提交
518
            'remote_prefetch': remote_prefetch,
519 520
            'padding_idx': padding_idx
        })
Y
Yu Yang 已提交
521 522 523
    return tmp


524 525 526 527 528 529 530 531 532
def _pull_sparse(input,
                 size,
                 table_id,
                 accessor_class,
                 name="embedding",
                 ctr_label_name="",
                 padding_id=0,
                 dtype='float32',
                 scale_sparse_grad=True):
533
    r"""
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
    **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):
604
    r"""
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 659 660 661 662 663 664 665
    **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 已提交
666
def _pull_box_sparse(input, size, dtype='float32'):
667
    r"""
H
hutuxian 已提交
668 669 670 671 672 673 674
    **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:
675
        input(Variable|list of Variable): Input is a Tensor<int64> Variable, which
H
hutuxian 已提交
676
            contains the IDs information.
677
        size(int): The embedding size parameter, which indicates the size of
H
hutuxian 已提交
678
            each embedding vector respectively.
679
        dtype(str): The dtype refers to the data type of output tensor. Only supports
H
hutuxian 已提交
680 681 682 683 684 685 686 687 688 689 690
	    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)
691
          emb = fluid.layers.pull_box_sparse(input=data, size=[11])
H
hutuxian 已提交
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
    """
    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 已提交
714
@templatedoc()
715
def linear_chain_crf(input, label, param_attr=None, length=None):
Y
yuyang18 已提交
716
    """
717 718
    :api_attr: Static Graph

Y
yuyang18 已提交
719 720 721 722 723
    Linear Chain CRF.

    ${comment}

    Args:
724
        input(${emission_type}): ${emission_comment}
Y
yuyang18 已提交
725
        label(${label_type}): ${label_comment}
726
        Length(${length_type}): ${length_comment}
727
        param_attr(ParamAttr): The attribute of the learnable parameter for transition parameter.
Y
yuyang18 已提交
728 729

    Returns:
D
dzhwinter 已提交
730 731
        output(${emission_exps_type}): ${emission_exps_comment} \n
        output(${transition_exps_type}): ${transition_exps_comment} \n
732
        output(${log_likelihood_type}): ${log_likelihood_comment} \n
Y
yuyang18 已提交
733

J
JesseyXujin 已提交
734 735 736
    Examples:
        .. code-block:: python

737 738
            import paddle.fluid as fluid
            import numpy as np
739 740
            import paddle
            paddle.enable_static()
741 742 743 744 745

            #define net structure, using LodTensor
            train_program = fluid.Program()
            startup_program = fluid.Program()
            with fluid.program_guard(train_program, startup_program):
746 747
                input_data = fluid.data(name='input_data', shape=[-1,10], dtype='float32')
                label = fluid.data(name='label', shape=[-1,1], dtype='int')
748 749 750 751 752 753
                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',
754
                    learning_rate=0.01))
755 756 757
            use_cuda = False
            place = fluid.CUDAPlace(0) if use_cuda else fluid.CPUPlace()
            exe = fluid.Executor(place)
758
            exe.run(startup_program)
759 760 761 762 763
            #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])
764
            print(loss)
765 766 767 768 769

            #define net structure, using padding
            train_program = fluid.Program()
            startup_program = fluid.Program()
            with fluid.program_guard(train_program, startup_program):
770 771 772
                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')
773 774 775 776 777 778
                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 已提交
779
                     name='crfw',
780 781 782 783 784 785
                     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 已提交
786

787 788 789
            #define data, using padding
            cc=np.random.rand(4,10,10).astype('float32')
            dd=np.random.rand(4,10,1).astype('int64')
790
            ll=np.array([[3],[3],[4],[2]])
791 792
            feed2 = {'input_data2':cc,'label2':dd,'length':ll}
            loss2= exe.run(train_program,feed=feed2, fetch_list=[crf_cost2])
793
            print(loss2)
794 795 796 797 798
            #[array([[ 7.8902354],
            #        [ 7.3602567],
            #        [ 10.004011],
            #        [ 5.86721  ]], dtype=float32)]

799 800 801
            #you can use find_var to get transition parameter.
            transition=np.array(fluid.global_scope().find_var('crfw').get_tensor())
            print(transition)
802

Y
yuyang18 已提交
803
    """
804 805 806
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'linear_chain_crf')
    check_variable_and_dtype(label, 'label', ['int64'], 'linear_chain_crf')
Y
Yu Yang 已提交
807
    helper = LayerHelper('linear_chain_crf', **locals())
808
    size = input.shape[2] if length else input.shape[1]
Y
Yu Yang 已提交
809 810 811 812
    transition = helper.create_parameter(
        attr=helper.param_attr,
        shape=[size + 2, size],
        dtype=helper.input_dtype())
X
Xin Pan 已提交
813 814 815 816 817 818 819 820
    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())
821 822 823 824 825 826
    this_inputs = {
        "Emission": [input],
        "Transition": transition,
        "Label": [label]
    }
    if length:
827
        this_inputs['Length'] = [length]
Y
Yu Yang 已提交
828 829
    helper.append_op(
        type='linear_chain_crf',
830
        inputs=this_inputs,
Y
Yu Yang 已提交
831 832 833 834 835 836 837 838 839 840
        outputs={
            "Alpha": [alpha],
            "EmissionExps": [emission_exps],
            "TransitionExps": transition_exps,
            "LogLikelihood": log_likelihood
        })

    return log_likelihood


W
wopeizl 已提交
841
@templatedoc()
842
def crf_decoding(input, param_attr, label=None, length=None):
W
wopeizl 已提交
843
    """
844
    :api_attr: Static Graph
845

W
wopeizl 已提交
846
    ${comment}
Y
yi.wu 已提交
847

W
wopeizl 已提交
848
    Args:
849
        input(Tensor): ${emission_comment}
Y
yi.wu 已提交
850

851 852
        param_attr (ParamAttr|None): To specify the weight parameter attribute.
            Default: None, which means the default weight parameter property is
853
            used. See usage for details in :ref:`api_paddle_fluid_param_attr_ParamAttr` .
Y
yuyang18 已提交
854

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

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

W
wopeizl 已提交
859
    Returns:
860
        Tensor: ${viterbi_path_comment}
Y
yi.wu 已提交
861

W
wopeizl 已提交
862 863
    Examples:
        .. code-block:: python
Y
yi.wu 已提交
864

865 866
           import paddle
           paddle.enable_static()
867 868 869

           # LoDTensor-based example
           num_labels = 10
870 871 872
           feature = paddle.static.data(name='word_emb', shape=[-1, 784], dtype='float32', lod_level=1)
           label = paddle.static.data(name='label', shape=[-1, 1], dtype='int64', lod_level=1)
           emission = paddle.static.nn.fc(feature, size=num_labels)
873

874 875 876 877
           crf_cost = paddle.fluid.layers.linear_chain_crf(input=emission, label=label,
                     param_attr=paddle.ParamAttr(name="crfw"))
           crf_decode = paddle.static.nn.crf_decoding(input=emission,
                     param_attr=paddle.ParamAttr(name="crfw"))
878 879 880

           # Common tensor example
           num_labels, max_len = 10, 20
881 882 883 884
           feature = paddle.static.data(name='word_emb_pad', shape=[-1, max_len, 784], dtype='float32')
           label = paddle.static.data(name='label_pad', shape=[-1, max_len, 1], dtype='int64')
           length = paddle.static.data(name='length', shape=[-1, 1], dtype='int64')
           emission = paddle.static.nn.fc(feature, size=num_labels,
885
                                      num_flatten_dims=2)
886

887 888 889 890
           crf_cost = paddle.fluid.layers.linear_chain_crf(input=emission, label=label, length=length,
                     param_attr=paddle.ParamAttr(name="crfw_pad"))
           crf_decode = paddle.static.nn.crf_decoding(input=emission, length=length,
                     param_attr=paddle.ParamAttr(name="crfw_pad"))
W
wopeizl 已提交
891
    """
892 893
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'crf_decoding')
W
wopeizl 已提交
894 895 896
    helper = LayerHelper('crf_decoding', **locals())
    transition = helper.get_parameter(param_attr.name)
    viterbi_path = helper.create_variable_for_type_inference(
897
        dtype=core.VarDesc.VarType.INT64)
898 899 900
    inputs = {"Emission": [input], "Transition": transition, "Label": label}
    if length:
        inputs['Length'] = length
W
wopeizl 已提交
901 902
    helper.append_op(
        type='crf_decoding',
903
        inputs=inputs,
W
wopeizl 已提交
904
        outputs={"ViterbiPath": [viterbi_path]})
Y
Yu Yang 已提交
905

W
wopeizl 已提交
906
    return viterbi_path
Y
Yu Yang 已提交
907 908


Y
yi.wu 已提交
909
@templatedoc()
F
fengjiayi 已提交
910
def cos_sim(X, Y):
Y
Yu Yang 已提交
911
    """
Y
yi.wu 已提交
912 913 914
    ${comment}

    Args:
N
Noel 已提交
915 916
        X (Tensor): ${x_comment}.
        Y (Tensor): ${y_comment}.
F
fengjiayi 已提交
917

Y
yi.wu 已提交
918
    Returns:
N
Noel 已提交
919
        A Tensor representing the output of cosine(X, Y).
L
lvmengsi 已提交
920 921 922 923

    Examples:
        .. code-block:: python

N
Noel 已提交
924 925 926 927 928 929 930
            import paddle

            x = paddle.rand(shape=[3, 7], dtype='float32')
            y = paddle.rand(shape=[1, 7], dtype='float32')
            out = paddle.fluid.layers.cos_sim(x, y)
            print(out)

Y
Yu Yang 已提交
931
    """
932 933
    check_variable_and_dtype(X, 'X', ['float32'], 'cos_sim')
    check_variable_and_dtype(Y, 'Y', ['float32'], 'cos_sim')
F
fengjiayi 已提交
934
    helper = LayerHelper('cos_sim', **locals())
X
Xin Pan 已提交
935 936 937
    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 已提交
938 939 940 941 942 943 944 945 946 947
    helper.append_op(
        type='cos_sim',
        inputs={'X': [X],
                'Y': [Y]},
        outputs={'Out': [out],
                 'XNorm': [xnorm],
                 'YNorm': [ynorm]})
    return out


948
@deprecated(since="2.0.0", update_to="paddle.nn.functional.dropout")
P
phlrain 已提交
949 950
def dropout(x,
            dropout_prob,
951
            is_test=None,
P
phlrain 已提交
952 953
            seed=None,
            name=None,
P
phlrain 已提交
954
            dropout_implementation="downgrade_in_infer"):
955
    """
956

957 958 959 960
    Computes dropout.

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

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

967
    Args:
L
lvmengsi 已提交
968
        x (Variable): The input tensor variable. The data type is float16 or float32 or float64.
969
        dropout_prob (float): Probability of setting units to zero.
970 971
        is_test (bool): A flag indicating whether it is in test phrase or not. 
                        Default None, in dynamic graph, it use global tracer mode; in static graph, it means False.
972 973 974
        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 已提交
975
                    units will be dropped. DO NOT use a fixed seed in training.Default: None.
976 977
        name (str|None): A name for this layer(optional). If set None, the layer
                         will be named automatically.
H
haowang101779990 已提交
978 979
        dropout_implementation(string): ['downgrade_in_infer'(default)|'upscale_in_train']

P
phlrain 已提交
980
                                        1. downgrade_in_infer(default), downgrade the outcome at inference
H
haowang101779990 已提交
981 982

                                           - train: out = input * mask
C
ceci3 已提交
983
                                           - inference: out = input * (1.0 - dropout_prob)
H
haowang101779990 已提交
984 985 986

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

H
haowang101779990 已提交
989 990
                                           - train: out = input * mask / ( 1.0 - dropout_prob )
                                           - inference: out = input
P
phlrain 已提交
991

H
haowang101779990 已提交
992 993
                                           (mask is a tensor same shape with input, value is 0 or 1
                                           ratio of 0 is dropout_prob)
994

M
minqiyang 已提交
995

996
    Returns:
L
lvmengsi 已提交
997
        A Variable holding Tensor representing the dropout, has same shape and data type with `x`.
998 999

    Examples:
1000

1001 1002
        .. code-block:: python

1003
            import paddle
1004
            import paddle.fluid as fluid
1005 1006
            
            paddle.enable_static()
L
lvmengsi 已提交
1007
            x = fluid.data(name="data", shape=[None, 32, 32], dtype="float32")
T
tianshuo78520a 已提交
1008
            dropped = fluid.layers.dropout(x, dropout_prob=0.5)
1009
    """
1010 1011 1012
    # fast return for p == 0
    if dropout_prob == 0:
        return x
1013

1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
    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():
1027 1028 1029
        if (seed is None or
                seed == 0) and default_main_program().random_seed != 0:
            seed = default_main_program().random_seed
1030 1031
        if is_test is None:
            is_test = not _dygraph_tracer()._train_mode
1032
        out, mask = core.ops.dropout(
1033
            x, 'dropout_prob', dropout_prob, 'is_test', is_test, 'fix_seed',
1034 1035
            seed is not None, 'seed', seed if seed is not None else 0,
            'dropout_implementation', dropout_implementation)
1036
        return out
1037

F
fengjiayi 已提交
1038
    helper = LayerHelper('dropout', **locals())
1039 1040
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'],
                             'dropout')
1041

X
Xin Pan 已提交
1042 1043
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    mask = helper.create_variable_for_type_inference(
Z
Zeng Jinle 已提交
1044
        dtype=core.VarDesc.VarType.UINT8, stop_gradient=True)
C
chengduo 已提交
1045

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

1048 1049 1050 1051 1052
    helper.append_op(
        type='dropout',
        inputs={'X': [x]},
        outputs={'Out': [out],
                 'Mask': [mask]},
1053
        attrs=attrs)
1054 1055 1056
    return out


Y
yi.wu 已提交
1057
@templatedoc()
Y
Yu Yang 已提交
1058 1059 1060 1061
def chunk_eval(input,
               label,
               chunk_scheme,
               num_chunk_types,
1062 1063
               excluded_chunk_types=None,
               seq_length=None):
1064
    r"""
G
Guo Sheng 已提交
1065 1066
    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 已提交
1067

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

G
Guo Sheng 已提交
1071 1072
    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 已提交
1073 1074

    .. code-block:: python
1075

Y
yi.wu 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
       ====== ====== ======  =====  ==  ============   =====  ===== =====  ==  =========
              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 已提交
1086
    and LOC(location), and we can see that the labels have the form `<tag type>-<chunk type>` .
Y
yi.wu 已提交
1087

G
Guo Sheng 已提交
1088 1089 1090
    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 已提交
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100

    .. 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
1101

Y
yi.wu 已提交
1102 1103 1104 1105 1106 1107
       Scheme Begin Inside End   Single
        plain   0     -      -     -
        IOB     0     1      -     -
        IOE     -     0      1     -
        IOBES   0     1      2     3

G
Guo Sheng 已提交
1108 1109
    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 已提交
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120

    .. 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 已提交
1121 1122
    With which we can map each label id to the corresponding tag type and chunk
    type correctly.
Y
yi.wu 已提交
1123

Y
yi.wu 已提交
1124
    Args:
N
Noel 已提交
1125 1126 1127 1128 1129
        input (Tensor): A Tensor representing the predicted labels
            from the network. Its shape would be `[N, M, 1]`,
            where `N` stands for batch size, `M` for sequence length. 
            The data type should be int64.
        label (Tensor): A Tensor representing the ground-truth labels.
T
tianshuo78520a 已提交
1130
            It should have the same shape, lod and data type as ``input`` .
G
Guo Sheng 已提交
1131 1132 1133 1134 1135 1136
        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.
N
Noel 已提交
1137 1138
        seq_length(Tensor, optional): A 1D Tensor containing the length of each
            sequence when ``input`` and ``label`` are Tensor. Default None.
F
fengjiayi 已提交
1139

Y
yi.wu 已提交
1140
    Returns:
G
Guo Sheng 已提交
1141 1142 1143 1144
        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.
1145

Y
yi.wu 已提交
1146 1147 1148
    Examples:
        .. code-block:: python

1149 1150 1151 1152
            import paddle.fluid as fluid

            dict_size = 10000
            label_dict_len = 7
G
Guo Sheng 已提交
1153
            sequence = fluid.data(
1154
                name='id', shape=[None, 1], lod_level=1, dtype='int64')
G
Guo Sheng 已提交
1155
            embedding = fluid.embedding(
1156 1157
                input=sequence, size=[dict_size, 512])
            hidden = fluid.layers.fc(input=embedding, size=512)
1158 1159
            label = fluid.data(
                name='label', shape=[None, 1], lod_level=1, dtype='int64')
Y
yi.wu 已提交
1160
            crf = fluid.layers.linear_chain_crf(
1161
                input=hidden, label=label, param_attr=fluid.ParamAttr(name="crfw"))
Y
yi.wu 已提交
1162
            crf_decode = fluid.layers.crf_decoding(
1163
                input=hidden, param_attr=fluid.ParamAttr(name="crfw"))
Y
yi.wu 已提交
1164 1165 1166 1167
            fluid.layers.chunk_eval(
                input=crf_decode,
                label=label,
                chunk_scheme="IOB",
1168
                num_chunk_types=int((label_dict_len - 1) / 2))
Y
Yu Yang 已提交
1169
    """
F
fengjiayi 已提交
1170
    helper = LayerHelper("chunk_eval", **locals())
Y
Yu Yang 已提交
1171

1172 1173 1174
    check_variable_and_dtype(input, 'input', ['int64'], 'chunk_eval')
    check_variable_and_dtype(label, 'label', ['int64'], 'chunk_eval')

Y
Yu Yang 已提交
1175
    # prepare output
X
Xin Pan 已提交
1176 1177 1178 1179 1180 1181 1182
    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 已提交
1183

1184 1185
    this_input = {"Inference": [input], "Label": [label]}

1186
    if seq_length is not None:
1187 1188
        this_input["SeqLength"] = [seq_length]

Y
Yu Yang 已提交
1189 1190
    helper.append_op(
        type="chunk_eval",
1191
        inputs=this_input,
Y
Yu Yang 已提交
1192 1193 1194
        outputs={
            "Precision": [precision],
            "Recall": [recall],
1195 1196 1197 1198
            "F1-Score": [f1_score],
            "NumInferChunks": [num_infer_chunks],
            "NumLabelChunks": [num_label_chunks],
            "NumCorrectChunks": [num_correct_chunks]
Y
Yu Yang 已提交
1199 1200 1201
        },
        attrs={
            "num_chunk_types": num_chunk_types,
G
guosheng 已提交
1202 1203
            "chunk_scheme": chunk_scheme,
            "excluded_chunk_types": excluded_chunk_types or []
Y
Yu Yang 已提交
1204
        })
1205 1206
    return (precision, recall, f1_score, num_infer_chunks, num_label_chunks,
            num_correct_chunks)
Y
Yu Yang 已提交
1207 1208


1209
@deprecated(since="2.0.0", update_to="paddle.nn.functional.softmax")
1210
def softmax(input, use_cudnn=True, name=None, axis=-1):
1211
    r"""
1212
    This operator implements the softmax layer. The calculation process is as follows:
1213

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

1216 1217 1218 1219 1220 1221 1222
    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.
1223

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

1227 1228 1229 1230 1231
    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.
1232

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

1235
    .. math::
1236

N
Noel 已提交
1237
        Out[i, j] = \\frac{\\exp(X[i, j])}{\\sum_j(exp(X[i, j])}
1238

1239
    Example:
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 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283

    .. 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],
1284
                         [0.72747516, 0.72747516, 0.72747516, 0.72747516]]]
1285

Q
qiaolongfei 已提交
1286
    Args:
N
Noel 已提交
1287
        input (Tensor): The input tensor. A multi-dimension ``Tensor`` with type float32 or float64.
1288
        use_cudnn (bool, optional): Use cudnn kernel or not, it is valid only when the cudnn \
G
GaoWei8 已提交
1289
            library is installed. To improve performance, set use_cudnn to True by default.
1290
        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 已提交
1291
            will be named automatically. Default: None.
1292
        axis (int, optional): The index of dimension to perform softmax calculations, it should
D
dengkaipeng 已提交
1293
            be in range :math:`[-1, rank - 1]`, while :math:`rank` is the rank of
N
Noel 已提交
1294
            input tensor. Default: -1. -1 means the last dimension.
Q
qiaolongfei 已提交
1295 1296

    Returns:
N
Noel 已提交
1297
        Tensor: ``Tensor`` indicates the output of softmax. The data type and shape are the same as ``input`` .
Q
qiaolongfei 已提交
1298 1299 1300 1301 1302

    Examples:

        .. code-block:: python

N
Noel 已提交
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319
            import paddle
            import paddle.nn.functional as F

            x = paddle.to_tensor([[[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]]], dtype='float32')
            y = F.softmax(x, axis=1)
            print(y)
            # [[[0.00657326, 0.00657326, 0.01714783, 0.01714783],
            #   [0.01786798, 0.01786798, 0.04661262, 0.04661262],
            #   [0.97555870, 0.97555870, 0.93623954, 0.93623954]],
            #  [[0.00490169, 0.00490169, 0.00490169, 0.00490169],
            #   [0.26762316, 0.26762316, 0.26762316, 0.26762316],
            #   [0.72747517, 0.72747517, 0.72747517, 0.72747517]]]
Q
qiaolongfei 已提交
1320 1321

    """
1322 1323

    if in_dygraph_mode():
1324 1325 1326 1327
        return core.ops.softmax(input, 'axis', axis, 'use_cudnn', use_cudnn)

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

1329
    helper = LayerHelper('softmax', **locals())
1330 1331
    check_variable_and_dtype(input, 'input/x',
                             ['float16', 'float32', 'float64'], 'softmax')
1332

1333
    dtype = helper.input_dtype()
X
Xin Pan 已提交
1334
    softmax_out = helper.create_variable_for_type_inference(dtype)
1335 1336 1337 1338
    helper.append_op(
        type="softmax",
        inputs={"X": input},
        outputs={"Out": softmax_out},
1339
        attrs=attrs)
1340 1341 1342
    return softmax_out


Y
Yu Yang 已提交
1343 1344 1345
def conv2d(input,
           num_filters,
           filter_size,
C
chengduoZH 已提交
1346 1347
           stride=1,
           padding=0,
1348
           dilation=1,
Y
Yu Yang 已提交
1349 1350 1351
           groups=None,
           param_attr=None,
           bias_attr=None,
C
chengduoZH 已提交
1352
           use_cudnn=True,
1353
           act=None,
L
liym27 已提交
1354 1355
           name=None,
           data_format="NCHW"):
1356
    r"""
1357 1358
    :api_attr: Static Graph

C
chengduoZH 已提交
1359
    The convolution2D layer calculates the output based on the input, filter
T
tensor-tang 已提交
1360
    and strides, paddings, dilations, groups parameters. Input and
L
liym27 已提交
1361
    Output are in NCHW or NHWC format, where N is batch size, C is the number of
1362
    channels, H is the height of the feature, and W is the width of the feature.
T
tensor-tang 已提交
1363 1364 1365 1366 1367 1368
    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/>`_
1369
    for more details.
1370 1371 1372
    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 已提交
1373

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

C
chengduoZH 已提交
1376 1377
    .. math::

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

T
tensor-tang 已提交
1380
    Where:
C
chengduoZH 已提交
1381

L
liym27 已提交
1382
    * :math:`X`: Input value, a tensor with NCHW or NHWC format.
1383 1384 1385 1386
    * :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 已提交
1387
    * :math:`Out`: Output value, the shape of :math:`Out` and :math:`X` may be different.
C
chengduoZH 已提交
1388 1389 1390

    Example:

1391 1392
        - Input:

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

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

1397
        - Output:
T
tensor-tang 已提交
1398

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

C
chengduoZH 已提交
1401
        Where
1402 1403

        .. math::
C
chengduoZH 已提交
1404

W
weixing02 已提交
1405 1406
            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 已提交
1407 1408

    Args:
1409
        input (Tensor): The input is 4-D Tensor with shape [N, C, H, W], the data type
L
lvmengsi 已提交
1410
            of input is float16 or float32 or float64.
T
tensor-tang 已提交
1411
        num_filters(int): The number of filter. It is as same as the output
1412
            image channel.
1413 1414
        filter_size (int|tuple): The filter size. If filter_size
            is a tuple, it must contain two integers, (filter_size_height,
L
lvmengsi 已提交
1415 1416
            filter_size_width). Otherwise, filter_size_height = filter_size_width =\
            filter_size.
1417 1418
        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 已提交
1419 1420
            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 已提交
1421
            on both sides for each dimension.If `padding` is a string, either 'VALID' or
L
liym27 已提交
1422 1423
            '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
1424 1425
            `[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 已提交
1426
            [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]`.
L
liym27 已提交
1427 1428 1429
            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 已提交
1430
        dilation (int|tuple): The dilation size. It means the spacing between the kernel
1431 1432
            points. If dilation is a tuple, it must contain two integers, (dilation_height,
            dilation_width). Otherwise, dilation_height = dilation_width = dilation.
L
lvmengsi 已提交
1433
            Default: dilation = 1.
1434 1435 1436 1437
        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 已提交
1438 1439 1440 1441 1442
            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 已提交
1443
            and the :math:`std` is :math:`(\\frac{2.0 }{filter\_elem\_num})^{0.5}`. Default: None.
C
chengduo 已提交
1444 1445 1446 1447 1448
        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.
1449 1450
        use_cudnn (bool): Use cudnn kernel or not, it is valid only when the cudnn
            library is installed. Default: True
C
chengduo 已提交
1451 1452
        act (str): Activation type, if it is set to None, activation is not appended.
            Default: None
1453 1454
        name(str|None): For detailed information, please refer
           to :ref:`api_guide_Name`. Usually name is no need to set and
L
lvmengsi 已提交
1455
           None by default.
1456
        data_format (str, optional): Specify the data format of the input, and the data format of the output
1457
            will be consistent with that of the input. An optional string from: `"NCHW"`, `"NHWC"`.
L
liym27 已提交
1458 1459
            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 已提交
1460 1461

    Returns:
1462 1463 1464
        A Tensor representing the conv2d, whose data type is the
        same with input. If act is None, the tensor storing the convolution
        result, and if act is not None, the tensor storing convolution
L
lvmengsi 已提交
1465
        and non-linearity activation result.
C
refine  
chengduoZH 已提交
1466

1467 1468 1469 1470 1471
    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".
1472
        ValueError: If `padding` is a tuple, but the element corresponding to the input's batch size is not 0
1473 1474 1475 1476 1477 1478 1479
            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 已提交
1480 1481 1482
    Examples:
        .. code-block:: python

1483 1484 1485
          import paddle
          paddle.enable_static()
          
1486 1487 1488
          data = paddle.static.data(name='data', shape=[None, 3, 32, 32], dtype='float32')
          conv2d = paddle.static.nn.conv2d(input=data, num_filters=2, filter_size=3, act="relu")
          print(conv2d.shape) # [-1, 2, 30, 30]
Y
Yu Yang 已提交
1489 1490
    """

1491 1492
    check_variable_and_dtype(input, 'input', ['float16', 'float32', 'float64'],
                             'conv2d')
1493
    num_channels = input.shape[1]
L
liym27 已提交
1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
    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 已提交
1509
    assert param_attr is not False, "param_attr should not be False here."
L
liym27 已提交
1510

1511
    l_type = 'conv2d'
X
xzl 已提交
1512 1513
    if (num_channels == groups and num_filters % num_channels == 0 and
            not use_cudnn):
1514
        l_type = 'depthwise_conv2d'
1515 1516 1517 1518

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

Y
Yu Yang 已提交
1519 1520 1521 1522
    if groups is None:
        num_filter_channels = num_channels
    else:
        if num_channels % groups != 0:
L
liym27 已提交
1523
            raise ValueError(
1524 1525 1526
                "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 已提交
1527
        num_filter_channels = num_channels // groups
Y
Yu Yang 已提交
1528

C
chengduoZH 已提交
1529 1530
    filter_size = utils.convert_to_list(filter_size, 2, 'filter_size')
    stride = utils.convert_to_list(stride, 2, 'stride')
1531
    dilation = utils.convert_to_list(dilation, 2, 'dilation')
C
chengduoZH 已提交
1532

L
liym27 已提交
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
    # 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')
1556 1557 1558
            if utils._is_symmetric_padding(padding, 2):
                padding = [padding[0], padding[2]]

L
liym27 已提交
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
        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"
1573
            padding = [0, 0]
L
liym27 已提交
1574 1575
        elif padding == "SAME":
            padding_algorithm = "SAME"
1576
            padding = [0, 0]
L
liym27 已提交
1577 1578

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

M
minqiyang 已提交
1580
    filter_shape = [num_filters, int(num_filter_channels)] + filter_size
Y
Yu Yang 已提交
1581 1582

    def _get_default_param_initializer():
C
chengduo 已提交
1583 1584
        filter_elem_num = filter_size[0] * filter_size[1] * num_channels
        std = (2.0 / filter_elem_num)**0.5
Y
Yu Yang 已提交
1585 1586 1587 1588 1589 1590 1591 1592
        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 已提交
1593
    pre_bias = helper.create_variable_for_type_inference(dtype)
Y
Yu Yang 已提交
1594 1595

    helper.append_op(
1596
        type=l_type,
Y
Yu Yang 已提交
1597 1598 1599 1600 1601
        inputs={
            'Input': input,
            'Filter': filter_param,
        },
        outputs={"Output": pre_bias},
C
chengduoZH 已提交
1602 1603 1604
        attrs={
            'strides': stride,
            'paddings': padding,
1605
            'dilations': dilation,
C
chengduoZH 已提交
1606
            'groups': groups,
1607
            'use_cudnn': use_cudnn,
1608
            'use_mkldnn': False,
L
liym27 已提交
1609 1610 1611
            'fuse_relu_before_depthwise_conv': False,
            "padding_algorithm": padding_algorithm,
            "data_format": data_format,
C
chengduoZH 已提交
1612
        })
Y
Yu Yang 已提交
1613

1614 1615 1616 1617
    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 已提交
1618 1619 1620 1621

    return helper.append_activation(pre_act)


C
chengduoZH 已提交
1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
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 已提交
1633 1634
           name=None,
           data_format="NCDHW"):
1635
    r"""
1636 1637
    :api_attr: Static Graph

C
chengduoZH 已提交
1638 1639
    The convolution3D layer calculates the output based on the input, filter
    and strides, paddings, dilations, groups parameters. Input(Input) and
L
liym27 已提交
1640
    Output(Output) are in NCDHW or NDHWC format. Where N is batch size C is the number of
1641 1642 1643 1644 1645
    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 已提交
1646 1647 1648 1649 1650 1651 1652 1653 1654

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

    .. math::

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

    In the above equation:

L
liym27 已提交
1655
    * :math:`X`: Input value, a tensor with NCDHW or NDHWC format.
1656
    * :math:`W`: Filter value, a tensor with MCDHW format.
C
chengduoZH 已提交
1657 1658 1659
    * :math:`\\ast`: Convolution operation.
    * :math:`b`: Bias value, a 2-D tensor with shape [M, 1].
    * :math:`\\sigma`: Activation function.
1660
    * :math:`Out`: Output value, the shape of :math:`Out` and :math:`X` may be different.
C
chengduoZH 已提交
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681

    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:
M
mls1999725 已提交
1682
        input (Tensor): The input is 5-D Tensor with shape [N, C, D, H, W], the data
L
lvmengsi 已提交
1683
            type of input is float16 or float32 or float64.
1684
        num_filters(int): The number of filter. It is as same as the output
C
chengduoZH 已提交
1685
            image channel.
1686
        filter_size (int|tuple): The filter size. If filter_size is a tuple,
1687
            it must contain three integers, (filter_size_depth, filter_size_height,
1688 1689
            filter_size_width). Otherwise, filter_size_depth = filter_size_height = \
            filter_size_width = filter_size.
1690 1691
        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 已提交
1692
            Otherwise, stride_depth = stride_height = stride_width = stride. Default: stride = 1.
1693
        padding (string|int|list|tuple): The padding size. It means the number of zero-paddings
T
tianshuo78520a 已提交
1694
            on both sides for each dimension. If `padding` is a string, either 'VALID' or
L
liym27 已提交
1695 1696 1697 1698 1699 1700 1701 1702
            '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.
1703
        dilation (int|tuple): The dilation size. It means the spacing between the kernel points.
L
lvmengsi 已提交
1704
            If dilation is a tuple, it must contain three integers, (dilation_depth, dilation_height,
1705
            dilation_width). Otherwise, dilation_depth = dilation_height = dilation_width = dilation.
L
lvmengsi 已提交
1706
            Default: dilation = 1.
C
chengduoZH 已提交
1707 1708 1709 1710 1711
        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 已提交
1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
        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 已提交
1722 1723
        use_cudnn (bool): Use cudnn kernel or not, it is valid only when the cudnn
            library is installed. Default: True
C
chengduo 已提交
1724 1725
        act (str): Activation type, if it is set to None, activation is not appended.
            Default: None.
1726 1727
        name(str|None): For detailed information, please refer
           to :ref:`api_guide_Name`. Usually name is no need to set and
L
lvmengsi 已提交
1728
           None by default.
1729
        data_format (str, optional): Specify the data format of the input, and the data format of the output
1730 1731 1732
            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 已提交
1733 1734

    Returns:
1735 1736 1737
        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 已提交
1738
        convolution and non-linearity activation result.
C
chengduoZH 已提交
1739

1740 1741 1742 1743 1744
    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".
1745
        ValueError: If `padding` is a tuple, but the element corresponding to the input's batch size is not 0
1746 1747 1748 1749 1750 1751 1752
            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 已提交
1753 1754 1755
    Examples:
        .. code-block:: python

1756
          import paddle
M
mls1999725 已提交
1757 1758
          import numpy as np
	  
1759
          paddle.enable_static()
M
mls1999725 已提交
1760 1761 1762 1763 1764 1765 1766 1767 1768
          data = paddle.static.data(name='data', shape=[None, 3, 12, 32, 32], dtype='float32')
          param_attr = paddle.framework.ParamAttr(name='conv3d.weight', initializer=paddle.nn.initializer.XavierNormal(), learning_rate=0.001)
          res = paddle.static.nn.conv3d(input=data, num_filters=2, filter_size=3, act="relu", param_attr=param_attr)
          place = paddle.CPUPlace()
          exe = paddle.static.Executor(place)
          exe.run(paddle.static.default_startup_program())
          x = np.random.rand(1, 3, 12, 32, 32).astype("float32")
          output = exe.run(feed={"data": x}, fetch_list=[res])
          print(output)
C
chengduoZH 已提交
1769 1770 1771
    """

    l_type = 'conv3d'
C
chengduo 已提交
1772
    assert param_attr is not False, "param_attr should not be False here."
C
chengduoZH 已提交
1773 1774 1775
    helper = LayerHelper(l_type, **locals())
    dtype = helper.input_dtype()

L
liym27 已提交
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
    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 已提交
1791 1792 1793 1794 1795

    if groups is None:
        num_filter_channels = num_channels
    else:
        if num_channels % groups != 0:
L
liym27 已提交
1796 1797 1798 1799
            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 已提交
1800
        num_filter_channels = num_channels // groups
C
chengduoZH 已提交
1801 1802 1803 1804 1805

    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 已提交
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
    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')
1828 1829
            if utils._is_symmetric_padding(padding, 3):
                padding = [padding[0], padding[2], padding[4]]
L
liym27 已提交
1830 1831
        elif is_list_or_tuple(padding) and len(padding) == 6:
            padding = utils.convert_to_list(padding, 6, 'padding')
1832 1833
            if utils._is_symmetric_padding(padding, 3):
                padding = [padding[0], padding[2], padding[4]]
L
liym27 已提交
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
        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"
1848
            padding = [0, 0, 0]
L
liym27 已提交
1849 1850
        elif padding == "SAME":
            padding_algorithm = "SAME"
1851
            padding = [0, 0, 0]
L
liym27 已提交
1852 1853

    padding = _update_padding(padding, data_format)
C
chengduoZH 已提交
1854 1855 1856 1857 1858

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

    def _get_default_param_initializer():
C
chengduo 已提交
1859 1860 1861
        filter_elem_num = filter_size[0] * filter_size[1] * filter_size[
            2] * num_channels
        std = (2.0 / filter_elem_num)**0.5
C
chengduoZH 已提交
1862 1863 1864 1865 1866 1867 1868 1869
        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 已提交
1870
    pre_bias = helper.create_variable_for_type_inference(dtype)
C
chengduoZH 已提交
1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884

    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 已提交
1885 1886 1887
            'use_mkldnn': False,
            "padding_algorithm": padding_algorithm,
            "data_format": data_format,
C
chengduoZH 已提交
1888 1889
        })

1890 1891 1892 1893
    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 已提交
1894 1895 1896 1897

    return helper.append_activation(pre_act)


F
fengjiayi 已提交
1898
@templatedoc()
Y
Yu Yang 已提交
1899
def pool2d(input,
C
chengduoZH 已提交
1900 1901
           pool_size=-1,
           pool_type="max",
C
chengduoZH 已提交
1902 1903
           pool_stride=1,
           pool_padding=0,
C
caoying03 已提交
1904
           global_pooling=False,
C
chengduoZH 已提交
1905
           use_cudnn=True,
1906
           ceil_mode=False,
1907
           name=None,
1908 1909
           exclusive=True,
           data_format="NCHW"):
Y
Yu Yang 已提交
1910
    """
1911

F
fengjiayi 已提交
1912
    ${comment}
1913 1914

    Args:
K
Kaipeng Deng 已提交
1915 1916 1917 1918 1919
        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 已提交
1920
        pool_size (int|list|tuple): The pool kernel size. If pool kernel size is a tuple or list,
J
JiabinYang 已提交
1921 1922
            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 已提交
1923
        pool_type: ${pooling_type_comment}
J
JiabinYang 已提交
1924 1925 1926
        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.
1927 1928 1929 1930 1931 1932 1933
        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 已提交
1934
            Otherwise, the pool padding size will be a square of an int.
1935 1936 1937
        global_pooling (bool): ${global_pooling_comment}
        use_cudnn (bool): ${use_cudnn_comment}
        ceil_mode (bool): ${ceil_mode_comment}
K
Kaipeng Deng 已提交
1938 1939 1940
        name(str, optional): For detailed information, please refer
                             to :ref:`api_guide_Name`. Usually name is no need to set and
                             None by default.
1941
        exclusive (bool): Whether to exclude padding points in average pooling
1942
                          mode, default is `true`.
1943
        data_format (string): The data format of the input and output data. An optional string from: `"NCHW"`, `"NHWC"`.
1944 1945
                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 已提交
1946

1947
    Returns:
K
Kaipeng Deng 已提交
1948
        Variable: The output tensor of pooling result. The data type is same as input tensor.
F
fengjiayi 已提交
1949 1950

    Raises:
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
        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 已提交
1963 1964 1965 1966 1967

    Examples:

        .. code-block:: python

1968
          import paddle.fluid as fluid
1969 1970 1971
          import paddle

          paddle.enable_static()
1972

K
Kaipeng Deng 已提交
1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
          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)
1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015

          # 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 已提交
2016 2017 2018
    """
    if pool_type not in ["max", "avg"]:
        raise ValueError(
2019
            "Unknown Attr(pool_type): '%s'. It can only be 'max' or 'avg'.",
Y
Yu Yang 已提交
2020
            str(pool_type))
C
chengduoZH 已提交
2021

C
chengduoZH 已提交
2022 2023
    if global_pooling is False and pool_size == -1:
        raise ValueError(
2024 2025 2026 2027
            "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):
2028 2029
        raise TypeError("Attr(use_cudnn) should be True or False. Received "
                        "Attr(use_cudnn): %s." % str(use_cudnn))
2030 2031 2032 2033 2034

    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 已提交
2035

C
chengduoZH 已提交
2036 2037 2038
    pool_size = utils.convert_to_list(pool_size, 2, 'pool_size')
    pool_stride = utils.convert_to_list(pool_stride, 2, 'pool_stride')

2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
    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')
2061

2062 2063
            if utils._is_symmetric_padding(padding, 2):
                padding = [padding[0], padding[2]]
2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077
        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"
2078
            pool_padding = [0, 0]
2079 2080 2081 2082 2083 2084
            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"
2085
            pool_padding = [0, 0]
2086 2087 2088 2089 2090

    pool_padding = update_padding(pool_padding, data_format)

    op_type = 'pool2d'
    helper = LayerHelper(op_type, **locals())
Y
Yu Yang 已提交
2091
    dtype = helper.input_dtype()
X
Xin Pan 已提交
2092
    pool_out = helper.create_variable_for_type_inference(dtype)
Y
Yu Yang 已提交
2093 2094

    helper.append_op(
2095
        type=op_type,
2096 2097 2098 2099 2100 2101 2102 2103
        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,
2104
            "padding_algorithm": padding_algorithm,
2105 2106
            "use_cudnn": use_cudnn,
            "ceil_mode": ceil_mode,
2107 2108
            "use_mkldnn": False,
            "exclusive": exclusive,
2109
            "data_format": data_format,
2110 2111 2112 2113 2114
        })

    return pool_out


D
dengkaipeng 已提交
2115
@templatedoc()
2116 2117 2118 2119 2120 2121 2122 2123
def pool3d(input,
           pool_size=-1,
           pool_type="max",
           pool_stride=1,
           pool_padding=0,
           global_pooling=False,
           use_cudnn=True,
           ceil_mode=False,
2124
           name=None,
2125 2126
           exclusive=True,
           data_format="NCDHW"):
2127
    """
2128

2129
    ${comment}
2130 2131

    Args:
K
Kaipeng Deng 已提交
2132 2133
        input (Variable): The input tensor of pooling operator, which is a 5-D tensor with
                          shape [N, C, D, H, W]. The format of
2134 2135 2136
                          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 已提交
2137
                          of the feature.
2138 2139
        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 已提交
2140 2141 2142
            (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}
2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153
        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]]`.
2154 2155 2156
        global_pooling (bool): ${global_pooling_comment}
        use_cudnn (bool): ${use_cudnn_comment}
        ceil_mode (bool): ${ceil_mode_comment}
K
Kaipeng Deng 已提交
2157 2158 2159
        name(str, optional): For detailed information, please refer
                             to :ref:`api_guide_Name`. Usually name is no need to set and
                             None by default.
2160
        exclusive (bool): Whether to exclude padding points in average pooling
2161 2162 2163 2164
                          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]`.
2165

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

2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181
    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 已提交
2182 2183 2184 2185
    Examples:

        .. code-block:: python

2186
          import paddle.fluid as fluid
2187 2188 2189
          import paddle

          paddle.enable_static()
2190

K
Kaipeng Deng 已提交
2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215
          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)
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238

          # 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 已提交
2239 2240 2241
    """
    if pool_type not in ["max", "avg"]:
        raise ValueError(
2242
            "Unknown Attr(pool_type): '%s'. It can only be 'max' or 'avg'.",
Y
Yu Yang 已提交
2243
            str(pool_type))
C
chengduoZH 已提交
2244

C
chengduoZH 已提交
2245 2246
    if global_pooling is False and pool_size == -1:
        raise ValueError(
2247 2248 2249 2250 2251
            "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):
2252 2253
        raise TypeError("Attr(use_cudnn) should be True or False. Received "
                        "Attr(use_cudnn): %s. " % str(use_cudnn))
2254 2255 2256 2257 2258

    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 已提交
2259

2260 2261
    pool_size = utils.convert_to_list(pool_size, 3, 'pool_size')
    pool_stride = utils.convert_to_list(pool_stride, 3, 'pool_stride')
C
chengduoZH 已提交
2262

2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284
    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')
2285 2286
            if utils._is_symmetric_padding(padding, 3):
                padding = [padding[0], padding[2], padding[4]]
2287 2288 2289

        elif is_list_or_tuple(padding) and len(padding) == 6:
            padding = utils.convert_to_list(padding, 6, 'padding')
2290 2291
            if utils._is_symmetric_padding(padding, 3):
                padding = [padding[0], padding[2], padding[4]]
2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305
        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"
2306
            pool_padding = [0, 0, 0]
2307 2308 2309 2310 2311 2312
            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"
2313
            pool_padding = [0, 0, 0]
2314 2315 2316 2317 2318

    pool_padding = update_padding(pool_padding, data_format)

    op_type = "pool3d"
    helper = LayerHelper(op_type, **locals())
Y
Yu Yang 已提交
2319
    dtype = helper.input_dtype()
X
Xin Pan 已提交
2320
    pool_out = helper.create_variable_for_type_inference(dtype)
Y
Yu Yang 已提交
2321 2322

    helper.append_op(
2323
        type=op_type,
Y
Yu Yang 已提交
2324 2325 2326 2327 2328 2329 2330
        inputs={"X": input},
        outputs={"Out": pool_out},
        attrs={
            "pooling_type": pool_type,
            "ksize": pool_size,
            "global_pooling": global_pooling,
            "strides": pool_stride,
C
chengduoZH 已提交
2331
            "paddings": pool_padding,
2332
            "padding_algorithm": padding_algorithm,
2333
            "use_cudnn": use_cudnn,
2334
            "ceil_mode": ceil_mode,
2335 2336
            "use_mkldnn": False,
            "exclusive": exclusive,
2337
            "data_format": data_format,
Y
Yu Yang 已提交
2338 2339 2340 2341 2342
        })

    return pool_out


2343
@deprecated(since="2.0.0")
2344 2345 2346 2347 2348 2349
@templatedoc(op_type="pool2d")
def adaptive_pool2d(input,
                    pool_size,
                    pool_type="max",
                    require_index=False,
                    name=None):
2350
    r"""
2351

K
Kaipeng Deng 已提交
2352
    This operation calculates the output based on the input, pool_size,
D
dengkaipeng 已提交
2353 2354 2355 2356
    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 已提交
2357
    is same as Parameter(pool_size). The output tensor shape will be [N, C, pool_size[0], pool_size[1]]
2358

2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371
    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)}
2372 2373

    Args:
2374
        input (Tensor): The input tensor of pooling operator, which is a 4-D tensor
K
Kaipeng Deng 已提交
2375 2376 2377 2378
                          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.
2379 2380 2381
        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 已提交
2382
        require_index (bool): If true, the index of max pooling point will be returned along
K
Kaipeng Deng 已提交
2383 2384 2385 2386
            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.
2387 2388

    Returns:
2389
        Tensor: The output tensor of adaptive pooling result. The data type is same
K
Kaipeng Deng 已提交
2390
                  as input tensor.
2391 2392 2393 2394 2395 2396 2397 2398 2399

    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 已提交
2400
          # average adaptive pool2d
M
minqiyang 已提交
2401
          # suppose input data in shape of [N, C, H, W], `pool_size` is [m, n],
T
tianshuo78520a 已提交
2402
          # output shape is [N, C, m, n], adaptive pool divide H and W dimensions
M
minqiyang 已提交
2403
          # of input data into m * n grids averagely and performs poolings in each
2404 2405
          # grid to get output.
          # adaptive average pool performs calculations as follow:
M
minqiyang 已提交
2406
          #
2407 2408 2409 2410 2411 2412 2413 2414
          #     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])
          #
2415
          import paddle
2416
          paddle.enable_static()
2417 2418
          data = paddle.rand(shape=[1,3,32,32])
          pool_out = paddle.fluid.layers.adaptive_pool2d(
2419 2420
                            input=data,
                            pool_size=[3, 3],
2421
                            pool_type='avg')
K
Kaipeng Deng 已提交
2422 2423 2424

          # max adaptive pool2d
          # suppose input data in shape of [N, C, H, W], `pool_size` is [m, n],
T
tianshuo78520a 已提交
2425
          # output shape is [N, C, m, n], adaptive pool divide H and W dimensions
K
Kaipeng Deng 已提交
2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437
          # 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])
          #
2438 2439 2440
          import paddle
          data = paddle.rand(shape=[1,3,32,32])
          pool_out = paddle.fluid.layers.adaptive_pool2d(
K
Kaipeng Deng 已提交
2441 2442 2443
                            input=data,
                            pool_size=[3, 3],
                            pool_type='max')
2444
    """
2445 2446 2447 2448 2449 2450
    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')
2451 2452 2453 2454 2455 2456 2457 2458 2459
    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'.")

2460
    pool_size = utils.convert_to_list(pool_size, 2, 'pool_size')
2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485

    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 已提交
2486
    return (pool_out, mask) if require_index else pool_out
2487 2488


2489
@deprecated(since="2.0.0")
2490 2491 2492 2493 2494 2495
@templatedoc(op_type="pool3d")
def adaptive_pool3d(input,
                    pool_size,
                    pool_type="max",
                    require_index=False,
                    name=None):
2496
    r"""
2497

K
Kaipeng Deng 已提交
2498
    This operation calculates the output based on the input, pool_size,
D
dengkaipeng 已提交
2499 2500 2501 2502
    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 已提交
2503 2504
    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]]
2505

2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522
    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)}
2523 2524

    Args:
2525
        input (Tensor): The input tensor of pooling operator, which is a 5-D tensor with
K
Kaipeng Deng 已提交
2526 2527
                          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 已提交
2528
                          H is the height of the feature, and W is the width of the feature.
K
Kaipeng Deng 已提交
2529
                          The data type is float32 or float64.
2530
        pool_size (int|list|tuple): The pool kernel size. If pool kernel size is a tuple or list,
D
dengkaipeng 已提交
2531
            it must contain three integers, (Depth, Height, Width).
2532
        pool_type: ${pooling_type_comment}
D
dengkaipeng 已提交
2533
        require_index (bool): If true, the index of max pooling point will be returned along
K
Kaipeng Deng 已提交
2534 2535 2536 2537
            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.
2538 2539

    Returns:
2540
        Tensor: The output tensor of adaptive pooling result. The data type is same as input tensor.
2541 2542 2543 2544 2545 2546 2547 2548 2549

    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 已提交
2550
          # average adaptive pool3d
2551
          # suppose input data in shape of [N, C, D, H, W], `pool_size` is [l, m, n],
T
tianshuo78520a 已提交
2552
          # output shape is [N, C, l, m, n], adaptive pool divide D, H and W dimensions
M
minqiyang 已提交
2553
          # of input data into l * m * n grids averagely and performs poolings in each
2554 2555
          # grid to get output.
          # adaptive average pool performs calculations as follow:
M
minqiyang 已提交
2556
          #
2557 2558 2559 2560 2561 2562 2563 2564 2565
          #     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 已提交
2566
          #                 output[:, :, i, j, k] =
2567 2568
          #                     avg(input[:, :, dstart:dend, hstart: hend, wstart: wend])
          #
K
Kaipeng Deng 已提交
2569

2570
          import paddle
2571
          paddle.enable_static()
2572 2573
          data = paddle.rand(shape=[1,3,32,32,32])
          pool_out = paddle.fluid.layers.adaptive_pool3d(
2574
                            input=data,
D
dengkaipeng 已提交
2575
                            pool_size=[3, 3, 3],
2576
                            pool_type='avg')
K
Kaipeng Deng 已提交
2577 2578 2579

          # max adaptive pool3d
          # suppose input data in shape of [N, C, D, H, W], `pool_size` is [l, m, n],
T
tianshuo78520a 已提交
2580
          # output shape is [N, C, l, m, n], adaptive pool divide D, H and W dimensions
K
Kaipeng Deng 已提交
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597
          # 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])
          #

2598 2599 2600
          import paddle
          data = paddle.rand(shape=[1,3,32,32,32])
          pool_out = paddle.fluid.layers.adaptive_pool3d(
K
Kaipeng Deng 已提交
2601 2602 2603
                            input=data,
                            pool_size=[3, 3, 3],
                            pool_type='max')
2604
    """
2605 2606 2607 2608 2609 2610
    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')
2611 2612 2613 2614 2615 2616 2617 2618 2619
    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'.")

2620
    pool_size = utils.convert_to_list(pool_size, 3, 'pool_size')
2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645

    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 已提交
2646
    return (pool_out, mask) if require_index else pool_out
2647 2648


Y
Yu Yang 已提交
2649 2650 2651 2652 2653 2654 2655
def batch_norm(input,
               act=None,
               is_test=False,
               momentum=0.9,
               epsilon=1e-05,
               param_attr=None,
               bias_attr=None,
C
caoying03 已提交
2656
               data_layout='NCHW',
Y
Yang Yang 已提交
2657
               in_place=False,
2658 2659
               name=None,
               moving_mean_name=None,
W
wanghaoshuang 已提交
2660
               moving_variance_name=None,
2661
               do_model_average_for_mean_and_var=True,
2662
               use_global_stats=False):
2663
    r"""
2664 2665
    :api_attr: Static Graph

Q
qiaolongfei 已提交
2666 2667
    **Batch Normalization Layer**

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

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

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

Q
qiaolongfei 已提交
2675 2676 2677
    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 已提交
2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689

    :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
2690

L
lvmengsi 已提交
2691
        moving\_mean = moving\_mean * momentum + mini-batch\_mean * (1. - momentum) \\\\
2692
        moving\_var = moving\_var * momentum + mini-batch\_var * (1. - momentum)
L
lvmengsi 已提交
2693

2694

L
lvmengsi 已提交
2695
    moving_mean is global mean and moving_var is global variance.
2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708

    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 已提交
2709
    Note:
2710
        if build_strategy.sync_batch_norm=True, the batch_norm in network will use
L
lvmengsi 已提交
2711
        sync_batch_norm automatically.
2712
        `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 已提交
2713

2714
    Args:
2715
        input(Tensor): The rank of input Tensor can be 2, 3, 4, 5. The data type
L
lvmengsi 已提交
2716
            is float16 or float32 or float64.
Q
qiaolongfei 已提交
2717
        act(string, Default None): Activation type, linear|relu|prelu|...
Q
qingqing01 已提交
2718 2719
        is_test (bool, Default False): A flag indicating whether it is in
            test phrase or not.
2720 2721
        momentum(float|Tensor, Default 0.9): The value used for the moving_mean and
            moving_var computation. This should be a float number or a Tensor with
2722
            shape [1] and data type as float32. The updated formula is:
Q
qingqing01 已提交
2723 2724 2725 2726 2727
            :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 已提交
2728 2729
        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
2730
	     will create ParamAttr as param_attr, the name of scale can be set in ParamAttr.
2731
	     If the Initializer of the param_attr is not set, the parameter is initialized
2732
	     with Xavier. Default: None.
C
chengduo 已提交
2733 2734
        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
2735 2736
	     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.
2737
	     Default: None.
2738
        data_layout (str, optional): Specify the data format of the input, and the data format of the output
K
Kaipeng Deng 已提交
2739 2740 2741
             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]`.
2742
        in_place(bool, Default False): Make the input and output of batch norm reuse memory.
2743 2744 2745 2746
        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
2747
            will save global mean with the string.
L
lvmengsi 已提交
2748
        moving_variance_name(str, Default None): The name of the moving_variance which store the global Variance.
2749
            If it is set to None, batch_norm will save global variance with a random name, otherwise, batch_norm
2750
            will save global variance with the string.
2751 2752
        do_model_average_for_mean_and_var(bool, Default True): Whether parameter mean and variance should do model
            average when model average is enabled.
2753 2754 2755 2756 2757
        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.
2758
    Returns:
2759
        A Tensor which is the result after applying batch normalization on the input,
2760
        has same shape and data type with input.
Q
qiaolongfei 已提交
2761 2762 2763 2764 2765

    Examples:

        .. code-block:: python

2766
            import paddle
2767
            
2768
            paddle.enable_static()
2769 2770 2771 2772 2773 2774 2775
            x = paddle.static.data(name='x', shape=[3, 7, 3, 7], dtype='float32')
            hidden1 = paddle.static.nn.fc(x=x, size=200)
            print(hidden1.shape)
            # [3, 200]
            hidden2 = paddle.static.nn.batch_norm(input=hidden1)
            print(hidden2.shape)
            # [3, 200]
Y
Yu Yang 已提交
2776
    """
C
chengduo 已提交
2777
    assert bias_attr is not False, "bias_attr should not be False in batch_norm."
Y
Yu Yang 已提交
2778 2779
    helper = LayerHelper('batch_norm', **locals())

2780 2781
    check_variable_and_dtype(input, 'input', ['float16', 'float32', 'float64'],
                             'batch_norm')
2782
    dtype = helper.input_dtype()
2783 2784 2785 2786 2787 2788 2789

    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 已提交
2790 2791 2792 2793
    # use fp32 for bn parameter
    if dtype == core.VarDesc.VarType.FP16:
        dtype = core.VarDesc.VarType.FP32

Y
Yu Yang 已提交
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811
    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(
2812
        attr=helper.bias_attr, shape=param_shape, dtype=dtype, is_bias=True)
Y
Yu Yang 已提交
2813

2814 2815
    mean = helper.create_parameter(
        attr=ParamAttr(
W
wanghaoshuang 已提交
2816 2817 2818
            name=moving_mean_name,
            initializer=Constant(0.0),
            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 2823 2824 2825 2826 2827
    mean.stop_gradient = True

    variance = helper.create_parameter(
        attr=ParamAttr(
            name=moving_variance_name,
            initializer=Constant(1.0),
W
wanghaoshuang 已提交
2828
            trainable=False,
W
wanghaoshuang 已提交
2829
            do_model_average=do_model_average_for_mean_and_var),
Q
QI JUN 已提交
2830
        shape=param_shape,
W
Wu Yi 已提交
2831
        dtype=dtype)
2832
    variance.stop_gradient = True
Y
Yu Yang 已提交
2833 2834 2835 2836 2837 2838

    # 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 已提交
2839 2840 2841 2842
    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 已提交
2843

2844 2845 2846 2847 2848
    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 已提交
2849 2850
    batch_norm_out = input if in_place else \
            helper.create_variable_for_type_inference(dtype)
Y
Yu Yang 已提交
2851

2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870
    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
2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881

    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 已提交
2882
    helper.append_op(
2883
        type="batch_norm", inputs=inputs, outputs=outputs, attrs=attrs)
Y
Yu Yang 已提交
2884 2885 2886 2887

    return helper.append_activation(batch_norm_out)


K
Kaipeng Deng 已提交
2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901
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):
2902
    r"""
K
Kaipeng Deng 已提交
2903
    **In-place Activation Batch Normalization Layer**
2904

K
Kaipeng Deng 已提交
2905 2906
    This layer calculates batch normalization and activation with in-place memory.
    For batch normalization calculations, see `fluid.layers.batch_norm`.
2907
    For in-place activation batch normalization, see `In-Place Activated BatchNorm for
K
Kaipeng Deng 已提交
2908 2909 2910 2911 2912 2913 2914
    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:
2915
        if build_strategy.sync_batch_norm=True, the batch_norm in network will use
K
Kaipeng Deng 已提交
2916 2917 2918 2919
        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:
2920
        input(Variable): The rank of input variable can be 2, 3, 4, 5. The data type
K
Kaipeng Deng 已提交
2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933
            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`
2934
             of inplace_abn. If it is set to None or one attribute of ParamAttr, inplace_abn
K
Kaipeng Deng 已提交
2935
	     will create ParamAttr as param_attr, the name of scale can be set in ParamAttr.
2936
	     If the Initializer of the param_attr is not set, the parameter is initialized
K
Kaipeng Deng 已提交
2937 2938
	     with Xavier. Default: None.
        bias_attr(ParamAttr|None): The parameter attribute for the bias of inplace_abn.
2939 2940 2941
             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 已提交
2942
	     Default: None.
2943
        data_layout (str, optional): Specify the data format of the input, and the data format of the output
K
Kaipeng Deng 已提交
2944 2945 2946
             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]`.
2947 2948 2949 2950
        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 已提交
2951 2952
            will save global mean with the string.
        moving_variance_name(str, Default None): The name of the moving_variance which store the global Variance.
2953
            If it is set to None, inplace_abn, will save global variance with a random name, otherwise, inplace_abn
K
Kaipeng Deng 已提交
2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965
            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:
2966 2967
        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 已提交
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 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090

    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 已提交
3091 3092 3093 3094 3095
def instance_norm(input,
                  epsilon=1e-05,
                  param_attr=None,
                  bias_attr=None,
                  name=None):
3096
    r"""
3097 3098
    :api_attr: Static Graph

L
lvmengsi 已提交
3099 3100
    **Instance Normalization Layer**

L
lvmengsi 已提交
3101
    Can be used as a normalizer function for convolution or fully_connected operations.
L
lvmengsi 已提交
3102 3103 3104 3105
    The required data format for this layer is one of the following:

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

3106
    Refer to `Instance Normalization: The Missing Ingredient for
L
lvmengsi 已提交
3107 3108 3109 3110 3111 3112 3113 3114
    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 已提交
3115
        \\ mean\ of\ one\  feature\ map\ in\ mini-batch \\\\
L
lvmengsi 已提交
3116
        \\sigma_{\\beta}^{2} &\\gets \\frac{1}{HW} \\sum_{i=1}^{HW}(x_i - \\
L
lvmengsi 已提交
3117
        \\mu_{\\beta})^2 \\qquad &//\ variance\ of\ one\ feature\ map\ in\ mini-batch \\\\
L
lvmengsi 已提交
3118 3119 3120 3121
        \\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 已提交
3122 3123
    Note:
        `H` means height of feature map, `W` means width of feature map.
L
lvmengsi 已提交
3124 3125

    Args:
C
ceci3 已提交
3126
        input(Tensor): The rank of input tensor can be 2, 3, 4, 5.
L
lvmengsi 已提交
3127
            The data type is float32 or float64.
L
lvmengsi 已提交
3128 3129
        epsilon(float, Default 1e-05): A value added to the denominator for
            numerical stability. Default is 1e-5.
C
ceci3 已提交
3130
        param_attr(ParamAttr|None|bool, optional): The parameter attribute for Parameter `scale`
L
lvmengsi 已提交
3131 3132
             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.
3133
	     If the Initializer of the param_attr is not set, the parameter is initialized
C
ceci3 已提交
3134 3135 3136
	     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 已提交
3137
             If it is set to None or one attribute of ParamAttr, instance_norm
3138 3139
	     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 已提交
3140
             If the bias_attr is set to False, instance_norm will not create bias_attr.
L
lvmengsi 已提交
3141 3142 3143 3144 3145
	     Default: None.
        name(string, Default None): A name for this layer(optional). If set None, the layer
            will be named automatically.

    Returns:
C
ceci3 已提交
3146
        A Tensor which is the result after applying instance normalization on the input,
3147
        has same shape and data type with input.
L
lvmengsi 已提交
3148 3149 3150 3151 3152

    Examples:

        .. code-block:: python

3153 3154
            import paddle
            paddle.enable_static()
C
ceci3 已提交
3155 3156 3157
            x = paddle.static.data(name='x', shape=[3, 7, 3, 7], dtype='float32')
            hidden1 = paddle.static.nn.fc(x, size=200)
            hidden2 = paddle.static.nn.instance_norm(hidden1)
L
lvmengsi 已提交
3158
    """
3159 3160
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'instance_norm')
C
ceci3 已提交
3161 3162 3163
    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 已提交
3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175
    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]

3176
    if param_attr != False and bias_attr != False:
C
ceci3 已提交
3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188
        # 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 已提交
3189 3190 3191 3192 3193 3194 3195 3196 3197

    # 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 已提交
3198
    inputs = {"X": input}
3199
    if param_attr != False and bias_attr != False:
C
ceci3 已提交
3200 3201 3202
        inputs["Scale"] = scale
        inputs["Bias"] = bias

L
lvmengsi 已提交
3203 3204
    helper.append_op(
        type="instance_norm",
C
ceci3 已提交
3205
        inputs=inputs,
L
lvmengsi 已提交
3206 3207 3208 3209 3210 3211 3212 3213 3214 3215
        outputs={
            "Y": instance_norm_out,
            "SavedMean": saved_mean,
            "SavedVariance": saved_variance
        },
        attrs={"epsilon": epsilon, })

    return instance_norm_out


3216
@static_only
H
heqiaozhi 已提交
3217 3218 3219 3220 3221 3222 3223 3224 3225
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,
3226
              do_model_average_for_mean_and_var=True,
H
hutuxian 已提交
3227 3228
              slot_dim=-1,
              sync_stats=False,
3229 3230
              summary_decay_rate=0.9999999,
              enable_scale_and_shift=False):
3231
    r"""
3232 3233
    :api_attr: Static Graph

H
heqiaozhi 已提交
3234 3235
    **Data Normalization Layer**

3236
    This op can be used as a normalizer function for conv2d and fully_connected operations.
H
heqiaozhi 已提交
3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255
    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:
Y
yaoxuefeng 已提交
3256
        input(Tensor): The input Tensor.
H
heqiaozhi 已提交
3257 3258 3259
        act(string, Default None): Activation type, linear|relu|prelu|...
        epsilon(float, Default 1e-05):
        param_attr(ParamAttr): The parameter attribute for Parameter `scale`.
3260
        data_layout (str, optional): Specify the data format of the input, and the data format of the output
3261 3262 3263
            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 已提交
3264 3265 3266 3267 3268
        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.
3269 3270
        do_model_average_for_mean_and_var(bool, Default True): Whether parameter mean and variance
            should do model average when model average is enabled.
3271
        slot_dim(int): The embedding dimension of one slot. Slot is a set of one specific feature. In pslib mode, we
3272 3273
            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).
3274 3275
            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
3276 3277
            the show number and judge if the show number is zero. If so, we choose to skip normalization on this
            embedding.
H
hutuxian 已提交
3278 3279 3280
        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.
3281
        enable_scale_and_shift(bool, Default False): do scale&shift after normalization.
H
heqiaozhi 已提交
3282 3283

    Returns:
Y
yaoxuefeng 已提交
3284
        Tensor: A tensor which is the result after applying data normalization on the input.
H
heqiaozhi 已提交
3285 3286 3287 3288

    Examples:

        .. code-block:: python
3289

Y
yaoxuefeng 已提交
3290
            import paddle
3291
            paddle.enable_static()
H
heqiaozhi 已提交
3292

Y
yaoxuefeng 已提交
3293 3294
            x = paddle.randn(shape=[32,100])
            hidden2 = paddle.static.nn.data_norm(input=x)
H
heqiaozhi 已提交
3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312
    """
    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
3313 3314
    scale_w_default = 1.0
    bias_default = 0.0
H
heqiaozhi 已提交
3315 3316 3317 3318 3319

    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)
3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341
    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 已提交
3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371
    # 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)

3372 3373 3374 3375 3376 3377
    inputs = {
        "X": input,
        "BatchSize": batch_size,
        "BatchSum": batch_sum,
        "BatchSquareSum": batch_square_sum
    }
3378 3379 3380 3381 3382 3383 3384 3385 3386
    attrs = {
        "epsilon": epsilon,
        "sync_stats": sync_stats,
        "summary_decay_rate": summary_decay_rate,
    }
    if slot_dim > 0:
        attrs["slot_dim"] = slot_dim
    if enable_scale_and_shift:
        attrs["enable_scale_and_shift"] = enable_scale_and_shift
3387 3388 3389
    if enable_scale_and_shift:
        inputs["scale_w"] = scale_w
        inputs["bias"] = bias
H
heqiaozhi 已提交
3390 3391
    helper.append_op(
        type="data_norm",
3392
        inputs=inputs,
H
hutuxian 已提交
3393 3394 3395 3396 3397 3398 3399 3400
        outputs={
            "Y": data_norm_out,
            "Means": means,
            "Scales": scales,
            "BatchSize": batch_size,
            "BatchSum": batch_sum,
            "BatchSquareSum": batch_square_sum
        },
3401
        attrs=attrs)
H
heqiaozhi 已提交
3402 3403 3404 3405

    return helper.append_activation(data_norm_out)


Y
yuyang18 已提交
3406
@templatedoc()
G
guosheng 已提交
3407 3408 3409 3410 3411 3412 3413 3414 3415
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):
3416
    r"""
3417 3418
    :api_attr: Static Graph

3419 3420 3421 3422
    **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 已提交
3423 3424 3425

    The formula is as follows:

Y
yuyang18 已提交
3426
    ..  math::
G
guosheng 已提交
3427

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

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

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

3434 3435 3436 3437 3438
    - :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 已提交
3439

G
guosheng 已提交
3440
    Args:
3441
        input(Tensor): A multi-dimension ``Tensor`` , and the data type is float32 or float64.
3442 3443 3444 3445 3446
        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 已提交
3447
            dimensions from :attr:`begin_norm_axis` to :attr:`rank(input)`.
3448 3449 3450 3451
            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 已提交
3452 3453
            gain :math:`g`. If :attr:`scale` is False, :attr:`param_attr` is
            omitted. If :attr:`scale` is True and :attr:`param_attr` is None,
3454
            a default :code:`ParamAttr` would be added as scale. The
3455 3456
            :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 已提交
3457 3458
            bias :math:`b`. If :attr:`shift` is False, :attr:`bias_attr` is
            omitted. If :attr:`shift` is True and :attr:`param_attr` is None,
3459
            a default :code:`ParamAttr` would be added as bias. The
3460
            :attr:`bias_attr` is initialized as 0 if it is added. Default: None.
T
tianshuo78520a 已提交
3461
        act(str, optional): Activation to be applied to the output of layer normalization.
3462 3463
                  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 已提交
3464 3465

    Returns:
3466
        Tensor: ``Tensor``  indicating the normalized result, the data type is the same as  ``input`` , and the return dimension is the same as  ``input`` .
G
guosheng 已提交
3467 3468 3469

    Examples:

3470 3471
        .. code-block:: python

3472 3473
            import paddle
            paddle.enable_static()
3474 3475 3476
            x = paddle.static.data(name='x', shape=[8, 32, 32], dtype='float32')
            output = paddle.static.nn.layer_norm(input=x, begin_norm_axis=1)
            print(output.shape)  # [8, 32, 32]
G
guosheng 已提交
3477
    """
L
lujun 已提交
3478
    assert in_dygraph_mode(
3479
    ) is not True, "please use LayerNorm instead of layer_norm in dygraph mode!"
G
guosheng 已提交
3480
    helper = LayerHelper('layer_norm', **locals())
3481 3482
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'layer_norm')
G
guosheng 已提交
3483 3484 3485 3486 3487 3488 3489
    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:
3490
        assert param_attr is not False, "param_attr should not be False when using scale."
G
guosheng 已提交
3491 3492 3493 3494 3495 3496
        scale = helper.create_parameter(
            attr=helper.param_attr,
            shape=param_shape,
            dtype=dtype,
            default_initializer=Constant(1.0))
        inputs['Scale'] = scale
3497 3498
    else:
        if param_attr:
T
tianshuo78520a 已提交
3499
            warnings.warn("param_attr is only available with scale is True.")
G
guosheng 已提交
3500
    if shift:
3501
        assert bias_attr is not False, "bias_attr should not be False when using shift."
G
guosheng 已提交
3502 3503 3504
        bias = helper.create_parameter(
            attr=helper.bias_attr, shape=param_shape, dtype=dtype, is_bias=True)
        inputs['Bias'] = bias
3505 3506
    else:
        if bias_attr:
T
tianshuo78520a 已提交
3507
            warnings.warn("bias_attr is only available with shift is True.")
G
guosheng 已提交
3508 3509

    # create output
X
Xin Pan 已提交
3510 3511 3512 3513 3514
    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 已提交
3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529

    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 已提交
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539
@templatedoc()
def group_norm(input,
               groups,
               epsilon=1e-05,
               param_attr=None,
               bias_attr=None,
               act=None,
               data_layout='NCHW',
               name=None):
    """
3540 3541
    :api_attr: Static Graph

D
Dun 已提交
3542 3543
    **Group Normalization Layer**

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

3546
    Parameters:
C
Chen Long 已提交
3547
        input(Tensor): 4-D Tensor, the data type is float32 or float64.
3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559
        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 已提交
3560
        act(str, optional): Activation to be applied to the output of group normalization.
3561
        data_layout(str, optional): Specify the data format of the input, and the data format of the output
3562 3563 3564
            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]`.
3565 3566
        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 已提交
3567 3568

    Returns:
C
Chen Long 已提交
3569
        Tensor: A 4-D Tensor has same data type and data format with `input`.
D
Dun 已提交
3570 3571

    Examples:
3572
       .. code-block:: python
D
Dun 已提交
3573

3574 3575 3576
            import paddle
            paddle.enable_static()
            
C
Chen Long 已提交
3577 3578 3579
            data = paddle.static.data(name='data', shape=[2, 8, 32, 32], dtype='float32')
            x = paddle.static.nn.group_norm(input=data, groups=4)
            print(x.shape) # [2, 8, 32, 32]
D
Dun 已提交
3580 3581 3582
    """
    helper = LayerHelper('group_norm', **locals())
    dtype = helper.input_dtype()
3583 3584
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'group_norm')
D
Dun 已提交
3585 3586 3587
    # create intput and parameters
    inputs = {'X': input}
    input_shape = input.shape
3588 3589 3590 3591 3592 3593
    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 已提交
3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606
    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 已提交
3607 3608
    mean_out = helper.create_variable(dtype=dtype, stop_gradient=True)
    variance_out = helper.create_variable(dtype=dtype, stop_gradient=True)
D
dengkaipeng 已提交
3609 3610 3611 3612 3613 3614 3615 3616 3617 3618
    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,
        },
3619 3620 3621 3622 3623
        attrs={
            "epsilon": epsilon,
            "groups": groups,
            "data_layout": data_layout
        })
D
dengkaipeng 已提交
3624 3625 3626 3627 3628

    return helper.append_activation(group_norm_out)


@templatedoc()
3629
def spectral_norm(weight, dim=0, power_iters=1, eps=1e-12, name=None):
3630
    r"""
3631 3632
    :api_attr: Static Graph

D
dengkaipeng 已提交
3633 3634
    **Spectral Normalization Layer**

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

D
dengkaipeng 已提交
3640 3641 3642
    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 已提交
3643
    and W is the product result of remaining dimensions.
D
dengkaipeng 已提交
3644 3645

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

3650
    .. math::
D
dengkaipeng 已提交
3651 3652 3653 3654 3655 3656

        \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 已提交
3657
    Calculate :math:`\sigma(\mathbf{W})` and normalize weight values.
D
dengkaipeng 已提交
3658 3659 3660 3661

    .. math::

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

D
dengkaipeng 已提交
3663
        \mathbf{W} = \\frac{\mathbf{W}}{\sigma(\mathbf{W})}
3664

3665

D
dengkaipeng 已提交
3666 3667 3668
    Refer to `Spectral Normalization <https://arxiv.org/abs/1802.05957>`_ .

    Args:
C
Chen Long 已提交
3669
        weight(Tensor): ${weight_comment}
D
dengkaipeng 已提交
3670 3671 3672
        dim(int): ${dim_comment}
        power_iters(int): ${power_iters_comment}
        eps(float): ${eps_comment}
K
Kaipeng Deng 已提交
3673 3674 3675
        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 已提交
3676 3677

    Returns:
C
Chen Long 已提交
3678
        Tensor: A tensor of weight parameters after spectral normalization.
K
Kaipeng Deng 已提交
3679
                  The data type and shape is same as input tensor.
D
dengkaipeng 已提交
3680 3681

    Examples:
K
Kaipeng Deng 已提交
3682
       .. code-block:: python
D
dengkaipeng 已提交
3683

3684
            import paddle
K
Kaipeng Deng 已提交
3685

3686
            paddle.enable_static()
C
Chen Long 已提交
3687
            weight = paddle.static.data(name='weight', shape=[2, 8, 32, 32], dtype='float32')
3688
            x = paddle.static.nn.spectral_norm(weight=weight, dim=1, power_iters=2)
C
Chen Long 已提交
3689
            print(x.shape) # [2, 8, 32, 32]
D
dengkaipeng 已提交
3690 3691
    """
    helper = LayerHelper('spectral_norm', **locals())
3692 3693 3694 3695 3696
    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')
3697
    dtype = weight.dtype
D
dengkaipeng 已提交
3698 3699 3700

    # create intput and parameters
    inputs = {'Weight': weight}
3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718
    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 已提交
3719 3720

    # create output
3721
    out = helper.create_variable(dtype=dtype)
D
Dun 已提交
3722 3723

    helper.append_op(
3724
        type="spectral_norm",
D
Dun 已提交
3725
        inputs=inputs,
3726 3727 3728 3729 3730 3731
        outputs={"Out": out, },
        attrs={
            "dim": dim,
            "power_iters": power_iters,
            "eps": eps,
        })
D
Dun 已提交
3732

3733
    return out
D
Dun 已提交
3734 3735


Y
Yu Yang 已提交
3736 3737 3738 3739
def conv2d_transpose(input,
                     num_filters,
                     output_size=None,
                     filter_size=None,
C
chengduoZH 已提交
3740 3741 3742
                     padding=0,
                     stride=1,
                     dilation=1,
3743
                     groups=None,
C
caoying03 已提交
3744
                     param_attr=None,
3745
                     bias_attr=None,
C
chengduoZH 已提交
3746
                     use_cudnn=True,
3747
                     act=None,
3748 3749
                     name=None,
                     data_format='NCHW'):
3750
    r"""
3751 3752
    :api_attr: Static Graph

3753 3754
    The convolution2D transpose layer calculates the output based on the input,
    filter, and dilations, strides, paddings. Input(Input) and output(Output)
3755
    are in NCHW or NHWC format. Where N is batch size, C is the number of channels,
3756 3757 3758
    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
3759
    layer, please refer to the following explanation and references
L
lvmengsi 已提交
3760
    `therein <https://arxiv.org/pdf/1603.07285.pdf>`_.
3761 3762 3763
    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.
3764 3765 3766 3767 3768

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

    .. math::

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

3771
    Where:
3772

3773 3774
    * :math:`X`: Input value, a 4-D Tensor with NCHW or NHWC format.
    * :math:`W`: Filter value, a 4-D Tensor with MCHW format.
3775
    * :math:`\\ast`: Convolution operation.
3776
    * :math:`b`: Bias value, a 2-D Tensor with shape [M, 1].
3777
    * :math:`\\sigma`: Activation function.
3778
    * :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 已提交
3779

3780 3781 3782 3783
    Example:

        - Input:

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

3786
          Filter shape: :math:`(C_{in}, C_{out}, H_f, W_f)`
3787 3788 3789

        - Output:

3790
          Output shape: :math:`(N, C_{out}, H_{out}, W_{out})`
3791 3792

        Where
Y
Yu Yang 已提交
3793

3794 3795
        .. math::

3796 3797
           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 已提交
3798
           H_{out} &\in [ H^\prime_{out}, H^\prime_{out} + strides[0] ] \\\\
3799 3800
           W_{out} &\in [ W^\prime_{out}, W^\prime_{out} + strides[1] ]

L
lvmengsi 已提交
3801
    Note:
3802 3803
          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 已提交
3804
          so for conv2d_transpose, when stride > 1, input shape maps multiple output shape.
3805 3806 3807 3808
          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 已提交
3809
          conv2d_transpose can compute the kernel size automatically.
Y
Yu Yang 已提交
3810 3811

    Args:
3812
        input(Tensor): 4-D Tensor with [N, C, H, W] or [N, H, W, C] format,
3813
                         its data type is float32 or float64.
3814 3815
        num_filters(int): The number of the filter. It is as same as the output
            image channel.
3816
        output_size(int|tuple, optional): The output image size. If output size is a
3817
            tuple, it must contain two integers, (image_height, image_width). None if use
3818
            filter_size, padding, and stride to calculate output_size.
L
lvmengsi 已提交
3819
            If output_size and filter_size are specified at the same time, They
3820
            should follow the formula above. Default: None. output_size and filter_size
L
lvmengsi 已提交
3821
            should not be None at the same time.
3822
        filter_size(int|tuple, optional): The filter size. If filter_size is a tuple,
3823
            it must contain two integers, (filter_size_height, filter_size_width).
3824 3825
            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 已提交
3826
            output_size should not be None at the same time.
3827 3828
        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 已提交
3829
            Otherwise, stride_height = stride_width = stride. Default: stride = 1.
3830 3831 3832 3833 3834 3835 3836 3837
        padding(str|int|list|tuple, optional): The padding size. It means the number of zero-paddings 
            on both sides for each dimension. If `padding` is a string, either 'VALID' or 
            'SAME' 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 
3838 3839
            `[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]`.
            Default: padding = 0.
3840 3841
        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 已提交
3842 3843 3844
            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).
3845
            Otherwise, filter_size_height = filter_size_width = filter_size. None if
L
lvmengsi 已提交
3846
            use output size to calculate filter_size. Default: None.
3847
        groups(int, optional): The groups number of the Conv2d transpose layer. Inspired by
3848 3849 3850 3851
            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 已提交
3852
            Default: groups = 1.
3853
        param_attr (ParamAttr, optional): The parameter attribute for learnable parameters/weights
C
chengduo 已提交
3854 3855 3856
            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.
3857
        bias_attr (ParamAttr|bool, optional): The parameter attribute for the bias of conv2d_transpose.
C
chengduo 已提交
3858 3859 3860 3861
            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.
3862
        use_cudnn(bool, optional): Use cudnn kernel or not, it is valid only when the cudnn
C
chengduo 已提交
3863
            library is installed. Default: True.
3864
        act (str, optional): Activation type, if it is set to None, activation is not appended.
C
chengduo 已提交
3865
            Default: None.
3866 3867
        name(str, optional): For detailed information, please refer
           to :ref:`api_guide_Name`. Usually name is no need to set and
L
lvmengsi 已提交
3868
           None by default.
3869
        data_format (str, optional): Specify the data format of the input, and the data format of the output
3870 3871 3872
            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 已提交
3873 3874

    Returns:
3875
        A Tensor representing the conv2d_transpose, whose
3876
        data type is the same with input and shape is (num_batches, channels, out_h,
3877
        out_w) or (num_batches, out_h, out_w, channels). If act is None, the tensor 
3878
        storing the transposed convolution result, and if act is not None, the
3879
        tensor storing transposed convolution and non-linearity activation
L
lvmengsi 已提交
3880
        result.
3881 3882

    Raises:
3883 3884 3885
        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".
3886
        ValueError: If `padding` is a tuple, but the element corresponding to the input's batch size is not 0
3887 3888 3889 3890 3891 3892 3893
            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`.
3894 3895 3896 3897

    Examples:
       .. code-block:: python

3898 3899
          import paddle
          paddle.enable_static()
3900 3901 3902 3903

          data = paddle.static.data(name='data', shape=[None, 3, 32, 32], dtype='float32')
          conv2d_transpose = paddle.static.nn.conv2d_transpose(input=data, num_filters=2, filter_size=3)
          print(conv2d_transpose.shape) # [-1, 2, 34, 34]
Y
Yu Yang 已提交
3904
    """
C
chengduo 已提交
3905
    assert param_attr is not False, "param_attr should not be False in conv2d_transpose."
3906 3907 3908 3909
    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.")
3910

3911
    input_channel = input.shape[1] if data_format == 'NCHW' else input.shape[-1]
3912 3913 3914 3915 3916 3917
    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 已提交
3918 3919 3920
    if not isinstance(input, Variable):
        raise TypeError("Input of conv2d_transpose must be Variable")

C
chengduoZH 已提交
3921 3922
    stride = utils.convert_to_list(stride, 2, 'stride')
    dilation = utils.convert_to_list(dilation, 2, 'dilation')
G
guosheng 已提交
3923

C
chengduoZH 已提交
3924 3925
    if not isinstance(use_cudnn, bool):
        raise ValueError("use_cudnn should be True or False")
G
guosheng 已提交
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 3961 3962 3963 3964 3965 3966 3967 3968 3969
    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 已提交
3970 3971 3972 3973 3974
    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 已提交
3975

3976 3977
        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 已提交
3978

3979 3980 3981 3982
        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 已提交
3983
        filter_size = [filter_size_h, filter_size_w]
C
chengduoZH 已提交
3984 3985 3986
    else:
        filter_size = utils.convert_to_list(filter_size, 2,
                                            'conv2d_transpose.filter_size')
C
chengduo 已提交
3987

3988 3989 3990
    if len(padding) == 4 and utils._is_symmetric_padding(padding, 2):
        padding = [padding[0], padding[2]]

3991 3992
    if output_size is None:
        output_size = []
3993
    elif isinstance(output_size, (list, tuple, int)):
3994 3995
        output_size = utils.convert_to_list(output_size, 2, 'output_size')
    else:
3996
        raise ValueError("output_size should be int, list[int] or tuple[int]")
3997
    groups = 1 if groups is None else groups
M
minqiyang 已提交
3998
    filter_shape = [input_channel, num_filters // groups] + filter_size
C
chengduo 已提交
3999

Y
Yu Yang 已提交
4000 4001 4002
    img_filter = helper.create_parameter(
        dtype=input.dtype, shape=filter_shape, attr=helper.param_attr)

X
Xin Pan 已提交
4003
    pre_bias = helper.create_variable_for_type_inference(dtype=input.dtype)
Y
Yu Yang 已提交
4004
    helper.append_op(
4005
        type=op_type,
Y
Yu Yang 已提交
4006 4007
        inputs={'Input': [input],
                'Filter': [img_filter]},
4008
        outputs={'Output': pre_bias},
C
chengduoZH 已提交
4009
        attrs={
4010
            'output_size': output_size,
4011 4012
            'strides': stride,
            'paddings': padding,
4013
            'padding_algorithm': padding_algorithm,
4014 4015
            'dilations': dilation,
            'groups': groups,
4016 4017
            'use_cudnn': use_cudnn,
            'data_format': data_format
Y
Yu Yang 已提交
4018 4019
        })

4020 4021 4022 4023
    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)
4024 4025
    out = helper.append_activation(pre_act)
    return out
Y
Yu Yang 已提交
4026 4027


4028
def conv3d_transpose(input,
Y
Yu Yang 已提交
4029 4030 4031
                     num_filters,
                     output_size=None,
                     filter_size=None,
C
chengduoZH 已提交
4032 4033 4034
                     padding=0,
                     stride=1,
                     dilation=1,
4035
                     groups=None,
C
caoying03 已提交
4036
                     param_attr=None,
4037
                     bias_attr=None,
C
chengduoZH 已提交
4038
                     use_cudnn=True,
4039
                     act=None,
4040 4041
                     name=None,
                     data_format='NCDHW'):
4042
    r"""
4043 4044
    :api_attr: Static Graph

4045
    The convolution3D transpose layer calculates the output based on the input,
4046
    filter, and dilations, strides, paddings. Input(Input) and output(Output)
4047
    are in NCDHW or NDHWC format. Where N is batch size, C is the number of channels,
4048 4049 4050 4051
    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 已提交
4052
    explanation and references `therein <https://arxiv.org/pdf/1603.07285.pdf>`_.
4053 4054 4055
    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.
4056 4057 4058 4059 4060

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

    .. math::

4061
        Out = \sigma (W \\ast X + b)
4062 4063 4064

    In the above equation:

4065 4066
    * :math:`X`: Input value, a Tensor with NCDHW or NDHWC format.
    * :math:`W`: Filter value, a Tensor with MCDHW format.
4067
    * :math:`\\ast`: Convolution operation.
4068
    * :math:`b`: Bias value, a 2-D Tensor with shape [M, 1].
4069 4070
    * :math:`\\sigma`: Activation function.
    * :math:`Out`: Output value, the shape of :math:`Out` and :math:`X` may be different.
Y
Yu Yang 已提交
4071

4072 4073 4074 4075
    Example:

        - Input:

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

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

        - Output:

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

        Where
Y
Yu Yang 已提交
4085

4086 4087
        .. math::

L
lvmengsi 已提交
4088 4089 4090 4091 4092 4093
           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 已提交
4094

L
lvmengsi 已提交
4095
    Note:
4096 4097
          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 已提交
4098 4099
          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} = \
4100 4101 4102 4103 4104
          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 已提交
4105 4106 4107
          conv3d_transpose can compute the kernel size automatically.

    Args:
M
mls1999725 已提交
4108
        input(Tensor): The input is 5-D Tensor with shape [N, C, D, H, W] or [N, D, H, W, C], the data type
L
lvmengsi 已提交
4109
            of input is float32 or float64.
4110 4111
        num_filters(int): The number of the filter. It is as same as the output
            image channel.
4112
        output_size(int|tuple, optional): The output image size. If output size is a
L
lvmengsi 已提交
4113
            tuple, it must contain three integers, (image_depth, image_height, image_width). This
4114 4115
            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 已提交
4116
            Output_size and filter_size should not be None at the same time.
4117
        filter_size(int|tuple, optional): The filter size. If filter_size is a tuple,
L
lvmengsi 已提交
4118
            it must contain three integers, (filter_size_depth, filter_size_height,
4119 4120
            filter_size_width). Otherwise, filter_size_depth = filter_size_height = \
            filter_size_width = filter_size. None if use output size to
4121
            calculate filter_size. Default: None. filter_size and output_size should not be
L
lvmengsi 已提交
4122 4123 4124
            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,
4125 4126 4127 4128 4129 4130 4131 4132
             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.
4133 4134 4135
        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 已提交
4136
            Default: stride = 1.
4137 4138 4139
        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 已提交
4140
            Default: dilation = 1.
4141
        groups(int, optional): The groups number of the Conv3d transpose layer. Inspired by
4142 4143 4144 4145 4146
            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
4147
        param_attr (ParamAttr, optional): The parameter attribute for learnable parameters/weights
C
chengduo 已提交
4148 4149 4150
            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.
4151
        bias_attr (ParamAttr|bool, optional): The parameter attribute for the bias of conv3d_transpose.
C
chengduo 已提交
4152 4153 4154 4155
            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.
4156
        use_cudnn(bool, optional): Use cudnn kernel or not, it is valid only when the cudnn
4157
            library is installed. Default: True
4158
        act (str, optional): Activation type, if it is set to None, activation is not appended.
C
chengduo 已提交
4159
            Default: None.
4160 4161
        name(str, optional): For detailed information, please refer
           to :ref:`api_guide_Name`. Usually name is no need to set and
L
lvmengsi 已提交
4162
           None by default.
4163
        data_format (str, optional): Specify the data format of the input, and the data format of the output
4164 4165 4166
            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 已提交
4167 4168

    Returns:
4169 4170 4171 4172
        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 已提交
4173
        variable storing transposed convolution and non-linearity activation result.
4174 4175

    Raises:
4176 4177 4178
        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".
4179
        ValueError: If `padding` is a tuple, but the element corresponding to the input's batch size is not 0
4180 4181 4182 4183 4184 4185 4186
            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`.
4187 4188 4189 4190

    Examples:
       .. code-block:: python

4191
          import paddle
M
mls1999725 已提交
4192 4193
          import numpy as np
	    
4194
          paddle.enable_static()
M
mls1999725 已提交
4195 4196 4197 4198 4199 4200 4201 4202 4203
          data = paddle.static.data(name='data', shape=[None, 3, 12, 32, 32], dtype='float32')
          param_attr = paddle.framework.ParamAttr(name='conv3d.weight', initializer=paddle.nn.initializer.XavierNormal(), learning_rate=0.001)
          res = paddle.static.nn.conv3d_transpose(input=data, num_filters=2, filter_size=3, act="relu", param_attr=param_attr)
          place = paddle.CPUPlace()
          exe = paddle.static.Executor(place)
          exe.run(paddle.static.default_startup_program())
          x = np.random.rand(1, 3, 12, 32, 32).astype("float32")
          output = exe.run(feed={"data": x}, fetch_list=[res])
          print(output)
Y
Yu Yang 已提交
4204
    """
C
chengduo 已提交
4205
    assert param_attr is not False, "param_attr should not be False in conv3d_transpose."
4206 4207 4208 4209
    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.")
4210 4211
    l_type = "conv3d_transpose"
    helper = LayerHelper(l_type, **locals())
Y
Yu Yang 已提交
4212
    if not isinstance(input, Variable):
4213
        raise TypeError("Input of conv3d_transpose must be Variable")
4214 4215
    input_channel = input.shape[1] if data_format == 'NCDHW' else input.shape[
        -1]
Y
Yu Yang 已提交
4216

4217 4218
    stride = utils.convert_to_list(stride, 3, 'stride')
    dilation = utils.convert_to_list(dilation, 3, 'dilation')
C
chengduoZH 已提交
4219

C
chengduoZH 已提交
4220 4221 4222
    if not isinstance(use_cudnn, bool):
        raise ValueError("use_cudnn should be True or False")

4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236
    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]
4237 4238 4239 4240 4241 4242 4243 4244
            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 已提交
4245

4246 4247
        elif is_list_or_tuple(padding) and len(padding) == 6:
            padding = utils.convert_to_list(padding, 6, 'padding')
G
Guo Sheng 已提交
4248

4249 4250 4251 4252 4253 4254 4255
        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 已提交
4256

4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269
    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 已提交
4270

4271
    padding = _update_padding(padding, data_format)
Y
yangyaming 已提交
4272

4273 4274 4275 4276
    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):
4277
            output_size = [output_size, output_size, output_size]
Y
yangyaming 已提交
4278

4279 4280 4281
        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 已提交
4282

4283 4284 4285 4286 4287 4288 4289 4290 4291 4292
        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 已提交
4293

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

4297 4298 4299 4300 4301 4302 4303
    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]")

4304 4305 4306 4307
    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)
4308

4309 4310 4311 4312
    if data_format == 'NCDHW':
        data_format = 'NCHW'
    if data_format == 'NDHWC':
        data_format = 'NHWC'
Y
yangyaming 已提交
4313

4314
    pre_bias = helper.create_variable_for_type_inference(dtype=input.dtype)
Y
yangyaming 已提交
4315
    helper.append_op(
4316 4317 4318 4319 4320
        type=l_type,
        inputs={'Input': [input],
                'Filter': [img_filter]},
        outputs={'Output': pre_bias},
        attrs={
4321
            'output_size': output_size,
4322 4323 4324 4325 4326 4327 4328 4329
            'strides': stride,
            'paddings': padding,
            'padding_algorithm': padding_algorithm,
            'dilations': dilation,
            'groups': groups,
            'use_cudnn': use_cudnn,
            'data_format': data_format
        })
Y
yangyaming 已提交
4330

4331 4332 4333 4334 4335 4336
    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 已提交
4337 4338


C
caoying03 已提交
4339
def reduce_sum(input, dim=None, keep_dim=False, name=None):
G
guosheng 已提交
4340
    """
4341

Y
yangyaming 已提交
4342
    Computes the sum of tensor elements over the given dimension.
G
guosheng 已提交
4343 4344

    Args:
4345 4346 4347
        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 已提交
4348 4349
            :attr:`None`, sum all elements of :attr:`input` and return a
            Tensor variable with a single element, otherwise must be in the
W
whs 已提交
4350 4351
            range :math:`[-rank(input), rank(input))`. If :math:`dim[i] < 0`,
            the dimension to reduce is :math:`rank + dim[i]`.
4352
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
Y
yangyaming 已提交
4353
            output Tensor. The result tensor will have one fewer dimension
4354 4355 4356 4357
            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 已提交
4358 4359

    Returns:
4360 4361
        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 已提交
4362

4363 4364
    Raises:
        TypeError, if out data type is different with the input data type.
4365

G
guosheng 已提交
4366 4367 4368
    Examples:
        .. code-block:: python

4369
            import paddle.fluid as fluid
4370 4371
            import paddle
            paddle.enable_static()
G
guosheng 已提交
4372 4373 4374
            # 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 已提交
4375
            # Each example is followed by the corresponding output tensor.
4376
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
G
guosheng 已提交
4377 4378 4379 4380
            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 已提交
4381

4382
            # y is a Tensor variable with shape [2, 2, 2] and elements as below:
W
whs 已提交
4383 4384
            #      [[[1, 2], [3, 4]],
            #      [[5, 6], [7, 8]]]
Q
qiaolongfei 已提交
4385
            # Each example is followed by the corresponding output tensor.
4386
            y = fluid.data(name='y', shape=[2, 2, 2], dtype='float32')
4387 4388
            fluid.layers.reduce_sum(y, dim=[1, 2]) # [10, 26]
            fluid.layers.reduce_sum(y, dim=[0, 1]) # [16, 20]
W
whs 已提交
4389

G
guosheng 已提交
4390
    """
4391 4392
    if dim is not None and not isinstance(dim, list):
        dim = [dim]
4393 4394

    if in_dygraph_mode():
Q
Qinghe JING 已提交
4395 4396
        reduce_all = True if dim == None or dim == [] or len(dim) == len(
            input.shape) else False
4397 4398 4399
        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)
4400
    attrs = {
4401
        'dim': dim if dim != None and dim != [] else [0],
4402
        'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4403 4404
        'reduce_all': True
        if dim == None or dim == [] or len(dim) == len(input.shape) else False
4405
    }
4406 4407
    check_variable_and_dtype(
        input, 'input', ['float32', 'float64', 'int32', 'int64'], 'reduce_sum')
4408
    helper = LayerHelper('reduce_sum', **locals())
X
Xin Pan 已提交
4409
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
G
guosheng 已提交
4410 4411 4412 4413
    helper.append_op(
        type='reduce_sum',
        inputs={'X': input},
        outputs={'Out': out},
4414
        attrs=attrs)
G
guosheng 已提交
4415
    return out
G
guosheng 已提交
4416 4417


4418
@deprecated(since="2.0.0", update_to="paddle.mean")
C
caoying03 已提交
4419
def reduce_mean(input, dim=None, keep_dim=False, name=None):
G
guosheng 已提交
4420
    """
Y
Yibing Liu 已提交
4421
    Computes the mean of the input tensor's elements along the given dimension.
G
guosheng 已提交
4422 4423

    Args:
4424 4425 4426
        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 已提交
4427 4428
            `None`, compute the mean over all elements of :attr:`input`
            and return a variable with a single element, otherwise it
Y
yangyaming 已提交
4429
            must be in the range :math:`[-rank(input), rank(input))`. If
4430
            :math:`dim[i] < 0`, the dimension to reduce is
Y
Yibing Liu 已提交
4431
            :math:`rank(input) + dim[i]`.
4432
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
Y
yangyaming 已提交
4433
            output Tensor. The result tensor will have one fewer dimension
4434
            than the :attr:`input` unless :attr:`keep_dim` is true, default
4435 4436 4437
            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`
4438

G
guosheng 已提交
4439
    Returns:
4440 4441
        Variable: Tensor, results of average on the specified dim of input tensor,
        it's data type is the same as input's Tensor.
4442

4443 4444
    Raises:
        TypeError, if out data type is different with the input data type.
4445

G
guosheng 已提交
4446 4447 4448
    Examples:
        .. code-block:: python

4449
            import paddle.fluid as fluid
G
guosheng 已提交
4450 4451 4452
            # 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 已提交
4453
            # Each example is followed by the corresponding output tensor.
4454
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
G
guosheng 已提交
4455 4456 4457
            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]
4458
            fluid.layers.reduce_mean(x, dim=1, keep_dim=True)  # [[0.475], [0.4]]
W
whs 已提交
4459

4460
            # y is a Tensor variable with shape [2, 2, 2] and elements as below:
W
whs 已提交
4461 4462
            #      [[[1.0, 2.0], [3.0, 4.0]],
            #      [[5.0, 6.0], [7.0, 8.0]]]
T
tianshuo78520a 已提交
4463
            # Each example is followed by the corresponding output tensor.
4464
            y = fluid.data(name='y', shape=[2, 2, 2], dtype='float32')
4465 4466
            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 已提交
4467
    """
4468

4469
    return paddle.mean(x=input, axis=dim, keepdim=keep_dim, name=name)
4470 4471


C
caoying03 已提交
4472
def reduce_max(input, dim=None, keep_dim=False, name=None):
4473
    """
4474

Y
yangyaming 已提交
4475
    Computes the maximum of tensor elements over the given dimension.
4476 4477

    Args:
4478 4479 4480
        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 已提交
4481 4482 4483
            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 已提交
4484
            If :math:`dim[i] < 0`, the dimension to reduce is :math:`rank + dim[i]`.
4485
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
Y
yangyaming 已提交
4486
            output Tensor. The result tensor will have one fewer dimension
4487 4488
            than the :attr:`input` unless :attr:`keep_dim` is true, default
            value is False.
4489
        name(str, optional): The default value is None.  Normally there is no need for
4490
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
4491 4492

    Returns:
4493 4494
        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 已提交
4495

4496 4497 4498
    Examples:
        .. code-block:: python

4499
            import paddle.fluid as fluid
4500 4501
            import paddle
            paddle.enable_static()
4502 4503 4504
            # 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 已提交
4505
            # Each example is followed by the corresponding output tensor.
4506
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
4507 4508 4509 4510
            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 已提交
4511

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


C
caoying03 已提交
4537
def reduce_min(input, dim=None, keep_dim=False, name=None):
4538
    """
4539

Y
yangyaming 已提交
4540
    Computes the minimum of tensor elements over the given dimension.
4541 4542

    Args:
4543 4544 4545
        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 已提交
4546 4547 4548
            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 已提交
4549
            If :math:`dim[i] < 0`, the dimension to reduce is :math:`rank + dim[i]`.
4550
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
Y
yangyaming 已提交
4551
            output Tensor. The result tensor will have one fewer dimension
4552 4553
            than the :attr:`input` unless :attr:`keep_dim` is true, default
            value is False.
4554
        name(str, optional): The default value is None.  Normally there is no need for
4555
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
4556 4557

    Returns:
4558 4559
        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 已提交
4560

4561 4562 4563
    Examples:
        .. code-block:: python

4564
            import paddle.fluid as fluid
4565 4566 4567
            import paddle
            paddle.enable_static()

4568 4569 4570
            # 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 已提交
4571
            # Each example is followed by the corresponding output tensor.
4572
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
4573 4574 4575 4576
            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 已提交
4577

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


4603 4604
def reduce_prod(input, dim=None, keep_dim=False, name=None):
    """
4605

4606 4607 4608
    Computes the product of tensor elements over the given dimension.

    Args:
4609 4610
        input (Variable): The input variable which is a Tensor, the data type is float32,
            float64, int32, int64.
G
guofei 已提交
4611
        dim (int|list|tuple, optional): The dimensions along which the product is performed. If
T
tianshuo78520a 已提交
4612
            :attr:`None`, multiply all elements of :attr:`input` and return a
4613
            Tensor variable with a single element, otherwise must be in the
W
whs 已提交
4614 4615
            range :math:`[-rank(input), rank(input))`. If :math:`dim[i] < 0`,
            the dimension to reduce is :math:`rank + dim[i]`.
4616
        keep_dim (bool, optional): Whether to reserve the reduced dimension in the
4617
            output Tensor. The result tensor will have one fewer dimension
4618 4619
            than the :attr:`input` unless :attr:`keep_dim` is true, default
            value is False.
4620
        name(str, optional): The default value is None.  Normally there is no need for
4621
            user to set this property.  For more information, please refer to :ref:`api_guide_Name`
4622 4623

    Returns:
4624 4625
        Variable: Tensor, result of product on the specified dim of input tensor,
        it's data type is the same as input's Tensor.
4626

4627 4628 4629
    Examples:
        .. code-block:: python

4630
            import paddle.fluid as fluid
4631 4632
            import paddle
            paddle.enable_static()
4633 4634 4635
            # 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 已提交
4636
            # Each example is followed by the corresponding output tensor.
4637
            x = fluid.data(name='x', shape=[2, 4], dtype='float32')
4638 4639 4640
            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 已提交
4641
            fluid.layers.reduce_prod(x, dim=1,
Z
zhouhanqing 已提交
4642
                                     keep_dim=True)  # [[0.027], [0.0084]]
W
whs 已提交
4643

4644
            # y is a Tensor variable with shape [2, 2, 2] and elements as below:
W
whs 已提交
4645 4646
            #      [[[1.0, 2.0], [3.0, 4.0]],
            #      [[5.0, 6.0], [7.0, 8.0]]]
T
tianshuo78520a 已提交
4647
            # Each example is followed by the corresponding output tensor.
4648
            y = fluid.data(name='y', shape=[2, 2, 2], dtype='float32')
4649 4650
            fluid.layers.reduce_prod(y, dim=[1, 2]) # [24.0, 1680.0]
            fluid.layers.reduce_prod(y, dim=[0, 1]) # [105.0, 384.0]
4651 4652
    """
    helper = LayerHelper('reduce_prod', **locals())
W
whs 已提交
4653
    if dim is not None and not isinstance(dim, list):
G
guofei 已提交
4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664
        if isinstance(dim, tuple):
            dim = list(dim)
        elif isinstance(dim, int):
            dim = [dim]
        else:
            raise TypeError(
                "The type of axis must be int, list or tuple, but received {}".
                format(type(dim)))
    check_variable_and_dtype(
        input, 'input', ['float32', 'float64', 'int32', 'int64'], 'reduce_prod')
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
4665 4666 4667 4668 4669
    helper.append_op(
        type='reduce_prod',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={
4670
            'dim': dim if dim != None and dim != [] else [0],
4671
            'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4672 4673
            'reduce_all': True if dim == None or dim == [] or
            len(dim) == len(input.shape) else False
4674 4675 4676 4677
        })
    return out


Z
zhoukunsheng 已提交
4678 4679
def reduce_all(input, dim=None, keep_dim=False, name=None):
    """
4680

4681
    This OP computes the ``logical and`` of tensor elements over the given dimension, and output the result.
Z
zhoukunsheng 已提交
4682 4683

    Args:
4684
        input (Tensor): the input tensor, it's data type should be `bool`.
4685
        dim (list|int|optional): The dimension along which the logical and is computed.
Z
zhoukunsheng 已提交
4686 4687 4688
            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))`.
4689
            If :math:`dim[i] < 0`, the dimension to reduce is :math:`rank + dim[i]`. The default value is None.
Z
zhoukunsheng 已提交
4690 4691
        keep_dim (bool): Whether to reserve the reduced dimension in the
            output Tensor. The result tensor will have one fewer dimension
4692
            than the :attr:`input` unless :attr:`keep_dim` is true. The default value is False.
Z
zhoukunsheng 已提交
4693
        name(str|None): A name for this layer(optional). If set None, the layer
4694
                       will be named automatically. The default value is None.
Z
zhoukunsheng 已提交
4695

4696
    Returns:
4697
        Tensor, the output data type is bool. : The reduced tensor variable with ``logical and`` in given dims.
Z
zhoukunsheng 已提交
4698 4699 4700

    Examples:
        .. code-block:: python
4701

4702
            import paddle
4703
            import paddle.fluid as fluid
4704 4705 4706
            import paddle.fluid.layers as layers
            import numpy as np

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

4713 4714 4715
            out = fluid.layers.reduce_all(x)  # False
            out = fluid.layers.reduce_all(x, dim=0)  # [True, False]
            out = fluid.layers.reduce_all(x, dim=-1)  # [False, True]
4716 4717
            # keep_dim=False, x.shape=(2,2), out.shape=(2,)

4718
            out = fluid.layers.reduce_all(x, dim=1, keep_dim=True)  # [[False], [True]]
4719
            # keep_dim=True, x.shape=(2,2), out.shape=(2,1)
Z
zhoukunsheng 已提交
4720 4721

    """
4722
    check_variable_and_dtype(input, 'input', ('bool'), 'reduce_all')
Z
zhoukunsheng 已提交
4723 4724 4725 4726 4727 4728 4729 4730 4731
    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={
4732
            'dim': dim if dim != None and dim != [] else [0],
Z
zhoukunsheng 已提交
4733
            'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4734 4735
            'reduce_all': True if dim == None or dim == [] or
            len(dim) == len(input.shape) else False
Z
zhoukunsheng 已提交
4736 4737 4738 4739 4740 4741
        })
    return out


def reduce_any(input, dim=None, keep_dim=False, name=None):
    """
4742
    This OP computes the ``logical or`` of tensor elements over the given dimension, and output the result.
Z
zhoukunsheng 已提交
4743 4744

    Args:
4745
        input (Tensor): the input tensor, it's data type should be `bool`.
4746 4747
        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 已提交
4748 4749
            :attr:`input` and return a Tensor variable with a single element,
            otherwise must be in the range :math:`[-rank(input), rank(input))`.
4750
            If :math:`dim[i] < 0`, the dimension to reduce is :math:`rank + dim[i]`. The default value is None.
Z
zhoukunsheng 已提交
4751 4752
        keep_dim (bool): Whether to reserve the reduced dimension in the
            output Tensor. The result tensor will have one fewer dimension
4753
            than the :attr:`input` unless :attr:`keep_dim` is true. The default value is False.
4754
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
Z
zhoukunsheng 已提交
4755

4756
    Returns:
4757
        Tensor, the output data type is bool. : The reduced tensor variable with ``logical or`` in given dims.
Z
zhoukunsheng 已提交
4758 4759 4760

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

4762
            import paddle
4763
            import paddle.fluid as fluid
4764 4765 4766
            import paddle.fluid.layers as layers
            import numpy as np

Z
zhoukunsheng 已提交
4767 4768 4769
            # x is a bool Tensor variable with following elements:
            #    [[True, False]
            #     [False, False]]
4770 4771
            x = fluid.layers.assign(np.array([[1, 0], [0, 0]], dtype='int32'))
            x = fluid.layers.cast(x, 'bool')
4772

4773 4774 4775
            out = fluid.layers.reduce_any(x)  # True
            out = fluid.layers.reduce_any(x, dim=0)  # [True, False]
            out = fluid.layers.reduce_any(x, dim=-1)  # [True, False]
4776 4777
            # keep_dim=False, x.shape=(2,2), out.shape=(2,)

4778
            out = fluid.layers.reduce_any(x, dim=1,
Z
zhoukunsheng 已提交
4779
                                     keep_dim=True)  # [[True], [False]]
4780
            # keep_dim=True, x.shape=(2,2), out.shape=(2,1)
Z
zhoukunsheng 已提交
4781 4782

    """
4783
    check_variable_and_dtype(input, 'input', ('bool'), 'reduce_any')
Z
zhoukunsheng 已提交
4784 4785 4786 4787 4788 4789 4790 4791 4792
    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={
4793
            'dim': dim if dim != None and dim != [] else [0],
Z
zhoukunsheng 已提交
4794
            'keep_dim': keep_dim,
Q
Qinghe JING 已提交
4795 4796
            'reduce_all': True if dim == None or dim == [] or
            len(dim) == len(input.shape) else False
4797 4798 4799 4800
        })
    return out


C
caoying03 已提交
4801
def split(input, num_or_sections, dim=-1, name=None):
G
guosheng 已提交
4802
    """
4803
    Split the input tensor into multiple sub-Tensors.
G
guosheng 已提交
4804 4805

    Args:
4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816
        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 已提交
4817 4818

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

4821
    Example:
G
guosheng 已提交
4822 4823
        .. code-block:: python

4824 4825
            import paddle.fluid as fluid

4826
            # input is a Tensor which shape is [3, 9, 5]
4827
            input = fluid.data(
4828 4829
                 name="input", shape=[3, 9, 5], dtype="float32")

4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850
            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]
4851

G
guosheng 已提交
4852
    """
4853
    if in_dygraph_mode():
4854 4855 4856
        num = None
        attrs = ()

S
songyouwei 已提交
4857 4858
        if isinstance(dim, Variable):
            dim = dim.numpy()
4859
            dim = dim.item(0)
S
songyouwei 已提交
4860
        dim = (len(input.shape) + dim) if dim < 0 else dim
4861
        attrs += ('axis', dim)
4862 4863 4864

        if isinstance(num_or_sections, int):
            num = num_or_sections
4865
            attrs += ('num', num_or_sections)
L
Leo Chen 已提交
4866
        elif isinstance(num_or_sections, (list, tuple)):
4867
            num = len(num_or_sections)
L
Leo Chen 已提交
4868
            if utils._contain_var(num_or_sections):
4869 4870 4871 4872 4873
                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 已提交
4874
            else:
4875
                attrs += ('sections', list(num_or_sections))
4876 4877
        else:
            raise TypeError(
4878
                "The type of 'num_or_sections' in split must be int, list or tuple in imperative mode, but "
4879
                "received %s." % (type(num_or_sections)))
4880
        return core.ops.split(input, num, *attrs)
L
Leo Chen 已提交
4881

4882 4883
    check_variable_and_dtype(
        input, 'input',
4884
        ['bool', 'float16', 'float32', 'float64', 'int32', 'int64'], 'split')
4885 4886 4887 4888
    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')
4889

G
guosheng 已提交
4890
    helper = LayerHelper('split', **locals())
4891

G
guosheng 已提交
4892
    input_shape = input.shape
4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923
    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 已提交
4924 4925
    if isinstance(num_or_sections, int):
        assert num_or_sections > 1, 'num_or_sections must be more than 1.'
4926 4927 4928 4929 4930
        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 已提交
4931 4932
        num = num_or_sections
    else:
4933 4934 4935
        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 已提交
4936
        num = len(num_or_sections)
4937 4938 4939
        attrs['sections'] = list(
            map(lambda ele: -1 if isinstance(ele, Variable) else ele,
                num_or_sections))
L
Leo Chen 已提交
4940
        if utils._contain_var(num_or_sections):
4941 4942 4943
            inputs['SectionsTensorList'] = _get_SectionsTensorList(
                num_or_sections)

G
guosheng 已提交
4944
    outs = [
X
Xin Pan 已提交
4945
        helper.create_variable_for_type_inference(dtype=helper.input_dtype())
G
guosheng 已提交
4946 4947 4948
        for i in range(num)
    ]
    helper.append_op(
4949
        type='split', inputs=inputs, outputs={'Out': outs}, attrs=attrs)
G
guosheng 已提交
4950
    return outs
C
caoying03 已提交
4951 4952 4953


def l2_normalize(x, axis, epsilon=1e-12, name=None):
4954
    r"""
4955

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

4959
    .. math::
4960 4961

        y = \\frac{x}{ \sqrt{\sum {x^2} + epsion }}
C
caoying03 已提交
4962 4963 4964 4965 4966

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

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

C
caoying03 已提交
4975
    Returns:
R
ruri 已提交
4976
        Variable: The output has the same shape and data type with `x`.
C
caoying03 已提交
4977 4978

    Examples:
4979

C
caoying03 已提交
4980
        .. code-block:: python
4981

R
ruri 已提交
4982 4983 4984
	    # declarative mode
	    import paddle.fluid as fluid
	    import numpy as np
4985 4986
        import paddle
        paddle.enable_static()
R
ruri 已提交
4987 4988 4989 4990 4991
	    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())
4992

R
ruri 已提交
4993 4994
	    input_data = np.random.rand(2,3).astype("float32")
	    print(input_data)
C
caoying03 已提交
4995

R
ruri 已提交
4996 4997
	    # [[0.5171216  0.12704141 0.56018186]
	    # [0.93251234 0.5382788  0.81709313]]
4998

R
ruri 已提交
4999 5000 5001 5002
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
5003

R
ruri 已提交
5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015
	    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())
5016

R
ruri 已提交
5017 5018
		# [[0.66907585 0.16437206 0.7247892 ]
		# [0.6899054  0.3982376  0.6045142 ]]
5019

C
caoying03 已提交
5020 5021
    """

F
fengjiayi 已提交
5022 5023
    if len(x.shape) == 1:
        axis = 0
5024
    check_variable_and_dtype(x, "X", ("float32", "float64"), "norm")
C
caoying03 已提交
5025

5026
    helper = LayerHelper("l2_normalize", **locals())
X
Xin Pan 已提交
5027 5028
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    norm = helper.create_variable_for_type_inference(dtype=x.dtype)
C
caoying03 已提交
5029
    helper.append_op(
5030 5031 5032 5033
        type="norm",
        inputs={"X": x},
        outputs={"Out": out,
                 "Norm": norm},
C
caoying03 已提交
5034
        attrs={
5035 5036
            "axis": 1 if axis is None else axis,
            "epsilon": epsilon,
C
caoying03 已提交
5037 5038
        })
    return out
5039 5040


S
ShenLiang 已提交
5041
@deprecated(since="2.0.0", update_to="paddle.matmul")
S
sneaxiy 已提交
5042
def matmul(x, y, transpose_x=False, transpose_y=False, alpha=1.0, name=None):
G
guosheng 已提交
5043
    """
Y
ying 已提交
5044 5045 5046 5047
    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 已提交
5048

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

5052 5053 5054 5055 5056
    - 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
5057
      :math:`[1, D]` in transposed form.
G
guosheng 已提交
5058

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

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

Y
ying 已提交
5067 5068
    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 已提交
5069
    removed after matrix multiplication.
G
guosheng 已提交
5070 5071 5072

    Args:
        x (Variable): The input variable which is a Tensor or LoDTensor.
5073 5074 5075
        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 已提交
5076
        alpha (float): The scale of output. Default 1.0.
5077
        name(str|None): A name for this layer(optional). If set None, the layer
5078
            will be named automatically.
G
guosheng 已提交
5079 5080

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

G
guosheng 已提交
5083 5084 5085
    Examples:
        .. code-block:: python

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

5090
            # x: [B, M, K], y: [B, K, N]
5091
            # fluid.layers.matmul(x, y)  # out: [B, M, N]
Y
ying 已提交
5092

5093
            # x: [B, M, K], y: [K, N]
5094
            # fluid.layers.matmul(x, y)  # out: [B, M, N]
Y
ying 已提交
5095

5096
            # x: [M, K], y: [K, N]
5097
            # fluid.layers.matmul(x, y)  # out: [M, N]
Y
ying 已提交
5098 5099

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

5102
            # x: [K], y: [K]
5103
            # fluid.layers.matmul(x, y)  # out: [1]
5104

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

5108
            import paddle.fluid as fluid
5109 5110 5111
            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 已提交
5112
    """
S
ShenLiang 已提交
5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171
    attrs = {
        'transpose_X': transpose_x,
        'transpose_Y': transpose_y,
        'alpha': float(alpha),
    }

    if in_dygraph_mode():
        out = _varbase_creator(dtype=x.dtype)
        core.ops.matmul(x, y, out, 'transpose_X', transpose_x, 'transpose_Y',
                        transpose_y, 'alpha', float(alpha))
        return out

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

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

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

    __check_input(x, y)

    helper = LayerHelper('matmul', **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
    helper.append_op(
        type='matmul',
        inputs={'X': x,
                'Y': y},
        outputs={'Out': out},
        attrs=attrs)
    return out
5172 5173


5174
def topk(input, k, name=None):
Q
qingqing01 已提交
5175
    """
5176 5177 5178 5179
    :alias_main: paddle.topk
	:alias: paddle.topk,paddle.tensor.topk,paddle.tensor.search.topk
	:old_api: paddle.fluid.layers.topk

5180
    This OP is used to find values and indices of the k largest entries
Q
qingqing01 已提交
5181 5182
    for the last dimension.

5183 5184
    If the input is a 1-D Tensor, finds the k largest entries and outputs
    their values and indices.
Q
qingqing01 已提交
5185 5186 5187 5188

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

F
fengjiayi 已提交
5189 5190
    .. code-block:: text

5191 5192 5193 5194 5195
        Case 1:

          Input:
            input.shape = [3, 4]
            input.data = [[5, 4, 2, 3],
F
fengjiayi 已提交
5196 5197 5198 5199
                     [9, 7, 10, 25],
                     [6, 2, 10, 1]]
            k = 2

5200
          Output:
F
fengjiayi 已提交
5201
            The first output:
5202 5203
            values.shape = [3, 2]
            values.data = [[5, 4],
F
fengjiayi 已提交
5204 5205 5206 5207
                      [10, 25],
                      [6, 10]]

            The second output:
5208 5209
            indices.shape = [3, 2]
            indices.data = [[0, 1],
F
fengjiayi 已提交
5210 5211 5212
                       [2, 3],
                       [0, 2]]

Q
qingqing01 已提交
5213
    Args:
5214 5215 5216 5217
        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 已提交
5218 5219

    Returns:
5220 5221
        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 已提交
5222

F
fengjiayi 已提交
5223
    Raises:
5224
        ValueError: If :math:`k < 1` or :math:`k > last dimension of input`.
Q
qingqing01 已提交
5225 5226 5227 5228

    Examples:
        .. code-block:: python

5229
            import paddle.fluid as fluid
5230
            import paddle.fluid.layers as layers
5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243
            # 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 已提交
5244
    """
5245
    if in_dygraph_mode():
5246 5247 5248 5249 5250
        _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
5251

5252 5253
    inputs = {"X": [input]}
    attrs = {}
S
songyouwei 已提交
5254 5255 5256 5257 5258
    if isinstance(k, Variable):
        inputs['K'] = [k]
    else:
        attrs = {'k': k}

5259 5260 5261 5262
    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 已提交
5263 5264
    helper.append_op(
        type="top_k",
W
whs 已提交
5265
        inputs=inputs,
Q
qingqing01 已提交
5266 5267
        outputs={"Out": [values],
                 "Indices": [indices]},
W
whs 已提交
5268
        attrs=attrs)
Q
qingqing01 已提交
5269 5270 5271 5272 5273
    values.stop_gradient = True
    indices.stop_gradient = True
    return values, indices


5274 5275 5276 5277 5278
def ctc_greedy_decoder(input,
                       blank,
                       input_length=None,
                       padding_value=0,
                       name=None):
5279
    r"""
S
SunGaofeng 已提交
5280
    This op is used to decode sequences by greedy policy by the following steps:
Y
yi.wu 已提交
5281

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

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

5291 5292 5293 5294 5295
    A simple example as below:

    .. code-block:: text

        Given:
S
SunGaofeng 已提交
5296
        (1) for lod mode:
5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307

        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]]

5308
        input.lod = [[4, 4]]
M
minqiyang 已提交
5309

W
whs 已提交
5310
        Computation:
5311

W
whs 已提交
5312 5313 5314 5315 5316 5317
        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:
5318 5319 5320 5321 5322

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

5323
        output.lod = [[2, 1]]
5324

S
SunGaofeng 已提交
5325
        (2) for padding mode:
5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341

         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]
5342
        step2: Change the argmax result to use padding mode, then argmax result is
5343 5344 5345 5346 5347 5348 5349 5350 5351
                [[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 已提交
5352
    Parameters:
5353

5354 5355
        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 已提交
5356
                         where Lp is the sum of all input sequences' length and
5357 5358
                         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 已提交
5359
                         (not including the blank label). The data type can be float32 or float64.
Y
ying 已提交
5360
        blank(int): the blank label index of Connectionist Temporal
S
SunGaofeng 已提交
5361
                    Classification (CTC) loss, which is in the half-opened
Y
ying 已提交
5362
                    interval [0, num_classes + 1).
S
SunGaofeng 已提交
5363 5364
        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.
5365
        padding_value(int): padding value.
5366 5367 5368
        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`
5369 5370

    Returns:
S
SunGaofeng 已提交
5371 5372 5373 5374 5375
        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 [[]].

5376
        For padding mode, returns a tuple of (output, output_length), which was described as below:
S
SunGaofeng 已提交
5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387

        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).

5388 5389 5390 5391

    Examples:
        .. code-block:: python

5392
            # for lod mode
S
SunGaofeng 已提交
5393
            import paddle.fluid as fluid
S
SunGaofeng 已提交
5394
            x = fluid.data(name='x', shape=[None, 8], dtype='float32', lod_level=1)
5395
            cost = fluid.layers.ctc_greedy_decoder(input=x, blank=0)
5396 5397

            # for padding mode
S
SunGaofeng 已提交
5398 5399
            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')
5400 5401 5402
            out, out_len = fluid.layers.ctc_greedy_decoder(input=x_pad, blank=0,
                            input_length=x_pad_len)

W
wanghaoshuang 已提交
5403
    """
5404 5405 5406
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'ctc_greedy_decoder')

5407
    helper = LayerHelper("ctc_greedy_decoder", **locals())
Q
qingqing01 已提交
5408
    _, topk_indices = topk(input, k=1)
5409 5410

    # ctc align op
X
Xin Pan 已提交
5411
    ctc_out = helper.create_variable_for_type_inference(dtype="int64")
5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436

    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
5437 5438


Y
fix ci.  
ying 已提交
5439
def transpose(x, perm, name=None):
Y
ying 已提交
5440
    """
5441
    Permute the data dimensions of `input` according to `perm`.
Y
ying 已提交
5442 5443 5444 5445 5446

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

    Args:
5447
        x (Tensor): The input Tensor. It is a N-D Tensor of data types float32, float64, int32.
5448
        perm (list|tuple): Permute the input according to the data of perm.
5449
        name (str): The name of this layer. It is optional.
Y
ying 已提交
5450 5451

    Returns:
5452
        Tensor: A transposed n-D Tensor, with data type being float32, float64, int32, int64.
5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475

    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 已提交
5476 5477

    Examples:
5478

Y
ying 已提交
5479 5480
        .. code-block:: python

5481 5482 5483 5484 5485 5486
            import paddle

            x = paddle.randn([2, 3, 4])
            x_transposed = paddle.transpose(x, perm=[1, 0, 2])
            print(x_transposed.shape)
            # [3L, 2L, 4L]
Y
ying 已提交
5487

5488
    """
5489
    if in_dygraph_mode():
5490 5491
        out, _ = core.ops.transpose2(x, 'axis', perm)
        return out
5492

5493 5494 5495
    check_variable_and_dtype(
        x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'],
        'transpose')
5496 5497 5498
    check_type(perm, 'perm', (list, tuple), 'transpose')
    if isinstance(perm, tuple):
        perm = list(perm)
Y
fix ci.  
ying 已提交
5499
    if len(perm) != len(x.shape):
Y
ying 已提交
5500
        raise ValueError(
5501 5502 5503 5504
            "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 已提交
5505 5506 5507
    for idx, dim in enumerate(perm):
        if dim >= len(x.shape):
            raise ValueError(
5508 5509 5510
                "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 已提交
5511 5512

    helper = LayerHelper('transpose', **locals())
X
Xin Pan 已提交
5513 5514
    out = helper.create_variable_for_type_inference(x.dtype)
    x_shape = helper.create_variable_for_type_inference(x.dtype)
Y
ying 已提交
5515
    helper.append_op(
5516
        type='transpose2',
Y
fix ci.  
ying 已提交
5517
        inputs={'X': [x]},
5518 5519
        outputs={'Out': [out],
                 'XShape': [x_shape]},
Y
ying 已提交
5520 5521
        attrs={'axis': perm})
    return out
5522 5523


5524 5525 5526 5527 5528 5529 5530
def im2sequence(input,
                filter_size=1,
                stride=1,
                padding=0,
                input_image_size=None,
                out_stride=1,
                name=None):
5531
    r"""
5532 5533
    :api_attr: Static Graph

5534
    Extracts image patches from the input tensor to form a tensor of shape
L
Liufang Sang 已提交
5535 5536 5537
    {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
5538 5539
    output_height * output_width for an image, in which output_height and
    output_width are calculated by below equation:
5540 5541 5542

    .. math::

L
Liufang Sang 已提交
5543 5544 5545 5546
        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
5547

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

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

L
Liufang Sang 已提交
5553 5554 5555
        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.
5556

L
Liufang Sang 已提交
5557 5558
        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.
5559

L
Liufang Sang 已提交
5560 5561 5562 5563 5564
        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
5565
            padding_up = padding_down = padding_left = padding_right = padding.
L
Liufang Sang 已提交
5566
            Default is 0.
5567

L
Liufang Sang 已提交
5568 5569 5570 5571
        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 已提交
5572
            If out_stride is List,  it must contain two integers,
L
Liufang Sang 已提交
5573 5574 5575 5576 5577
            :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` .
5578 5579 5580

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

    Return Type: Variable
5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610

    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 已提交
5611 5612 5613
            filter = [2, 2]
            stride = [1, 1]
            padding = [0, 0]
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625

            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.]]

5626
            output.dims = {8, 8}
5627

5628
            output.lod = [[4, 4]]
5629

T
Tink_Y 已提交
5630
    Examples:
5631 5632 5633

        .. code-block:: python

B
Bai Yifan 已提交
5634
            import paddle.fluid as fluid
5635 5636
            import paddle
            paddle.enable_static()
L
Liufang Sang 已提交
5637
            data = fluid.data(name='data', shape=[None, 3, 32, 32],
B
Bai Yifan 已提交
5638
                                     dtype='float32')
5639
            output = fluid.layers.im2sequence(
B
Bai Yifan 已提交
5640 5641
                input=data, stride=[1, 1], filter_size=[2, 2])

5642 5643

    """
L
lujun 已提交
5644
    assert not in_dygraph_mode(), (
5645
        "sequence layer is not supported in dygraph mode yet.")
W
wanghaoshuang 已提交
5646

5647 5648
    check_variable_and_dtype(input, 'input', ['float32'], 'im2sequence')

W
wanghaoshuang 已提交
5649 5650 5651 5652 5653 5654 5655 5656 5657
    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])
5658
    inputs = {"X": input}
5659
    attrs = {"kernels": filter_size, "strides": stride, "paddings": padding}
5660 5661 5662 5663 5664
    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
5665
    helper = LayerHelper('im2sequence', **locals())
X
Xin Pan 已提交
5666
    out = helper.create_variable_for_type_inference(dtype=helper.input_dtype())
5667
    helper.append_op(
5668
        type='im2sequence', inputs=inputs, outputs={'Out': out}, attrs=attrs)
5669
    return out
5670 5671


Y
yuyang18 已提交
5672
@templatedoc()
5673
def row_conv(input, future_context_size, param_attr=None, act=None):
Y
yuyang18 已提交
5674
    """
5675 5676
    :api_attr: Static Graph

Y
yuyang18 已提交
5677
    ${comment}
5678 5679

    Args:
Y
yuyang18 已提交
5680
        input (${x_type}): ${x_comment}.
Y
yangyaming 已提交
5681 5682
        future_context_size (int): Future context size. Please note, the shape
            of convolution kernel is [future_context_size + 1, D].
5683 5684 5685 5686 5687
        param_attr (ParamAttr): Attributes of parameters, including
            name, initializer etc.
        act (str): Non-linear activation to be applied to output variable.

    Returns:
Y
yuyang18 已提交
5688
        ${out_comment}.
5689 5690

    Examples:
B
Bai Yifan 已提交
5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702

      .. code-block:: python

        # for LodTensor inputs
        import paddle
        paddle.enable_static()
        x = paddle.static.data(name='x', shape=[9, 16],
                               dtype='float32', lod_level=1)
        out = paddle.static.nn.row_conv(input=x, future_context_size=2)
        # for Tensor inputs
        x = paddle.static.data(name='x', shape=[9, 4, 16], dtype='float32')
        out = paddle.static.nn.row_conv(input=x, future_context_size=2)
5703 5704
    """
    helper = LayerHelper('row_conv', **locals())
5705
    check_variable_and_dtype(input, 'input', ['float32'], 'row_conv')
5706
    dtype = helper.input_dtype()
5707
    filter_shape = [future_context_size + 1, input.shape[-1]]
5708 5709
    filter_param = helper.create_parameter(
        attr=helper.param_attr, shape=filter_shape, dtype=dtype)
X
Xin Pan 已提交
5710
    out = helper.create_variable_for_type_inference(dtype)
5711 5712 5713 5714 5715
    helper.append_op(
        type='row_conv',
        inputs={'X': [input],
                'Filter': [filter_param]},
        outputs={'Out': [out]})
Y
yangyaming 已提交
5716
    return helper.append_activation(out)
5717 5718


Y
yuyang18 已提交
5719
@templatedoc()
5720
def multiplex(inputs, index, name=None):
5721
    """
Y
yuyang18 已提交
5722

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

5725
    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 已提交
5726

5727
    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 已提交
5728

5729
    For Example:
L
lujun 已提交
5730

5731
            .. code-block:: text
L
lujun 已提交
5732

5733
                Given:
L
lujun 已提交
5734

5735 5736 5737 5738
                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 已提交
5739

5740
                index = [[3],[0],[1],[2]]
L
lujun 已提交
5741

5742 5743 5744 5745
                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 已提交
5746 5747


5748
    Args:
5749 5750 5751 5752 5753
        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 (Tensor): 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.
        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`.
5754
    Returns:
5755
        Tensor: Output of multiplex OP, with data type being float32, float64, int32, int64.
X
xuezhong 已提交
5756 5757

    Examples:
5758

X
xuezhong 已提交
5759 5760
        .. code-block:: python

5761
            import paddle
5762 5763 5764
            import numpy as np
            img1 = np.array([[1, 2], [3, 4]]).astype(np.float32)
            img2 = np.array([[5, 6], [7, 8]]).astype(np.float32)
5765 5766 5767
            inputs = [paddle.to_tensor(img1), paddle.to_tensor(img2)]
            index = paddle.to_tensor(np.array([[1], [0]]).astype(np.int32))
            res = paddle.multiplex(inputs, index)
5768
            print(res) # [array([[5., 6.], [3., 4.]], dtype=float32)]
X
xuezhong 已提交
5769

5770
    """
5771 5772
    if in_dygraph_mode():
        return core.ops.multiplex(index, inputs)
5773 5774
    helper = LayerHelper('multiplex', **locals())

5775 5776 5777 5778 5779 5780 5781 5782 5783
    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')
5784 5785

    out = helper.create_variable_for_type_inference(inputs[0].dtype)
5786
    helper.append_op(
5787 5788 5789 5790 5791
        type='multiplex',
        inputs={'X': inputs,
                'Ids': index},
        outputs={'Out': [out]})
    return out
X
xuezhong 已提交
5792 5793


5794 5795
def smooth_l1(x, y, inside_weight=None, outside_weight=None, sigma=None):
    """
5796

Y
Yibing Liu 已提交
5797 5798
    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 已提交
5799
    For each instance, it computes the smooth L1 loss element by element first
T
tianshuo78520a 已提交
5800
    and then sums all the losses. So the shape of output Variable is
5801
    [batch_size, 1].
5802

5803 5804
    Args:
        x (Variable): A tensor with rank at least 2. The input value of smooth
Q
qingqing01 已提交
5805
            L1 loss op with shape [batch_size, dim1, ..., dimN].
5806
            A LoDTensor or Tensor with type float32.
5807
        y (Variable): A tensor with rank at least 2. The target value of smooth
Y
Yibing Liu 已提交
5808
            L1 loss op with same shape as :attr:`x`.
5809
            A LoDTensor or Tensor with type float32.
5810
        inside_weight (Variable|None):  A tensor with rank at least 2. This
5811 5812
            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 已提交
5813
            by this tensor element by element.
5814
            A Tensor with type float32.
5815
        outside_weight (Variable|None): A tensor with rank at least 2. This
5816 5817
            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 已提交
5818
            element by element.
5819
            A Tensor with type float32.
5820
        sigma (float|None): Hyper parameter of smooth L1 loss layer. A float
5821 5822
           scalar with default value 1.0.

5823
    Returns:
5824
        Variable: The output smooth L1 loss with shape [batch_size, 1].  A Tensor with type float32.
5825 5826 5827 5828

    Examples:
        .. code-block:: python

5829
            import paddle.fluid as fluid
5830
            import numpy as np
5831 5832
            import paddle
            paddle.enable_static()
5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843
            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)
5844

5845 5846 5847 5848
            #[array([[0.08220536],
            #       [0.36652038],
            #      [0.20541131]], dtype=float32)]

5849
    """
5850 5851
    check_variable_and_dtype(x, 'X', ['float32', 'float64'], 'smooth_l1_loss')
    check_variable_and_dtype(y, 'Y', ['float32', 'float64'], 'smooth_l1_loss')
5852

5853
    helper = LayerHelper('smooth_l1_loss', **locals())
5854

X
Xin Pan 已提交
5855 5856
    diff = helper.create_variable_for_type_inference(dtype=x.dtype)
    loss = helper.create_variable_for_type_inference(dtype=x.dtype)
5857 5858 5859 5860 5861 5862 5863 5864 5865 5866
    helper.append_op(
        type='smooth_l1_loss',
        inputs={
            'X': x,
            'Y': y,
            'InsideWeight': inside_weight,
            'OutsideWeight': outside_weight
        },
        outputs={'Diff': diff,
                 'Out': loss},
5867
        attrs={'sigma': sigma if sigma is not None else 1.0})
5868
    return loss
5869 5870


5871
@deprecated(since='2.0.0', update_to='paddle.nn.functional.one_hot')
5872
def one_hot(input, depth, allow_out_of_range=False):
5873
    """
5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911

    **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.],
5912
                        [0., 1., 0., 0.],
5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924
                        [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
5925
            The second dimension in X is 5, which is greater than depth.
5926 5927
            Allow_out_of_range =False means that does not allow the word id to exceed depth,
            so it throws an exception.
5928 5929

    Args:
5930 5931 5932
        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.
5933
        depth(scalar): An integer defining the :attr:`depth` of the one hot dimension. If input
5934
            is word id, depth is generally the dictionary size.
5935
        allow_out_of_range(bool): A bool value indicating whether the input
5936 5937 5938 5939
            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.
5940 5941

    Returns:
5942
        Variable: The one-hot representations of input. A Tensor or LoDTensor with type float32.
5943 5944

    Examples:
C
caoying03 已提交
5945
        .. code-block:: python
5946

5947
            import paddle.fluid as fluid
5948 5949 5950
            # 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)
5951
    """
5952
    if in_dygraph_mode():
S
songyouwei 已提交
5953 5954 5955 5956
        if isinstance(depth, Variable):
            depth = depth.numpy()
            assert depth.shape == (
                1, ), "depth of type Variable should have shape [1]"
5957
            depth = depth.item(0)
5958 5959 5960 5961
        out = core.ops.one_hot(input, 'depth', depth, 'allow_out_of_range',
                               allow_out_of_range)
        out.stop_gradient = True
        return out
5962

5963
    helper = LayerHelper("one_hot", **locals())
5964 5965
    check_variable_and_dtype(input, 'input', ['int32', 'int64'], 'one_hot')
    check_type(depth, 'depth', (six.integer_types, Variable), 'one_hot')
X
Xin Pan 已提交
5966
    one_hot_out = helper.create_variable_for_type_inference(dtype='float32')
5967

5968 5969
    if not isinstance(depth, Variable):
        # user attribute
5970
        inputs = {'X': input}
Y
Yi Liu 已提交
5971
        attrs = {'depth': depth, 'allow_out_of_range': allow_out_of_range}
5972
    else:
5973 5974 5975
        depth.stop_gradient = True
        inputs = {'X': input, 'depth_tensor': depth}
        attrs = {'allow_out_of_range': allow_out_of_range}
5976 5977
    helper.append_op(
        type="one_hot",
5978 5979
        inputs=inputs,
        attrs=attrs,
5980 5981
        outputs={'Out': one_hot_out})
    one_hot_out.stop_gradient = True
5982
    return one_hot_out
Y
Yu Yang 已提交
5983 5984


Y
Yu Yang 已提交
5985
def autoincreased_step_counter(counter_name=None, begin=1, step=1):
Y
Yu Yang 已提交
5986
    """
5987 5988
    :api_attr: Static Graph

5989 5990
    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 已提交
5991
    and the step size is 1.
Y
Yu Yang 已提交
5992 5993

    Args:
Y
Yibing Liu 已提交
5994 5995 5996
        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 已提交
5997

5998
    Returns:
Y
Yibing Liu 已提交
5999
        Variable: The auto-increased Variable with data type int64.
Y
yi.wu 已提交
6000 6001 6002 6003

    Examples:
        .. code-block:: python

6004
           import paddle.fluid as fluid
6005 6006
           import paddle
           paddle.enable_static()
Y
yi.wu 已提交
6007
           global_step = fluid.layers.autoincreased_step_counter(
Y
Yibing Liu 已提交
6008
               counter_name='@LR_DECAY_COUNTER@', begin=0, step=1)
Y
Yu Yang 已提交
6009 6010
    """
    helper = LayerHelper('global_step_counter')
Y
Yu Yang 已提交
6011 6012
    if counter_name is None:
        counter_name = '@STEP_COUNTER@'
Y
Yu Yang 已提交
6013
    counter, is_new_var = helper.create_or_get_global_variable(
H
hong 已提交
6014 6015 6016 6017 6018
        name=counter_name,
        dtype='int64',
        shape=[1],
        persistable=True,
        belong_to_optimizer=True)
Y
Yu Yang 已提交
6019 6020 6021
    if is_new_var:
        helper.set_variable_initializer(
            counter, initializer=Constant(
Y
Yu Yang 已提交
6022
                value=begin - 1, force_cpu=True))
W
Wu Yi 已提交
6023
        helper.main_program.global_block()._prepend_op(
Y
Yu Yang 已提交
6024 6025
            type='increment',
            inputs={'X': [counter]},
Y
Yu Yang 已提交
6026
            outputs={'Out': [counter]},
6027
            attrs={'step': float(step)})
Y
Yu Yang 已提交
6028 6029 6030
        counter.stop_gradient = True

    return counter
Y
yangyaming 已提交
6031 6032


6033
def reshape(x, shape, actual_shape=None, act=None, inplace=False, name=None):
6034
    r"""
6035 6036 6037
    :alias_main: paddle.reshape
	:alias: paddle.reshape,paddle.tensor.reshape,paddle.tensor.manipulation.reshape

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

6040 6041 6042 6043
    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 已提交
6044
    guarantee shape inference in compile-time.
C
caoying03 已提交
6045

6046
    Some tricks exist when specifying the target shape.
C
caoying03 已提交
6047

6048 6049 6050 6051
    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.

6052
    2. 0 means the actual dimension value is going to be copied from the
T
tianshuo78520a 已提交
6053
    corresponding dimension of x. The index of 0s in shape can not exceed
6054
    the dimension of x.
6055 6056

    Here are some examples to explain it.
C
caoying03 已提交
6057 6058

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

6062
    2. Given a 3-D tensor x with a shape [2, 4, 6], and the target shape
6063 6064
    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 已提交
6065 6066
    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
6067
    dimensions.
C
caoying03 已提交
6068

6069
    3. Given a 3-D tensor x with a shape [2, 4, 6], and the target shape
6070 6071 6072 6073
    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 已提交
6074

6075 6076
    **Note**:
        The parameter ``actual_shape`` will be deprecated in the future and only use ``shape`` instead to represent the target shape.
6077

C
caoying03 已提交
6078
    Args:
6079 6080
        x(Tensor): An N-D Tensor. The data type is ``float32``, ``float64``, ``int32`` or ``int64``.
        shape(list|tuple|Tensor): Define the target shape. At most one dimension of the target shape can be -1.
6081
                        The data type is ``int32`` . If ``shape`` is a list or tuple, the elements of it should be integers or Tensors with shape [1].
6082
                        If ``shape`` is an Tensor, it should be an 1-D Tensor .
6083 6084 6085
        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
6086
                                than ``shape(list|tuple)`` but not ``shape(Tensor)``. \
6087 6088 6089 6090 6091 6092 6093 6094 6095
                                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 已提交
6096

6097
    Returns:
6098
        Tensor: A reshaped Tensor with the same data type 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 已提交
6099

X
Xin Pan 已提交
6100

C
caoying03 已提交
6101 6102
    Examples:
        .. code-block:: python
6103 6104
            
            import paddle
6105
            import paddle.fluid as fluid
6106 6107
            paddle.enable_static()
            
6108
            # example 1:
6109
            # attr shape is a list which doesn't contain Tensors.
6110 6111
            data_1 = fluid.data(
              name='data_1', shape=[2, 4, 6], dtype='float32')
6112
            reshaped_1 = fluid.layers.reshape(
6113
              x=data_1, shape=[-1, 0, 3, 2])
6114
            # the shape of reshaped_1 is [2,4,3,2].
6115 6116

            # example 2:
6117
            # attr shape is a list which contains Tensors.
6118 6119 6120
            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])
6121
            # the shape of reshaped_2 is [5,10].
M
mapingshuo 已提交
6122 6123 6124 6125 6126 6127

            # 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 已提交
6128
    """
6129
    if in_dygraph_mode():
L
Leo Chen 已提交
6130
        #TODO(zhiqiu): enable inplace in dygraph mode.
6131 6132 6133 6134 6135
        if inplace:
            warnings.warn(
                "Inplace on reshape is not allowed and will be discarded in dygraph mode currently."
            )
        if isinstance(shape, (list, tuple)):
6136
            shape = [
6137
                item.numpy().item(0) if isinstance(item, Variable) else item
6138 6139 6140 6141
                for item in shape
            ]
            out, _ = core.ops.reshape2(x, 'shape', shape)
            return dygraph_utils._append_activation_in_dygraph(out, act)
6142

6143
    check_variable_and_dtype(
6144 6145
        x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64',
                 'bool'], 'reshape')
6146 6147
    check_type(shape, 'shape', (list, tuple, Variable), 'reshape')
    check_type(actual_shape, 'actual_shape', (Variable, type(None)), 'reshape')
6148

6149
    helper = LayerHelper("reshape2", **locals())
6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160

    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, (
6161 6162
                        "Only one dimension value of 'shape' in reshape can "
                        "be -1. But received shape[%d] is also -1." % dim_idx)
6163 6164 6165
                    unk_dim_idx = dim_idx
                elif dim_size == 0:
                    assert dim_idx < len(x.shape), (
6166 6167 6168 6169
                        "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)))
6170 6171
                else:
                    assert dim_size > 0, (
6172
                        "Each dimension value of 'shape' in reshape must not "
T
tianshuo78520a 已提交
6173
                        "be negative except one unknown dimension. "
6174 6175
                        "But received shape[%d] = %s." %
                        (dim_idx, str(dim_size)))
6176 6177
        return attrs_shape

6178 6179 6180 6181 6182 6183 6184 6185 6186
    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 已提交
6187
        if utils._contain_var(shape):
6188
            inputs['ShapeTensor'] = utils._convert_to_tensor_list(shape)
6189 6190 6191 6192 6193 6194
        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 已提交
6195
    x_shape = helper.create_variable_for_type_inference(dtype=x.dtype)
C
caoying03 已提交
6196
    helper.append_op(
6197
        type="reshape2",
X
Xin Pan 已提交
6198
        inputs=inputs,
6199
        attrs=attrs,
6200 6201
        outputs={"Out": out,
                 "XShape": x_shape})
C
caoying03 已提交
6202

D
dzhwinter 已提交
6203
    return helper.append_activation(out)
6204

6205

6206
def squeeze(input, axes, name=None):
Y
Yibing Liu 已提交
6207
    """
6208 6209 6210
    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 已提交
6211

H
haowang101779990 已提交
6212

6213
    .. code-block:: text
H
haowang101779990 已提交
6214

6215
        Case1:
H
haowang101779990 已提交
6216

6217
          Input:
H
haowang101779990 已提交
6218 6219
            X.shape = (1, 3, 1, 5)
            axes = [0]
6220
          Output:
H
haowang101779990 已提交
6221 6222
            Out.shape = (3, 1, 5)

6223
        Case2:
H
haowang101779990 已提交
6224

6225
          Input:
H
haowang101779990 已提交
6226 6227
            X.shape = (1, 3, 1, 5)
            axes = []
6228
          Output:
H
haowang101779990 已提交
6229
            Out.shape = (3, 5)
M
minqiyang 已提交
6230

6231 6232 6233 6234 6235 6236 6237 6238
        Case3:

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

Y
Yibing Liu 已提交
6239
    Args:
6240
        input (Variable): The input Tensor. Supported data type: float32, float64, bool, int8, int32, int64.
6241 6242 6243 6244
                          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 已提交
6245 6246

    Returns:
6247
        Variable: Output squeezed Tensor. Data type is same as input Tensor.
Y
Yibing Liu 已提交
6248 6249 6250 6251

    Examples:
        .. code-block:: python

6252
            import paddle.fluid as fluid
6253
            import paddle.fluid.layers as layers
6254 6255 6256 6257
            # 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 已提交
6258
    """
L
Leo Chen 已提交
6259 6260 6261 6262
    if in_dygraph_mode():
        out, _ = core.ops.squeeze2(input, 'axes', axes)
        return out

Y
Yibing Liu 已提交
6263
    helper = LayerHelper("squeeze", **locals())
6264 6265
    check_variable_and_dtype(
        input, 'input',
6266 6267 6268
        ['float16', 'float32', 'float64', 'bool', 'int8', 'int32', 'int64'],
        'squeeze')
    check_type(axes, 'axis/axes', (list, tuple), 'squeeze')
X
Xin Pan 已提交
6269 6270
    out = helper.create_variable_for_type_inference(dtype=input.dtype)
    x_shape = helper.create_variable_for_type_inference(dtype=input.dtype)
Y
Yibing Liu 已提交
6271
    helper.append_op(
6272
        type="squeeze2",
6273
        inputs={"X": input},
Y
Yibing Liu 已提交
6274
        attrs={"axes": axes},
6275 6276
        outputs={"Out": out,
                 "XShape": x_shape})
Y
Yibing Liu 已提交
6277

6278 6279 6280
    return out


6281
def unsqueeze(input, axes, name=None):
Y
Yibing Liu 已提交
6282
    """
6283
    Insert single-dimensional entries to the shape of a Tensor. Takes one
M
minqiyang 已提交
6284 6285
    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 已提交
6286

M
minqiyang 已提交
6287
    For example:
H
haowang101779990 已提交
6288 6289 6290

    .. code-block:: text

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

Y
Yibing Liu 已提交
6294
    Args:
6295
        input (Variable): The input Tensor to be unsqueezed. Supported data type: float32, float64, bool, int8, int32, int64.
6296
        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 .
6297
        name (str|None): Name for this layer.
Y
Yibing Liu 已提交
6298 6299

    Returns:
6300
        Variable: Unsqueezed Tensor, with the same data type as input.
Y
Yibing Liu 已提交
6301 6302 6303 6304

    Examples:
        .. code-block:: python

6305 6306 6307
            import paddle.fluid as fluid
            x = fluid.layers.data(name='x', shape=[5, 10])
            y = fluid.layers.unsqueeze(input=x, axes=[1])
6308

Y
Yibing Liu 已提交
6309
    """
6310
    if in_dygraph_mode():
L
Leo Chen 已提交
6311 6312 6313
        if isinstance(axes, int):
            axes = [axes]
        elif isinstance(axes, Variable):
6314
            axes = axes.numpy().tolist()
L
Leo Chen 已提交
6315 6316 6317 6318 6319
        elif isinstance(axes, (list, tuple)):
            axes = [
                item.numpy().item(0) if isinstance(item, Variable) else item
                for item in axes
            ]
6320 6321 6322 6323 6324 6325 6326 6327
        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')
6328 6329 6330 6331 6332 6333 6334 6335 6336 6337
    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 已提交
6338
        if utils._contain_var(axes):
6339
            inputs["AxesTensorList"] = utils._convert_to_tensor_list(axes)
6340 6341 6342
        else:
            attrs["axes"] = axes

X
Xin Pan 已提交
6343 6344
    out = helper.create_variable_for_type_inference(dtype=input.dtype)
    x_shape = helper.create_variable_for_type_inference(dtype=input.dtype)
Y
Yibing Liu 已提交
6345
    helper.append_op(
6346
        type="unsqueeze2",
6347 6348
        inputs=inputs,
        attrs=attrs,
6349 6350
        outputs={"Out": out,
                 "XShape": x_shape})
Y
Yibing Liu 已提交
6351

6352 6353
    return out

6354

Y
yangyaming 已提交
6355
def lod_reset(x, y=None, target_lod=None):
Y
yangyaming 已提交
6356
    """
Y
Yibing Liu 已提交
6357
    Set LoD of :attr:`x` to a new one specified by :attr:`y` or
6358 6359 6360 6361
    :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
6362
    :attr:`y.data` or :attr:`target_lod`, only one level LoD is supported.
Y
yangyaming 已提交
6363 6364 6365 6366 6367 6368

    .. code-block:: text

        * Example 1:

            Given a 1-level LoDTensor x:
6369
                x.lod =  [[ 2,           3,                   1 ]]
Y
yangyaming 已提交
6370 6371 6372
                x.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                x.dims = [6, 1]

6373
            target_lod: [4, 2]
Y
yangyaming 已提交
6374 6375

            then we get a 1-level LoDTensor:
6376
                out.lod =  [[4,                          2]]
Y
yangyaming 已提交
6377 6378 6379 6380 6381 6382
                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:
6383
                x.lod =  [[2,            3,                   1]]
Y
yangyaming 已提交
6384 6385 6386 6387
                x.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                x.dims = [6, 1]

            y is a Tensor:
6388
                y.data = [[2, 4]]
Y
yangyaming 已提交
6389 6390 6391
                y.dims = [1, 3]

            then we get a 1-level LoDTensor:
6392
                out.lod =  [[2,            4]]
Y
yangyaming 已提交
6393 6394 6395 6396 6397 6398
                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:
6399
                x.lod =  [[2,            3,                   1]]
Y
yangyaming 已提交
6400 6401 6402 6403
                x.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                x.dims = [6, 1]

            y is a 2-level LoDTensor:
6404
                y.lod =  [[2, 2], [2, 2, 1, 1]]
Y
yangyaming 已提交
6405 6406 6407 6408
                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:
6409
                out.lod =  [[2, 2], [2, 2, 1, 1]]
Y
yangyaming 已提交
6410 6411 6412 6413
                out.data = [[1.0], [2.0], [3.0], [4.0], [5.0], [6.0]]
                out.dims = [6, 1]

    Args:
6414 6415 6416 6417 6418 6419
        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 已提交
6420
                                      as target LoD when :attr:`y` not provided.
Y
yangyaming 已提交
6421 6422

    Returns:
Y
Yibing Liu 已提交
6423
        Variable: Output variable with LoD specified by this layer.
Y
yangyaming 已提交
6424 6425

    Raises:
Y
Yibing Liu 已提交
6426
        ValueError: If :attr:`y` and :attr:`target_lod` are both None.
Y
yangyaming 已提交
6427 6428 6429 6430

    Examples:
        .. code-block:: python

6431
            import paddle.fluid as fluid
6432 6433 6434
            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 已提交
6435
    """
6436 6437
    check_variable_and_dtype(x, 'x', ['float32', 'float64', 'int32', 'int64'],
                             'lod_reset')
Y
yangyaming 已提交
6438
    helper = LayerHelper("lod_reset", **locals())
X
Xin Pan 已提交
6439
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
Y
yangyaming 已提交
6440
    if y is not None:
6441
        check_type(y, 'y', (Variable), 'lod_reset')
G
GaoWei8 已提交
6442
        #TODO: check y.lod_level = 0 dtype
Y
yangyaming 已提交
6443 6444 6445 6446 6447 6448 6449 6450 6451 6452
        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:
6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477
        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:
6478 6479 6480 6481 6482
        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.
6483 6484 6485 6486 6487
    Returns:
        Variable: Output variable with new LoD level.

    Raises:
        ValueError: If :attr:`y` is None or and :attr:`level` is not Iterator.
Y
yangyaming 已提交
6488

6489 6490 6491 6492 6493 6494 6495 6496 6497 6498
    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.")
6499 6500 6501
    if (not isinstance(level, Iterable)) and (not isinstance(level, Variable)):
        raise ValueError("Input(level) must be list, tuple or Variable.")

6502 6503 6504
    check_variable_and_dtype(x, 'x', ['float32', 'float64', 'int32', 'int64'],
                             'lod_append')

6505 6506
    helper = LayerHelper("lod_append", **locals())
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
6507 6508 6509 6510 6511 6512

    inputs = {'X': x}
    attrs = {'append': True}

    if isinstance(level, Variable):
        inputs['Y'] = level
G
GaoWei8 已提交
6513
        #TODO: check y.lod_level = 0 dtype
6514 6515
    else:
        attrs['target_lod'] = level
6516
    helper.append_op(
6517
        type="lod_reset", inputs=inputs, attrs=attrs, outputs={'Out': out})
Y
yangyaming 已提交
6518
    return out
D
dragonwarrior 已提交
6519 6520


6521 6522
def lrn(input, n=5, k=1.0, alpha=1e-4, beta=0.75, name=None,
        data_format='NCHW'):
6523
    r"""
6524 6525 6526 6527
    :alias_main: paddle.nn.functional.lrn
	:alias: paddle.nn.functional.lrn,paddle.nn.functional.norm.lrn
	:old_api: paddle.fluid.layers.lrn

6528 6529 6530
    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 已提交
6531 6532 6533 6534 6535

    The formula is as follows:

    .. math::

6536
        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 已提交
6537 6538 6539

    In the above equation:

6540 6541 6542 6543
    - :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 已提交
6544 6545 6546


    Args:
6547 6548
        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
6549
            type is float32. The rank of this tensor must be 4, otherwise it will raise ValueError.
6550 6551 6552 6553
        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
6554 6555 6556
        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
6557 6558 6559
            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]`.
6560

D
dragonwarrior 已提交
6561
    Returns:
6562 6563
        Variable: A tensor variable storing the transformation result with the same shape and data type as input.

D
dragonwarrior 已提交
6564 6565 6566

    Examples:

6567 6568 6569 6570 6571 6572 6573 6574
    .. 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 已提交
6575 6576
    """
    helper = LayerHelper('lrn', **locals())
6577
    check_variable_and_dtype(input, 'input', ['float32'], 'lrn')
D
dragonwarrior 已提交
6578 6579 6580 6581 6582 6583
    dtype = helper.input_dtype()
    input_shape = input.shape
    dims = len(input_shape)

    if dims != 4:
        raise ValueError(
6584
            "Input's dimension size of Op(lrn) must be 4, but received %d." %
D
dragonwarrior 已提交
6585
            (dims))
6586 6587 6588 6589
    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 已提交
6590

X
Xin Pan 已提交
6591 6592 6593
    mid_out = helper.create_variable_for_type_inference(
        dtype=dtype, stop_gradient=True)
    lrn_out = helper.create_variable_for_type_inference(dtype)
D
dragonwarrior 已提交
6594 6595 6596 6597 6598 6599 6600
    helper.append_op(
        type="lrn",
        inputs={"X": input},
        outputs={
            "Out": lrn_out,
            "MidOut": mid_out,
        },
6601 6602 6603 6604 6605 6606 6607
        attrs={
            "n": n,
            "k": k,
            "alpha": alpha,
            "beta": beta,
            "data_format": data_format
        })
D
dragonwarrior 已提交
6608 6609

    return lrn_out
G
guosheng 已提交
6610 6611 6612


def pad(x, paddings, pad_value=0., name=None):
6613
    r"""
6614 6615 6616 6617
    :alias_main: paddle.nn.functional.pad
	:alias: paddle.nn.functional.pad,paddle.nn.functional.common.pad
	:old_api: paddle.fluid.layers.pad

S
SunGaofeng 已提交
6618 6619
    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 已提交
6620

S
SunGaofeng 已提交
6621 6622 6623 6624
    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 已提交
6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642

    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 已提交
6643
        x (Variable): Tensor, data type is float32.
G
guosheng 已提交
6644
        paddings (list): A list of integers. Its elements specify the padded
S
SunGaofeng 已提交
6645
                         width before and after each dimension in turn.
6646
                         The length of :attr:`paddings` must be equal to
G
guosheng 已提交
6647 6648
                         :math:`rank(x) \\times 2`.
        pad_value (float): The constant value used to pad.
6649 6650
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
6651
                             For more information, please refer to :ref:`api_guide_Name`
G
guosheng 已提交
6652 6653

    Returns:
S
SunGaofeng 已提交
6654 6655 6656 6657
        The padded tensor, with the same data type and rank as :attr:`x`

    Return Type:
        Variable
G
guosheng 已提交
6658 6659 6660

    Examples:
        .. code-block:: python
G
guosheng 已提交
6661

6662
            # x is a rank 2 tensor variable
S
SunGaofeng 已提交
6663
            import paddle.fluid as fluid
6664 6665
            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 已提交
6666
    """
6667 6668 6669
    check_variable_and_dtype(
        x, 'x', ['float16', 'float32', 'float64', 'int32', 'int64'], "pad")

6670 6671
    helper = LayerHelper('pad', **locals())
    dtype = helper.input_dtype(input_param_name='x')
X
Xin Pan 已提交
6672
    out = helper.create_variable_for_type_inference(dtype)
G
guosheng 已提交
6673 6674 6675 6676 6677 6678 6679
    helper.append_op(
        type='pad',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'paddings': paddings,
               'pad_value': float(pad_value)})
    return out
6680 6681


C
chengduo 已提交
6682
def pad_constant_like(x, y, pad_value=0., name=None):
6683
    r"""
S
SunGaofeng 已提交
6684
    Pad :attr:`y` with :attr:`pad_value`, the number of values padded to
C
chengduo 已提交
6685
    the edges of each axis is specified by the difference of the shape
S
SunGaofeng 已提交
6686 6687
    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 已提交
6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705

    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]]]]
6706

C
chengduo 已提交
6707 6708 6709 6710 6711
            X.shape = (2, 3, 2, 3)

            Y = [[[[35, 36, 37]],
                  [[38, 39, 40]],
                  [[41, 42, 43]]]]
6712

C
chengduo 已提交
6713
            Y.shape = (1, 3, 1, 3)
6714 6715 6716

        And
            pad_value = 0.
C
chengduo 已提交
6717

T
Tink_Y 已提交
6718 6719
        Return:
            Out = [[[[35, 36, 37],
6720
                     [ 0,  0,  0]],
T
Tink_Y 已提交
6721
                    [[38, 39, 40],
6722
                     [ 0,  0,  0]],
T
Tink_Y 已提交
6723
                    [[41, 42, 43],
6724
                     [ 0,  0,  0]]],
6725
                   [[[ 0,  0,  0],
6726
                     [ 0,  0,  0]],
6727
                    [[ 0,  0,  0],
6728
                     [ 0,  0,  0]],
6729
                    [[ 0,  0,  0],
6730 6731 6732 6733
                     [ 0,  0,  0]]]]

            Out.shape = [2, 3, 2, 3]

C
chengduo 已提交
6734 6735

    Args:
T
tianshuo78520a 已提交
6736
        x (Variable): Tensor, its shape specifies the shape of output.
6737
        y (Variable): Tensor, its rank is the same with :attr:`x`, and for each dimension :math:`i` ,
S
SunGaofeng 已提交
6738
                      :math:`y\_shape[i] <= x\_shape[i]` . The data type can be float32 or float64.
C
chengduo 已提交
6739
        pad_value (float): The constant value used to pad.
6740 6741
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
6742
                             For more information, please refer to :ref:`api_guide_Name`
C
chengduo 已提交
6743 6744

    Returns:
S
SunGaofeng 已提交
6745 6746 6747 6748
        The padded tensor, with the same shape as :attr:`x` and the same data type as :attr:`y`

    Return Type:
        Variable
C
chengduo 已提交
6749 6750 6751 6752 6753 6754

    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 已提交
6755
            import paddle.fluid as fluid
S
SunGaofeng 已提交
6756 6757
            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 已提交
6758 6759 6760
            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]
    """
6761 6762 6763 6764
    check_type(x, 'x', (Variable), 'pad_constant_like')
    check_variable_and_dtype(y, 'y', ['float32', 'float64', 'int32', 'int64'],
                             "pad_constant_like")

6765 6766
    helper = LayerHelper('pad_constant_like', **locals())
    dtype = helper.input_dtype(input_param_name='y')
X
Xin Pan 已提交
6767
    out = helper.create_variable_for_type_inference(dtype)
C
chengduo 已提交
6768 6769 6770 6771 6772 6773 6774 6775 6776
    helper.append_op(
        type='pad_constant_like',
        inputs={'X': x,
                'Y': y},
        outputs={'Out': out},
        attrs={'pad_value': float(pad_value)})
    return out


6777 6778 6779 6780 6781
def label_smooth(label,
                 prior_dist=None,
                 epsilon=0.1,
                 dtype="float32",
                 name=None):
6782
    r"""
6783 6784 6785 6786
    :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

6787 6788
    Label smoothing is a mechanism to regularize the classifier layer and is called
    label-smoothing regularization (LSR).
6789

6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806
    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 已提交
6807
    Parameters:
6808
        label(Variable): The input variable containing the label data. The
6809 6810
                        label data should use one-hot representation. It's
                        a multidimensional tensor with a shape of
6811
                        :math:`[N_1, ..., Depth]`, where Depth is class number. The dtype can be "float32" and "float64".
D
DuYao 已提交
6812 6813 6814 6815 6816
        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
6817
                        distribution and the fixed distribution. The default value is
D
DuYao 已提交
6818 6819 6820
                        0.1.
        dtype(np.dtype|core.VarDesc.VarType|str, optional): The data type can be set
                        as 'float32', 'float64'. The default value is 'float32'.
6821 6822
        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 已提交
6823
                        :ref:`api_guide_Name`.
6824 6825 6826 6827 6828 6829

    Returns:
        Variable: The tensor variable containing the smoothed labels.

    Examples:
        .. code-block:: python
6830

6831
            import paddle.fluid as fluid
6832
            import paddle.fluid.layers as layers
6833

6834
            label = layers.data(name="label", shape=[1], dtype="int32")
6835 6836 6837 6838 6839 6840
            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.")
6841 6842

    if in_dygraph_mode():
6843 6844
        return core.ops.label_smooth(label, prior_dist, 'epsilon',
                                     float(epsilon))
6845

6846 6847 6848
    check_variable_and_dtype(label, 'label', ['float32', 'float64'],
                             'label_smooth')

6849 6850
    helper = LayerHelper("label_smooth", **locals())
    label.stop_gradient = True
X
Xin Pan 已提交
6851
    smooth_label = helper.create_variable_for_type_inference(dtype)
6852 6853 6854 6855 6856 6857 6858
    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
6859 6860


W
wopeizl 已提交
6861
@templatedoc()
F
FDInSky 已提交
6862 6863 6864 6865 6866
def roi_pool(input,
             rois,
             pooled_height=1,
             pooled_width=1,
             spatial_scale=1.0,
6867 6868
             rois_num=None,
             name=None):
W
wopeizl 已提交
6869
    """
6870

6871
    This operator implements the roi_pooling layer.
6872
    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).
6873

6874
    The operator has three steps:
6875

6876 6877 6878
        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.
6879

6880
    For more information, please refer to https://stackoverflow.com/questions/43430056/what-is-roi-layer-in-fast-rcnn
6881

W
wopeizl 已提交
6882
    Args:
6883 6884 6885 6886 6887
        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.
        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
6888 6889 6890 6891 6892
        rois_num (Tensor): The number of RoIs in each image. Default: None
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name`. Usually name is no need to set and
            None by default.

6893

W
wopeizl 已提交
6894
    Returns:
6895
        Variable: The pooled feature, 4D-Tensor with the shape of [num_rois, C, pooled_height, pooled_width].
6896 6897


W
wopeizl 已提交
6898
    Examples:
6899

6900
    ..  code-block:: python
6901

6902 6903
        import paddle.fluid as fluid
        import numpy as np
6904 6905
        import paddle
        paddle.enable_static()
6906

6907
        DATATYPE='float32'
6908

6909 6910
        place = fluid.CPUPlace()
        #place = fluid.CUDAPlace(0)
6911

6912 6913
        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)
6914
        rois_num_data = np.array([2]).astype('int32')
F
FDInSky 已提交
6915

6916 6917
        x = fluid.data(name='input', shape=[None,1,4,4], dtype=DATATYPE)
        rois = fluid.data(name='roi', shape=[None,4], dtype=DATATYPE)
6918
        rois_num = fluid.data(name='rois_num', shape=[None], dtype='int32')
F
FDInSky 已提交
6919

6920
        pool_out = fluid.layers.roi_pool(
6921 6922
                input=x,
                rois=rois,
6923 6924
                pooled_height=1,
                pooled_width=1,
F
FDInSky 已提交
6925
                spatial_scale=1.0,
6926
                rois_num=rois_num)
6927

6928
        exe = fluid.Executor(place)
6929
        out, = exe.run(feed={'input':input_data ,'roi':roi_data, 'rois_num': rois_num_data}, fetch_list=[pool_out.name])
6930 6931
        print(out)   #array([[[[11.]]], [[[16.]]]], dtype=float32)
        print(np.array(out).shape)  # (2, 1, 1, 1)
W
wopeizl 已提交
6932
    """
6933 6934 6935 6936 6937 6938 6939
    if in_dygraph_mode():
        assert rois_num is not None, "rois_num should not be None in dygraph mode."
        pool_out, argmaxes = core.ops.roi_pool(
            input, rois, rois_num, "pooled_height", pooled_height,
            "pooled_width", pooled_width, "spatial_scale", spatial_scale)
        return pool_out, argmaxes

6940 6941
    check_variable_and_dtype(input, 'input', ['float32'], 'roi_pool')
    check_variable_and_dtype(rois, 'rois', ['float32'], 'roi_pool')
W
wopeizl 已提交
6942 6943 6944 6945
    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')
6946 6947 6948 6949 6950 6951 6952

    inputs = {
        "X": input,
        "ROIs": rois,
    }
    if rois_num is not None:
        inputs['RoisNum'] = rois_num
W
wopeizl 已提交
6953 6954
    helper.append_op(
        type="roi_pool",
6955
        inputs=inputs,
W
wopeizl 已提交
6956 6957 6958 6959 6960 6961 6962 6963
        outputs={"Out": pool_out,
                 "Argmax": argmaxes},
        attrs={
            "pooled_height": pooled_height,
            "pooled_width": pooled_width,
            "spatial_scale": spatial_scale
        })
    return pool_out
W
whs 已提交
6964 6965


J
jerrywgz 已提交
6966 6967 6968 6969 6970 6971
@templatedoc()
def roi_align(input,
              rois,
              pooled_height=1,
              pooled_width=1,
              spatial_scale=1.0,
J
jerrywgz 已提交
6972
              sampling_ratio=-1,
6973 6974
              rois_num=None,
              name=None):
J
jerrywgz 已提交
6975
    """
6976

J
jerrywgz 已提交
6977 6978 6979 6980
    ${comment}

    Args:
        input (Variable): ${x_comment}
6981
        rois (Variable): ROIs (Regions of Interest) to pool over.It should be
6982 6983
            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 已提交
6984
            (x1, y1) is the top left coordinates, and (x2, y2) is the bottom
F
FDInSky 已提交
6985
            right coordinates.
W
wangguanzhong 已提交
6986 6987 6988 6989
        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
6990
        rois_num (Tensor): The number of RoIs in each image. Default: None
6991 6992 6993
        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 已提交
6994 6995

    Returns:
W
wangguanzhong 已提交
6996 6997 6998 6999 7000
        Variable:

        Output: ${out_comment}.


J
jerrywgz 已提交
7001 7002 7003
    Examples:
        .. code-block:: python

7004
            import paddle.fluid as fluid
7005 7006 7007
            import paddle
            paddle.enable_static()

7008 7009 7010 7011
            x = fluid.data(
                name='data', shape=[None, 256, 32, 32], dtype='float32')
            rois = fluid.data(
                name='rois', shape=[None, 4], dtype='float32')
7012
            rois_num = fluid.data(name='rois_num', shape=[None], dtype='int32')
7013 7014 7015
            align_out = fluid.layers.roi_align(input=x,
                                               rois=rois,
                                               pooled_height=7,
J
jerrywgz 已提交
7016 7017
                                               pooled_width=7,
                                               spatial_scale=0.5,
F
FDInSky 已提交
7018
                                               sampling_ratio=-1,
7019
                                               rois_num=rois_num)
J
jerrywgz 已提交
7020
    """
7021 7022 7023 7024 7025 7026 7027 7028
    if in_dygraph_mode():
        assert rois_num is not None, "rois_num should not be None in dygraph mode."
        align_out = core.ops.roi_align(
            input, rois, rois_num, "pooled_height", pooled_height,
            "pooled_width", pooled_width, "spatial_scale", spatial_scale,
            "sampling_ratio", sampling_ratio)
        return align_out

7029 7030 7031
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             'roi_align')
    check_variable_and_dtype(rois, 'rois', ['float32', 'float64'], 'roi_align')
J
jerrywgz 已提交
7032 7033
    helper = LayerHelper('roi_align', **locals())
    dtype = helper.input_dtype()
X
Xin Pan 已提交
7034
    align_out = helper.create_variable_for_type_inference(dtype)
7035 7036 7037 7038 7039 7040
    inputs = {
        "X": input,
        "ROIs": rois,
    }
    if rois_num is not None:
        inputs['RoisNum'] = rois_num
J
jerrywgz 已提交
7041 7042
    helper.append_op(
        type="roi_align",
7043
        inputs=inputs,
J
jerrywgz 已提交
7044 7045 7046 7047 7048 7049 7050 7051 7052 7053
        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 已提交
7054
def dice_loss(input, label, epsilon=0.00001, name=None):
7055
    r"""
7056

S
SunGaofeng 已提交
7057 7058 7059 7060
    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 已提交
7061 7062 7063 7064 7065 7066 7067 7068

    .. 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 已提交
7069
    Parameters:
7070
        input (Tensor): Tensor, rank>=2, shape is :math:`[N_1, N_2, ..., N_D]`, where :math:`N_1` is
S
SunGaofeng 已提交
7071 7072
                          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.
7073
        label (Tensor): Tensor, the groud truth with the same rank as input, shape is :math:`[N_1, N_2, ..., N_D]`.
S
SunGaofeng 已提交
7074
                          where :math:`N_1` is the batch_size, :math:`N_D` is 1. The data type can be float32 or float64.
W
whs 已提交
7075 7076 7077
        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
7078 7079
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
7080
                             For more information, please refer to :ref:`api_guide_Name`
W
whs 已提交
7081 7082

    Returns:
7083
        Tensor, which shape is [1], data type is the same as `input` .
W
whs 已提交
7084

S
SunGaofeng 已提交
7085
    Example:
7086 7087
        .. code-block:: python

7088 7089 7090 7091 7092 7093 7094
            import paddle
            import paddle.nn.functional as F

            x = paddle.randn((3,224,224,2))
            label = paddle.randint(high=2, shape=(3,224,224,1))
            predictions = F.softmax(x)
            loss = F.dice_loss(input=predictions, label=label)
W
whs 已提交
7095 7096
    """
    label = one_hot(label, depth=input.shape[-1])
7097
    reduce_dim = list(range(1, len(input.shape)))
W
whs 已提交
7098 7099 7100 7101 7102 7103
    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)
7104 7105


7106 7107 7108 7109
def image_resize(input,
                 out_shape=None,
                 scale=None,
                 name=None,
7110
                 resample='BILINEAR',
7111 7112
                 actual_shape=None,
                 align_corners=True,
7113 7114
                 align_mode=1,
                 data_format='NCHW'):
7115
    """
7116

R
ruri 已提交
7117
    This op resizes a batch of images.
F
stash  
fengjiayi 已提交
7118

7119 7120
    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)
7121 7122
    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 已提交
7123
    and the resizing only applies on the three dimensions(depth, height and width).
7124

7125
    **Warning:** the parameter :attr:`actual_shape` will be deprecated in the
7126 7127
    future and only use :attr:`out_shape` instead.

7128
    Supporting resample methods:
7129
        'LINEAR' : Linear interpolation 
Q
update  
qiaolongfei 已提交
7130

7131
        'BILINEAR' : Bilinear interpolation
T
Tink_Y 已提交
7132

K
Kaipeng Deng 已提交
7133 7134
        'TRILINEAR' : Trilinear interpolation

7135
        'NEAREST' : Nearest neighbor interpolation
7136 7137
        
        'BICUBIC' : Bicubic interpolation
7138 7139 7140 7141
    
    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.
    
7142
    Nearest neighbor interpolation is to perform nearest neighbor interpolation
7143
    in both the 3rd dimension(in height direction) and the 4th dimension(in width
7144
    direction) on input tensor.
7145 7146 7147 7148 7149

    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
7150 7151
    again in the other direction.

7152 7153 7154
    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 已提交
7155
    The linear interpolation is performed on three directions.
7156 7157 7158 7159 7160
    
    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 已提交
7161

7162
    Align_corners and align_mode are optional parameters,the calculation method
7163 7164 7165 7166
    of interpolation can be selected by them.

    Example:

T
Tink_Y 已提交
7167
    .. code-block:: text
7168

T
Tink_Y 已提交
7169
        For scale:
7170

T
Tink_Y 已提交
7171
            if align_corners = True && out_size > 1 :
7172

T
Tink_Y 已提交
7173
              scale_factor = (in_size-1.0)/(out_size-1.0)
7174

T
Tink_Y 已提交
7175
            else:
7176

T
Tink_Y 已提交
7177
              scale_factor = float(in_size/out_size)
7178 7179


T
Tink_Y 已提交
7180
        Nearest neighbor interpolation:
7181

T
Tink_Y 已提交
7182 7183
          if:
              align_corners = False
7184

T
Tink_Y 已提交
7185 7186
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7187

T
Tink_Y 已提交
7188 7189
              H_out = floor (H_{in} * scale_{factor})
              W_out = floor (W_{in} * scale_{factor})
7190

T
Tink_Y 已提交
7191 7192
          else:
              align_corners = True
7193

T
Tink_Y 已提交
7194 7195
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7196

T
Tink_Y 已提交
7197 7198
              H_out = round(H_{in} * scale_{factor})
              W_out = round(W_{in} * scale_{factor})
7199

7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216
        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 已提交
7217 7218 7219 7220
        Bilinear interpolation:

          if:
              align_corners = False , align_mode = 0
7221

T
Tink_Y 已提交
7222 7223
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7224

T
Tink_Y 已提交
7225 7226
              H_out = (H_{in}+0.5) * scale_{factor} - 0.5
              W_out = (W_{in}+0.5) * scale_{factor} - 0.5
7227

T
Tink_Y 已提交
7228
          else:
7229

T
Tink_Y 已提交
7230 7231
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7232

T
Tink_Y 已提交
7233 7234
              H_out = H_{in} * scale_{factor}
              W_out = W_{in} * scale_{factor}
7235

K
Kaipeng Deng 已提交
7236 7237 7238 7239
        Trilinear interpolation:

          if:
              align_corners = False , align_mode = 0
7240

K
Kaipeng Deng 已提交
7241 7242
              input : (N,C,D_in,H_in,W_in)
              output: (N,C,D_out,H_out,W_out) where:
7243

K
Kaipeng Deng 已提交
7244 7245 7246 7247 7248 7249
              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:
7250

K
Kaipeng Deng 已提交
7251 7252 7253 7254
              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}
7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267
       
        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 已提交
7268 7269
              H_out = H_{in} * scale_{factor}
              W_out = W_{in} * scale_{factor}
7270
        
7271

7272 7273 7274
    For details of linear interpolation, please refer to Wikipedia:
    https://en.wikipedia.org/wiki/Linear_interpolation.
    
7275
    For details of nearest neighbor interpolation, please refer to Wikipedia:
7276
    https://en.wikipedia.org/wiki/Nearest-neighbor_interpolation.
7277
    
7278
    For details of bilinear interpolation, please refer to Wikipedia:
7279
    https://en.wikipedia.org/wiki/Bilinear_interpolation.
7280
    
7281
    For details of trilinear interpolation, please refer to Wikipedia:
K
Kaipeng Deng 已提交
7282
    https://en.wikipedia.org/wiki/Trilinear_interpolation.
7283 7284 7285
    
    For details of bicubic interpolation, please refer to Wikipedia:
    https://en.wikipedia.org/wiki/Bicubic_interpolation
7286

R
ruri 已提交
7287
    Parameters:
7288
        input (Variable): 3-D, 4-D or 5-D Tensor, its data type is float32, float64, or uint8,
7289
                          its data format is specified by :attr:`data_format`.
7290 7291 7292 7293
        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].
7294
             If a Tensor Variable, its dimensions size should be a 1.
7295 7296 7297
        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 已提交
7298
             Default: None.
7299 7300
        name(str|None): A name for this layer(optional). If set None, the layer
                        will be named automatically.
7301
        resample(str): The resample method. It supports 'LINEAR', 'BICUBIC', 'BILINEAR', 'TRILINEAR'
K
Kaipeng Deng 已提交
7302
                       and 'NEAREST' currently. Default: 'BILINEAR'
7303 7304 7305
        actual_shape(Variable): An optional input to specify output shape
                                dynamically. If provided, image resize
                                according to this given shape rather than
7306
                                :attr:`out_shape` and :attr:`scale` specifying
7307 7308
                                shape. That is to say actual_shape has the
                                highest priority. It is recommended to use
7309 7310 7311 7312 7313
                                :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 已提交
7314
                                errors would be occurred in graph constructing stage.
7315
                                Default: None
7316 7317
        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
7318 7319
                               corner pixels.
                               Default: True
7320 7321 7322
        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.
7323
        data_format (str, optional): Specify the data format of the input, and the data format of the output
7324
            will be consistent with that of the input. An optional string from:`NCW`, `NWC`, `"NCHW"`, `"NHWC"`, `"NCDHW"`,
7325
            `"NDHWC"`. The default is `"NCHW"`. When it is `"NCHW"`, the data is stored in the order of:
7326
            `[batch_size, input_channels, input_height, input_width]`. When it is `"NCHW"`, the data is stored
7327
            in the order of: `[batch_size, input_channels, input_depth, input_height, input_width]`.
7328 7329

    Returns:
7330
        A 3-D Tensor of the shape (num_batches, channels, out_w) or (num_batches, out_w, channels),
7331 7332
        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 已提交
7333

7334 7335 7336
    Raises:
        TypeError: out_shape should be a list or tuple or Variable.
        TypeError: actual_shape should either be Variable or None.
7337 7338
        ValueError: The 'resample' of image_resize can only be 'LINEAR', 'BILINEAR',
                    'TRILINEAR', 'BICUBIC' or 'NEAREST' currently.
7339
        ValueError: 'LINEAR' only support 3-D tensor.
7340
        ValueError: 'BICUBIC', 'BILINEAR' and 'NEAREST' only support 4-D tensor.
K
Kaipeng Deng 已提交
7341
        ValueError: 'TRILINEAR' only support 5-D tensor.
7342
        ValueError: One of out_shape and scale must not be None.
7343
        ValueError: out_shape length should be 1 for input 3-D tensor.
K
Kaipeng Deng 已提交
7344 7345
        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 已提交
7346
        ValueError: scale should be greater than zero.
T
tianshuo78520a 已提交
7347
        TypeError: align_corners should be a bool value
7348
        ValueError: align_mode can only be '0' or '1'
7349
        ValueError: data_format can only be 'NCW', 'NWC', 'NCHW', 'NHWC', 'NCDHW' or 'NDHWC'.
7350

7351 7352
    Examples:
        .. code-block:: python
7353

R
ruri 已提交
7354
	    #declarative mode
7355
	    import paddle
R
ruri 已提交
7356 7357
	    import paddle.fluid as fluid
	    import numpy as np
7358
	    paddle.enable_static()
R
ruri 已提交
7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384
	    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())
7385

R
ruri 已提交
7386
	    input_data = np.random.rand(2,3,6,10).astype("float32")
7387

R
ruri 已提交
7388 7389 7390 7391
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
7392

R
ruri 已提交
7393
	    print(output_data[0].shape)
7394

R
ruri 已提交
7395 7396 7397 7398 7399 7400 7401 7402
	    #1
	    # (2, 3, 12, 12)
	    #2
	    # (2, 3, 12, 2)
	    #3
	    # (2, 3, 3, 12)
	    #4
	    # (2, 3, 3, 5)
7403

R
ruri 已提交
7404 7405
	    #imperative mode
	    import paddle.fluid.dygraph as dg
7406

R
ruri 已提交
7407 7408 7409 7410
	    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)
7411

R
ruri 已提交
7412
		# [2L, 3L, 12L, 12L]
7413

7414
    """
7415
    resample_methods = {
7416
        'LINEAR': 'linear',
7417
        'BILINEAR': 'bilinear',
K
Kaipeng Deng 已提交
7418
        'TRILINEAR': 'trilinear',
7419
        'NEAREST': 'nearest',
7420
        'LINEAR': 'linear',
7421
    }
7422
    resample = resample.upper()
7423 7424
    if resample not in resample_methods:
        raise ValueError(
7425
            "The 'resample' of image_resize can only be 'LINEAR', 'BILINEAR', 'TRILINEAR' "
K
Kaipeng Deng 已提交
7426
            "or 'NEAREST' currently.")
7427
    resample_type = resample_methods[resample]
7428

7429 7430 7431
    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 已提交
7432
        raise ValueError("'BILINEAR' and 'NEAREST' only support 4-D tensor.")
7433
    elif resample == 'TRILINEAR' and len(input.shape) != 5:
K
Kaipeng Deng 已提交
7434 7435
        raise ValueError("'TRILINEAR'only support 5-D tensor.")

7436 7437 7438 7439 7440
    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")

7441
    if out_shape is None and scale is None:
7442
        raise ValueError("One of out_shape and scale must not be None.")
7443
    helper = LayerHelper('{}_interp'.format(resample_type), **locals())
7444
    dtype = helper.input_dtype()
7445

7446
    if len(input.shape) == 3 and data_format not in ['NCW', 'NWC']:
7447 7448
        raise ValueError(
            "Got wrong value for param `data_format`: " + data_format +
7449
            " received but only `NCW` or `NWC` supported for 3-D input.")
7450
    elif len(input.shape) == 4 and data_format not in ['NCHW', 'NHWC']:
7451 7452 7453 7454 7455 7456 7457 7458
        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.")

7459 7460 7461
    def _is_list_or_turple_(data):
        return (isinstance(data, list) or isinstance(data, tuple))

7462
    if data_format == 'NCHW' or data_format == 'NCDHW' or data_format == 'NCW':
7463
        data_layout = 'NCHW'
7464
    if data_format == 'NHWC' or data_format == 'NDHWC' or data_format == 'NWC':
7465 7466
        data_layout = 'NHWC'

7467
    inputs = {"X": input}
D
dengkaipeng 已提交
7468
    attrs = {
7469 7470 7471
        "out_d": -1,
        "out_h": -1,
        "out_w": -1,
D
dengkaipeng 已提交
7472 7473
        "interp_method": resample_type,
        "align_corners": align_corners,
7474 7475
        "align_mode": align_mode,
        "data_layout": data_layout
D
dengkaipeng 已提交
7476 7477
    }

7478
    if out_shape is not None:
7479
        if isinstance(out_shape, Variable):
7480
            out_shape.stop_gradient = True
7481
            inputs['OutSize'] = out_shape
7482 7483
        else:
            if not (_is_list_or_turple_(out_shape)):
D
dengkaipeng 已提交
7484 7485
                raise TypeError(
                    "out_shape should be a list or tuple or Variable.")
7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513
            # 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

7514 7515 7516 7517 7518 7519 7520 7521 7522 7523
            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 已提交
7524 7525 7526
                if len(out_shape) != 2:
                    raise ValueError("out_shape length should be 2 for "
                                     "input 4-D tensor.")
7527 7528 7529 7530 7531 7532 7533
                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 已提交
7534 7535 7536 7537
            if len(input.shape) == 5:
                if len(out_shape) != 3:
                    raise ValueError("out_shape length should be 3 for "
                                     "input 5-D tensor.")
7538 7539 7540 7541 7542 7543 7544 7545 7546
                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]
7547

7548
    else:
7549 7550 7551
        if isinstance(scale, Variable):
            scale.stop_gradient = True
            inputs["Scale"] = scale
7552
        elif isinstance(scale, float) or isinstance(scale, int):
7553
            if scale <= 0:
7554
                raise ValueError("Attr(scale) should be greater than zero.")
7555
            attrs['scale'] = float(scale)
7556 7557 7558
        else:
            raise TypeError(
                "Attr(scale)'s type should be float, int or Variable.")
7559

7560
    if isinstance(actual_shape, Variable):
7561 7562 7563 7564 7565
        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
7566 7567 7568
        inputs["OutSize"] = actual_shape
    elif actual_shape is not None:
        raise TypeError("actual_shape should either be Variable or None.")
X
Xin Pan 已提交
7569
    out = helper.create_variable_for_type_inference(dtype)
7570
    helper.append_op(
7571
        type='{}_interp'.format(resample_type),
7572
        inputs=inputs,
7573
        outputs={"Out": out},
D
dengkaipeng 已提交
7574
        attrs=attrs)
7575
    return out
F
stash  
fengjiayi 已提交
7576 7577


7578 7579 7580 7581 7582 7583 7584 7585
@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,
7586
                  data_format='NCW'):
7587 7588 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
    """
    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:
7629
        input(Variable): 3-D Tensor(NCW), its data type is float32, float64, or uint8,
7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654
                          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 
7655 7656 7657 7658 7659
            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`
7660 7661

    Returns:
7662
	Variable: 3-D tensor(NCW or NWC).
7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704
    
    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)


7705
@templatedoc(op_type="bilinear_interp")
7706 7707 7708 7709
def resize_bilinear(input,
                    out_shape=None,
                    scale=None,
                    name=None,
7710 7711
                    actual_shape=None,
                    align_corners=True,
7712 7713
                    align_mode=1,
                    data_format='NCHW'):
7714
    """
7715

R
ruri 已提交
7716
    This op resizes the input by performing bilinear interpolation based on given
7717
    output shape which specified by actual_shape, out_shape and scale
7718 7719
    in priority order.

7720
    **Warning:** the parameter :attr:`actual_shape` will be deprecated in
7721 7722
    the future and only use :attr:`out_shape` instead.

7723 7724 7725 7726
    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
7727 7728
    again in the other direction.

7729
    For details of bilinear interpolation, please refer to Wikipedia:
7730
    https://en.wikipedia.org/wiki/Bilinear_interpolation
Y
yuyang18 已提交
7731

7732
    Align_corners and align_mode are optional parameters,the calculation
7733 7734 7735 7736
    method of interpolation can be selected by them.

    Example:

T
Tink_Y 已提交
7737
    .. code-block:: text
7738

T
Tink_Y 已提交
7739
        For scale:
7740

T
Tink_Y 已提交
7741
            if align_corners = True && out_size > 1 :
7742

T
Tink_Y 已提交
7743
              scale_factor = (in_size-1.0)/(out_size-1.0)
7744

T
Tink_Y 已提交
7745
            else:
7746

7747
              scale_factor = float(in_size/out_size)
7748

T
Tink_Y 已提交
7749 7750 7751 7752
        Bilinear interpolation:

          if:
              align_corners = False , align_mode = 0
7753

T
Tink_Y 已提交
7754 7755
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
7756

T
Tink_Y 已提交
7757 7758
              H_out = (H_{in}+0.5) * scale_{factor} - 0.5
              W_out = (W_{in}+0.5) * scale_{factor} - 0.5
7759

T
Tink_Y 已提交
7760
          else:
T
tink2123 已提交
7761

T
Tink_Y 已提交
7762 7763 7764 7765
              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}
7766

R
ruri 已提交
7767 7768
    Parameters:
        input(Variable): 4-D Tensor(NCHW), its data type is float32, float64, or uint8,
7769
                          its data format is specified by :attr:`data_format`.
D
dengkaipeng 已提交
7770
        out_shape(list|tuple|Variable|None): Output shape of resize bilinear
7771 7772
            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
7773
            Tensor Variable, its dimension size should be 1.
7774
        scale(float|Variable|None): The multiplier for the input height or width. At
7775 7776
             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 已提交
7777
             Default: None.
7778 7779 7780
        actual_shape(Variable): An optional input to specify output shape
                                dynamically. If provided, image resize
                                according to this given shape rather than
7781
                                :attr:`out_shape` and :attr:`scale` specifying
7782 7783
                                shape. That is to say actual_shape has the
                                highest priority. It is recommended to use
7784 7785 7786 7787 7788
                                :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 已提交
7789
                                errors would be occurred in graph constructing stage.
7790
                                Default: None
7791 7792
        align_corners(bool): ${align_corners_comment}
        align_mode(bool): ${align_mode_comment}
7793
        data_format (str, optional): Specify the data format of the input, and the data format of the output
7794 7795 7796
            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 已提交
7797
        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 已提交
7798 7799

    Returns:
R
ruri 已提交
7800
	Variable: 4-D tensor(NCHW or NHWC).
7801

7802 7803
    Examples:
        .. code-block:: python
7804

R
ruri 已提交
7805 7806
	    #declarative mode
	    import paddle.fluid as fluid
7807
	    import numpy as np
7808 7809
	    import paddle
	    paddle.enable_static()
R
ruri 已提交
7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835
	    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())
7836

R
ruri 已提交
7837
	    input_data = np.random.rand(2,3,6,10).astype("float32")
7838

R
ruri 已提交
7839 7840 7841 7842
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
7843

R
ruri 已提交
7844
	    print(output_data[0].shape)
7845

R
ruri 已提交
7846 7847 7848 7849 7850 7851 7852 7853
	    #1
	    # (2, 3, 12, 12)
	    #2
	    # (2, 3, 12, 2)
	    #3
	    # (2, 3, 3, 12)
	    #4
	    # (2, 3, 3, 5)
7854

R
ruri 已提交
7855 7856
	    #imperative mode
	    import paddle.fluid.dygraph as dg
7857

R
ruri 已提交
7858 7859 7860 7861
	    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)
7862

R
ruri 已提交
7863
		# [2L, 3L, 12L, 12L]
7864

7865 7866
    """

7867
    return image_resize(input, out_shape, scale, name, 'BILINEAR', actual_shape,
7868
                        align_corners, align_mode, data_format)
7869 7870


K
Kaipeng Deng 已提交
7871 7872 7873 7874 7875 7876 7877
@templatedoc(op_type="trilinear_interp")
def resize_trilinear(input,
                     out_shape=None,
                     scale=None,
                     name=None,
                     actual_shape=None,
                     align_corners=True,
7878 7879
                     align_mode=1,
                     data_format='NCDHW'):
K
Kaipeng Deng 已提交
7880
    """
7881

R
ruri 已提交
7882
    This op resizes the input by performing trilinear interpolation based on given
K
Kaipeng Deng 已提交
7883 7884 7885
    output shape which specified by actual_shape, out_shape and scale
    in priority order.

7886
    **Warning:** the parameter :attr:`actual_shape` will be deprecated
7887 7888
    in the future and only use :attr:`out_shape` instead.

7889 7890 7891
    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 已提交
7892 7893 7894 7895 7896
    The linear interpolation is performed on three directions.

    For details of trilinear interpolation, please refer to Wikipedia:
    https://en.wikipedia.org/wiki/Trilinear_interpolation

7897
    Align_corners and align_mode are optional parameters,the calculation
K
Kaipeng Deng 已提交
7898 7899 7900 7901 7902 7903 7904
    method of interpolation can be selected by them.

    Example:

    .. code-block:: text

        For scale:
7905

K
Kaipeng Deng 已提交
7906 7907 7908
            if align_corners = True && out_size > 1 :

              scale_factor = (in_size-1.0)/(out_size-1.0)
7909

K
Kaipeng Deng 已提交
7910
            else:
7911 7912

              scale_factor = float(in_size/out_size)
K
Kaipeng Deng 已提交
7913 7914 7915 7916

        Bilinear interpolation:

          if:
7917

K
Kaipeng Deng 已提交
7918
              align_corners = False , align_mode = 0
7919

K
Kaipeng Deng 已提交
7920 7921
              input : (N,C,D_in,H_in,W_in)
              output: (N,C,D_out,H_out,W_out) where:
7922

K
Kaipeng Deng 已提交
7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935
              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 已提交
7936
    Parameters:
7937 7938
        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 已提交
7939
        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.
7940
        scale(float|Variable|None): The multiplier for the input depth, height or width.
7941 7942
             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 已提交
7943
             Default: None.
R
ruri 已提交
7944
        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 已提交
7945 7946 7947 7948 7949 7950
        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
7951 7952 7953 7954 7955
                                :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 已提交
7956
                                errors would be occurred in graph constructing stage.
K
Kaipeng Deng 已提交
7957 7958 7959
                                Default: None
        align_corners(bool): ${align_corners_comment}
        align_mode(bool): ${align_mode_comment}
7960
        data_format (str, optional): Specify the data format of the input, and the data format of the output
7961 7962 7963
            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 已提交
7964 7965

    Returns:
7966
        Variable: A 5-D Tensor(NCDHW or NDHWC)
K
Kaipeng Deng 已提交
7967 7968 7969

    Examples:
        .. code-block:: python
7970

R
ruri 已提交
7971 7972
	    #declarative mode
	    import paddle.fluid as fluid
7973
	    import paddle
R
ruri 已提交
7974
	    import numpy as np
7975
	    paddle.enable_static()
R
ruri 已提交
7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001
	    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())
8002

R
ruri 已提交
8003
	    input_data = np.random.rand(2,3,6,8,10).astype("float32")
K
Kaipeng Deng 已提交
8004

R
ruri 已提交
8005 8006 8007 8008
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
8009

R
ruri 已提交
8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022
	    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
8023

R
ruri 已提交
8024 8025 8026 8027
	    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)
8028

R
ruri 已提交
8029
		# [2L, 3L, 12L, 12L, 12L]
8030 8031 8032



K
Kaipeng Deng 已提交
8033 8034 8035
    """

    return image_resize(input, out_shape, scale, name, 'TRILINEAR',
8036
                        actual_shape, align_corners, align_mode, data_format)
K
Kaipeng Deng 已提交
8037 8038


8039
@templatedoc(op_type="nearest_interp")
8040 8041 8042 8043
def resize_nearest(input,
                   out_shape=None,
                   scale=None,
                   name=None,
8044
                   actual_shape=None,
8045 8046
                   align_corners=True,
                   data_format='NCHW'):
8047
    """
8048

R
ruri 已提交
8049
    This op resizes the input by performing nearest neighbor interpolation in both the
8050
    height direction and the width direction based on given output shape
8051
    which is specified by actual_shape, out_shape and scale in priority order.
8052

8053
    **Warning:** the parameter :attr:`actual_shape` will be deprecated in the
8054 8055
    future and only use :attr:`out_shape` instead.

8056 8057
    Example:

T
Tink_Y 已提交
8058 8059 8060
    .. code-block:: text

        For scale:
8061

T
Tink_Y 已提交
8062 8063
            if align_corners = True && out_size > 1 :
              scale_factor = (in_size-1.0)/(out_size-1.0)
8064

T
Tink_Y 已提交
8065
            else:
8066

T
Tink_Y 已提交
8067
              scale_factor = float(in_size/out_size)
8068

T
Tink_Y 已提交
8069
        Nearest neighbor interpolation:
8070

T
Tink_Y 已提交
8071 8072
          if:
              align_corners = False
8073

T
Tink_Y 已提交
8074 8075
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
8076

T
Tink_Y 已提交
8077 8078
              H_out = floor(H_{in} * scale_{factor})
              W_out = floor(W_{in} * scale_{factor})
8079

T
Tink_Y 已提交
8080 8081
          else:
              align_corners = True
8082

T
Tink_Y 已提交
8083 8084
              input : (N,C,H_in,W_in)
              output: (N,C,H_out,W_out) where:
8085

T
Tink_Y 已提交
8086 8087
              H_out = round(H_{in} * scale_{factor})
              W_out = round(W_{in} * scale_{factor})
8088 8089


8090
    For details of nearest neighbor interpolation, please refer to Wikipedia:
8091
    https://en.wikipedia.org/wiki/Nearest-neighbor_interpolation
Y
yuyang18 已提交
8092

R
ruri 已提交
8093
    Parameters:
8094 8095
        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 已提交
8096
        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.
8097
        scale(float|Variable|None): The multiplier for the input height or width. At
8098 8099 8100
             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 已提交
8101 8102
        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
8103 8104
                                dynamically. If provided, image resize
                                according to this given shape rather than
8105
                                :attr:`out_shape` and :attr:`scale` specifying
8106 8107
                                shape. That is to say actual_shape has the
                                highest priority. It is recommended to use
8108 8109 8110 8111 8112
                                :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 已提交
8113
                                errors would be occurred in graph constructing stage.
8114
                                Default: None
8115
        align_corners(bool): ${align_corners_comment}
8116
        data_format (str, optional): Specify the data format of the input, and the data format of the output
8117 8118 8119
            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 已提交
8120 8121

    Returns:
R
ruri 已提交
8122
	Variable: 4-D tensor(NCHW or NHWC).
8123 8124 8125

    Examples:
        .. code-block:: python
8126

R
ruri 已提交
8127 8128 8129
	    #declarative mode
	    import paddle.fluid as fluid
	    import numpy as np
8130 8131 8132
	    import paddle
	    paddle.enable_static()

R
ruri 已提交
8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158
	    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())
8159

R
ruri 已提交
8160
	    input_data = np.random.rand(2,3,6,10).astype("float32")
8161

R
ruri 已提交
8162 8163 8164 8165
	    output_data = exe.run(fluid.default_main_program(),
                feed={"input":input_data},
                fetch_list=[output],
                return_numpy=True)
8166

R
ruri 已提交
8167 8168 8169 8170 8171 8172 8173 8174 8175 8176
	    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)
8177

R
ruri 已提交
8178 8179
	    #imperative mode
	    import paddle.fluid.dygraph as dg
8180

R
ruri 已提交
8181 8182 8183 8184 8185 8186
	    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]
8187 8188 8189



8190 8191
    """

8192 8193 8194 8195 8196 8197 8198 8199 8200 8201
    return image_resize(
        input,
        out_shape,
        scale,
        name,
        'NEAREST',
        actual_shape,
        align_corners,
        align_mode=1,
        data_format=data_format)
8202 8203 8204 8205


def image_resize_short(input, out_short_len, resample='BILINEAR'):
    """
R
ruri 已提交
8206
    This op resizes a batch of images. The short edge of input images will be
8207 8208
    resized to the given 'out_short_len'. The long edge of input images
    will be resized proportionately to make images' length-width ratio
8209 8210
    constant.

R
ruri 已提交
8211 8212
    Parameters:
        input (Variable): 4-D tensor(NCHW), The input tensor of image resize layer.
8213
        out_short_len(int): The length of output images' short edge.
8214
        resample (str): resample method, default: BILINEAR.
F
fengjiayi 已提交
8215

8216
    Returns:
R
ruri 已提交
8217
        Variable: 4-D tensor(NCHW).
R
ruri 已提交
8218 8219 8220 8221

    Examples:
        .. code-block:: python

8222
            import paddle.fluid as fluid
R
ruri 已提交
8223
            input = fluid.data(name="input", shape=[None,3,6,9], dtype="float32")
R
ruri 已提交
8224
            out = fluid.layers.image_resize_short(input, out_short_len=3)
8225 8226 8227 8228 8229 8230 8231 8232 8233 8234
    """
    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 已提交
8235 8236 8237
    out_shape[long_idx] = int(
        float(out_shape[long_idx]) * (float(out_short_len) / float(hw[
            short_idx])) + 0.5)
8238 8239 8240
    return image_resize(input=input, out_shape=out_shape, resample=resample)


8241
@deprecated(since="2.0.0", update_to="paddle.gather")
8242
def gather(input, index, overwrite=True):
W
whs 已提交
8243
    """
Q
qiaolongfei 已提交
8244

8245
    Output is obtained by gathering entries of the outer-most dimension
W
whs 已提交
8246 8247 8248 8249
    of X indexed by `index` and concatenate them together.

    .. math::

8250
        Out = X[Index]
W
whs 已提交
8251 8252 8253 8254 8255 8256 8257


    .. code-block:: text


                Given:

8258 8259
                X = [[1, 2],
                     [3, 4],
W
whs 已提交
8260 8261 8262 8263 8264 8265 8266 8267 8268 8269
                     [5, 6]]

                Index = [1, 2]

                Then:

                Out = [[3, 4],
                       [5, 6]]

    Args:
8270
        input (Tensor): The source input tensor with rank>=1. Supported data type is
8271
            int32, int64, float32, float64 and uint8 (only for CPU),
Y
Yibing Liu 已提交
8272
            float16 (only for GPU).
8273
        index (Tensor): The index input tensor with rank=1. Data type is int32 or int64.
Y
Yibing Liu 已提交
8274
        overwrite (bool, optional): The mode that updating the grad when has same index.
8275
            If True, use the overwrite mode to update the grad of the same index,
8276
	    if False, use the accumulate mode to update the grad of the same index.
8277
	    Default value is True.
8278

W
whs 已提交
8279
    Returns:
8280 8281
        output (Tensor): The output is a tensor with the same rank as input.
    
W
whs 已提交
8282
    Examples:
W
whs 已提交
8283

W
whs 已提交
8284 8285
        .. code-block:: python

8286
            import paddle.fluid as fluid
Y
Yibing Liu 已提交
8287 8288
            x = fluid.data(name='x', shape=[-1, 5], dtype='float32')
            index = fluid.data(name='index', shape=[-1, 1], dtype='int32')
W
whs 已提交
8289 8290
            output = fluid.layers.gather(x, index)
    """
8291
    if in_dygraph_mode():
Z
Zhong Hui 已提交
8292
        return core.ops.gather(input, index, None, 'overwrite', overwrite)
8293 8294 8295 8296 8297

    check_variable_and_dtype(
        input, 'x',
        ['float16', 'float32', 'float64', 'int32', 'int64', 'uint8'], 'gather')
    check_variable_and_dtype(index, 'index', ['int32', 'int64'], 'gather')
W
whs 已提交
8298 8299
    helper = LayerHelper('gather', **locals())
    dtype = helper.input_dtype()
X
Xin Pan 已提交
8300
    out = helper.create_variable_for_type_inference(dtype)
W
whs 已提交
8301 8302 8303 8304
    helper.append_op(
        type="gather",
        inputs={"X": input,
                "Index": index},
8305 8306
        outputs={"Out": out},
        attrs={'overwrite': overwrite})
W
whs 已提交
8307 8308 8309
    return out


8310
@deprecated(since="2.0.0", update_to="paddle.gather_nd")
8311 8312 8313 8314
def gather_nd(input, index, name=None):
    """
    **Gather Nd Layer**

8315 8316 8317 8318
    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
8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340
    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]]
8341 8342 8343

                gather_nd(input, index)
                         = [input[1, :, :]]
8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362
                         = [[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:
8363
        input (Tensor): The input Tensor which it's data type should be bool, float32, float64, int32, int64.
8364 8365 8366 8367
        index (Tensor): The index input with rank > 1, index.shape[-1] <= input.rank.
                        Its dtype should be int32, 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` .
8368 8369

    Returns:
8370
        output (Tensor): A tensor with the shape index.shape[:-1] + input.shape[index.shape[-1]:]
8371 8372 8373 8374 8375 8376

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid
8377 8378
            x = fluid.data(name='x', shape=[3, 4, 5], dtype='float32')
            index = fluid.data(name='index', shape=[2, 2], dtype='int32')
8379 8380 8381
            output = fluid.layers.gather_nd(x, index)

    """
8382 8383 8384 8385 8386 8387
    if in_dygraph_mode():
        return core.ops.gather_nd(input, index)
    check_variable_and_dtype(input, 'input',
                             ['bool', 'float32', 'float64', 'int32', 'int64'],
                             'gather_np')
    check_variable_and_dtype(index, 'index', ['int32', 'int64'], 'gather_np')
8388 8389
    helper = LayerHelper('gather_nd', **locals())
    dtype = helper.input_dtype()
8390
    output = helper.create_variable_for_type_inference(dtype)
8391 8392 8393 8394 8395 8396 8397 8398
    helper.append_op(
        type="gather_nd",
        inputs={"X": input,
                "Index": index},
        outputs={"Out": output})
    return output


S
ShenLiang 已提交
8399
@deprecated(since="2.0.0", update_to="paddle.scatter")
8400
def scatter(input, index, updates, name=None, overwrite=True):
8401
    """
8402 8403 8404 8405
    :alias_main: paddle.scatter
	:alias: paddle.scatter,paddle.tensor.scatter,paddle.tensor.manipulation.scatter
	:old_api: paddle.fluid.layers.scatter

8406 8407
    **Scatter Layer**

8408
    Output is obtained by updating the input on selected indices based on updates.
8409

8410 8411
    .. code-block:: python
        import numpy as np
8412

8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433
        #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]
8434 8435

    Args:
8436 8437
        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 已提交
8438
        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.
8439 8440
        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.
8441
            If True, use the overwrite mode to update the output of the same index,
8442
	    if False, use the accumulate mode to update the output of the same index.
8443
	    Default value is True.
8444 8445

    Returns:
8446
        Variable(Tensor|LoDTensor): The output is a Tensor with the same shape as input.
8447 8448 8449 8450 8451

    Examples:

        .. code-block:: python

8452
            import numpy as np
8453 8454
            import paddle.fluid as fluid

8455 8456 8457
            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)
8458

8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472
            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)]
8473 8474 8475
    """
    helper = LayerHelper('scatter', **locals())
    dtype = helper.input_dtype()
X
Xin Pan 已提交
8476
    out = helper.create_variable_for_type_inference(dtype)
8477 8478 8479 8480 8481
    helper.append_op(
        type="scatter",
        inputs={"X": input,
                "Ids": index,
                "Updates": updates},
8482
        attrs={'overwrite': overwrite},
8483 8484 8485 8486
        outputs={"Out": out})
    return out


8487
def scatter_nd_add(ref, index, updates, name=None):
8488
    r"""
8489 8490 8491
    **Scatter_nd_add Layer**

    Output is obtained by applying sparse addition to a single value
8492
    or slice in a Variable.
8493

8494 8495 8496
    :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`
8497 8498
    is a Tensor with rank :math:`K - 1 + R - Q` and its
    shape is :math:`index.shape[:-1] + ref.shape[index.shape[-1]:]` .
8499

8500 8501 8502 8503 8504
    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
8505

8506 8507 8508 8509 8510 8511 8512 8513
        Given:

        * Case 1:
            ref = [0, 1, 2, 3, 4, 5]
            index = [[1], [2], [3], [1]]
            updates = [9, 10, 11, 12]

          we get:
8514

8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526
            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:
8527

8528 8529 8530
            output = [[67, 19], [-16, -27]]

    Args:
S
ShenLiang 已提交
8531
        ref (Variable): The ref input. Its dtype should be float32, float64.
8532 8533
        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.
8534 8535 8536
        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.
8537 8538

    Returns:
8539
        output (Variable): The output is a tensor with the same shape and dtype as ref.
8540 8541 8542 8543 8544 8545

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid
8546 8547
            import paddle
            paddle.enable_static()
8548 8549 8550
            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')
8551 8552 8553

            output = fluid.layers.scatter_nd_add(ref, index, updates)
    """
8554 8555 8556 8557 8558

    if in_dygraph_mode():
        op = getattr(core.ops, 'scatter_nd_add')
        return op(ref, index, updates)

8559 8560 8561 8562
    if ref.dtype != updates.dtype:
        raise ValueError("ref and updates must have same data type.")

    helper = LayerHelper('scatter_nd_add', **locals())
8563
    dtype = helper.input_dtype(input_param_name='ref')
8564
    output = helper.create_variable_for_type_inference(dtype)
8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577
    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**

8578 8579 8580
    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)`
8581
    is equal to :code:`scatter_nd_add(paddle.zeros(shape, updates.dtype), index, updates)` .
8582 8583 8584
    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
8585 8586 8587
    seen :code:`scatter_nd_add` . This op is the inverse of the :code:`gather_nd` op.

    Args:
8588
        index (Tensor): The index input with ndim > 1 and index.shape[-1] <= len(shape).
8589
                          Its dtype should be int32 or int64 as it is used as indexes.
8590
        updates (Tensor): The updated value of scatter_nd op. Its dtype should be float32, float64.
8591 8592
                            It must have the shape index.shape[:-1] + shape[index.shape[-1]:]
        shape(tuple|list): Shape of output tensor.
8593
        name (str|None): The output Tensor name. If set None, the layer will be named automatically.
8594 8595

    Returns:
8596
        output (Tensor): The output is a tensor with the same type as :attr:`updates` .
8597 8598 8599 8600 8601

    Examples:

        .. code-block:: python

8602 8603
            import paddle
            import numpy as np
8604

8605 8606 8607 8608 8609
            index_data = np.array([[1, 1],
                                   [0, 1],
                                   [1, 3]]).astype(np.int64)
            index = paddle.to_tensor(index_data)
            updates = paddle.rand(shape=[3, 9, 10], dtype='float32')
8610 8611
            shape = [3, 5, 9, 10]

8612
            output = paddle.scatter_nd(index, updates, shape)
8613 8614 8615 8616
    """
    return scatter_nd_add(zeros(shape, updates.dtype), index, updates, name)


Y
yuyang18 已提交
8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629
@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}
8630

8631
    Examples:
Q
qingqing01 已提交
8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644
        .. 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 已提交
8645
    """
F
stash  
fengjiayi 已提交
8646
    helper = LayerHelper("random_crop", **locals())
8647 8648 8649 8650
    check_variable_and_dtype(x, 'x',
                             ['float32', 'float64', 'uint8', 'int16', 'int32'],
                             'random_crop')
    check_type(shape, 'shape', (list, Variable), 'random_crop')
F
fengjiayi 已提交
8651
    dtype = x.dtype
X
Xin Pan 已提交
8652
    out = helper.create_variable_for_type_inference(dtype)
Y
yuyang18 已提交
8653
    if seed is None:
8654
        seed = np.random.randint(-65536, 65536)
F
fengjiayi 已提交
8655
    op_attrs = {"shape": shape}
F
stash  
fengjiayi 已提交
8656
    if isinstance(seed, int):
F
fengjiayi 已提交
8657 8658 8659 8660 8661
        op_attrs["startup_seed"] = seed
        seed = helper.create_variable(
            name=unique_name.generate("random_crop_seed"),
            dtype="int64",
            persistable=True)
F
stash  
fengjiayi 已提交
8662 8663 8664 8665
    elif not isinstance(seed, Variable):
        raise ValueError("'seed' must be a Variable or an int.")
    helper.append_op(
        type="random_crop",
F
fix  
fengjiayi 已提交
8666
        inputs={"X": x,
F
stash  
fengjiayi 已提交
8667 8668
                "Seed": seed},
        outputs={"Out": out,
F
fengjiayi 已提交
8669 8670
                 "SeedOut": seed},
        attrs=op_attrs)
F
stash  
fengjiayi 已提交
8671
    return out
W
whs 已提交
8672 8673


8674
def log(x, name=None):
8675
    r"""
W
wanghaoshuang 已提交
8676 8677 8678 8679
    Calculates the natural log of the given input tensor, element-wise.

    .. math::

8680
        Out = \\ln(x)
W
wanghaoshuang 已提交
8681 8682

    Args:
S
Steffy-zxf 已提交
8683
        x (Tensor): Input Tensor. Must be one of the following types: float32, float64.
W
Wilber 已提交
8684
        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`
8685

W
wanghaoshuang 已提交
8686 8687

    Returns:
S
Steffy-zxf 已提交
8688
        Tensor: The natural log of the input Tensor computed element-wise.
W
wanghaoshuang 已提交
8689 8690 8691 8692 8693

    Examples:

        .. code-block:: python

S
Steffy-zxf 已提交
8694
            import paddle
W
Wilber 已提交
8695

S
Steffy-zxf 已提交
8696 8697 8698 8699
            x = [[2,3,4], [7,8,9]]
            x = paddle.to_tensor(x, dtype='float32')
            res = paddle.log(x)
            # [[0.693147, 1.09861, 1.38629], [1.94591, 2.07944, 2.19722]]
W
wanghaoshuang 已提交
8700
    """
8701
    if in_dygraph_mode():
8702
        return core.ops.log(x)
8703

8704
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], "log")
8705
    inputs = {'X': [x]}
W
wanghaoshuang 已提交
8706
    helper = LayerHelper('log', **locals())
W
wanghaoshuang 已提交
8707
    dtype = helper.input_dtype(input_param_name='x')
X
Xin Pan 已提交
8708
    out = helper.create_variable_for_type_inference(dtype)
W
wanghaoshuang 已提交
8709
    helper.append_op(type="log", inputs={"X": x}, outputs={"Out": out})
W
wanghaoshuang 已提交
8710 8711 8712
    return out


8713
@deprecated(since="2.0.0", update_to="paddle.nn.functional.relu")
8714
def relu(x, name=None):
W
wanghaoshuang 已提交
8715
    """
Z
zhupengyang 已提交
8716
    ${comment}
W
wanghaoshuang 已提交
8717 8718

    Args:
Z
zhupengyang 已提交
8719 8720 8721 8722
        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 已提交
8723 8724

    Returns:
Z
zhupengyang 已提交
8725
        Variable: ${out_comment}
W
wanghaoshuang 已提交
8726 8727 8728 8729 8730

    Examples:

        .. code-block:: python

8731
            import paddle.fluid as fluid
Z
zhupengyang 已提交
8732 8733 8734 8735 8736 8737 8738 8739 8740
            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]]
"""
8741
    if in_dygraph_mode():
8742
        return core.ops.relu(x)
8743

8744 8745
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'relu')

8746
    inputs = {'X': [x]}
W
wanghaoshuang 已提交
8747
    helper = LayerHelper('relu', **locals())
W
wanghaoshuang 已提交
8748
    dtype = helper.input_dtype(input_param_name='x')
X
Xin Pan 已提交
8749
    out = helper.create_variable_for_type_inference(dtype)
X
Xin Pan 已提交
8750 8751
    helper.append_op(
        type="relu", inputs={"X": helper.input('x')}, outputs={"Out": out})
W
wanghaoshuang 已提交
8752
    return out
8753 8754


8755
@deprecated(since="2.0.0", update_to="paddle.nn.functional.selu")
C
chengduo 已提交
8756
def selu(x, scale=None, alpha=None, name=None):
8757
    r"""
8758

8759 8760 8761
    Selu Operator.

    The equation is:
8762

8763 8764 8765 8766 8767 8768
    .. math::
        selu= \\lambda*
        \\begin{cases}
            x                      &\\quad \\text{ if } x>0 \n
            \\alpha * e^x - \\alpha  &\\quad \\text{ if } x<=0
        \\end{cases}
8769

8770 8771 8772

    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 已提交
8773 8774

    Args:
8775 8776
        x (Variable): The input N-D Tensor.
        scale(float, optional): lambda in selu activation function,
C
chengduo 已提交
8777 8778 8779
            the default value is 1.0507009873554804934193349852946.
            For more information about this value, please refer
            to: https://arxiv.org/abs/1706.02515.
8780
        alpha(float, optional): alpha in selu activation function,
C
chengduo 已提交
8781 8782 8783
            the default value is 1.6732632423543772848170429916717.
            For more information about this value, please refer
            to: https://arxiv.org/abs/1706.02515.
8784 8785
        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 已提交
8786 8787

    Returns:
8788
        Variable(Tensor|LoDTensor): The output Tensor or LoDTensor with the same shape and LoD information as input.
C
chengduo 已提交
8789 8790 8791 8792

    Examples:

        .. code-block:: python
8793

8794
            import paddle.fluid as fluid
8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806
            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 已提交
8807
    """
8808 8809
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'selu')

C
chengduo 已提交
8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823
    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 已提交
8824
def mean_iou(input, label, num_classes):
8825
    r"""
W
whs 已提交
8826
    Mean Intersection-Over-Union is a common evaluation metric for
8827 8828 8829 8830
    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 已提交
8831
    .. math::
8832

H
haowang101779990 已提交
8833
        IOU = \\frac{true\_positive}{(true\_positive + false\_positive + false\_negative)}.
W
whs 已提交
8834

8835
    The predictions are accumulated in a confusion matrix and mean-IOU
W
whs 已提交
8836 8837 8838
    is then calculated from it.


L
Liufang Sang 已提交
8839
    Parameters:
S
Steffy-zxf 已提交
8840 8841
        input (Tensor): A n-D Tensor of prediction results for semantic labels with type int32 or int64.
        label (Tensor): A Tensor of ground truth labels with type int32 or int64.
W
whs 已提交
8842
                           Its shape should be the same as input.
L
Liufang Sang 已提交
8843 8844
        num_classes (int32): The possible number of labels.

8845
    Returns:
S
Steffy-zxf 已提交
8846
	Three Tensors.
L
Liufang Sang 已提交
8847

S
Steffy-zxf 已提交
8848
        - mean_iou(Tensor) : A 1-D Tensor representing the mean intersection-over-union with shape [1]. \
L
Liufang Sang 已提交
8849
			    Data type is float32.
S
Steffy-zxf 已提交
8850
        - out_wrong(Tensor) : A 1-D Tensor with shape [num_classes]. Data type is int32. \
L
Liufang Sang 已提交
8851
			     The wrong numbers of each class.
S
Steffy-zxf 已提交
8852
        - out_correct(Tensor): A 1-D  Tensor with shape [num_classes]. Data type is int32. The correct numbers of each class.
8853 8854


W
whs 已提交
8855 8856 8857
    Examples:

        .. code-block:: python
8858

S
Steffy-zxf 已提交
8859 8860 8861
            import paddle

            iou_shape = [64, 32, 32]
8862
            num_classes = 5
S
Steffy-zxf 已提交
8863 8864 8865
            predict = paddle.randint(low=0, high=255, shape=iou_shape, dtype='int64')
            label = paddle.randint(low=0, high=255, shape=iou_shape, dtype='int64')
            mean_iou, out_wrong, out_correct = paddle.metric.mean_iou(predict, label, num_classes)
W
whs 已提交
8866
    """
S
Steffy-zxf 已提交
8867 8868 8869
    if in_dygraph_mode():
        return core.ops.mean_iou(input, label, 'num_classes', num_classes)

W
whs 已提交
8870
    helper = LayerHelper('mean_iou', **locals())
8871 8872 8873
    check_variable_and_dtype(input, 'Predictions', ['int32', 'int64'],
                             'mean_iou')
    check_variable_and_dtype(label, 'Labels', ['int32', 'int64'], 'mean_iou')
X
Xin Pan 已提交
8874 8875 8876
    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 已提交
8877 8878
    helper.append_op(
        type="mean_iou",
W
whs 已提交
8879 8880
        inputs={"Predictions": input,
                "Labels": label},
W
whs 已提交
8881
        outputs={
W
whs 已提交
8882 8883 8884
            "OutMeanIou": out_mean_iou,
            "OutWrong": out_wrong,
            "OutCorrect": out_correct
W
whs 已提交
8885 8886 8887
        },
        attrs={"num_classes": num_classes})
    return out_mean_iou, out_wrong, out_correct
8888 8889 8890 8891 8892 8893


def crop(x, shape=None, offsets=None, name=None):
    """
    Crop input into output, as specified by offsets and shape.

S
SunGaofeng 已提交
8894 8895
    **Warning:** THIS OP IS DEPRECATED. It will be removed in the future version.
    Instructions for updating: Use :ref:`api_fluid_layers_crop_tensor` instead.
8896

8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924
    .. 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 已提交
8925 8926 8927 8928
    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.
8929
            If it is a Tensor, it's rank must be the same as `x` , only
S
SunGaofeng 已提交
8930
            it's shape will be used, and the value of it will be ignored. This way
8931
            is suitable for the case that the output shape may be changed each
S
SunGaofeng 已提交
8932
            iteration. If it is a list/tuple of integers, it's length must be the same
8933
            as the rank of `x`
S
SunGaofeng 已提交
8934 8935 8936
        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`.
8937
            This way is suitable for the case that the offsets may be changed
S
SunGaofeng 已提交
8938 8939
            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.
8940 8941 8942
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name` . Usually name is no need to set and
            None by default.
8943 8944

    Returns:
S
SunGaofeng 已提交
8945 8946 8947 8948
        The cropped Tensor, which has the same rank and data type with `x`

    Return Type:
        Variable
8949 8950 8951 8952 8953 8954 8955 8956

    Raises:
        ValueError: If shape is not a list, tuple or Variable.

    Examples:

        .. code-block:: python

S
SunGaofeng 已提交
8957
            import paddle.fluid as fluid
8958 8959 8960
            import paddle.fluid as fluid
            import paddle
            paddle.enable_static()
S
SunGaofeng 已提交
8961 8962
            x = fluid.data(name="x", shape=[3, 3, 5], dtype="float32")
            y = fluid.data(name="y", shape=[2, 2, 3], dtype="float32")
8963 8964 8965
            crop = fluid.layers.crop(x, shape=y)

            # or
S
SunGaofeng 已提交
8966 8967
            z = fluid.data(name="z", shape=[3, 3, 5], dtype="float32")
            crop = fluid.layers.crop(z, shape=[2, 2, 3])
8968 8969

    """
8970 8971
    check_variable_and_dtype(x, 'x', ['float32'], 'crop')
    check_type(shape, 'shape', (list, tuple, Variable), 'crop')
8972 8973 8974 8975 8976
    helper = LayerHelper('crop', **locals())

    if offsets is None:
        offsets = [0] * len(x.shape)

X
Xin Pan 已提交
8977
    out = helper.create_variable_for_type_inference(x.dtype)
8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994
    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
8995 8996


8997 8998 8999 9000 9001 9002
def crop_tensor(x, shape=None, offsets=None, name=None):
    """
    Crop input into output, as specified by offsets and shape.

    .. code-block:: text

9003 9004
        * Case 1 (input is a 2-D Tensor):
            Input:
9005
                X.shape = [3, 5]
9006 9007 9008 9009 9010 9011 9012
                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:
9013 9014 9015
                Out.shape = [2, 2]
                Out.data = [[1, 2],
                            [3, 4]]
9016 9017 9018 9019 9020 9021 9022 9023 9024 9025
        * 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:
9026
                shape = [2, 2, -1]
9027 9028
                offsets = [0, 0, 1]
            Output:
9029 9030 9031 9032 9033
                Out.shape = [2, 2, 3]
                Out.data  = [[[1, 2, 3],
                              [5, 6, 7]],
                             [[3, 4, 5],
                              [6, 7, 8]]]
9034 9035

    Parameters:
9036
        x (Variable): 1-D to 6-D Tensor, the data type is float32, float64, int32 or int64.
9037 9038
        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 已提交
9039
            the same as the dimension size of `x`. If a Variable, it should be a 1-D Tensor.
9040
            When it is a list, each element can be an integer or a Tensor of shape: [1].
9041 9042
            If Variable contained, it is suitable for the case that the shape may
            be changed each iteration.
9043 9044
        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 已提交
9045
            must be the same as the dimension size of `x`. If a Variable, it should be a 1-D
9046 9047 9048 9049 9050
            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` .
9051 9052

    Returns:
9053
        Variable: The cropped Tensor has same data type with `x`.
9054 9055

    Raises:
9056 9057 9058 9059 9060 9061
        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.
9062 9063 9064 9065 9066 9067

    Examples:

        .. code-block:: python

            import paddle.fluid as fluid
9068 9069 9070
            import paddle.fluid as fluid
            import paddle
            paddle.enable_static()
9071
            x = fluid.data(name="x", shape=[None, 3, 5], dtype="float32")
9072 9073
            # x.shape = [-1, 3, 5], where -1 indicates batch size, and it will get the exact value in runtime.

9074 9075
            # shape is a 1-D Tensor
            crop_shape = fluid.data(name="crop_shape", shape=[3], dtype="int32")
9076 9077 9078 9079
            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
9080
            crop1 = fluid.layers.crop_tensor(x, shape=[-1, -1, 3], offsets=[0, 1, 0])
9081 9082
            # crop1.shape = [-1, 2, 3]

9083 9084 9085 9086 9087
            # 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]
9088

9089 9090
            # offsets is a 1-D Tensor
            crop_offsets = fluid.data(name="crop_offsets", shape=[3], dtype="int32")
9091 9092 9093
            crop3 = fluid.layers.crop_tensor(x, shape=[-1, 2, 3], offsets=crop_offsets)
            # crop3.shape = [-1, 2, 3]

9094 9095
            # offsets is a list in which each element is a constant or Variable
            offsets_var =  fluid.data(name="dim1", shape=[1], dtype="int32")
9096 9097 9098 9099 9100
            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())
9101 9102
    check_variable_and_dtype(x, 'x', ['float32', 'float64', 'int32', 'int64'],
                             'crop_tensor')
9103 9104 9105
    check_type(shape, 'shape', (list, tuple, Variable), 'crop_tensor')
    check_type(offsets, 'offsets', (list, tuple, Variable, type(None)),
               'crop_tensor')
9106 9107 9108 9109 9110 9111 9112 9113

    if offsets is None:
        offsets = [0] * len(x.shape)

    out = helper.create_variable_for_type_inference(x.dtype)
    ipts = {'X': x}
    attrs = {}

9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137
    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))

9138 9139 9140
    if isinstance(offsets, Variable):
        offsets.stop_gradient = True
        ipts['Offsets'] = offsets
9141
        attrs['offsets'] = [-1] * len(x.shape)
L
Leo Chen 已提交
9142
    elif utils._contain_var(offsets):
9143
        new_offsets_tensor = []
9144
        offsets_attr = []
9145 9146 9147 9148
        for dim in offsets:
            if isinstance(dim, Variable):
                dim.stop_gradient = True
                new_offsets_tensor.append(dim)
9149
                offsets_attr.append(-1)
9150
            else:
9151
                _attr_offsets_check(dim)
9152 9153 9154
                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)
9155
                offsets_attr.append(dim)
9156
        ipts['OffsetsTensor'] = new_offsets_tensor
9157
        attrs['offsets'] = offsets_attr
9158
    else:
9159 9160
        for offset in offsets:
            _attr_offsets_check(offset)
9161 9162 9163 9164 9165
        attrs['offsets'] = offsets

    if isinstance(shape, Variable):
        shape.stop_gradient = True
        ipts['Shape'] = shape
L
Leo Chen 已提交
9166
    elif utils._contain_var(shape):
9167 9168
        new_shape_tensor = []
        shape_attr = []
9169
        for dim_size in shape:
9170 9171 9172
            if isinstance(dim_size, Variable):
                dim_size.stop_gradient = True
                new_shape_tensor.append(dim_size)
9173
                shape_attr.append(0)
9174
            else:
9175
                _attr_shape_check(dim_size)
9176 9177 9178 9179 9180 9181 9182 9183
                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:
9184 9185
        for dim_size in shape:
            _attr_shape_check(dim_size)
9186 9187 9188 9189 9190 9191 9192 9193 9194 9195
        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 已提交
9196 9197
def affine_grid(theta, out_shape, name=None):
    """
9198 9199 9200 9201
    :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 已提交
9202 9203 9204 9205 9206 9207
    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:
9208 9209 9210 9211 9212 9213
        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 已提交
9214 9215

    Returns:
9216
        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 已提交
9217 9218 9219 9220 9221 9222 9223

    Raises:
        ValueError: If the type of arguments is not supported.

    Examples:

        .. code-block:: python
H
haowang101779990 已提交
9224

S
SunGaofeng 已提交
9225
            import paddle.fluid as fluid
9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239
            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 已提交
9240 9241 9242
    """
    helper = LayerHelper('affine_grid')

9243 9244 9245
    check_variable_and_dtype(theta, 'theta', ['float32', 'float64'],
                             'affine_grid')

W
whs 已提交
9246
    if not (isinstance(out_shape, list) or isinstance(out_shape, tuple) or \
9247
            isinstance(out_shape, Variable)):
W
whs 已提交
9248 9249 9250 9251 9252 9253 9254 9255 9256 9257
        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
9258 9259
        check_variable_and_dtype(out_shape, 'out_shape', ['int32'],
                                 'affine_grid')
W
whs 已提交
9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270
    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 已提交
9271 9272 9273 9274 9275 9276 9277
def pad2d(input,
          paddings=[0, 0, 0, 0],
          mode='constant',
          pad_value=0.0,
          data_format="NCHW",
          name=None):
    """
9278

T
tianshuo78520a 已提交
9279
    Pad 2-d images according to 'paddings' and 'mode'.
W
whs 已提交
9280 9281 9282
    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 已提交
9283
    Parameters:
9284 9285
        input (Tensor): 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 (Tensor | List[int32]): The padding size. If padding is a List, it must
L
Liufang Sang 已提交
9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300
            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` .

9301
    Returns: Tensor, a 4-D Tensor padded according to paddings and mode and data type is same as input.
L
Liufang Sang 已提交
9302 9303

    Examples:
T
Tink_Y 已提交
9304
        .. code-block:: text
W
whs 已提交
9305

9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329
            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 已提交
9330

L
Liufang Sang 已提交
9331
    Code Examples:
W
whs 已提交
9332 9333
        .. code-block:: python

9334 9335 9336 9337 9338 9339 9340 9341
            import numpy as np
            import paddle
            import paddle.nn.functional as F

            # example 1
            x_shape = (1, 1, 3, 4)
            x = np.arange(np.prod(x_shape), dtype=np.float32).reshape(x_shape) + 1
            tensor_x = paddle.to_tensor(x)
9342
            y = paddle.fluid.layers.pad2d(tensor_x, paddings=[1, 2, 2, 1], pad_value=1, mode='constant')
9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354
            print(y.numpy())
            # [[[[ 1.  1.  1.  1.  1.  1.  1.]
            #    [ 1.  1.  1.  2.  3.  4.  1.]
            #    [ 1.  1.  5.  6.  7.  8.  1.]
            #    [ 1.  1.  9. 10. 11. 12.  1.]
            #    [ 1.  1.  1.  1.  1.  1.  1.]
            #    [ 1.  1.  1.  1.  1.  1.  1.]]]]

            # example 2
            x_shape = (1, 1, 2, 3)
            x = np.arange(np.prod(x_shape), dtype=np.float32).reshape(x_shape) + 1
            tensor_x = paddle.to_tensor(x)
9355
            y = paddle.fluid.layers.pad2d(tensor_x, paddings=[1, 1, 1, 1], mode='reflect')
9356 9357 9358 9359 9360
            print(y.numpy())
            # [[[[5. 4. 5. 6. 5.]
            #    [2. 1. 2. 3. 2.]
            #    [5. 4. 5. 6. 5.]
            #    [2. 1. 2. 3. 2.]]]]
W
whs 已提交
9361
    """
9362 9363 9364
    check_variable_and_dtype(
        input, 'input', ['float16', 'float32', 'float64', 'int32', 'int64'],
        "pad2d")
9365 9366 9367 9368 9369 9370 9371

    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)

9372 9373 9374 9375 9376 9377 9378 9379
    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 已提交
9380
    helper = LayerHelper('pad2d', **locals())
9381 9382 9383 9384

    assert mode in ['reflect', 'edge', 'constant'
                    ], "mode should be one of constant, reflect, edge."

W
whs 已提交
9385
    dtype = helper.input_dtype(input_param_name='input')
X
Xin Pan 已提交
9386
    out = helper.create_variable_for_type_inference(dtype)
9387

W
whs 已提交
9388
    helper.append_op(
9389
        type='pad2d', inputs=inputs, outputs={"Out": out}, attrs=attrs)
W
whs 已提交
9390 9391 9392 9393

    return out


9394
@deprecated(since="2.0.0", update_to="paddle.nn.functional.elu")
9395 9396
def elu(x, alpha=1.0, name=None):
    """
9397 9398 9399 9400
    :alias_main: paddle.nn.functional.elu
	:alias: paddle.nn.functional.elu,paddle.nn.functional.activation.elu
	:old_api: paddle.fluid.layers.elu

9401 9402 9403 9404
    ${comment}
    Args:
        x(${x_type}): ${x_comment}
        alpha(${alpha_type}|1.0): ${alpha_comment}
9405
        name(str|None): The default value is None. Normally there is no need for user to set this property.
9406
                        For more information, please refer to :ref:`api_guide_Name`.
9407
    Returns:
9408
        ${out_type}: ${out_comment}
Z
ZhenWang 已提交
9409 9410 9411 9412 9413

    Examples:

        .. code-block:: python

9414
            import paddle.fluid as fluid
9415
            import numpy as np
9416

9417 9418 9419 9420 9421 9422 9423
            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       ]]
9424 9425
    """
    helper = LayerHelper('elu', **locals())
9426
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'elu')
X
Xin Pan 已提交
9427
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9428 9429 9430 9431 9432 9433 9434 9435
    helper.append_op(
        type='elu',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'alpha': alpha})
    return out


9436
@deprecated(since="2.0.0", update_to="paddle.nn.functional.relu6")
9437 9438
def relu6(x, threshold=6.0, name=None):
    """
9439

9440
    ${comment}
Z
zhupengyang 已提交
9441

9442 9443
    Args:
        x(${x_type}): ${x_comment}
Z
zhupengyang 已提交
9444 9445 9446 9447
        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`.
9448 9449 9450

    Returns:
        output(${out_type}): ${out_comment}
Z
ZhenWang 已提交
9451 9452 9453 9454 9455

    Examples:

        .. code-block:: python

9456
            import paddle.fluid as fluid
Z
zhupengyang 已提交
9457 9458 9459 9460 9461 9462 9463 9464
            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. ]]
9465
    """
9466 9467
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'relu6')

9468
    helper = LayerHelper('relu6', **locals())
X
Xin Pan 已提交
9469
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9470 9471 9472 9473
    helper.append_op(
        type='relu6',
        inputs={'X': x},
        outputs={'Out': out},
A
Adam 已提交
9474 9475 9476 9477
        attrs={
            'threshold': threshold,
            'use_mkldnn': core.globals()["FLAGS_use_mkldnn"]
        })
9478 9479 9480 9481 9482 9483
    return out


@templatedoc()
def pow(x, factor=1.0, name=None):
    """
9484 9485 9486 9487
    This is Pow Activation Operator.

    :math:`out = x^{factor}`

9488
    Args:
9489 9490 9491
        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` .
9492 9493

    Returns:
9494
        Variable: A ``Tensor`` or ``LoDTensor``. The data type is same as ``x``.
Z
ZhenWang 已提交
9495 9496 9497 9498 9499

    Examples:

        .. code-block:: python

9500
            import paddle.fluid as fluid
9501

9502
            x = fluid.data(name="x", shape=[32,32], dtype="float32")
9503 9504 9505

            # example 1: argument factor is float
            y_1 = fluid.layers.pow(x, factor=2.0)
9506
            # y_1 is x^{2.0}
9507 9508 9509 9510

            # 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)
9511
            # y_2 is x^{3.0}
9512
    """
9513 9514 9515
    check_variable_and_dtype(x, 'x', ['int32', 'int64', 'float32', 'float64'],
                             'pow')

9516
    helper = LayerHelper('pow', **locals())
9517 9518 9519
    inputs = {'X': x}
    attrs = {}
    if isinstance(factor, Variable):
9520
        check_variable_and_dtype(factor, 'factor', ['float32'], 'pow')
9521 9522 9523 9524 9525
        factor.stop_gradient = True
        inputs['FactorTensor'] = factor
    else:
        attrs['factor'] = factor

X
Xin Pan 已提交
9526
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9527
    helper.append_op(
9528
        type='pow', inputs=inputs, outputs={'Out': out}, attrs=attrs)
9529 9530 9531 9532
    return out


@templatedoc()
9533
def stanh(x, scale_a=0.67, scale_b=1.7159, name=None):
9534
    """
9535
    stanh activation.
9536

9537 9538 9539 9540 9541 9542 9543 9544 9545 9546
    .. math::

        out = b * \\frac{e^{a * x} - e^{-a * x}}{e^{a * x} + e^{-a * x}}

    Parameters:
        x (Tensor): The input Tensor with data type float32, float64.
        scale_a (float, optional): The scale factor a of the input. Default is 0.67.
        scale_b (float, optional): The scale factor b of the output. Default is 1.7159.
        name (str, optional): Name for the operation (optional, default is None).
            For more information, please refer to :ref:`api_guide_Name`.
9547 9548

    Returns:
9549
        A Tensor with the same data type and shape as ``x`` .
Z
ZhenWang 已提交
9550 9551 9552 9553

    Examples:
        .. code-block:: python

N
Noel 已提交
9554
            import paddle
9555

9556 9557
            x = paddle.to_tensor([1.0, 2.0, 3.0, 4.0])
            out = paddle.stanh(x, scale_a=0.67, scale_b=1.72) # [1.00616539, 1.49927628, 1.65933108, 1.70390463]
9558

9559
    """
9560 9561 9562 9563

    if in_dygraph_mode():
        return core.ops.stanh(x, 'scale_a', scale_a, 'scale_b', scale_b)

9564 9565
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'stanh')

9566
    helper = LayerHelper('stanh', **locals())
X
Xin Pan 已提交
9567
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580
    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):
    """
    ${comment}
9581 9582 9583 9584 9585 9586 9587
    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`
9588 9589

    Returns:
9590
        ${out_type}: ${out_comment}
Z
ZhenWang 已提交
9591 9592 9593 9594 9595

    Examples:

        .. code-block:: python

9596
            import paddle.fluid as fluid
9597 9598 9599
            import paddle
            paddle.enable_static()

9600 9601
            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]]
9602
    """
9603 9604 9605
    if in_dygraph_mode():
        return core.ops.hard_sigmoid(x, 'slope', slope, 'offset', offset)

9606 9607 9608
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'],
                             'hard_sigmoid')

9609
    helper = LayerHelper('hard_sigmoid', **locals())
X
Xin Pan 已提交
9610
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621
    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):
9622
    r"""
9623 9624 9625 9626
    :alias_main: paddle.nn.functional.swish
	:alias: paddle.nn.functional.swish,paddle.nn.functional.activation.swish
	:old_api: paddle.fluid.layers.swish

9627
    Elementwise swish activation function. See `Searching for Activation Functions <https://arxiv.org/abs/1710.05941>`_ for more details.
9628

9629 9630 9631 9632
    Equation:

    .. math::
        out = \\frac{x}{1 + e^{- beta * x}}
9633

9634
    Args:
9635
        x(Variable): Tensor or LoDTensor, dtype: float32 or float64, the input of swish activation.
9636

9637
        beta(float): Constant beta of swish operator, default 1.0.
9638

9639
        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`.
9640 9641

    Returns:
9642 9643

        Variable: Output of the swish activation, Tensor or LoDTensor, with the same dtype and shape with the input x.
Z
ZhenWang 已提交
9644 9645 9646 9647

    Examples:

        .. code-block:: python
9648

9649 9650 9651
            # declarative mode
            import numpy as np
            from paddle import fluid
9652

9653
            x = fluid.data(name="x", shape=(-1, 3), dtype="float32")
Z
ZhenWang 已提交
9654
            y = fluid.layers.swish(x, beta=2.0)
9655

9656 9657 9658 9659
            place = fluid.CPUPlace()
            exe = fluid.Executor(place)
            start = fluid.default_startup_program()
            main = fluid.default_main_program()
9660

9661 9662 9663
            data = np.random.randn(2, 3).astype("float32")
            exe.run(start)
            y_np, = exe.run(main, feed={"x": data}, fetch_list=[y])
9664

9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678
            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
9679

9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691
            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)
9692
    """
9693 9694
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'swish')

9695
    helper = LayerHelper('swish', **locals())
X
Xin Pan 已提交
9696
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9697 9698 9699 9700 9701 9702 9703 9704
    helper.append_op(
        type='swish',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'slope': beta})
    return out


Z
zhupengyang 已提交
9705
@deprecated(since="2.0.0", update_to="paddle.static.nn.prelu")
J
jerrywgz 已提交
9706
def prelu(x, mode, param_attr=None, name=None):
9707
    r"""
Z
zhupengyang 已提交
9708
    prelu activation.
J
jerrywgz 已提交
9709

H
haowang101779990 已提交
9710
    .. math::
Z
zhupengyang 已提交
9711
        prelu(x) = max(0, x) + \\alpha * min(0, x)
J
jerrywgz 已提交
9712

J
jerrywgz 已提交
9713 9714 9715 9716 9717 9718 9719 9720
    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.

Z
zhupengyang 已提交
9721 9722
    Parameters:
        x (Tensor): The input Tensor or LoDTensor with data type float32.
9723
        mode (str): The mode for weight sharing.
Z
zhupengyang 已提交
9724 9725 9726 9727 9728
        param_attr (ParamAttr|None, optional): The parameter attribute for the learnable
            weight (alpha), it can be create by ParamAttr. None by default.
            For detailed information, please refer to :ref:`api_fluid_ParamAttr`.
        name (str, optional): Name for the operation (optional, default is None).
            For more information, please refer to :ref:`api_guide_Name`.
J
jerrywgz 已提交
9729 9730

    Returns:
Z
zhupengyang 已提交
9731
        Tensor: A tensor with the same shape and data type as x.
J
jerrywgz 已提交
9732 9733 9734 9735 9736

    Examples:

        .. code-block:: python

9737
            import paddle
Z
zhupengyang 已提交
9738 9739 9740 9741 9742

            x = paddle.to_tensor([-1., 2., 3.])
            param = paddle.ParamAttr(initializer=paddle.nn.initializer.Constant(0.2))
            out = paddle.static.nn.prelu(x, 'all', param)
            # [-0.2, 2., 3.]
J
jerrywgz 已提交
9743

J
jerrywgz 已提交
9744
    """
9745 9746
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'prelu')

J
jerrywgz 已提交
9747 9748 9749 9750
    helper = LayerHelper('prelu', **locals())
    if mode not in ['all', 'channel', 'element']:
        raise ValueError('mode should be one of all, channel, element.')
    alpha_shape = [1]
9751
    # NOTE(): The input of this API should be ``N,C,...`` format,
9752
    # which means x.shape[0] is batch_size and x.shape[0] is channel.
J
jerrywgz 已提交
9753
    if mode == 'channel':
9754 9755 9756 9757 9758
        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.
9759 9760
        #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 已提交
9761
    elif mode == 'element':
9762 9763 9764 9765
        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 已提交
9766 9767
    dtype = helper.input_dtype(input_param_name='x')
    alpha = helper.create_parameter(
Q
Qiao Longfei 已提交
9768
        attr=helper.param_attr,
J
jerrywgz 已提交
9769 9770 9771
        shape=alpha_shape,
        dtype='float32',
        is_bias=False,
9772
        default_initializer=Constant(0.25))
X
Xin Pan 已提交
9773
    out = helper.create_variable_for_type_inference(dtype)
J
jerrywgz 已提交
9774 9775 9776 9777 9778 9779 9780 9781 9782
    helper.append_op(
        type="prelu",
        inputs={"X": x,
                'Alpha': alpha},
        attrs={"mode": mode},
        outputs={"Out": out})
    return out


9783 9784 9785 9786 9787 9788 9789 9790
@templatedoc()
def brelu(x, t_min=0.0, t_max=24.0, name=None):
    """
    ${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}
9791
        name(str|None): The default value is None. Normally there is no need for user to set this property.
9792
                        For more information, please refer to :ref:`api_guide_Name`.
9793
    Returns:
9794
        ${out_type}: ${out_comment}
9795 9796 9797

    Examples:

9798
    .. code-block:: python
9799

9800
            import paddle.fluid as fluid
9801
            import paddle
9802
            import numpy as np
9803
            paddle.enable_static()
9804

9805 9806 9807 9808 9809 9810
            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.]
9811
                #[ 1. 10.]]
9812
    """
9813 9814 9815
    if in_dygraph_mode():
        return core.ops.brelu(x, 't_min', t_min, 't_max', t_max)

9816 9817
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'brelu')

9818
    helper = LayerHelper('brelu', **locals())
X
Xin Pan 已提交
9819
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9820 9821 9822 9823 9824 9825 9826 9827 9828
    helper.append_op(
        type='brelu',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'t_min': t_min,
               't_max': t_max})
    return out


9829
@deprecated(since="2.0.0", update_to="paddle.nn.functional.leaky_relu")
9830 9831 9832 9833 9834 9835 9836
@templatedoc()
def leaky_relu(x, alpha=0.02, name=None):
    """
    ${comment}
    Args:
        x(${x_type}): ${x_comment}
        alpha(${alpha_type}|0.02): ${alpha_comment}
W
Wilber 已提交
9837 9838
        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`

9839
    Returns:
9840
        output(${out_type}): ${out_comment}
9841 9842 9843 9844 9845

    Examples:

        .. code-block:: python

N
Noel 已提交
9846
            import paddle
W
Wilber 已提交
9847

N
Noel 已提交
9848 9849 9850
            x = paddle.to_tensor([[-1, 2], [3, -4]], dtype='float32')
            y = paddle.fluid.layers.leaky_relu(x, alpha=0.1)
            print(y) # [[-0.1, 2], [3, -0.4]]
W
Wilber 已提交
9851

9852
    """
9853
    return paddle.nn.functional.leaky_relu(x, alpha, name)
9854 9855 9856


def soft_relu(x, threshold=40.0, name=None):
9857
    r"""
9858

9859 9860 9861 9862
    SoftRelu Activation Operator.

    $out = \ln(1 + \exp(\max(\min(x, threshold), -threshold)))$

9863
    Args:
9864 9865 9866 9867
        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` .

9868
    Returns:
9869
        Variable(Tensor|LoDTensor)): Output of soft_relu operator, shape and LoD same as input.
9870 9871 9872

    Examples:

9873 9874
        .. code-block:: python

9875
            import paddle.fluid as fluid
9876
            import numpy as np
9877 9878
            import numpy as np
            import paddle
9879

9880
            paddle.enable_static()
9881 9882 9883 9884 9885 9886 9887 9888 9889 9890
            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)]
9891
    """
9892 9893 9894
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'],
                             'soft_relu')

9895
    helper = LayerHelper('soft_relu', **locals())
X
Xin Pan 已提交
9896
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
9897 9898 9899 9900 9901 9902 9903 9904
    helper.append_op(
        type='soft_relu',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'threshold': threshold})
    return out


9905
def flatten(x, axis=1, name=None):
9906
    r"""
9907 9908 9909
    **Flatten op**

    Flatten the input tensor into a 2D matrix.
M
minqiyang 已提交
9910

H
haowang101779990 已提交
9911
    For Example:
M
minqiyang 已提交
9912

H
haowang101779990 已提交
9913
    .. code-block:: text
9914

H
haowang101779990 已提交
9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935
        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)
9936 9937

    Args:
9938 9939
        x (Variable): A tensor of rank >= axis. A tensor with type float32,
                      float64, int8, int32, int64.
9940 9941
        axis (int): Indicate up to which input dimensions (exclusive) should
                    be flattened to the outer dimension of the output.
9942
                    The value for axis must be in the range [0, R], where R
9943 9944 9945
                    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.
9946 9947

    Returns:
H
haowang101779990 已提交
9948 9949 9950
        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 \
9951
                  inner dimension of the output. A Tensor with type same as input x.
9952 9953 9954

    Raises:
        ValueError: If x is not a variable.
9955
        ValueError: If axis is not in range [0, rank(x)].
9956 9957 9958 9959 9960

    Examples:

        .. code-block:: python

9961
            import paddle.fluid as fluid
B
Bai Yifan 已提交
9962
            x = fluid.data(name="x", shape=[4, 4, 3], dtype="float32")
9963
            # x shape is [4, 4, 3]
9964
            out = fluid.layers.flatten(x=x, axis=2)
9965
            # out shape is [16, 3]
9966
    """
9967 9968
    check_variable_and_dtype(
        x, 'x', ['float32', 'float64', 'int8', 'int32', 'int64'], 'flatten')
9969 9970 9971 9972 9973 9974 9975 9976
    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 已提交
9977 9978
    out = helper.create_variable_for_type_inference(x.dtype)
    x_shape = helper.create_variable_for_type_inference(x.dtype)
9979
    helper.append_op(
9980
        type='flatten2',
9981
        inputs={"X": x},
9982 9983
        outputs={'Out': out,
                 'XShape': x_shape},
9984 9985
        attrs={"axis": axis})
    return out
X
Xin Pan 已提交
9986 9987


L
Leo Chen 已提交
9988
def stack(x, axis=0, name=None):
S
sneaxiy 已提交
9989
    """
9990

9991
    This OP stacks all the inputs :code:`x` along axis.
C
chengduozh 已提交
9992

C
chengduozh 已提交
9993 9994 9995
    .. code-block:: text

        Case 1:
9996

C
chengduozh 已提交
9997
          Input:
9998
            x[0].shape = [1, 2]
C
chengduozh 已提交
9999
            x[0].data = [ [1.0 , 2.0 ] ]
10000
            x[1].shape = [1, 2]
C
chengduozh 已提交
10001
            x[1].data = [ [3.0 , 4.0 ] ]
10002
            x[2].shape = [1, 2]
C
chengduozh 已提交
10003 10004 10005 10006 10007 10008
            x[2].data = [ [5.0 , 6.0 ] ]

          Attrs:
            axis = 0

          Output:
10009
            Out.dims = [3, 1, 2]
C
chengduozh 已提交
10010 10011 10012
            Out.data =[ [ [1.0, 2.0] ],
                        [ [3.0, 4.0] ],
                        [ [5.0, 6.0] ] ]
10013

C
chengduozh 已提交
10014 10015

        Case 2:
10016 10017 10018 10019


          Input:
            x[0].shape = [1, 2]
C
chengduozh 已提交
10020
            x[0].data = [ [1.0 , 2.0 ] ]
10021
            x[1].shape = [1, 2]
C
chengduozh 已提交
10022
            x[1].data = [ [3.0 , 4.0 ] ]
10023
            x[2].shape = [1, 2]
C
chengduozh 已提交
10024
            x[2].data = [ [5.0 , 6.0 ] ]
10025

C
chengduozh 已提交
10026 10027 10028 10029 10030

          Attrs:
            axis = 1 or axis = -2

          Output:
10031
            Out.shape = [1, 3, 2]
C
chengduozh 已提交
10032 10033 10034
            Out.data =[ [ [1.0, 2.0]
                          [3.0, 4.0]
                          [5.0, 6.0] ] ]
10035

C
chengduozh 已提交
10036

S
sneaxiy 已提交
10037
    Args:
L
Leo Chen 已提交
10038
        x (list(Variable)|tuple(Variable)): Input :code:`x` can be a :code:`list` or :code:`tuple` of Tensors, the shapes of all these Tensors
10039 10040 10041
                                     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}]`.
10042
                                     Supported data types: float32, float64, int32, int64.
L
Leo Chen 已提交
10043 10044 10045 10046 10047
        axis (int, optional): The axis along which all inputs are stacked. ``axis`` range is ``[-(R+1), R+1)``,
                              where ``R`` is the number of dimensions of the first input tensor ``x[0]``. 
                              If ``axis < 0``, ``axis = axis+R+1``. The default value of axis is 0.
        name (str, optional): Please refer to :ref:`api_guide_Name`, Default None.
    
10048

S
sneaxiy 已提交
10049
    Returns:
10050
        Variable: The stacked Tensor, has same data type with input Tensors. Output dim is :math:`rank(x[0])+1`.
10051

10052 10053 10054
    Examples:
        .. code-block:: python

10055
            import paddle.fluid as fluid
10056
            import paddle.fluid.layers as layers
10057 10058 10059 10060 10061 10062 10063 10064
            # 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]

10065

S
sneaxiy 已提交
10066
    """
X
Xin Pan 已提交
10067
    axis = 0 if axis is None else axis
L
Leo Chen 已提交
10068 10069 10070 10071

    if in_dygraph_mode():
        return core.ops.stack(x, 'axis', axis)

L
Leo Chen 已提交
10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083
    if not isinstance(x, list) and not isinstance(x, tuple):
        # NOTE:(zhiqiu) Only support Variable as input if the Variable is a LOD_TENSOR_ARRAY create by create_array, array_write, array_read, etc.
        # In that case, Variable is array of tensors indeed.
        if isinstance(x, Variable) and x.desc.type(
        ) == core.VarDesc.VarType.LOD_TENSOR_ARRAY:
            x = [x]
        else:
            raise TypeError("The type of '%s' in %s must be %s, but received %s"
                            % ('x', 'stack',
                               'list[Tensor], tuple[Tensor] or TensorArray',
                               type(x)))

L
Leo Chen 已提交
10084
    helper = LayerHelper('stack', **locals())
L
Leo Chen 已提交
10085

X
Xin Pan 已提交
10086
    out = helper.create_variable_for_type_inference(x[0].dtype)
L
Leo Chen 已提交
10087
    if x[0].desc.type() == core.VarDesc.VarType.LOD_TENSOR_ARRAY:
10088 10089 10090
        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 已提交
10091 10092 10093 10094 10095

        for i in x:
            check_variable_and_dtype(i, 'x', \
                ['float16', 'float32', 'float64', 'int32', 'int64'], 'stack')

10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108
        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})
10109

X
Xin Pan 已提交
10110
    return out
D
dzhwinter 已提交
10111 10112


J
Jiawei Wang 已提交
10113
@templatedoc(op_type="filter_by_instag")
Y
yaoxuefeng 已提交
10114
def filter_by_instag(ins, ins_tag, filter_tag, is_lod, out_val_if_empty=0):
J
Jiawei Wang 已提交
10115 10116
    """
    **Filter By Instag Layer**
10117 10118 10119

    This function filter a batch of ins by instag,
    There are multiple ins, and every ins belongs to some tags.
J
Jiawei Wang 已提交
10120 10121
    We can specify some tags we want. So the ins which belongs to that tags
    remains in the output, and others removed.
10122 10123 10124

    For example, one batch has 4 ins. Every ins has its tag list.

J
Jiawei Wang 已提交
10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139
       | 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.

10140
    Actually, if is_lod is false, it is normal tensor that equals to
J
Jiawei Wang 已提交
10141 10142 10143 10144 10145 10146 10147
    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
10148
        filter_tag (Variable): Input Variable (1D Tensor/List), usually it is
J
Jiawei Wang 已提交
10149 10150
                        list that holds the tags.
        is_lod (Bool): Boolean value to indicate ins is lod tensor or not.
Y
yaoxuefeng 已提交
10151 10152
        out_val_if_empty(Int64): If the output after filter is empty, this value
                        will be set to Output tensor.
J
Jiawei Wang 已提交
10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164

    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)
10165

J
Jiawei Wang 已提交
10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179
    """
    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 已提交
10180 10181
        attrs={'is_lod': is_lod,
               'out_val_if_empty': out_val_if_empty})
J
Jiawei Wang 已提交
10182 10183 10184 10185

    return [out, loss_weight]


D
dzhwinter 已提交
10186 10187
def unstack(x, axis=0, num=None):
    """
10188 10189 10190 10191
    :alias_main: paddle.unstack
	:alias: paddle.unstack,paddle.tensor.unstack,paddle.tensor.manipulation.unstack
	:old_api: paddle.fluid.layers.unstack

D
dzhwinter 已提交
10192 10193
    **UnStack Layer**

10194
    This layer unstacks input Tensor :code:`x` into several Tensors along :code:`axis`.
M
minqiyang 已提交
10195

D
dzhwinter 已提交
10196 10197 10198
    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 已提交
10199
    raised.
D
dzhwinter 已提交
10200 10201

    Args:
M
MRXLT 已提交
10202
        x (Tensor): Input Tensor. It is a N-D Tensors of data types float32, float64, int32, int64.
D
dzhwinter 已提交
10203 10204
        axis (int): The axis along which the input is unstacked.
        num (int|None): The number of output variables.
M
minqiyang 已提交
10205

D
dzhwinter 已提交
10206
    Returns:
M
MRXLT 已提交
10207
        list(Tensor): The unstacked Tensors list. The list elements are N-D Tensors of data types float32, float64, int32, int64.
10208 10209 10210

    Raises:
        ValueError: If x.shape[axis] <= 0 or axis is not in range [-D, D).
M
minqiyang 已提交
10211

10212 10213 10214
    Examples:
        .. code-block:: python

10215 10216 10217
            import paddle
            x = paddle.ones(name='x', shape=[2, 3, 5], dtype='float32')  # create a tensor with shape=[2, 3, 5]
            y = paddle.unstack(x, axis=1)  # unstack with second axis, which results 3 tensors with shape=[2, 5]
D
dzhwinter 已提交
10218

10219
    """
M
MRXLT 已提交
10220 10221 10222 10223 10224
    if in_dygraph_mode():
        if num == None:
            num = x.shape[axis]
        return core.ops.unstack(x, num, 'axis', int(axis), 'num', num)

D
dzhwinter 已提交
10225 10226 10227 10228 10229 10230 10231 10232
    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 已提交
10233
    for _ in range(num):
X
Xin Pan 已提交
10234
        outs.append(helper.create_variable_for_type_inference(x.dtype))
D
dzhwinter 已提交
10235 10236 10237 10238 10239 10240 10241 10242

    helper.append_op(
        type='unstack',
        inputs={'X': [x]},
        outputs={'Y': outs},
        attrs={'axis': axis,
               'num': num})
    return outs
W
whs 已提交
10243 10244


10245
@deprecated(since='2.0.0', update_to="paddle.expand")
W
whs 已提交
10246
def expand(x, expand_times, name=None):
10247
    """
10248 10249 10250 10251
    :alias_main: paddle.expand
	:alias: paddle.expand,paddle.tensor.expand,paddle.tensor.manipulation.expand
	:old_api: paddle.fluid.layers.expand

10252 10253 10254
    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 已提交
10255 10256 10257 10258 10259 10260
    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 已提交
10261

W
whs 已提交
10262 10263 10264 10265
                [
                   [[1], [2], [3]],
                   [[4], [5], [6]]
                ]
M
minqiyang 已提交
10266

W
whs 已提交
10267
        Attr(expand_times):  [1, 2, 2]
M
minqiyang 已提交
10268

W
whs 已提交
10269
        Output(Out) is a 3-D tensor with shape [2, 6, 2]:
M
minqiyang 已提交
10270

W
whs 已提交
10271 10272 10273 10274
                [
                    [[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 已提交
10275

W
whs 已提交
10276
    Args:
10277 10278 10279 10280 10281
        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 已提交
10282 10283

    Returns:
10284
        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 已提交
10285

10286 10287 10288
    Raises:
        TypeError: The type of ``expand_times`` must be list, tuple or Variable.
        ValueError: The elements of ``expand_times`` cannot be negative.
W
whs 已提交
10289 10290 10291

    Examples:
        .. code-block:: python
L
liym27 已提交
10292

W
wangchaochaohu 已提交
10293
            import paddle.fluid as fluid
L
liym27 已提交
10294 10295 10296 10297

            # 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])
10298
            # the shape of expanded_1 is [2, 6, 2].
L
liym27 已提交
10299 10300 10301 10302 10303

            # 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)
10304
            # the shape of expanded_2 is [48, 56].
W
whs 已提交
10305
    """
10306 10307
    if in_dygraph_mode():
        if isinstance(expand_times, (list, tuple)):
10308
            expand_times = [
10309
                item.numpy().item(0) if isinstance(item, Variable) else item
10310 10311
                for item in expand_times
            ]
10312

10313
            return core.ops.expand(x, 'expand_times', expand_times)
10314

10315 10316
    inputs = {"X": [x]}
    attrs = {}
10317 10318
    check_variable_and_dtype(
        x, 'x', ['bool', 'float32', 'float64', 'int32', 'int64'], 'expand')
10319
    check_type(expand_times, 'expand_times', (list, tuple, Variable), 'expand')
W
wangchaochaohu 已提交
10320 10321 10322
    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 已提交
10323

W
whs 已提交
10324
    helper = LayerHelper('expand', input=x, **locals())
L
liym27 已提交
10325 10326 10327 10328 10329 10330 10331 10332 10333

    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 已提交
10334
                    "Each element given in expand_times must not be negative.")
L
liym27 已提交
10335 10336
        return attrs_expand_times

L
Leo Chen 已提交
10337 10338 10339 10340 10341 10342
    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):
10343
            inputs['expand_times_tensor'] = utils._convert_to_tensor_list(
L
Leo Chen 已提交
10344
                expand_times)
10345

L
liym27 已提交
10346 10347
    dtype = helper.input_dtype(input_param_name='x')
    out = helper.create_variable_for_type_inference(dtype)
W
whs 已提交
10348
    helper.append_op(
10349
        type='expand', inputs=inputs, outputs={'Out': out}, attrs=attrs)
W
whs 已提交
10350
    return out
S
sneaxiy 已提交
10351 10352


10353
@deprecated(since='2.0.0', update_to="paddle.expand_as")
10354 10355
def expand_as(x, target_tensor, name=None):
    """
10356 10357 10358 10359
    :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
    
10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374
    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]]
                ]

10375
        target_tensor's shape:  [2, 6, 2]
10376 10377 10378 10379 10380 10381 10382

        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]]
                ]
10383

10384 10385 10386 10387 10388 10389 10390 10391

    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:
10392 10393
        Variable: A Tensor with dtype float64, float32, int32.
        After expanding, size of each dimension of Output(Out) is equal to the size
10394 10395 10396 10397 10398 10399
        of the corresponding dimension of target_tensor multiplying the corresponding
        value given by target_tensor.


    Examples:
        .. code-block:: python
10400

10401 10402 10403 10404 10405 10406
        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')
10407
        result = fluid.layers.expand_as(x=data, target_tensor=target_tensor)
10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418
        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)

    """
10419 10420 10421
    if in_dygraph_mode():
        return core.ops.expand_as(x, target_tensor)

10422 10423 10424 10425 10426
    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')
10427 10428 10429 10430 10431 10432 10433 10434
    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 已提交
10435 10436 10437
from paddle.fluid.framework import convert_np_dtype_to_dtype_


10438
@deprecated(since='1.8.0', update_to="paddle.uniform")
G
gongweibao 已提交
10439
@templatedoc()
G
fix  
gongweibao 已提交
10440 10441 10442 10443 10444 10445 10446 10447 10448
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):
    """
10449 10450 10451 10452 10453 10454
    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 已提交
10455

10456 10457 10458 10459 10460
            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],
10461
            output_dim_idx = 0,
10462
            input_dim_idx = 0,
10463
            result.shape[0] = input.shape[0],
10464 10465
            then:
                result=[[ 0.3443427 , -0.23056602,  0.3477049 ,  0.06139076]]    # result.shape=[1,4]
10466

10467
       *Case 2:
10468

10469 10470 10471 10472 10473
           Given:
               input =[[0.946741  , 0.1357001 , 0.38086128]]     # input.shape=[1,3]
               shape=[2,4]
               input_dim_idx=1
               output_dim_idx=1
10474

10475
           result.shape[output_dim_idx] = input.shape[input_dim_idx],
10476
           output_dim_idx = 1,
10477
           input_dim_idx = 1,
10478
           result.shape[1] = input.shape[1],
10479 10480 10481
           then:
               result=[[-0.23133647, -0.84195036,  0.21441269],
                       [-0.08774924,  0.25605237, -0.09403259]]    # result.shape=[2,3]
G
fix  
gongweibao 已提交
10482
    Args:
10483 10484
        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.
10485
        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.
10486 10487 10488 10489 10490
        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 已提交
10491
    Returns:
10492
        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 已提交
10493

10494 10495 10496
    Examples:
        .. code-block:: python

10497
            import paddle.fluid as fluid
10498 10499

            # example 1:
10500 10501
            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]
10502

10503
            # example 2:
10504 10505
            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]

10506

G
fix  
gongweibao 已提交
10507
    """
10508 10509 10510 10511 10512
    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 已提交
10513 10514

    helper = LayerHelper('uniform_random_batch_size_like', **locals())
X
Xin Pan 已提交
10515
    out = helper.create_variable_for_type_inference(dtype)
G
fix  
gongweibao 已提交
10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531
    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 已提交
10532 10533


10534
@deprecated(since="2.0.0", update_to="paddle.normal")
G
gongweibao 已提交
10535
@templatedoc()
10536 10537 10538 10539 10540 10541
def gaussian_random(shape,
                    mean=0.0,
                    std=1.0,
                    seed=0,
                    dtype='float32',
                    name=None):
G
fix  
gongweibao 已提交
10542
    """
10543 10544
    This OP returns a Tensor filled with random values sampled from a Gaussian
    distribution, with ``shape`` and ``dtype``.
G
fix  
gongweibao 已提交
10545 10546

    Args:
10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561
        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 已提交
10562 10563

    Returns:
10564 10565
        Tensor: A Tensor filled with random values sampled from a Gaussian
        distribution, with ``shape`` and ``dtype``.
G
fix  
gongweibao 已提交
10566

10567
    Examples:
10568
       .. code-block:: python
10569

10570 10571 10572
            import paddle.fluid as fluid

            # example 1:
10573
            # attr shape is a list which doesn't contain Tensor.
10574
            result_1 = fluid.layers.gaussian_random(shape=[3, 4])
10575 10576 10577
            # [[-0.31261674,  1.8736548,  -0.6274357,   0.96988016],
            #  [-0.12294637,  0.9554768,   1.5690808,  -1.2894802 ],
            #  [-0.60082096, -0.61138713,  1.5345167,  -0.21834975]]
10578 10579

            # example 2:
10580 10581 10582
            # 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)
10583
            result_2 = fluid.layers.gaussian_random(shape=[dim_1, dim_2])
10584 10585
            # [[ 0.51398206, -0.3389769,   0.23597084],
            #  [ 1.0388143,  -1.2015356,  -1.0499583 ]]
10586 10587

            # example 3:
10588
            # attr shape is a Tensor, the data type must be int64 or int32.
10589 10590
            var_shape = fluid.data(name='var_shape', shape=[2], dtype="int64")
            result_3 = fluid.layers.gaussian_random(var_shape)
10591 10592 10593 10594
            # if var_shape's value is [2, 3]
            # result_3 is:
            # [[-0.12310527,  0.8187662,   1.923219  ]
            #  [ 0.70721835,  0.5210541,  -0.03214082]]
10595 10596 10597 10598
       
       .. code-block:: python
       
           # declarative mode 
10599 10600
           import numpy as np
           from paddle import fluid
10601
   
10602
           x = fluid.layers.gaussian_random((2, 3), std=2., seed=10)
10603
   
10604 10605 10606 10607
           place = fluid.CPUPlace()
           exe = fluid.Executor(place)
           start = fluid.default_startup_program()
           main = fluid.default_main_program()
10608
   
10609 10610
           exe.run(start)
           x_np, = exe.run(main, feed={}, fetch_list=[x])
10611

10612 10613 10614 10615 10616 10617 10618 10619 10620 10621
           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
10622
    
10623 10624 10625
           place = fluid.CPUPlace()
           with dg.guard(place) as g:
               x = fluid.layers.gaussian_random((2, 4), mean=2., dtype="float32", seed=10)
10626
               x_np = x.numpy()       
10627 10628 10629
           x_np
           # array([[2.3060477 , 2.676496  , 3.9911983 , 0.9990833 ],
           #        [2.8675377 , 2.2279181 , 0.79029655, 2.8447366 ]], dtype=float32)
G
fix  
gongweibao 已提交
10630
    """
10631 10632
    if not isinstance(dtype, core.VarDesc.VarType):
        dtype = convert_np_dtype_to_dtype_(dtype)
10633 10634

    if in_dygraph_mode():
10635
        shape = utils.convert_shape_to_list(shape)
10636 10637 10638 10639
        return core.ops.gaussian_random('shape', shape, 'mean',
                                        float(mean), 'std',
                                        float(std), 'seed', seed, 'dtype',
                                        dtype)
10640 10641 10642

    check_type(shape, 'shape', (list, tuple, Variable), 'gaussian_random/randn')
    check_dtype(dtype, 'dtype', ['float32', 'float64'], 'gaussian_random/randn')
10643 10644

    inputs = {}
10645 10646 10647 10648
    attrs = {
        'mean': mean,
        'std': std,
        'seed': seed,
10649
        'dtype': dtype,
10650 10651
        'use_mkldnn': False
    }
10652
    utils.get_shape_tensor_inputs(
10653 10654 10655 10656
        inputs=inputs,
        attrs=attrs,
        shape=shape,
        op_type='gaussian_random/randn')
10657

10658 10659
    helper = LayerHelper('gaussian_random', **locals())
    out = helper.create_variable_for_type_inference(dtype)
G
fix  
gongweibao 已提交
10660 10661
    helper.append_op(
        type='gaussian_random',
10662
        inputs=inputs,
G
fix  
gongweibao 已提交
10663
        outputs={'Out': out},
10664
        attrs=attrs)
G
fix  
gongweibao 已提交
10665 10666 10667 10668

    return out


G
gongweibao 已提交
10669
@templatedoc()
G
fix  
gongweibao 已提交
10670
def sampling_id(x, min=0.0, max=1.0, seed=0, dtype='float32'):
G
fix  
gongweibao 已提交
10671
    """
R
ruri 已提交
10672
    This op is used for sampling id from multinomial distribution from the input, sampling one id for one sample.
G
fix  
gongweibao 已提交
10673

R
ruri 已提交
10674 10675 10676 10677
    Parameters:
        x (Variable): 2-D tensor, [batch_size, input_feature_dimensions]
        min (Float): minimum , default 0.0.
        max (Float): maximum, default 1.0.
10678
        seed (Float): Random seed, default 0. if seed is not 0, will generate same number every time.
G
fix  
gongweibao 已提交
10679
        dtype(np.dtype|core.VarDesc.VarType|str): The type of output data : float32, float_16, int etc
G
fix  
gongweibao 已提交
10680 10681

    Returns:
R
ruri 已提交
10682
        Variable: sampling tensor.
G
fix  
gongweibao 已提交
10683

10684 10685 10686
    Examples:
        .. code-block:: python

10687
            import paddle.fluid as fluid
R
ruri 已提交
10688
            x = fluid.data(
10689 10690
                name="X",
                shape=[13, 11],
R
ruri 已提交
10691
                dtype='float32')
10692

Y
Yibing Liu 已提交
10693
            out = fluid.layers.sampling_id(x)
G
fix  
gongweibao 已提交
10694 10695 10696
    """

    helper = LayerHelper('sampling_id', **locals())
X
Xin Pan 已提交
10697
    out = helper.create_variable_for_type_inference(dtype)
G
fix  
gongweibao 已提交
10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708
    helper.append_op(
        type='sampling_id',
        inputs={'X': x},
        outputs={'Out': out},
        attrs={'min': min,
               'max': max,
               'seed': seed})

    return out


10709
@deprecated(since='1.8.0', update_to="paddle.normal")
G
gongweibao 已提交
10710
@templatedoc()
G
fix  
gongweibao 已提交
10711 10712 10713 10714 10715 10716 10717 10718 10719
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 已提交
10720
    ${comment}
G
fix  
gongweibao 已提交
10721 10722

    Args:
G
gongweibao 已提交
10723 10724
        input (Variable): ${input_comment}
        shape (tuple|list): ${shape_comment}
Y
Yibing Liu 已提交
10725 10726 10727 10728 10729 10730
        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 已提交
10731 10732

    Returns:
G
gongweibao 已提交
10733
        out (Variable): ${out_comment}
10734 10735 10736 10737

    Examples:
        .. code-block:: python

10738
            import paddle.fluid as fluid
Y
Yibing Liu 已提交
10739
            input = fluid.data(name="input", shape=[13, 11], dtype='float32')
10740

Y
Yibing Liu 已提交
10741
            out = fluid.layers.gaussian_random_batch_size_like(
10742
                input, shape=[-1, 11], mean=1.0, std=2.0)
G
fix  
gongweibao 已提交
10743 10744 10745
    """

    helper = LayerHelper('gaussian_random_batch_size_like', **locals())
10746 10747 10748 10749 10750 10751
    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 已提交
10752
    out = helper.create_variable_for_type_inference(dtype)
G
fix  
gongweibao 已提交
10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770
    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 已提交
10771
@templatedoc()
X
Xin Pan 已提交
10772
def sum(x):
G
fix  
gongweibao 已提交
10773
    """
G
gongweibao 已提交
10774
    ${comment}
10775

10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804
    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 已提交
10805 10806

    Args:
10807
        x (Variable|list(Variable)): ${x_comment}
G
fix  
gongweibao 已提交
10808 10809

    Returns:
10810
        Variable: ${out_comment}
10811 10812 10813 10814

    Examples:
        .. code-block:: python

10815
            import paddle.fluid as fluid
10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834

            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.
10835 10836
            # 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,
10837
            #       and '__int64' on Windows. They both represent 64-bit integer variables.
G
fix  
gongweibao 已提交
10838 10839
    """

S
Steffy-zxf 已提交
10840
    return paddle.add_n(x)
G
fix  
gongweibao 已提交
10841 10842


G
gongweibao 已提交
10843
@templatedoc()
G
fix  
gongweibao 已提交
10844 10845
def slice(input, axes, starts, ends):
    """
10846
    This operator produces a slice of ``input`` along multiple axes. Similar to numpy:
10847
    https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html
10848 10849 10850 10851 10852 10853 10854
    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.
10855
    For slicing to the end of a dimension with unknown size, it is recommended
10856
    to pass in INT_MAX. The size of ``axes`` must be equal to ``starts`` and ``ends``.
10857 10858 10859
    Following examples will explain how slice works:

    .. code-block:: text
G
fix  
gongweibao 已提交
10860

10861 10862 10863 10864 10865 10866 10867 10868
        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], ]
10869

10870 10871 10872 10873 10874
        Case2:
            Given:
                data = [ [1, 2, 3, 4], [5, 6, 7, 8], ]
                axes = [0, 1]
                starts = [0, 1]
10875
                ends = [-1, 1000]       # -1 denotes the reverse 0th position of dimension 0.
10876
            Then:
10877
                result = [ [2, 3, 4], ] # result = data[0:1, 1:4]
T
Thunderbrook 已提交
10878
    
G
fix  
gongweibao 已提交
10879
    Args:
T
Thunderbrook 已提交
10880
        input (Tensor): A ``Tensor`` . The data type is ``float16``, ``float32``, ``float64``, ``int32`` or ``int64``.
10881
        axes (list|tuple): The data type is ``int32`` . Axes that `starts` and `ends` apply to .
T
Thunderbrook 已提交
10882 10883
        starts (list|tuple|Tensor): 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 Tensor, it should be an 1-D Tensor.
10884
                It represents starting indices of corresponding axis in ``axes``.
T
Thunderbrook 已提交
10885 10886
        ends (list|tuple|Tensor): 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 Tensor, it should be an 1-D Tensor .
10887
                It represents ending indices of corresponding axis in ``axes``.
G
fix  
gongweibao 已提交
10888 10889

    Returns:
T
Thunderbrook 已提交
10890
        Tensor:  A ``Tensor``. The data type is same as ``input``.
10891 10892

    Raises:
T
Thunderbrook 已提交
10893 10894
        TypeError: The type of ``starts`` must be list, tuple or Tensor.
        TypeError: The type of ``ends`` must be list, tuple or Tensor.
G
fix  
gongweibao 已提交
10895

10896 10897 10898
    Examples:
        .. code-block:: python

T
Thunderbrook 已提交
10899
            import paddle
10900

T
Thunderbrook 已提交
10901
            input = paddle.rand(shape=[4, 5, 6], dtype='float32')
10902
            # example 1:
T
Thunderbrook 已提交
10903
            # attr starts is a list which doesn't contain tensor.
10904 10905 10906
            axes = [0, 1, 2]
            starts = [-3, 0, 2]
            ends = [3, 2, 4]
T
Thunderbrook 已提交
10907
            sliced_1 = paddle.slice(input, axes=axes, starts=starts, ends=ends)
10908
            # sliced_1 is input[0:3, 0:2, 2:4].
10909 10910

            # example 2:
T
Thunderbrook 已提交
10911 10912 10913
            # attr starts is a list which contain tensor.
            minus_3 = paddle.full([1], -3, "int32")
            sliced_2 = paddle.slice(input, axes=axes, starts=[minus_3, 0, 2], ends=ends)
10914
            # sliced_2 is input[0:3, 0:2, 2:4].
G
fix  
gongweibao 已提交
10915
    """
10916 10917
    if in_dygraph_mode():
        infer_flags = list(1 for i in range(len(axes)))
10918 10919 10920
        if isinstance(starts, (list, tuple)) and isinstance(ends,
                                                            (list, tuple)):
            starts = [
10921
                item.numpy().item(0) if isinstance(item, Variable) else item
10922 10923 10924
                for item in starts
            ]
            ends = [
10925
                item.numpy().item(0) if isinstance(item, Variable) else item
10926 10927
                for item in ends
            ]
10928

10929 10930
            return core.ops.slice(input, 'axes', axes, 'starts', starts, 'ends',
                                  ends, 'infer_flags', infer_flags)
10931

10932 10933 10934 10935 10936 10937 10938
    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 已提交
10939
    helper = LayerHelper('slice', **locals())
10940 10941 10942 10943 10944

    inputs = {'Input': input}
    attrs = {'axes': axes}
    infer_flags = list(1 for i in range(len(axes)))

10945 10946 10947 10948 10949 10950 10951
    # 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 已提交
10952
        if utils._contain_var(starts):
10953
            inputs['StartsTensorList'] = utils._convert_to_tensor_list(starts)
10954 10955 10956 10957 10958 10959
            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 已提交
10960 10961
        else:
            attrs['starts'] = starts
10962 10963 10964 10965 10966 10967 10968 10969

    # 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 已提交
10970
        if utils._contain_var(ends):
10971
            inputs['EndsTensorList'] = utils._convert_to_tensor_list(ends)
10972 10973 10974 10975 10976 10977
            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 已提交
10978 10979 10980
        else:
            attrs['ends'] = ends

10981 10982
    # infer_flags
    attrs['infer_flags'] = infer_flags
X
Xin Pan 已提交
10983 10984
    out = helper.create_variable_for_type_inference(
        dtype=helper.input_dtype('input'))
G
fix  
gongweibao 已提交
10985
    helper.append_op(
10986
        type='slice', inputs=inputs, attrs=attrs, outputs={'Out': out})
G
fix  
gongweibao 已提交
10987 10988 10989 10990

    return out


10991
@deprecated(since='2.0.0', update_to="paddle.strided_slice")
W
wangchaochaohu 已提交
10992 10993
def strided_slice(input, axes, starts, ends, strides):
    """
10994 10995 10996 10997
    :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 已提交
10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010
    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 已提交
11011 11012 11013 11014 11015 11016 11017 11018 11019

    .. 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 已提交
11020
                strides = [1, 1]
W
wangchaochaohu 已提交
11021
            Then:
11022
                result = [ [5, 6, 7], ]
11023

W
wangchaochaohu 已提交
11024 11025 11026 11027
        Case2:
            Given:
                data = [ [1, 2, 3, 4], [5, 6, 7, 8], ]
                axes = [0, 1]
11028
                starts = [0, 1]
W
wangchaochaohu 已提交
11029 11030 11031 11032
                ends = [2, 0]
                strides = [1, -1]
            Then:
                result = [ [8, 7, 6], ]
11033

W
wangchaochaohu 已提交
11034 11035 11036 11037
        Case3:
            Given:
                data = [ [1, 2, 3, 4], [5, 6, 7, 8], ]
                axes = [0, 1]
11038
                starts = [0, 1]
11039 11040
                ends = [-1, 1000]
                strides = [1, 3]
W
wangchaochaohu 已提交
11041
            Then:
11042 11043
                result = [ [2], ]
    Args:
W
wangchaochaohu 已提交
11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055
        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``.
11056 11057

    Returns:
W
wangchaochaohu 已提交
11058 11059 11060 11061 11062 11063
        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.
11064

W
wangchaochaohu 已提交
11065 11066 11067 11068
    Examples:
        .. code-block:: python

            import paddle.fluid as fluid
11069
            import paddle
W
wangchaochaohu 已提交
11070

11071
            paddle.enable_static()
W
wangchaochaohu 已提交
11072
            input = fluid.data(
W
wangchaochaohu 已提交
11073 11074
                name="input", shape=[3, 4, 5, 6], dtype='float32')

11075 11076 11077 11078 11079
            # 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 已提交
11080 11081 11082 11083 11084
            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].

11085 11086 11087 11088

            # example 2:
            # attr starts is a list which contain tensor Variable.
            minus_3 = fluid.layers.fill_constant([1], "int32", -3)
W
wangchaochaohu 已提交
11089 11090
            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 已提交
11091 11092 11093
    """
    helper = LayerHelper('strided_slice', **locals())

11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116
    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')

11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136
    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 已提交
11137 11138 11139
            'axes': axes,
            'starts': starts,
            'ends': ends,
11140 11141 11142 11143 11144 11145 11146 11147 11148 11149
            '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 已提交
11150
            if utils._contain_var(starts):
11151 11152 11153 11154 11155 11156 11157
                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 已提交
11158 11159
            else:
                attrs['starts'] = starts
11160 11161 11162 11163 11164 11165 11166

        # ends
        if isinstance(ends, Variable):
            ends.stop_gradient = True
            inputs['EndsTensor'] = ends
        elif isinstance(ends, (list, tuple)):
            attrs['ends'] = []
L
Leo Chen 已提交
11167
            if utils._contain_var(ends):
11168 11169 11170 11171 11172 11173 11174
                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 已提交
11175 11176 11177
            else:
                attrs['ends'] = ends

11178 11179 11180 11181 11182 11183
        # strides
        if isinstance(strides, Variable):
            strides.stop_gradient = True
            inputs['StridesTensor'] = strides
        elif isinstance(strides, (list, tuple)):
            attrs['strides'] = []
L
Leo Chen 已提交
11184
            if utils._contain_var(strides):
11185 11186 11187 11188 11189 11190 11191
                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 已提交
11192 11193
            else:
                attrs['strides'] = strides
11194 11195 11196 11197 11198
        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 已提交
11199 11200 11201 11202

    return out


G
fix  
gongweibao 已提交
11203 11204
def shape(input):
    """
11205 11206 11207 11208
    :alias_main: paddle.shape
	:alias: paddle.shape,paddle.tensor.shape,paddle.tensor.attribute.shape
	:old_api: paddle.fluid.layers.shape

C
chengduozh 已提交
11209 11210
    **Shape Layer**

C
fix doc  
chengduozh 已提交
11211
    Get the shape of the input.
G
fix  
gongweibao 已提交
11212

11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229
    .. 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 已提交
11230
    Args:
11231
        input (Variable): The input can be N-D Tensor or SelectedRows with data type bool, float16, float32, float64, int32, int64.
11232
                          If input variable is type of SelectedRows, returns the shape of it's inner tensor.
G
fix  
gongweibao 已提交
11233 11234

    Returns:
11235
        Variable (Tensor): The shape of the input variable.
G
fix  
gongweibao 已提交
11236

11237 11238 11239
    Examples:
        .. code-block:: python

11240
            import paddle.fluid as fluid
11241
            import numpy as np
11242

11243
            inputs = fluid.data(name="x", shape=[3, 100, 100], dtype="float32")
11244 11245 11246 11247 11248 11249 11250 11251 11252
            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 已提交
11253
    """
11254
    check_variable_and_dtype(
11255 11256
        input, 'input',
        ['bool', 'float16', 'float32', 'float64', 'int32', 'int64'], 'shape')
G
fix  
gongweibao 已提交
11257
    helper = LayerHelper('shape', **locals())
11258
    out = helper.create_variable_for_type_inference(dtype='int32')
G
fix  
gongweibao 已提交
11259
    helper.append_op(
G
fix  
gongweibao 已提交
11260
        type='shape', inputs={'Input': input}, outputs={'Out': out})
G
fix  
gongweibao 已提交
11261 11262

    return out
G
merge  
gongweibao 已提交
11263 11264


Z
zhoukunsheng 已提交
11265 11266
def rank(input):
    """
11267

11268
    The OP returns the number of dimensions for a tensor, which is a 0-D int32 Tensor.
Z
zhoukunsheng 已提交
11269 11270

    Args:
11271
        input (Tensor): The input N-D tensor with shape of :math:`[N_1, N_2, ..., N_k]`, the data type is arbitrary.
Z
zhoukunsheng 已提交
11272 11273

    Returns:
11274
        Tensor, the output data type is int32.: The 0-D tensor with the dimensions of the input Tensor.
Z
zhoukunsheng 已提交
11275 11276 11277 11278

    Examples:
        .. code-block:: python

11279
            import paddle
11280

11281 11282 11283 11284
            input = paddle.rand((3, 100, 100))
            rank = paddle.rank(input)
            print(rank)
            # 3
Z
zhoukunsheng 已提交
11285
    """
11286
    check_type(input, 'input', (Variable), 'input')
Z
zhoukunsheng 已提交
11287 11288 11289 11290 11291 11292
    ndims = len(input.shape)
    out = assign(np.array(ndims, 'int32'))

    return out


11293
@deprecated(since="2.0.0", update_to="paddle.numel")
Z
zhoukunsheng 已提交
11294 11295 11296 11297 11298 11299 11300
def size(input):
    """
    **Size Layer**

    Returns the number of elements for a tensor, which is a int64 Tensor with shape [1].

    Args:
11301
        input (Tensor): The input Tensor, it's data type can be bool, float16, float32, float64, int32, int64.
Z
zhoukunsheng 已提交
11302 11303

    Returns:
11304
        Tensor: The number of elements for the input Tensor.
Z
zhoukunsheng 已提交
11305

11306 11307 11308
    Raises:
        TypeError: ``input`` must be a Tensor and the data type of ``input`` must be one of bool, float16, float32, float64, int32, int64.
    
Z
zhoukunsheng 已提交
11309 11310 11311 11312 11313 11314 11315 11316 11317 11318
    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
    """

11319
    if in_dygraph_mode():
11320
        return core.ops.size(input)
11321
    check_variable_and_dtype(
11322 11323
        input, 'input',
        ['bool', 'float16', 'float32', 'float64', 'int32', 'int64'], "size")
Z
zhoukunsheng 已提交
11324 11325 11326 11327 11328 11329 11330
    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 已提交
11331 11332 11333 11334
def _elementwise_op(helper):
    op_type = helper.layer_type
    x = helper.kwargs.get('x', None)
    y = helper.kwargs.get('y', None)
X
Xin Pan 已提交
11335

S
sneaxiy 已提交
11336 11337
    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)
11338 11339 11340 11341
    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)
11342

S
sneaxiy 已提交
11343 11344
    axis = helper.kwargs.get('axis', -1)
    use_mkldnn = helper.kwargs.get('use_mkldnn', False)
S
sneaxiy 已提交
11345
    name = helper.kwargs.get('name', None)
11346
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
S
sneaxiy 已提交
11347

S
sneaxiy 已提交
11348 11349 11350 11351 11352 11353 11354 11355 11356 11357
    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 已提交
11358
def scale(x, scale=1.0, bias=0.0, bias_after_scale=True, act=None, name=None):
S
sneaxiy 已提交
11359
    """
11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372
    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 已提交
11373 11374

    Args:
S
Steffy-zxf 已提交
11375 11376
        x(Tensor): Input N-D Tensor of scale operator. Data type can be float32, float64, int8, int16, int32, int64, uint8.
        scale(float|Tensor): The scale factor of the input, it should be a float number or a Tensor with shape [1] and data type as float32.
11377 11378 11379
        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.
11380
        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 已提交
11381 11382

    Returns:
S
Steffy-zxf 已提交
11383
        Tensor: Output tensor of scale operator, with shape and data type same as input.
11384 11385 11386

    Examples:
        .. code-block:: python
S
Steffy-zxf 已提交
11387 11388 11389
            
            # scale as a float32 number
            import paddle
11390

S
Steffy-zxf 已提交
11391 11392
            data = paddle.randn(shape=[2,3], dtype='float32')
            res = paddle.scale(data, scale=2.0, bias=1.0)
11393 11394 11395

        .. code-block:: python

S
Steffy-zxf 已提交
11396 11397
            # scale with parameter scale as a Tensor
            import paddle
11398

S
Steffy-zxf 已提交
11399 11400 11401
            data = paddle.randn(shape=[2, 3], dtype='float32')
            factor = paddle.to_tensor([2], dtype='float32')
            res = paddle.scale(data, scale=factor, bias=1.0)
11402

S
sneaxiy 已提交
11403
    """
11404 11405 11406 11407 11408 11409 11410 11411

    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)

11412 11413 11414 11415
    check_variable_and_dtype(x, "x", [
        'float16', 'float32', 'float64', 'int8', 'int16', 'int32', 'int64',
        'uint8'
    ], "scale")
11416
    inputs = {'X': [x]}
11417 11418 11419 11420 11421
    attrs = {
        'bias': float(bias),
        'bias_after_scale': bias_after_scale,
    }
    if isinstance(scale, Variable):
11422
        inputs['ScaleTensor'] = [scale]
11423 11424
    else:
        attrs['scale'] = float(scale)
11425
    helper = LayerHelper('scale', **locals())
11426
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
11427

S
sneaxiy 已提交
11428
    helper.append_op(
11429
        type='scale', inputs=inputs, outputs={'Out': out}, attrs=attrs)
S
sneaxiy 已提交
11430
    return helper.append_activation(out)
S
sneaxiy 已提交
11431 11432


X
Xin Pan 已提交
11433
def elementwise_add(x, y, axis=-1, act=None, name=None):
11434
    """
11435

11436 11437 11438 11439 11440 11441 11442 11443 11444
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11445 11446
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11447 11448
            }

11449 11450
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11451
        z = fluid.layers.elementwise_add(x, y)
11452
        # z = x + y
11453 11454 11455 11456 11457 11458

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

11459
        print(z_value) # [3., 8., 6.]
11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472


    .. 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')
            }

11473 11474
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11475
        z = fluid.layers.elementwise_add(x, y, axis=1)
11476
        # z = x + y
11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496

        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')
            }
11497

11498 11499
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[5], dtype='float32')
11500
        z = fluid.layers.elementwise_add(x, y, axis=3)
11501
        # z = x + y
11502 11503 11504 11505 11506 11507 11508 11509 11510

        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]

    """
11511 11512
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
11513 11514 11515 11516 11517 11518
            x,
            y,
            axis=axis,
            act=act,
            op_name='elementwise_add',
            use_mkldnn=core.globals()["FLAGS_use_mkldnn"])
11519

S
sneaxiy 已提交
11520 11521 11522
    return _elementwise_op(LayerHelper('elementwise_add', **locals()))


11523
@deprecated(since="2.0.0", update_to="paddle.divide")
X
Xin Pan 已提交
11524
def elementwise_div(x, y, axis=-1, act=None, name=None):
11525
    """
11526

11527 11528 11529 11530 11531 11532 11533 11534 11535
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11536 11537
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11538 11539
            }

11540 11541
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11542
        z = fluid.layers.elementwise_div(x, y)
11543
        # z = x / y
11544 11545 11546 11547 11548 11549

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

11550
        print(z_value) # [2., 0.6, 2.]
11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563


    .. 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')
            }

11564 11565
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11566
        z = fluid.layers.elementwise_div(x, y, axis=1)
11567
        # z = x / y
11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587

        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')
            }
11588

11589 11590
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[5], dtype='float32')
11591
        z = fluid.layers.elementwise_div(x, y, axis=3)
11592
        # z = x / y
11593 11594 11595

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
11596

11597 11598 11599 11600 11601
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])
        print(z_value) # z.shape=[2,3,4,5]

    """
11602 11603 11604 11605
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_div')

S
sneaxiy 已提交
11606 11607 11608
    return _elementwise_op(LayerHelper('elementwise_div', **locals()))


X
Xin Pan 已提交
11609
def elementwise_sub(x, y, axis=-1, act=None, name=None):
11610
    """
11611

11612 11613 11614 11615 11616 11617 11618 11619 11620
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11621 11622
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11623 11624
            }

11625 11626
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11627
        z = fluid.layers.elementwise_sub(x, y)
11628
        # z = x - y
11629 11630 11631 11632 11633 11634

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

11635
        print(z_value) # [1., -2., 2.]
11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648


    .. 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')
            }

11649 11650
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11651
        z = fluid.layers.elementwise_sub(x, y, axis=1)
11652
        # z = x - y
11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672

        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')
            }
11673

11674 11675
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[5], dtype='float32')
11676
        z = fluid.layers.elementwise_sub(x, y, axis=3)
11677
        # z = x - y
11678 11679 11680

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
11681

11682 11683 11684 11685 11686
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])
        print(z_value) # z.shape=[2,3,4,5]

    """
11687 11688 11689 11690
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_sub')

S
sneaxiy 已提交
11691 11692 11693
    return _elementwise_op(LayerHelper('elementwise_sub', **locals()))


11694
@deprecated(since="2.0.0", update_to="paddle.multiply")
X
Xin Pan 已提交
11695
def elementwise_mul(x, y, axis=-1, act=None, name=None):
11696
    """
11697

11698 11699 11700 11701 11702 11703 11704 11705 11706
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11707 11708
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11709 11710
            }

11711 11712
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11713
        z = fluid.layers.elementwise_mul(x, y)
11714
        # z = x * y
11715 11716 11717 11718 11719 11720

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])

11721
        print(z_value) # [2., 15., 8.]
11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734


    .. 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')
            }

11735 11736
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11737
        z = fluid.layers.elementwise_mul(x, y, axis=1)
11738
        # z = x * y
11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758

        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')
            }
11759

11760 11761
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[5], dtype='float32')
11762
        z = fluid.layers.elementwise_mul(x, y, axis=3)
11763
        # z = x * y
11764 11765 11766

        place = fluid.CPUPlace()
        exe = fluid.Executor(place)
11767

11768 11769 11770
        z_value = exe.run(feed=gen_data(),
                            fetch_list=[z.name])
        print(z_value) # z.shape=[2,3,4,5]
11771

11772
    """
11773 11774 11775 11776
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_mul')

S
sneaxiy 已提交
11777 11778 11779
    return _elementwise_op(LayerHelper('elementwise_mul', **locals()))


X
Xin Pan 已提交
11780
def elementwise_max(x, y, axis=-1, act=None, name=None):
11781
    """
11782 11783 11784 11785
    :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

11786 11787 11788 11789 11790 11791 11792 11793 11794
Examples:

    .. code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11795 11796
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11797 11798
            }

11799 11800
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821
        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')
            }

11822 11823
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834
        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.]]]]

    """
11835 11836 11837 11838
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_max')

S
sneaxiy 已提交
11839 11840 11841
    return _elementwise_op(LayerHelper('elementwise_max', **locals()))


X
Xin Pan 已提交
11842
def elementwise_min(x, y, axis=-1, act=None, name=None):
11843
    """
11844 11845 11846 11847
    :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

11848 11849 11850 11851 11852 11853 11854 11855 11856
Examples:

    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11857 11858
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11859 11860
            }

11861 11862
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11863
        z = fluid.layers.elementwise_min(x, y)
11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882

        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')
            }

11883 11884
        x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
        y = fluid.data(name="y", shape=[3,4], dtype='float32')
11885
        z = fluid.layers.elementwise_min(x, y, axis=1)
11886 11887 11888 11889 11890 11891 11892 11893 11894

        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.]]]]
    """
11895 11896 11897
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_min')
11898

S
sneaxiy 已提交
11899 11900 11901
    return _elementwise_op(LayerHelper('elementwise_min', **locals()))


X
Xin Pan 已提交
11902
def elementwise_pow(x, y, axis=-1, act=None, name=None):
11903
    """
11904

11905 11906 11907 11908 11909 11910 11911 11912 11913
Examples:

    ..  code-block:: python

        import paddle.fluid as fluid
        import numpy as np

        def gen_data():
            return {
11914 11915
                "x": np.array([2, 3, 4]).astype('float32'),
                "y": np.array([1, 5, 2]).astype('float32')
11916 11917
            }

11918 11919
        x = fluid.data(name="x", shape=[3], dtype='float32')
        y = fluid.data(name="y", shape=[3], dtype='float32')
11920 11921 11922 11923 11924 11925 11926 11927 11928
        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]
    """
11929 11930 11931
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_pow')
S
sneaxiy 已提交
11932 11933 11934
    return _elementwise_op(LayerHelper('elementwise_pow', **locals()))


11935
@deprecated(since="2.0.0", update_to="paddle.remainder")
11936
def elementwise_mod(x, y, axis=-1, act=None, name=None):
11937
    """
11938

11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962
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]
    """
11963 11964 11965 11966
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_mod')

11967 11968 11969
    return _elementwise_op(LayerHelper('elementwise_mod', **locals()))


11970
@deprecated(since="2.0.0", update_to="paddle.floor_divide")
11971
def elementwise_floordiv(x, y, axis=-1, act=None, name=None):
11972
    """
11973

11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997
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]
    """
11998 11999 12000 12001
    if in_dygraph_mode():
        return _elementwise_op_in_dygraph(
            x, y, axis=axis, act=act, op_name='elementwise_floordiv')

12002 12003 12004
    return _elementwise_op(LayerHelper('elementwise_floordiv', **locals()))


S
sneaxiy 已提交
12005
for func in [
12006 12007 12008 12009
        elementwise_add,
        elementwise_div,
        elementwise_sub,
        elementwise_mul,
12010 12011
        elementwise_max,
        elementwise_pow,
12012
        elementwise_min,
12013 12014
        elementwise_mod,
        elementwise_floordiv,
12015 12016
]:
    op_proto = OpProtoHolder.instance().get_op_proto(func.__name__)
12017 12018

    # insert the c++ doc string on top of python doc string
12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030
    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` "
        ],
12031 12032
        skip_attrs_set={
            "x_data_format", "y_data_format", "axis", "use_quantizer",
12033
            "mkldnn_data_type", "Scale_x", "Scale_y", "Scale_out"
12034
        }) + """\n""" + str(func.__doc__)
12035

12036 12037 12038 12039 12040 12041 12042 12043 12044 12045
    doc_list = func.__doc__.splitlines()

    for idx, val in enumerate(doc_list):
        if val.startswith("Warning: ") and val.endswith(
                " instead."
        ) and "and will be removed in future versions." in val:
            doc_list.insert(0, doc_list.pop(idx))
            func.__doc__ = "\n" + "\n".join(i for i in doc_list)
            break

12046
for func in []:
S
sneaxiy 已提交
12047 12048 12049 12050
    op_proto = OpProtoHolder.instance().get_op_proto(func.__name__)
    func.__doc__ = _generate_doc_string_(
        op_proto,
        additional_args_lines=[
S
sneaxiy 已提交
12051 12052
            "act (basestring|None): Activation applied to the output.",
            "name (basestring|None): Name of the output."
S
sneaxiy 已提交
12053
        ])
12054 12055 12056 12057
    func.__doc__ = func.__doc__ + """

Examples:
  .. code-block:: python
12058

12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090
    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 已提交
12091 12092


12093
def _logical_op(op_name, x, y, out=None, name=None, binary_op=True):
12094 12095 12096 12097 12098 12099 12100
    if in_dygraph_mode():
        op = getattr(core.ops, op_name)
        if binary_op:
            return op(x, y)
        else:
            return op(x)

12101 12102 12103 12104
    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:
12105
        check_type(out, "out", Variable, op_name)
12106

M
minqiyang 已提交
12107 12108
    helper = LayerHelper(op_name, **locals())

M
minqiyang 已提交
12109 12110
    if binary_op:
        assert x.dtype == y.dtype
M
minqiyang 已提交
12111 12112

    if out is None:
12113
        out = helper.create_variable_for_type_inference(dtype=x.dtype)
M
minqiyang 已提交
12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124

    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


12125
def logical_and(x, y, out=None, name=None):
12126
    r"""
12127

12128
    ``logical_and`` operator computes element-wise logical AND on ``x`` and ``y``, and returns ``out``. ``x``, ``y`` and ``out`` are N-dim boolean ``Tensor``.
S
Shibo Tao 已提交
12129
    Each element of ``out`` is calculated by
12130

W
Wilber 已提交
12131 12132
    .. math::

S
Shibo Tao 已提交
12133
        out = x \&\& y
M
minqiyang 已提交
12134

12135 12136 12137
    .. note::
        ``paddle.logical_and`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting`.

M
minqiyang 已提交
12138
    Args:
12139 12140 12141 12142
        x (Tensor): the input tensor, it's data type should be bool.
        y (Tensor): the input tensor, it's data type should be bool.
        out(Tensor): The ``Tensor`` that specifies the output of the operator, which can be any ``Tensor`` that has been created in the program. The default value is None, and a new ``Tensor`` will be created to save the output.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
M
minqiyang 已提交
12143 12144

    Returns:
12145
        N-D Tensor. A location into which the result is stored. It's dimension equals with ``x``.
12146 12147 12148 12149

    Examples:
        .. code-block:: python

S
Shibo Tao 已提交
12150
            import paddle
W
Wilber 已提交
12151

12152 12153
            x = paddle.to_tensor([True])
            y = paddle.to_tensor([True, False, True, False])
S
Shibo Tao 已提交
12154
            res = paddle.logical_and(x, y)
N
Noel 已提交
12155
            print(res) # [True False True False]
M
minqiyang 已提交
12156 12157 12158 12159 12160
    """
    return _logical_op(
        op_name="logical_and", x=x, y=y, name=name, out=out, binary_op=True)


12161
def logical_or(x, y, out=None, name=None):
M
minqiyang 已提交
12162
    """
W
Wilber 已提交
12163

12164
    ``logical_or`` operator computes element-wise logical OR on ``x`` and ``y``, and returns ``out``. ``x``, ``y`` and ``out`` are N-dim boolean ``Tensor``.
S
Shibo Tao 已提交
12165
    Each element of ``out`` is calculated by
12166

W
Wilber 已提交
12167 12168
    .. math::

S
Shibo Tao 已提交
12169
        out = x || y
M
minqiyang 已提交
12170

12171 12172 12173
    .. note::
        ``paddle.logical_or`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting`.
    
M
minqiyang 已提交
12174
    Args:
12175 12176 12177 12178
        x (Tensor): the input tensor, it's data type should be bool.
        y (Tensor): the input tensor, it's data type should be bool.
        out(Tensor): The ``Variable`` that specifies the output of the operator, which can be any ``Tensor`` that has been created in the program. The default value is None, and a new ``Tensor`` will be created to save the output.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
M
minqiyang 已提交
12179 12180

    Returns:
12181
        N-D Tensor. A location into which the result is stored. It's dimension equals with ``x``.
12182 12183 12184 12185

    Examples:
        .. code-block:: python

S
Shibo Tao 已提交
12186
            import paddle
W
Wilber 已提交
12187 12188
            import numpy as np

12189 12190 12191 12192
            x_data = np.array([True, False], dtype=np.bool).reshape(2, 1)
            y_data = np.array([True, False, True, False], dtype=np.bool).reshape(2, 2)
            x = paddle.to_tensor(x_data)
            y = paddle.to_tensor(y_data)
S
Shibo Tao 已提交
12193
            res = paddle.logical_or(x, y)
N
Noel 已提交
12194
            print(res) # [[ True  True] [ True False]]
M
minqiyang 已提交
12195 12196 12197 12198 12199
    """
    return _logical_op(
        op_name="logical_or", x=x, y=y, name=name, out=out, binary_op=True)


12200
def logical_xor(x, y, out=None, name=None):
12201
    r"""
W
Wilber 已提交
12202

12203
    ``logical_xor`` operator computes element-wise logical XOR on ``x`` and ``y``, and returns ``out``. ``x``, ``y`` and ``out`` are N-dim boolean ``Tensor``.
S
Shibo Tao 已提交
12204
    Each element of ``out`` is calculated by
12205

W
Wilber 已提交
12206 12207
    .. math::

S
Shibo Tao 已提交
12208
        out = (x || y) \&\& !(x \&\& y)
M
minqiyang 已提交
12209

12210 12211 12212
    .. note::
        ``paddle.logical_xor`` supports broadcasting. If you want know more about broadcasting, please refer to :ref:`user_guide_broadcasting`.

M
minqiyang 已提交
12213
    Args:
12214 12215 12216 12217
        x (Tensor): the input tensor, it's data type should be bool.
        y (Tensor): the input tensor, it's data type should be bool.
        out(Tensor): The ``Tensor`` that specifies the output of the operator, which can be any ``Tensor`` that has been created in the program. The default value is None, and a new ``Tensor`` will be created to save the output.
        name (str, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`.
M
minqiyang 已提交
12218 12219

    Returns:
12220
        N-D Tensor. A location into which the result is stored. It's dimension equals with ``x``.
12221 12222 12223 12224

    Examples:
        .. code-block:: python

S
Shibo Tao 已提交
12225
            import paddle
W
Wilber 已提交
12226 12227
            import numpy as np

12228 12229 12230 12231
            x_data = np.array([True, False], dtype=np.bool).reshape([2, 1])
            y_data = np.array([True, False, True, False], dtype=np.bool).reshape([2, 2])
            x = paddle.to_tensor(x_data)
            y = paddle.to_tensor(y_data)
S
Shibo Tao 已提交
12232
            res = paddle.logical_xor(x, y)
N
Noel 已提交
12233
            print(res) # [[False,  True], [ True, False]]
M
minqiyang 已提交
12234 12235 12236 12237 12238 12239
    """
    return _logical_op(
        op_name="logical_xor", x=x, y=y, name=name, out=out, binary_op=True)


@templatedoc()
12240
def logical_not(x, out=None, name=None):
M
minqiyang 已提交
12241
    """
12242

S
Shibo Tao 已提交
12243 12244
    ``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
12245

W
Wilber 已提交
12246 12247
    .. math::

S
Shibo Tao 已提交
12248
        out = !x
M
minqiyang 已提交
12249 12250

    Args:
N
Noel 已提交
12251 12252
        x(Tensor):  Operand of logical_not operator. Must be a Tensor of type bool.
        out(Tensor): The ``Tensor`` that specifies the output of the operator, which can be any ``Tensor`` that has been created in the program. The default value is None, and a new ``Tensor` will be created to save the output.
S
Shibo Tao 已提交
12253
        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 已提交
12254 12255

    Returns:
N
Noel 已提交
12256
        Tensor: ${out_comment}
12257 12258 12259

    Examples:
        .. code-block:: python
N
Noel 已提交
12260

S
Shibo Tao 已提交
12261
            import paddle
W
Wilber 已提交
12262

12263
            x = paddle.to_tensor([True, False, True, False])
S
Shibo Tao 已提交
12264
            res = paddle.logical_not(x)
N
Noel 已提交
12265
            print(res) # [False  True False  True]
M
minqiyang 已提交
12266 12267 12268 12269
    """

    return _logical_op(
        op_name="logical_not", x=x, y=None, name=name, out=out, binary_op=False)
12270 12271 12272 12273 12274


@templatedoc()
def clip(x, min, max, name=None):
    """
12275 12276
	:old_api: paddle.fluid.layers.clip

12277 12278 12279 12280
    ${comment}

    Args:
        x(${x_type}): ${x_comment}
S
SunGaofeng 已提交
12281 12282
        min(float): ${min_comment}
        max(float): ${max_comment}
12283 12284
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
12285
                             For more information, please refer to :ref:`api_guide_Name`
12286 12287

    Returns:
S
SunGaofeng 已提交
12288 12289 12290 12291
        ${out_comment}

    Return Type:
        ${out_type}
12292 12293 12294 12295

    Examples:
        .. code-block:: python

S
SunGaofeng 已提交
12296
            import paddle.fluid as fluid
S
SunGaofeng 已提交
12297
            input = fluid.data(
12298 12299
                name='data', shape=[1], dtype='float32')
            reward = fluid.layers.clip(x=input, min=-1.0, max=1.0)
12300 12301 12302
    """

    helper = LayerHelper("clip", **locals())
12303
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'clip')
12304 12305

    if name is None:
12306 12307
        name = unique_name.generate_with_ignorable_key(".".join(
            [helper.name, 'tmp']))
S
sneaxiy 已提交
12308 12309 12310

    out = helper.create_variable(
        type=x.type, name=name, dtype=x.dtype, persistable=False)
12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329

    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}
12330 12331 12332
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name`. Usually name is no need to set and
            None by default.
12333 12334

    Returns:
12335
        Tensor:
W
wangguanzhong 已提交
12336

12337
        out(${out_type}): ${out_comment}
12338

W
wangguanzhong 已提交
12339

12340 12341 12342
    Examples:
        .. code-block:: python

12343 12344 12345 12346 12347
            import paddle
            import numpy as np

            input = paddle.to_tensor(data=np.array([[0.1, 0.2], [0.3, 0.4]]), dtype="float32")
            reward = paddle.nn.clip_by_norm(x=input, max_norm=1.0)
12348 12349
    """

12350 12351 12352
    if in_dygraph_mode():
        return core.ops.clip_by_norm(x, 'max_norm', max_norm)

12353
    helper = LayerHelper("clip_by_norm", **locals())
12354 12355
    check_variable_and_dtype(x, 'X', ['float32'], 'clip_by_norm')
    check_type(max_norm, 'max_norm', (float), 'clip_by_norm')
12356 12357

    if name is None:
12358 12359
        name = unique_name.generate_with_ignorable_key(".".join(
            [helper.name, 'tmp']))
S
sneaxiy 已提交
12360 12361 12362

    out = helper.create_variable(
        type=x.type, name=name, dtype=x.dtype, persistable=False)
12363 12364 12365 12366 12367 12368 12369 12370

    helper.append_op(
        type="clip_by_norm",
        inputs={"X": x},
        attrs={"max_norm": max_norm},
        outputs={"Out": out})

    return out
X
Xin Pan 已提交
12371 12372


12373
@deprecated(since="2.0.0", update_to="paddle.mean")
X
Xin Pan 已提交
12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384
@templatedoc()
def mean(x, name=None):
    """
    ${comment}

    Args:
        x(${x_type}): ${x_comment}
        name(basestring|None): Name of the output.

    Returns:
        out(${out_type}): ${out_comment}
12385 12386 12387 12388

    Examples:
        .. code-block:: python

12389
            import paddle.fluid as fluid
12390 12391 12392
            input = fluid.layers.data(
                name='data', shape=[2, 3], dtype='float32')
            mean = fluid.layers.mean(input)
X
Xin Pan 已提交
12393
    """
12394

12395
    if in_dygraph_mode():
12396
        return core.ops.mean(x)
X
Xin Pan 已提交
12397 12398

    helper = LayerHelper("mean", **locals())
12399
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'mean')
12400
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
X
Xin Pan 已提交
12401 12402 12403 12404 12405 12406 12407

    helper.append_op(
        type="mean", inputs={"X": x}, attrs={}, outputs={"Out": out})

    return out


C
chengduo 已提交
12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418
@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}
12419 12420 12421 12422

    Examples:
        .. code-block:: python

12423
            import paddle.fluid as fluid
12424 12425 12426 12427 12428
            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 已提交
12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440
    """

    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 已提交
12441 12442
def mul(x, y, x_num_col_dims=1, y_num_col_dims=1, name=None):
    """
L
liu zhengxi 已提交
12443 12444 12445 12446 12447 12448 12449 12450
    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 已提交
12451 12452

    Args:
L
liu zhengxi 已提交
12453 12454
        x (Variable): The first input Tensor/LoDTensor of mul_op.
        y (Variable): The second input Tensor/LoDTensor of mul_op.
12455 12456 12457
        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 已提交
12458 12459

    Returns:
L
liu zhengxi 已提交
12460
        Variable(Tensor/LoDTensor): The output Tensor/LoDTensor of mul op.
12461 12462

    Examples:
L
liu zhengxi 已提交
12463
        ..  code-block:: python
12464

12465
            import paddle.fluid as fluid
12466 12467
            import paddle
            paddle.enable_static()
12468 12469 12470 12471 12472
            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)
12473

12474

X
Xin Pan 已提交
12475
    """
12476
    if in_dygraph_mode():
12477 12478
        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 已提交
12479

12480 12481
    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 已提交
12482
    helper = LayerHelper("mul", **locals())
12483 12484
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'], 'mul')
    check_variable_and_dtype(y, 'y', ['float16', 'float32', 'float64'], 'mul')
12485
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
X
Xin Pan 已提交
12486 12487

    helper.append_op(
12488 12489
        type="mul", inputs={"X": x,
                            "Y": y}, attrs=attrs, outputs={"Out": out})
X
Xin Pan 已提交
12490 12491 12492
    return out


12493
@deprecated(since="2.0.0", update_to="paddle.nn.functional.maxout")
X
Xin Pan 已提交
12494
@templatedoc()
12495
def maxout(x, groups, name=None, axis=1):
X
Xin Pan 已提交
12496 12497 12498 12499 12500
    """
    ${comment}

    Args:
        x(${x_type}): ${x_comment}
12501 12502
        groups(int): ${groups_comment}
        axis(int, optional): ${axis_comment}
12503 12504
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name`. Usually name is no need to set and
W
wangguanzhong 已提交
12505
            None by default.
X
Xin Pan 已提交
12506 12507

    Returns:
12508
        Variable: ${out_comment}
J
jerrywgz 已提交
12509

12510 12511
    Raises:
        ValueError: If `axis` is not 1, -1 or 3.
12512
        ValueError: If the number of input channels can not be divisible by `groups`.
W
wangguanzhong 已提交
12513

J
jerrywgz 已提交
12514 12515 12516
    Examples:
        .. code-block:: python

12517
            import paddle.fluid as fluid
12518 12519 12520
            import paddle
            paddle.enable_static()

12521
            input = fluid.data(
12522 12523
                name='data',
                shape=[None, 256, 32, 32],
J
jerrywgz 已提交
12524 12525
                dtype='float32')
            out = fluid.layers.maxout(input, groups=2)
X
Xin Pan 已提交
12526
    """
12527
    return paddle.nn.functional.maxout(**locals())
12528 12529


J
JiabinYang 已提交
12530
def space_to_depth(x, blocksize, name=None):
12531
    r"""
12532

J
JiabinYang 已提交
12533
    Gives a blocksize to space_to_depth the input LoDtensor with Layout: [batch, channel, height, width]
12534

12535 12536 12537
    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 已提交
12538
    The attr blocksize indicates the input block size.
12539

T
tianshuo78520a 已提交
12540
    space_to_depth will reorganize the elements of input with shape[batch, channel, height, width] \
12541 12542
        according to blocksize to construct output with shape \
        [batch, channel * blocksize * blocksize, height/blocksize, width/blocksize]:
J
JiabinYang 已提交
12543

J
JiabinYang 已提交
12544 12545 12546 12547 12548
    - 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

12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565
    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 已提交
12566

J
JiabinYang 已提交
12567
    Args:
12568 12569 12570 12571 12572 12573
        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 已提交
12574

12575 12576 12577 12578
    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 已提交
12579 12580

    Raises:
12581
        TypeError: blocksize type must be int64.
J
JiabinYang 已提交
12582 12583 12584

    Examples:
        .. code-block:: python
12585

12586 12587
            import paddle.fluid as fluid
            import numpy as np
12588 12589
            import numpy as np
            import paddle
J
JiabinYang 已提交
12590

12591
            paddle.enable_static()
12592 12593
            data = fluid.data(
                name='data', shape=[1, 4, 2, 2], dtype='float32')
J
JiabinYang 已提交
12594
            space_to_depthed = fluid.layers.space_to_depth(
J
JiabinYang 已提交
12595
                x=data, blocksize=2)
12596

12597
            exe = fluid.Executor(fluid.CPUPlace())
12598
            data_np = np.arange(0,16).reshape((1,4,2,2)).astype('float32')
12599 12600 12601 12602 12603 12604 12605

            print(data_np)
            #array([[[[ 0.,  1.], [ 2.,  3.]],
            #        [[ 4.,  5.], [ 6.,  7.]],
            #        [[ 8.,  9.], [10., 11.]],
            #        [[12., 13.], [14., 15.]]]], dtype=float32)

12606
            out_main = exe.run(fluid.default_main_program(),
12607 12608 12609 12610 12611 12612 12613 12614
                        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)]
12615

J
JiabinYang 已提交
12616 12617
    """

J
JiabinYang 已提交
12618
    helper = LayerHelper("space_to_depth", **locals())
J
JiabinYang 已提交
12619

J
JiabinYang 已提交
12620 12621
    if not (isinstance(blocksize, int)):
        raise ValueError("blocksize must be a python Int")
J
JiabinYang 已提交
12622

X
xujiaqi01 已提交
12623 12624 12625
    check_variable_and_dtype(x, 'x', \
        ['float16', 'float32', 'float64', 'int32', 'int64'], 'space_to_depth')

12626
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
J
JiabinYang 已提交
12627 12628

    helper.append_op(
J
JiabinYang 已提交
12629
        type="space_to_depth",
J
JiabinYang 已提交
12630
        inputs={"X": x},
J
JiabinYang 已提交
12631
        attrs={"blocksize": blocksize},
J
JiabinYang 已提交
12632
        outputs={"Out": out})
J
JiabinYang 已提交
12633 12634
    return out

J
JiabinYang 已提交
12635

12636 12637 12638 12639 12640 12641
def affine_channel(x,
                   scale=None,
                   bias=None,
                   data_layout='NCHW',
                   name=None,
                   act=None):
12642
    """
12643

12644 12645 12646 12647
    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.
12648

12649 12650 12651
    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 已提交
12652
            is applied in the second dimension.The data type is float32 or float64.
12653 12654
        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 已提交
12655
            the input.The data type is float32 or float64.
12656 12657
        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 已提交
12658
            The data type is float32 or float64.
12659
        data_layout (str, optional): Specify the data format of the input, and the data format of the output
12660 12661
            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:
12662
            `[batch_size, input_channels, input_height, input_width]`. If input is 2D Tensor, you can ignore
12663
            data_layout.
L
LielinJiang 已提交
12664 12665
        name (str, default None): The name of this layer. For more information,
            please refer to :ref:`api_guide_Name` .
12666
        act (str, default None): Activation to be applied to the output of this layer.
12667 12668

    Returns:
L
LielinJiang 已提交
12669
        Variable: A tensor which has the same shape, data layout and data type with x.
B
Bai Yifan 已提交
12670 12671 12672

    Examples:
        .. code-block:: python
L
LielinJiang 已提交
12673 12674

            import numpy as np
B
Bai Yifan 已提交
12675
            import paddle.fluid as fluid
12676 12677
            import paddle.fluid as fluid
            import paddle
L
LielinJiang 已提交
12678

12679
            paddle.enable_static()
L
LielinJiang 已提交
12680 12681 12682 12683 12684 12685 12686 12687 12688
            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 已提交
12689
            out = fluid.layers.affine_channel(data,scale=input_scale,
L
LielinJiang 已提交
12690 12691 12692 12693 12694 12695 12696 12697 12698 12699
                                    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 已提交
12700

12701 12702
    """
    helper = LayerHelper("affine_channel", **locals())
12703 12704 12705
    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')
12706
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
12707 12708 12709 12710 12711 12712 12713 12714

    helper.append_op(
        type="affine_channel",
        inputs={"X": x,
                'Scale': scale,
                'Bias': bias},
        attrs={"data_layout": data_layout},
        outputs={"Out": out})
12715
    return helper.append_activation(out)
12716 12717


B
barrierye 已提交
12718
def similarity_focus(input, axis, indexes, name=None):
12719
    r"""
B
barrierye 已提交
12720
    SimilarityFocus Operator
B
barrierye 已提交
12721 12722

    Generate a similarity focus mask with the same shape of input using the following method:
M
minqiyang 已提交
12723

12724 12725 12726
    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 已提交
12727
       is (BatchSize, A, B, C), the shape of tensor T is (BatchSize, B, C).
12728 12729 12730 12731 12732 12733 12734
    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 已提交
12735
       each index.
B
barrierye 已提交
12736 12737 12738 12739
    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 已提交
12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788
    .. 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 已提交
12789
    Args:
12790
        input(Variable): The input tensor variable(default float). It should
12791
            be a 4-D tensor with shape [BatchSize, A, B, C]. Data type is
Y
Yibing Liu 已提交
12792
            float32 or float64.
B
barrierye 已提交
12793
        axis(int): Indicating the dimension to be selected. It can only be
B
barrierye 已提交
12794
            1, 2 or 3.
B
barrierye 已提交
12795
        indexes(list): Indicating the indexes of the selected dimension.
B
barrierye 已提交
12796 12797

    Returns:
H
haowang101779990 已提交
12798 12799
        Variable: A tensor variable with the same shape and same type \
                  as the input.
12800

B
barrierye 已提交
12801 12802
    Examples:
        .. code-block:: python
H
haowang101779990 已提交
12803

12804
            import paddle.fluid as fluid
12805 12806
            import paddle
            paddle.enable_static()
Y
Yibing Liu 已提交
12807
            data = fluid.data(
Y
Yibing Liu 已提交
12808 12809
                name='data', shape=[-1, 3, 2, 2], dtype='float32')
            fluid.layers.similarity_focus(input=data, axis=1, indexes=[0])
B
barrierye 已提交
12810 12811 12812
    """
    helper = LayerHelper('similarity_focus', **locals())
    # check attrs
12813 12814 12815 12816
    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 已提交
12817 12818 12819 12820 12821
    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.")

12822
    out = helper.create_variable_for_type_inference(dtype=input.dtype)
B
barrierye 已提交
12823 12824 12825 12826 12827 12828 12829
    helper.append_op(
        type='similarity_focus',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={"axis": axis,
               "indexes": indexes})
    return out
B
barrierye 已提交
12830 12831


M
minqiyang 已提交
12832 12833
def hash(input, hash_size, num_hash=1, name=None):
    """
12834

Z
zhupengyang 已提交
12835
    This OP hash the input to an integer less than the hash_size.
M
minqiyang 已提交
12836 12837
    The hash algorithm we used was xxHash - Extremely fast hash algorithm
    (https://github.com/Cyan4973/xxHash/tree/v0.6.5)
M
minqiyang 已提交
12838 12839

    Args:
Z
zhupengyang 已提交
12840 12841 12842 12843 12844 12845
        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 已提交
12846 12847

    Returns:
Z
zhupengyang 已提交
12848
       Variable: A LoDTensor with the same data type as input.
M
minqiyang 已提交
12849 12850

    Examples:
Z
zhupengyang 已提交
12851
        .. code-block:: python
H
haowang101779990 已提交
12852

12853
            import paddle.fluid as fluid
Z
zhupengyang 已提交
12854
            import numpy as np
12855 12856
            import paddle
            paddle.enable_static()
12857

Z
zhupengyang 已提交
12858
            place = fluid.core.CPUPlace()
12859

12860 12861
            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)
12862

Z
zhupengyang 已提交
12863 12864 12865 12866
            exe = fluid.Executor(place)
            exe.run(fluid.default_startup_program())
            in1 = np.array([[1,2],[3,4]]).astype("int32")
            print(in1)
12867
            x_i = fluid.create_lod_tensor(in1, [[0, 2]], place)
Z
zhupengyang 已提交
12868 12869 12870 12871 12872 12873 12874 12875 12876 12877
            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 已提交
12878
    """
12879
    check_variable_and_dtype(input, 'input', ['int32', 'int64'], 'hash')
12880 12881
    check_type(hash_size, 'hash_size', int, 'hash')
    check_type(num_hash, 'num_hash', int, 'hash')
M
minqiyang 已提交
12882
    helper = LayerHelper('hash', **locals())
M
minqiyang 已提交
12883 12884
    out = helper.create_variable_for_type_inference(
        helper.input_dtype(), stop_gradient=True)
M
minqiyang 已提交
12885 12886 12887 12888 12889 12890 12891
    helper.append_op(
        type='hash',
        inputs={'X': input},
        outputs={'Out': out},
        attrs={'num_hash': num_hash,
               'mod_by': hash_size})
    return out
G
gmcather 已提交
12892 12893


D
dengkaipeng 已提交
12894
@templatedoc()
12895 12896
def grid_sampler(x, grid, name=None):
    """
12897

12898
    This operation samples input X by using bilinear interpolation based on
T
tianshuo78520a 已提交
12899
    flow field grid, which is usually generated by :code:`affine_grid` . The grid of
K
Kaipeng Deng 已提交
12900 12901
    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 已提交
12902 12903
    (in width dimension) of input data x and y is indexing the 3rd
    dimension (in height dimension), finally results is the bilinear
12904
    interpolation value of 4 nearest corner points. The output tensor
K
Kaipeng Deng 已提交
12905
    shape will be [N, C, H, W].
12906

H
haowang101779990 已提交
12907
    .. code-block:: text
12908

H
haowang101779990 已提交
12909 12910
        Step 1:
        Get (x, y) grid coordinates and scale to [0, H-1/W-1].
12911

K
Kaipeng Deng 已提交
12912 12913 12914 12915
        .. code-block:: text

            grid_x = 0.5 * (grid[:, :, :, 0] + 1) * (W - 1)
            grid_y = 0.5 * (grid[:, :, :, 1] + 1) * (H - 1)
12916

H
haowang101779990 已提交
12917 12918 12919
        Step 2:
        Indices input data X with grid (x, y) in each [H, W] area, and bilinear
        interpolate point value by 4 nearest points.
12920

H
haowang101779990 已提交
12921 12922 12923 12924 12925 12926 12927 12928 12929
          wn ------- y_n ------- en
          |           |           |
          |          d_n          |
          |           |           |
         x_w --d_w-- grid--d_e-- x_e
          |           |           |
          |          d_s          |
          |           |           |
          ws ------- y_s ------- wn
12930

H
haowang101779990 已提交
12931 12932 12933 12934
        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
12935

H
haowang101779990 已提交
12936 12937 12938 12939
        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
12940

H
haowang101779990 已提交
12941 12942 12943 12944
        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
12945

H
haowang101779990 已提交
12946 12947
        output = wn * d_e * d_s + en * d_w * d_s
               + ws * d_e * d_n + es * d_w * d_n
D
dengkaipeng 已提交
12948 12949

    Args:
K
Kaipeng Deng 已提交
12950 12951 12952 12953 12954 12955 12956 12957 12958
        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 已提交
12959 12960

    Returns:
H
haowang101779990 已提交
12961
        Variable: Output of shape [N, C, H, W] data samples input X
K
Kaipeng Deng 已提交
12962 12963
                  using bilnear interpolation based on input grid.
                  The data type is same as input tensor.
12964

H
haowang101779990 已提交
12965 12966 12967 12968
    Examples:

        .. code-block:: python

K
Kaipeng Deng 已提交
12969
            import paddle.fluid as fluid
12970 12971
            import paddle.fluid as fluid
            import paddle
K
Kaipeng Deng 已提交
12972

12973
            paddle.enable_static()
K
Kaipeng Deng 已提交
12974 12975
            # use with affine_grid
            x = fluid.data(name='x', shape=[None, 10, 32, 32], dtype='float32')
K
Kaipeng Deng 已提交
12976 12977
            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 已提交
12978
            out = fluid.layers.grid_sampler(x=x, grid=grid)
12979

D
dengkaipeng 已提交
12980 12981 12982
    """
    helper = LayerHelper("grid_sampler", **locals())

12983 12984 12985
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'grid_sampler')
    check_variable_and_dtype(grid, 'grid', ['float32', 'float64'],
                             'grid_sampler')
D
dengkaipeng 已提交
12986 12987 12988 12989 12990 12991
    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")

12992
    out = helper.create_variable_for_type_inference(x.dtype)
D
dengkaipeng 已提交
12993 12994
    ipts = {'X': x, 'Grid': grid}

12995
    helper.append_op(type='grid_sampler', inputs=ipts, outputs={'Output': out})
12996 12997 12998
    return out


G
gmcather 已提交
12999
def log_loss(input, label, epsilon=1e-4, name=None):
13000
    r"""
13001

G
gmcather 已提交
13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012
    **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:
13013
        input (Tensor|list):  A 2-D tensor with shape [N x 1], where N is the
G
gmcather 已提交
13014
                                batch size. This input is a probability computed
Y
Yibing Liu 已提交
13015
                                by the previous operator. Data type float32.
13016
        label (Tensor|list):  The ground truth which is a 2-D tensor with
13017
                                shape [N x 1], where N is the batch size.
Y
Yibing Liu 已提交
13018 13019
                                Data type float32.
        epsilon (float, optional): A small number for numerical stability. Default 1e-4.
13020
        name(str|None): For detailed information, please refer to
Y
Yibing Liu 已提交
13021
            :ref:`api_guide_Name` . Usually name is no need to set and None by default.
G
gmcather 已提交
13022 13023

    Returns:
13024
        Tensor, which shape is [N x 1], data type is float32.
G
gmcather 已提交
13025 13026 13027 13028

    Examples:
        .. code-block:: python

13029 13030 13031 13032 13033 13034
          import paddle
          import paddle.nn.functional as F

          label = paddle.randn((10,1))
          prob = paddle.randn((10,1))
          cost = F.log_loss(input=prob, label=label)
G
gmcather 已提交
13035 13036
    """
    helper = LayerHelper('log_loss', **locals())
13037 13038
    check_variable_and_dtype(input, 'input', ['float32'], 'log_loss')
    check_variable_and_dtype(label, 'label', ['float32'], 'log_loss')
G
gmcather 已提交
13039

13040
    loss = helper.create_variable_for_type_inference(dtype=input.dtype)
G
gmcather 已提交
13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051

    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):
13052
    r"""
13053

G
Guo Sheng 已提交
13054 13055
    This operator performs weighted sum of input feature at each position
    (position in the sequence) and the corresponding position encoding.
G
gmcather 已提交
13056

13057
    For more details of position encoding, please refer to `Attention Is All You
G
Guo Sheng 已提交
13058
    Need <http://arxiv.org/pdf/1706.03762.pdf>`_ .
G
gmcather 已提交
13059

G
Guo Sheng 已提交
13060
    The formula is as follows:
G
gmcather 已提交
13061 13062

    .. math::
H
haowang101779990 已提交
13063 13064 13065
        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 已提交
13066 13067

    Where:
G
Guo Sheng 已提交
13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081
      - :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.
13082 13083
        name(str, optional): For detailed information, please refer
            to :ref:`api_guide_Name`. Usually name is no need to set and
G
Guo Sheng 已提交
13084
            None by default.
G
gmcather 已提交
13085 13086

    Returns:
G
Guo Sheng 已提交
13087
        Variable: A Tensor or LoDTensor. It has the same shape, data type and lod as `input`.
G
gmcather 已提交
13088 13089 13090 13091

    Examples:
        .. code-block:: python

13092
          import paddle
13093

13094
          tensor = paddle.randn([16, 32, 64])
13095
          position_tensor = paddle.fluid.layers.add_position_encoding(
13096
                input=tensor, alpha=1.0, beta=1.0)
H
haowang101779990 已提交
13097

G
gmcather 已提交
13098
    """
13099 13100 13101 13102
    if in_dygraph_mode():
        return core.ops.add_position_encoding(input, "alpha", alpha, "beta",
                                              beta)

G
gmcather 已提交
13103
    helper = LayerHelper('add_position_encoding', **locals())
13104 13105
    check_variable_and_dtype(input, 'input', ['float32', 'float64'],
                             "add_position_encoding")
G
gmcather 已提交
13106 13107
    dtype = helper.input_dtype()

13108
    out = helper.create_variable_for_type_inference(dtype=dtype)
G
gmcather 已提交
13109 13110 13111 13112 13113 13114 13115 13116

    helper.append_op(
        type="add_position_encoding",
        inputs={"X": input},
        outputs={"Out": out},
        attrs={"alpha": alpha,
               "beta": beta})
    return out
Q
Qiao Longfei 已提交
13117 13118 13119 13120 13121 13122 13123 13124 13125


def bilinear_tensor_product(x,
                            y,
                            size,
                            act=None,
                            name=None,
                            param_attr=None,
                            bias_attr=None):
13126
    r"""
13127 13128
    :api_attr: Static Graph

Y
Yibing Liu 已提交
13129
    **Bilinear Tensor Product Layer**
Q
Qiao Longfei 已提交
13130

Q
Qiao Longfei 已提交
13131
    This layer performs bilinear tensor product on two inputs.
Q
Qiao Longfei 已提交
13132 13133 13134
    For example:

    .. math::
H
haowang101779990 已提交
13135
       out_{i} = x * W_{i} * {y^\mathrm{T}}, i=0,1,...,size-1
Q
Qiao Longfei 已提交
13136

Q
Qiao Longfei 已提交
13137
    In this formula:
13138 13139
      - :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 已提交
13140
      - :math:`W_{i}`: the i-th learned weight, shape is [M, N].
H
haowang101779990 已提交
13141
      - :math:`out_{i}`: the i-th element of out, shape is [batch_size, size].
Q
Qiao Longfei 已提交
13142 13143 13144
      - :math:`y^\mathrm{T}`: the transpose of :math:`y_{2}`.

    Args:
13145
        x (Variable): 2-D input tensor with shape [batch_size, M]. Data type
Y
Yibing Liu 已提交
13146
            is float32 or float64.
13147
        y (Variable): 2-D input tensor with shape [batch_size, N]. Data type
Y
Yibing Liu 已提交
13148
            should be same as **x**.
Q
Qiao Longfei 已提交
13149
        size (int): The dimension of this layer.
Y
Yibing Liu 已提交
13150
        act (str|None): Activation to be applied to the output of this layer. Default None.
13151
        name(str|None): For detailed information, please refer to
Y
Yibing Liu 已提交
13152
            :ref:`api_guide_Name` . Usually name is no need to set and None by default.
13153 13154
        param_attr (ParamAttr|None): To specify the weight parameter attribute.
            Default: None, which means the default weight parameter property is
Y
Yibing Liu 已提交
13155
            used. See usage for details in :ref:`api_fluid_ParamAttr` .
13156 13157
        bias_attr (ParamAttr|None): To specify the bias parameter attribute.
            Default: None, which means the default bias parameter property is
Y
Yibing Liu 已提交
13158
            used. See usage for details in :ref:`api_fluid_ParamAttr` .
Q
Qiao Longfei 已提交
13159
    Returns:
Y
Yibing Liu 已提交
13160
        Variable: A 2-D Tensor of shape [batch_size, size]. Data type is the same as input **x**.
Q
Qiao Longfei 已提交
13161 13162 13163 13164

    Examples:
        .. code-block:: python

13165 13166 13167 13168 13169
            import paddle
            paddle.enable_static()
            layer1 = paddle.static.data("t1", shape=[-1, 5], dtype="float32")
            layer2 = paddle.static.data("t2", shape=[-1, 4], dtype="float32")
            tensor = paddle.static.nn.bilinear_tensor_product(x=layer1, y=layer2, size=1000)
Q
Qiao Longfei 已提交
13170 13171
    """
    helper = LayerHelper('bilinear_tensor_product', **locals())
Q
Qiao Longfei 已提交
13172
    dtype = helper.input_dtype('x')
Q
Qiao Longfei 已提交
13173 13174 13175 13176

    param_shape = [size, x.shape[1], y.shape[1]]

    w = helper.create_parameter(
Q
Qiao Longfei 已提交
13177
        attr=helper.param_attr, shape=param_shape, dtype=dtype, is_bias=False)
13178
    out = helper.create_variable_for_type_inference(dtype=dtype)
Q
Qiao Longfei 已提交
13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190

    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 已提交
13191 13192 13193 13194 13195


@templatedoc()
def get_tensor_from_selected_rows(x, name=None):
    """
13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211
    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 已提交
13212 13213

    Args:
13214 13215 13216
        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 已提交
13217 13218

    Returns:
13219
        Variable: LoDTensor transformed from SelectedRows. The data type is same with input.
B
bdzhuxiaoning 已提交
13220 13221 13222

    Examples:
        .. code-block:: python
13223

B
bdzhuxiaoning 已提交
13224 13225 13226 13227
            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 已提交
13228 13229
    """

13230 13231 13232 13233 13234
    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 已提交
13235 13236 13237 13238 13239 13240 13241 13242
    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
13243 13244


S
shippingwang 已提交
13245
def shuffle_channel(x, group, name=None):
S
shippingwang 已提交
13246
    """
S
shippingwang 已提交
13247 13248 13249 13250 13251 13252
    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
13253

S
shippingwang 已提交
13254
    .. code-block:: text
13255

S
shippingwang 已提交
13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273
        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]],
13274

S
shippingwang 已提交
13275 13276
                         [[0.5, 0.6],
                          [0.6, 0.7]],
13277

S
shippingwang 已提交
13278 13279
                         [[0.3, 0.4],
                          [0.4, 0.5]],
13280

S
shippingwang 已提交
13281 13282
                         [[0.7, 0.8],
                          [0.8, 0.9]]]]
13283 13284

    Args:
S
shippingwang 已提交
13285
        x(Variable): The input tensor variable. It should be a 4-D tensor with shape [N, C, H, W]
T
tianshuo78520a 已提交
13286
        group(int): Indicating the counts of subgroups, It should divide the number of channels.
S
shippingwang 已提交
13287 13288

    Returns:
13289
        out(Variable): the channels shuffling result is a tensor variable with the
S
shippingwang 已提交
13290
        same shape and same type as the input.
S
shippingwang 已提交
13291 13292

    Raises:
S
shippingwang 已提交
13293
        ValueError: If group is not an int type variable.
S
shippingwang 已提交
13294 13295 13296

    Examples:
        .. code-block:: python
13297

13298
            import paddle.fluid as fluid
R
ruri 已提交
13299
            input = fluid.data(name='input', shape=[None,4,2,2], dtype='float32')
S
shippingwang 已提交
13300
            out = fluid.layers.shuffle_channel(x=input, group=2)
S
shippingwang 已提交
13301 13302 13303
    """
    helper = LayerHelper("shuffle_channel", **locals())

S
shippingwang 已提交
13304
    out = helper.create_variable_for_type_inference(dtype=x.dtype)
S
shippingwang 已提交
13305 13306 13307 13308 13309 13310 13311 13312 13313

    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 已提交
13314
    return out
S
Add  
shippingwang 已提交
13315 13316


13317
@templatedoc()
D
dengkaipeng 已提交
13318
def temporal_shift(x, seg_num, shift_ratio=0.25, name=None):
13319
    """
13320

13321
    **Temporal Shift Operator**
13322

13323
    ${comment}
13324 13325

    Args:
13326
        x(Tensor): ${x_comment}
13327
        seg_num(int): ${seg_num_comment}
D
dengkaipeng 已提交
13328
        shift_ratio(float): ${shift_ratio_comment}
K
Kaipeng Deng 已提交
13329 13330 13331
        name(str, optional): For detailed information, please refer
                             to :ref:`api_guide_Name`. Usually name is no need to set and
                             None by default.
13332 13333

    Returns:
13334
        out(Tensor): The temporal shifting result is a tensor with the
K
Kaipeng Deng 已提交
13335
        same shape and same data type as the input.
13336 13337 13338 13339 13340 13341 13342

    Raises:
        TypeError: seg_num must be int type.

    Examples:
        .. code-block:: python

13343 13344 13345 13346
            import paddle
            import paddle.nn.functional as F

            input = paddle.randn([6, 4, 2, 2])
13347
            out = F.temporal_shift(x=input, seg_num=2, shift_ratio=0.2)
13348 13349
    """
    helper = LayerHelper("temporal_shift", **locals())
13350 13351 13352
    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')
13353 13354 13355 13356 13357 13358

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

    if not isinstance(seg_num, int):
        raise TypeError("seg_num must be int type.")

13359 13360 13361 13362
    if in_dygraph_mode():
        return core.ops.temporal_shift(x, 'seg_num', seg_num, 'shift_ratio',
                                       shift_ratio)

13363 13364 13365 13366
    helper.append_op(
        type="temporal_shift",
        inputs={"X": x},
        outputs={"Out": out},
D
dengkaipeng 已提交
13367 13368
        attrs={"seg_num": seg_num,
               "shift_ratio": shift_ratio})
13369 13370 13371
    return out


S
sneaxiy 已提交
13372
class PyFuncRegistry(object):
S
sneaxiy 已提交
13373 13374 13375
    _register_funcs = []

    def __init__(self, func):
S
sneaxiy 已提交
13376
        if func is None or not callable(func):
S
sneaxiy 已提交
13377 13378 13379
            raise TypeError('func must be a Python function')

        self._func = func
M
minqiyang 已提交
13380
        # find named args using reflection
S
sneaxiy 已提交
13381 13382 13383 13384 13385 13386 13387
        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 已提交
13388 13389 13390
        '''
        Why record self here?

M
minqiyang 已提交
13391 13392
        1. For debug usage. Users can call
           :code:`py_func.registered_func(idx)` method
S
sneaxiy 已提交
13393
           to find the registered function corresponding
M
minqiyang 已提交
13394
           to :code:`idx`.
S
sneaxiy 已提交
13395

M
minqiyang 已提交
13396 13397
        2. For increasing reference count of self.
           It seems that to release Python object
S
sneaxiy 已提交
13398
           whose reference count is 1 would cause
M
minqiyang 已提交
13399
           segmentation fault error in C++ side.
S
sneaxiy 已提交
13400 13401
           May be lack of Python GC in C++ side?
        '''
S
sneaxiy 已提交
13402
        PyFuncRegistry._register_funcs.append(self)
S
sneaxiy 已提交
13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416

    @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 已提交
13417 13418 13419 13420 13421 13422 13423 13424 13425
        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 已提交
13426

S
sneaxiy 已提交
13427 13428
        if not isinstance(func_ret, (list, tuple)):
            func_ret = (func_ret, )
S
sneaxiy 已提交
13429 13430

        ret = []
S
sneaxiy 已提交
13431 13432 13433
        for each_ret in func_ret:
            if each_ret is None or isinstance(each_ret, core.LoDTensor):
                ret.append(each_ret)
S
sneaxiy 已提交
13434 13435
                continue

S
sneaxiy 已提交
13436 13437
            if not isinstance(each_ret, np.ndarray):
                each_ret = np.array(each_ret)
S
sneaxiy 已提交
13438

S
sneaxiy 已提交
13439 13440 13441
            tensor = core.LoDTensor()
            tensor.set(each_ret, core.CPUPlace())
            ret.append(tensor)
S
sneaxiy 已提交
13442

S
sneaxiy 已提交
13443
        return tuple(ret)
S
sneaxiy 已提交
13444 13445


13446
@static_only
S
sneaxiy 已提交
13447 13448 13449
@templatedoc()
def py_func(func, x, out, backward_func=None, skip_vars_in_backward_input=None):
    """
13450 13451
    :api_attr: Static Graph

13452 13453
    This OP is used to register customized Python OP to Paddle. The design
    principe of py_func is that Tensor and numpy array can be converted to each
13454 13455
    other easily. So you can use Python and numpy API to register a python OP.

13456 13457
    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
13458
    call ``backward_func`` at backward runtime(if ``backward_func`` is not  None).
13459 13460
    ``x`` is the input of ``func``, whose type must be Tensor; ``out`` is
    the output of ``func``, whose type can be either Tensor or numpy array.
13461

13462
    The input of the backward function ``backward_func`` is ``x``, ``out`` and
13463 13464 13465
    the gradient of ``out``. If ``out`` have no gradient, the relevant input of
    ``backward_func`` is None. If ``x`` do not have a gradient, the user should
    return None in ``backward_func``.
13466

13467 13468
    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
13469 13470 13471 13472 13473 13474 13475
    ``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
13476 13477
            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
13478
            actively convert Tensor into a numpy array, so that we can use Python and
13479
            numpy API arbitrarily. If not, some operations of numpy may not be compatible.
13480 13481 13482 13483 13484 13485 13486
        x (Tensor|tuple(Tensor)|list[Tensor]): The input of the forward function ``func``.
            It can be Tensor|tuple(Tensor)|list[Tensor]. In addition, Multiple Tensor
            should be passed in the form of tuple(Tensor) or list[Tensor].
        out (T|tuple(T)|list[T]): The output of the forward function ``func``, it can be
            T|tuple(T)|list[T], where T can be either Tensor or numpy array. Since Paddle
            cannot automatically infer the shape and type of ``out``, you must create
            ``out`` in advance.
13487 13488 13489
        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
13490
            ``x`` when the network is at backward runtime.
13491 13492
        skip_vars_in_backward_input (Tensor, optional): It's used to limit the input
            list of ``backward_func``, and it can be Tensor|tuple(Tensor)|list[Tensor].
13493
            It must belong to either ``x`` or ``out``. The default  value is None, which means
13494 13495
            that no tensors need to be removed from ``x`` and ``out``. If it is not None,
            these tensors will not be the input of ``backward_func``. This parameter is only
13496
            useful when ``backward_func`` is not None.
13497 13498

    Returns:
13499
        Tensor|tuple(Tensor)|list[Tensor]: The output ``out`` of the forward function ``func``.
S
sneaxiy 已提交
13500 13501

    Examples:
13502
        .. code-block:: python
13503

13504
            # example 1:
13505
            import paddle
13506
            import six
13507
            import numpy as np
13508

13509 13510 13511
            paddle.enable_static()

            # Creates a forward function, Tensor can be input directly without
13512
            # being converted into numpy array.
13513 13514 13515
            def tanh(x):
                return np.tanh(x)

13516
            # Skip x in backward function and return the gradient of x
13517
            # Tensor must be actively converted to numpy array, otherwise,
13518
            # operations such as +/- can't be used.
13519 13520
            def tanh_grad(y, dy):
                return np.array(dy) * (1 - np.square(np.array(y)))
13521

13522
            # Creates a forward function for debugging running networks(print value)
13523 13524
            def debug_func(x):
                print(x)
13525

13526
            def create_tmp_var(name, dtype, shape):
13527
                return paddle.static.default_main_program().current_block().create_var(
13528
                    name=name, dtype=dtype, shape=shape)
13529 13530 13531 13532

            def simple_net(img, label):
                hidden = img
                for idx in six.moves.range(4):
13533
                    hidden = paddle.static.nn.fc(hidden, size=200)
13534 13535 13536
                    new_hidden = create_tmp_var(name='hidden_{}'.format(idx),
                        dtype=hidden.dtype, shape=hidden.shape)

13537
                    # User-defined forward and backward
13538
                    hidden = paddle.static.py_func(func=tanh, x=hidden,
13539 13540 13541
                        out=new_hidden, backward_func=tanh_grad,
                        skip_vars_in_backward_input=hidden)

13542
                    # User-defined debug functions that print out the input Tensor
13543
                    paddle.static.py_func(func=debug_func, x=hidden, out=None)
13544

13545
                prediction = paddle.static.nn.fc(hidden, size=10, activation='softmax')
13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562
                ce_loss = paddle.nn.loss.CrossEntropyLoss()
                return ce_loss(prediction, label)

            x = paddle.static.data(name='x', shape=[1,4], dtype='float32')
            y = paddle.static.data(name='y', shape=[1,10], dtype='int64')
            res = simple_net(x, y)

            exe = paddle.static.Executor(paddle.CPUPlace())
            exe.run(paddle.static.default_startup_program())
            input1 = np.random.random(size=[1,4]).astype('float32')
            input2 = np.random.randint(1, 10, size=[1,10], dtype='int64')
            out = exe.run(paddle.static.default_main_program(),
                          feed={'x':input1, 'y':input2},
                          fetch_list=[res.name])
            print(out)

        .. code-block:: python
13563

13564
            # example 2:
13565
            # This example shows how to turn Tensor into numpy array and
13566
            # use numpy API to register an Python OP
13567
            import paddle
13568 13569
            import numpy as np

13570 13571
            paddle.enable_static()

13572
            def element_wise_add(x, y):
13573
                # Tensor must be actively converted to numpy array, otherwise,
13574
                # numpy.shape can't be used.
13575
                x = np.array(x)
13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588
                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):
13589
                return paddle.static.default_main_program().current_block().create_var(
13590 13591 13592
                            name=name, dtype=dtype, shape=shape)

            def py_func_demo():
13593 13594
                start_program = paddle.static.default_startup_program()
                main_program = paddle.static.default_main_program()
13595 13596

                # Input of the forward function
13597 13598
                x = paddle.static.data(name='x', shape=[2,3], dtype='int32')
                y = paddle.static.data(name='y', shape=[2,3], dtype='int32')
13599

13600 13601 13602 13603
                # 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]
13604
                paddle.static.py_func(func=element_wise_add, x=[x,y], out=output)
13605

13606
                exe=paddle.static.Executor(paddle.CPUPlace())
13607 13608 13609 13610 13611
                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')
13612
                out = exe.run(main_program,
13613 13614 13615 13616 13617 13618 13619 13620 13621
                            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 已提交
13622
    """
S
sneaxiy 已提交
13623
    helper = LayerHelper('py_func', **locals())
13624
    check_type(x, 'X', (list, tuple, Variable, type(None)), 'py_func')
S
sneaxiy 已提交
13625 13626 13627
    if x is None:
        x = []
    elif isinstance(x, Variable):
S
sneaxiy 已提交
13628
        x = [x]
13629 13630 13631
    elif isinstance(x, tuple):
        x = list(x)
    elif not isinstance(x, (list, tuple, Variable)):
S
sneaxiy 已提交
13632
        raise TypeError('Input must be Variable/list(Variable)/tuple(Variable)')
13633
    check_type(out, 'Out', (list, tuple, Variable, type(None)), 'py_func')
S
sneaxiy 已提交
13634 13635 13636
    if out is None:
        out_list = []
    elif isinstance(out, Variable):
S
sneaxiy 已提交
13637
        out_list = [out]
13638 13639
    elif isinstance(out, tuple):
        out_list = list(out)
13640 13641 13642
    elif isinstance(out, list):
        out_list = out
    else:
S
sneaxiy 已提交
13643 13644
        raise TypeError(
            'Output must be Variable/list(Variable)/tuple(Variable)')
S
sneaxiy 已提交
13645

S
sneaxiy 已提交
13646 13647
    fwd_func_id = PyFuncRegistry(func).id
    bwd_func_id = PyFuncRegistry(
S
sneaxiy 已提交
13648
        backward_func).id if backward_func is not None else -1
S
sneaxiy 已提交
13649 13650

    for each_out in out_list:
S
sneaxiy 已提交
13651 13652
        if len(each_out.shape) == 0:
            raise ValueError(
S
sneaxiy 已提交
13653 13654
                'Output shapes of py_func op should be provided by users manually'
            )
S
sneaxiy 已提交
13655

S
sneaxiy 已提交
13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670
    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 已提交
13671 13672 13673 13674

    helper.append_op(
        type='py_func',
        inputs={'X': x},
S
sneaxiy 已提交
13675 13676
        outputs={'Out': out_list},
        attrs={
S
sneaxiy 已提交
13677 13678 13679
            'forward_callable_id': fwd_func_id,
            'backward_callable_id': bwd_func_id,
            'backward_skip_vars': list(backward_skip_vars)
S
sneaxiy 已提交
13680
        })
S
sneaxiy 已提交
13681
    return out
S
sneaxiy 已提交
13682 13683 13684


# For debug usage
S
sneaxiy 已提交
13685 13686 13687 13688
py_func.registered_func = PyFuncRegistry.registered_func
py_func.registered_func_num = PyFuncRegistry.registered_func_num


13689 13690 13691 13692 13693 13694 13695 13696 13697
@templatedoc()
def psroi_pool(input,
               rois,
               output_channels,
               spatial_scale,
               pooled_height,
               pooled_width,
               name=None):
    """
13698

13699 13700
    ${comment}

S
SunGaofeng 已提交
13701
    Parameters:
13702
        input (Variable): ${x_comment}
S
SunGaofeng 已提交
13703
        rois (Variable): LoDTensor, ROIs (Regions of Interest) to pool over.It should be
S
SunGaofeng 已提交
13704 13705 13706
                         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 已提交
13707 13708
                         right coordinates. The data type is the same as `input`
        output_channels (int): ${output_channels_comment}
13709
        spatial_scale (float): ${spatial_scale_comment} Default: 1.0
S
SunGaofeng 已提交
13710 13711
        pooled_height (int): ${pooled_height_comment} Default: 1
        pooled_width (int): ${pooled_width_comment} Default: 1
13712 13713
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
13714
                             For more information, please refer to :ref:`api_guide_Name`
13715 13716

    Returns:
S
SunGaofeng 已提交
13717 13718 13719 13720
        ${out_comment}.

    Return Type:
        Variable
13721 13722 13723 13724

    Examples:
        .. code-block:: python

S
SunGaofeng 已提交
13725
            import paddle.fluid as fluid
13726 13727
            import paddle
            paddle.enable_static()
S
SunGaofeng 已提交
13728 13729
            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 已提交
13730
            pool_out = fluid.layers.psroi_pool(x, rois, 10, 1.0, 7, 7)
13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755
    """
    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
13756 13757 13758 13759 13760 13761 13762 13763


@templatedoc()
def prroi_pool(input,
               rois,
               spatial_scale=1.0,
               pooled_height=1,
               pooled_width=1,
13764
               batch_roi_nums=None,
13765 13766
               name=None):
    """
13767

13768
    The precise roi pooling implementation for paddle. Reference: https://arxiv.org/pdf/1807.11590.pdf
13769 13770

    Args:
13771
        input (Variable):The input of precise roi pooliing.The shape of input tensor is
13772 13773 13774
                        [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
13775 13776 13777 13778 13779
                        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
13780 13781 13782 13783 13784 13785
                        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.
13786 13787
        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,
13788 13789
                         where N is the batch size. Default: None. Be note: The lod of input should be
                         empty when batch_roi_nums has values;
13790 13791 13792
        name (str, default None): The name of this operation.

    Returns:
13793
        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.
13794 13795 13796 13797

    Examples:
        .. code-block:: python

13798
            ## prroi_pool without batch_roi_num
13799
            import paddle.fluid as fluid
13800 13801
            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')
13802
            pool_out = fluid.layers.prroi_pool(x, rois, 1.0, 7, 7)
13803

13804 13805 13806 13807 13808 13809 13810 13811
            ## 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)


13812
    """
13813 13814
    check_variable_and_dtype(input, 'input', ['float32'], 'prroi_pool')
    check_variable_and_dtype(rois, 'rois', ['float32'], 'prroi_pool')
13815 13816 13817 13818 13819 13820 13821 13822 13823 13824
    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)
13825 13826 13827
    inputs_op = {'X': input, 'ROIs': rois}
    if batch_roi_nums is not None:
        inputs_op['BatchRoINums'] = batch_roi_nums
13828 13829
    helper.append_op(
        type='prroi_pool',
13830
        inputs=inputs_op,
13831 13832 13833 13834 13835 13836 13837
        outputs={'Out': out},
        attrs={
            'spatial_scale': spatial_scale,
            'pooled_height': pooled_height,
            'pooled_width': pooled_width
        })
    return out
13838

M
minqiyang 已提交
13839

R
ruri 已提交
13840 13841 13842
def pixel_shuffle(x, upscale_factor):
    """

R
ruri 已提交
13843
    This op rearranges elements in a tensor of shape [N, C, H, W]
R
ruri 已提交
13844 13845 13846
    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.
13847
    Please refer to the paper: `Real-Time Single Image and Video Super-Resolution
R
ruri 已提交
13848 13849 13850
    Using an Efficient Sub-Pixel Convolutional Neural Network <https://arxiv.org/abs/1609.05158v2>`_ .
    by Shi et. al (2016) for more details.

R
ruri 已提交
13851
    Parameters:
R
ruri 已提交
13852

R
ruri 已提交
13853 13854
        x(Variable): 4-D tensor, the data type should be float32 or float64.
        upscale_factor(int): factor to increase spatial resolution.
R
ruri 已提交
13855 13856

    Returns:
13857
        Out(Variable): Reshaped tensor according to the new dimension.
R
ruri 已提交
13858 13859 13860 13861 13862 13863 13864

    Raises:
        ValueError: If the square of upscale_factor cannot divide the channels of input.

    Examples:
        .. code-block:: python

R
ruri 已提交
13865 13866 13867 13868 13869 13870 13871 13872
	    # 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())
13873

R
ruri 已提交
13874 13875 13876 13877 13878
	    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)
13879

R
ruri 已提交
13880 13881
 	    # print(output.shape)
	    # (2L, 1L, 12L, 12L)
R
ruri 已提交
13882 13883 13884

    """

R
ruri 已提交
13885
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'pixel_shuffle')
R
ruri 已提交
13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900
    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


13901 13902 13903 13904 13905
def fsp_matrix(x, y):
    """

    **FSP matrix op**

13906
    This op is used to calculate the flow of solution procedure (FSP) matrix of two 4-D Tensor feature maps.
13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917
    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:

13918 13919 13920
        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].
13921
                      The y_channel can be different with the x_channel of Input(X)
13922 13923
                      while the other dimensions must be the same with Input(X)'s. A Tensor with
                      type float32, float64.
13924 13925 13926 13927

    Returns:

        fsp matrix (Variable): The output of FSP op with shape [batch_size, x_channel, y_channel].
13928 13929
        The x_channel is the channel of x and the y_channel is the channel of y. A Tensor with
        type float32, float64.
13930 13931 13932 13933 13934

    Examples:

        .. code-block:: python

B
Bai Yifan 已提交
13935
            import paddle.fluid as fluid
B
Bai Yifan 已提交
13936
            data = fluid.data(name='data', shape=[None, 3, 32, 32])
B
Bai Yifan 已提交
13937 13938 13939 13940
            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)
13941 13942 13943
            loss = fluid.layers.fsp_matrix(feature_map_0, feature_map_1)

    """
13944 13945
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'fsp_matrix')
    check_variable_and_dtype(y, 'y', ['float32', 'float64'], 'fsp_matrix')
13946 13947 13948 13949 13950
    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 已提交
13951 13952 13953


def continuous_value_model(input, cvm, use_cvm=True):
13954
    r"""
H
fix doc  
heqiaozhi 已提交
13955

H
heqiaozhi 已提交
13956
    **continuous_value_model layers**
H
fix doc  
heqiaozhi 已提交
13957

Z
zhoushiyu 已提交
13958
    Now, this OP is used in CTR project to remove or dispose show and click value in :attr:`input`.
H
fix doc  
heqiaozhi 已提交
13959

Z
zhoushiyu 已提交
13960 13961
    :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 已提交
13962
    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 已提交
13963 13964
    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 已提交
13965

Z
zhoushiyu 已提交
13966 13967 13968 13969 13970 13971 13972
    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 已提交
13973

H
heqiaozhi 已提交
13974
    Returns:
H
fix doc  
heqiaozhi 已提交
13975

Z
zhoushiyu 已提交
13976 13977
        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 已提交
13978

H
heqiaozhi 已提交
13979
    Examples:
H
fix doc  
heqiaozhi 已提交
13980

H
heqiaozhi 已提交
13981
        .. code-block:: python
H
fix doc  
heqiaozhi 已提交
13982

13983
          import paddle.fluid as fluid
Z
zhoushiyu 已提交
13984 13985
          input = fluid.data(name="input", shape=[64, 1], dtype="int64")
          label = fluid.data(name="label", shape=[64, 1], dtype="int64")
H
heqiaozhi 已提交
13986 13987 13988 13989 13990 13991 13992 13993
          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 已提交
13994

H
heqiaozhi 已提交
13995 13996 13997
    """
    helper = LayerHelper('cvm', **locals())
    out = helper.create_variable(dtype=input.dtype)
13998 13999
    check_variable_and_dtype(input, 'input', ['float16', 'float32', 'float64'],
                             'cvm')
H
heqiaozhi 已提交
14000 14001 14002 14003 14004 14005
    helper.append_op(
        type='cvm',
        inputs={'X': [input],
                'CVM': [cvm]},
        outputs={'Y': [out]},
        attrs={"use_cvm": use_cvm})
H
heqiaozhi 已提交
14006
    return out
Z
zhoukunsheng 已提交
14007 14008 14009 14010 14011 14012 14013


def where(condition):
    """
    Return an int64 tensor with rank 2, specifying the coordinate of true element in `condition`.

    Args:
14014
        condition(Variable): A bool tensor with rank at least 1, the data type is bool.
Z
zhoukunsheng 已提交
14015 14016

    Returns:
14017
        Variable, the output data type is int64. : The tensor variable storing a 2-D tensor, which involves all coordinate.
Z
zhoukunsheng 已提交
14018 14019 14020 14021

    Examples:
        .. code-block:: python

14022
             import paddle.fluid as fluid
14023 14024 14025
             import paddle.fluid.layers as layers
             import numpy as np

Z
zhoukunsheng 已提交
14026
             # condition is a tensor [True, False, True]
14027 14028 14029
             condition = layers.assign(np.array([1, 0, 1], dtype='int32'))
             condition = layers.cast(condition, 'bool')
             out = layers.where(condition) # [[0], [2]]
Z
zhoukunsheng 已提交
14030 14031

             # condition is a tensor [[True, False], [False, True]]
14032 14033 14034
             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 已提交
14035 14036

             # condition is a tensor [False, False, False]
14037 14038 14039 14040
             condition = layers.assign(np.array([0, 0, 0], dtype='int32'))
             condition = layers.cast(condition, 'bool')
             out = layers.where(condition) # [[]]

Z
zhoukunsheng 已提交
14041
    """
14042
    helper = LayerHelper("where_index", **locals())
Z
zhoukunsheng 已提交
14043

14044 14045 14046
    if in_dygraph_mode():
        return core.ops.where_index(condition)

Z
zhoukunsheng 已提交
14047 14048 14049 14050
    out = helper.create_variable_for_type_inference(
        dtype=core.VarDesc.VarType.INT64)

    helper.append_op(
14051 14052 14053
        type='where_index',
        inputs={'Condition': condition},
        outputs={'Out': [out]})
Z
zhoukunsheng 已提交
14054
    return out
Z
zhoukunsheng 已提交
14055 14056


W
WangXi 已提交
14057
@deprecated(since="2.0.0", update_to="paddle.sign")
Z
zhoukunsheng 已提交
14058
def sign(x):
14059
    r"""
14060
    This OP returns sign of every element in `x`: 1 for positive, -1 for negative and 0 for zero.
Z
zhoukunsheng 已提交
14061 14062

    Args:
14063 14064
        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 已提交
14065 14066

    Returns:
14067
        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 已提交
14068 14069 14070 14071

    Examples:
        .. code-block:: python

14072 14073 14074
          import paddle.fluid as fluid
          import numpy as np

14075
          # [1.0, 0.0, -1.0]
14076
          data = fluid.layers.sign(np.array([3.0, 0.0, -2.0], dtype='float32'))
Z
zhoukunsheng 已提交
14077 14078 14079
    """

    helper = LayerHelper("sign", **locals())
14080 14081 14082 14083
    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 已提交
14084 14085 14086 14087 14088
    out = helper.create_variable_for_type_inference(dtype=x.dtype)

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

    return out
14089 14090


Z
zhoukunsheng 已提交
14091
def unique(x, dtype='int32'):
14092
    r"""
Z
zhoukunsheng 已提交
14093 14094 14095
    Return a unique tensor for `x` and an index tensor pointing to this unique tensor.

    Args:
Z
Zhang Ting 已提交
14096 14097
        x(Tensor): A 1-D input tensor, it's data type should be float32, float64, int32, int64.
        dtype(np.dtype|str, optional): The type of index tensor: int32, int64. Default: int32.
Z
zhoukunsheng 已提交
14098 14099 14100 14101 14102 14103 14104 14105 14106 14107

    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 已提交
14108
             x = fluid.layers.assign(np.array([2, 3, 3, 1, 5, 3], dtype='int32'))
Z
zhoukunsheng 已提交
14109 14110 14111
             out, index = fluid.layers.unique(x) # out is [2, 3, 1, 5]; index is [0, 1, 1, 2, 3, 1]
    """

14112 14113
    check_variable_and_dtype(x, "x", ['float32', 'float64', 'int32', 'int64'],
                             "unique")
Z
zhoukunsheng 已提交
14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129
    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


14130
def unique_with_counts(x, dtype='int32'):
14131
    r"""
T
tianshuo78520a 已提交
14132
    This OP return a unique tensor for `x` , and count tensor that the count of unique result in raw input, \
14133
    and an index tensor pointing to this unique tensor.
14134

14135
    **NOTICE**: This op support the variable type of Tensor only.
14136 14137

    Args:
14138 14139
        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.
14140

14141
    Returns:
14142 14143 14144
        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 已提交
14145
        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\
14146
        the :attr:`x`, the data shape is :math:`[K]`, the data shape is the same as output :attr:`out`.
14147 14148 14149 14150 14151 14152 14153 14154 14155

    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]
14156
            # x.shape=(6,) out.shape=(4,), index.shape=(6,), count.shape=(4,)
14157
    """
14158 14159
    check_variable_and_dtype(x, "x", ['float32', 'float64', 'int32', 'int64'],
                             "unique_with_counts")
14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187
    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


14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200
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,
14201
                    modulated=True,
14202
                    name=None):
14203
    r"""
14204 14205
    :api_attr: Static Graph

14206
    **Deformable Convolution op**
14207 14208 14209

    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:
14210 14211 14212 14213


    Deformable Convolution v2:

14214 14215 14216
    .. math::

        y(p) = \sum_{k=1}^{K}{w_k * x(p + p_k + \Delta p_k) * \Delta m_k}
14217 14218

    Deformable Convolution v1:
14219

14220 14221 14222
    .. math::

        y(p) = \sum_{k=1}^{K}{w_k * x(p + p_k + \Delta p_k)}
14223 14224

    Where :math:`\Delta p_k` and :math:`\Delta m_k` are the learnable offset and modulation scalar for the k-th location,
14225
    Which :math:`\Delta m_k` is one in deformable convolution v1. Please refer to `Deformable ConvNets v2: More Deformable, Better Results
14226
    <https://arxiv.org/abs/1811.11168v2>`_ and `Deformable Convolutional Networks <https://arxiv.org/abs/1703.06211>`_.
14227

14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250
    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:
14251 14252
        input (Variable): The input image with [N, C, H, W] format. A Tensor with type
            float32, float64.
14253
        offset (Variable): The input coordinate offset of deformable convolution layer.
14254
            A Tensor with type float32, float64.
14255 14256 14257
        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.
14258 14259
        num_filters(int): The number of filter. It is as same as the output
            image channel.
14260
        filter_size (int|tuple): The filter size. If filter_size is a tuple,
14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278
            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.
14279
        im2col_step (int): Maximum number of images per im2col computation;
T
tianshuo78520a 已提交
14280
            The total batch size should be devisable by this value or smaller
14281 14282 14283
            than this value; if you face out of memory problem, you can try
            to use a smaller value here.
            Default: im2col_step = 64.
14284
        param_attr (ParamAttr, Optional): The parameter attribute for learnable parameters/weights
14285 14286 14287
            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
14288
            initialized with :math:`Normal(0.0, std)`, and the
14289
            :math:`std` is :math:`(\\frac{2.0 }{filter\_elem\_num})^{0.5}`. Default: None.
14290
        bias_attr (ParamAttr|bool, Optional): The parameter attribute for the bias of
14291 14292 14293 14294
            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.
14295 14296
        modulated (bool): Make sure which version should be used between v1 and v2, where v2 is \
            used while True. Default: True.
14297 14298
        name(str, Optional): For details, please refer to :ref:`api_guide_Name`.
                        Generally, no setting is required. Default: None.
14299 14300
    Returns:
        Variable: The tensor variable storing the deformable convolution \
14301
                  result. A Tensor with type float32, float64.
14302 14303 14304 14305 14306 14307
    Raises:
        ValueError: If the shapes of input, filter_size, stride, padding and
                    groups mismatch.
    Examples:
        .. code-block:: python

14308
          #deformable conv v2:
14309

14310
          import paddle.fluid as fluid
14311 14312 14313
          import paddle
          paddle.enable_static()
          
14314 14315
          C_in, H_in, W_in = 3, 32, 32
          filter_size, deformable_groups = 3, 1
B
Bai Yifan 已提交
14316 14317 14318
          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')
14319
          out = fluid.layers.deformable_conv(input=data, offset=offset, mask=mask,
14320
                                             num_filters=2, filter_size=filter_size, padding=1, modulated=True)
14321 14322 14323 14324

          #deformable conv v1:

          import paddle.fluid as fluid
14325 14326
          C_in, H_in, W_in = 3, 32, 32
          filter_size, deformable_groups = 3, 1
B
Bai Yifan 已提交
14327 14328
          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')
14329
          out = fluid.layers.deformable_conv(input=data, offset=offset, mask=None,
14330
                                             num_filters=2, filter_size=filter_size, padding=1, modulated=False)
14331 14332
    """

14333 14334 14335 14336 14337 14338
    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')

14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377
    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)

14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413
    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,
            })
14414 14415 14416

    output = helper.append_bias_op(pre_bias, dim_start=1, dim_end=2)
    return output
14417 14418 14419


def unfold(x, kernel_sizes, strides=1, paddings=0, dilations=1, name=None):
14420
    r"""
14421

S
SunGaofeng 已提交
14422
    This op returns a col buffer of sliding local blocks of input x, also known
14423
    as im2col for batched 2D image tensors. For each block under the convolution filter,
T
tianshuo78520a 已提交
14424
    all element will be rearranged as a column. While the convolution filter sliding over
14425 14426
    the input feature map, a series of such columns will be formed.

S
SunGaofeng 已提交
14427
    For each input :math:`x` with shape [N, C, H, W], the output shape [N, Cout, Lout]
14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444
    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 已提交
14445
    Parameters:
14446
        x(Tensor):              4-D Tensor, input tensor of format [N, C, H, W],
S
SunGaofeng 已提交
14447
                                  data type can be float32 or float64
14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459
        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 已提交
14460
        dilations(int|list):      the dilations of convolution kernel, should be
T
tianshuo78520a 已提交
14461
                                  [dilation_h, dilation_w], or an integer dilation treated as
14462
                                  [dilation, dilation]. For default, it will be [1, 1].
14463 14464
        name(str, optional): The default value is None.
                             Normally there is no need for user to set this property.
S
SunGaofeng 已提交
14465
                             For more information, please refer to :ref:`api_guide_Name`
14466

14467

14468
    Returns:
14469
        The tensor corresponding to the sliding local blocks.
14470 14471 14472
        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 已提交
14473 14474 14475
        The data type of output is the same as the input :math:`x`

    Return Type:
14476
        Tensor
14477 14478 14479 14480 14481

    Examples:

        .. code-block:: python

14482 14483 14484 14485 14486
            import paddle
            import paddle.nn.functional as F

            x = paddle.randn((100,3,224,224))
            y = F.unfold(x, [3, 3], 1, 1, 1)
14487 14488 14489 14490
    """

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

14491 14492
    check_variable_and_dtype(x, 'x', ['float32', 'float64'], 'unfold')

14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541
    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 已提交
14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556


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):
14557
    r"""
14558

14559
    Deformable ROI Pooling Layer
14560

14561
    Performs deformable region-of-interest pooling on inputs. As described
14562
    in `Deformable Convolutional Networks <https://arxiv.org/abs/1703.06211>`_, it will get offset for each bin after
14563
    roi pooling so that pooling at correct region. Batch_size will change to the number of region bounding boxes after deformable_roi_pooling.
14564

14565
    The operation has three steps:
14566

14567
    1. Dividing each region proposal into equal-sized sections with the pooled_width and pooled_height.
14568

14569 14570
    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.
14571

14572
    3. Sample several points in each bin to get average values as output.
14573 14574


14575 14576 14577 14578 14579 14580 14581 14582 14583
    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.
14584 14585 14586
        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.
14587 14588 14589 14590
        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.
14591
        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
14592
                          is k1 * k2 * (C + 1), which k1 and k2 are group width and height and C+1 is number of output
T
tianshuo78520a 已提交
14593
                          channels.) eg.(4, 6), which 4 is height of group and 6 is width of group. Default: [1, 1].
14594 14595 14596 14597 14598 14599 14600
        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 已提交
14601
                                   If value is True, input dimension should be output dimension * pooled_height * pooled_width. Default: False.
14602 14603 14604 14605
        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 已提交
14606 14607 14608 14609

    Examples:
      .. code-block:: python

14610 14611
        # position_sensitive=True
        import paddle.fluid as fluid
C
chengjuntao 已提交
14612
        input = fluid.data(name="input",
14613 14614
                           shape=[2, 192, 64, 64],
                           dtype='float32')
C
chengjuntao 已提交
14615 14616
        rois = fluid.data(name="rois",
                          shape=[-1, 4],
14617
                          dtype='float32',
C
chengjuntao 已提交
14618 14619
                          lod_level=1)
        trans = fluid.data(name="trans",
14620 14621 14622 14623 14624
                           shape=[2, 384, 64, 64],
                           dtype='float32')
        x = fluid.layers.deformable_roi_pooling(input=input,
                                                rois=rois,
                                                trans=trans,
C
chengjuntao 已提交
14625
                                                no_trans=False,
14626
                                                spatial_scale=1.0,
C
chengjuntao 已提交
14627 14628 14629 14630
                                                group_size=(1, 1),
                                                pooled_height=8,
                                                pooled_width=8,
                                                part_size=(8, 8),
14631
                                                sample_per_part=4,
C
chengjuntao 已提交
14632 14633
                                                trans_std=0.1,
                                                position_sensitive=True)
14634

14635
        # position_sensitive=False
14636
        import paddle.fluid as fluid
C
chengjuntao 已提交
14637
        input = fluid.data(name="input",
14638 14639
                           shape=[2, 192, 64, 64],
                           dtype='float32')
C
chengjuntao 已提交
14640 14641
        rois = fluid.data(name="rois",
                          shape=[-1, 4],
14642
                          dtype='float32',
C
chengjuntao 已提交
14643 14644
                          lod_level=1)
        trans = fluid.data(name="trans",
14645 14646 14647 14648 14649
                           shape=[2, 384, 64, 64],
                           dtype='float32')
        x = fluid.layers.deformable_roi_pooling(input=input,
                                                rois=rois,
                                                trans=trans,
C
chengjuntao 已提交
14650
                                                no_trans=False,
14651
                                                spatial_scale=1.0,
C
chengjuntao 已提交
14652 14653 14654 14655
                                                group_size=(1, 1),
                                                pooled_height=8,
                                                pooled_width=8,
                                                part_size=(8, 8),
14656
                                                sample_per_part=4,
C
chengjuntao 已提交
14657 14658
                                                trans_std=0.1,
                                                position_sensitive=False)
C
cjt222 已提交
14659 14660
    """

14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672
    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 已提交
14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707
    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
14708 14709


14710
@deprecated(since="2.0.0", update_to="paddle.shard_index")
14711 14712
def shard_index(input, index_num, nshards, shard_id, ignore_value=-1):
    """
14713
    Recompute the `input` indices according to the offset of the
14714 14715 14716 14717
    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:
14718 14719
    ::

14720 14721
        shard_size = (index_num + nshards - 1) // nshards
        y = x % shard_size if x // shard_size == shard_id else ignore_value
14722

14723 14724
    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`
14725 14726

    Args:
14727 14728 14729 14730 14731
        input (Tensor): Input indices with data type int64. It's last dimension must be 1.
        index_num (int): An integer defining the range of the index.
        nshards (int): The number of shards.
        shard_id (int): The index of the current shard.
        ignore_value (int): An integer value out of sharded index range.
14732 14733

    Returns:
14734
        Tensor: The sharded index of input.
14735 14736 14737 14738

    Examples:
        .. code-block:: python

14739 14740 14741 14742 14743 14744 14745 14746
            import paddle
            label = paddle.to_tensor([[16], [1]], "int64")
            shard_label = paddle.shard_index(input=label,
                                             index_num=20,
                                             nshards=2,
                                             shard_id=0)
            print(shard_label)
            # [[-1], [1]]
14747
    """
14748
    check_variable_and_dtype(input, 'input', ['int64'], 'shard_index')
14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767
    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 已提交
14768 14769 14770 14771


@templatedoc()
def hard_swish(x, threshold=6.0, scale=6.0, offset=3.0, name=None):
14772
    r"""
14773 14774 14775
    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 已提交
14776

14777
    The formula is as follows:
H
huangjun12 已提交
14778

14779
    .. math::
H
huangjun12 已提交
14780

14781
        out = \\frac{x * (min(max(0, x+offset), threshold))}{scale}
H
huangjun12 已提交
14782

14783 14784 14785 14786 14787 14788 14789 14790 14791
    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
14792 14793
        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`

14794 14795
    Returns:
        Variable: The output tensor with the same shape and data type as input.
14796 14797


14798
    Examples:
14799

14800
    .. code-block:: python
14801

14802
        import paddle.fluid as fluid
14803
        import paddle
14804
        import numpy as np
14805
        paddle.enable_static()
14806

14807
        DATATYPE='float32'
14808

14809
        x_data = np.array([i for i in range(1,5)]).reshape([1,1,4]).astype(DATATYPE)
14810

14811 14812
        x = fluid.data(name="x", shape=[None,1,4], dtype=DATATYPE)
        y = fluid.layers.hard_swish(x)
14813

14814 14815 14816 14817 14818
        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 已提交
14819
    """
14820 14821 14822 14823
    if in_dygraph_mode():
        return core.ops.hard_swish(x, 'threshold', threshold, 'scale', scale,
                                   'offset', offset)

14824 14825 14826
    check_variable_and_dtype(x, 'x', ['float16', 'float32', 'float64'],
                             'hard_swish')

H
huangjun12 已提交
14827 14828 14829 14830 14831 14832 14833 14834 14835 14836
    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 已提交
14837 14838


K
Kaipeng Deng 已提交
14839 14840
@templatedoc()
def mish(x, threshold=20, name=None):
14841
    r"""
K
Kaipeng Deng 已提交
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 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 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913
    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 已提交
14914
def gather_tree(ids, parents):
14915
    r"""
G
Guo Sheng 已提交
14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939
    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]]]

14940 14941
            Then:
                gather_tree(ids, parents)
G
Guo Sheng 已提交
14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977
                         = [[[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 已提交
14978 14979 14980
    check_variable_and_dtype(ids, 'ids', ['int32', 'int64'], 'gather_tree')
    check_variable_and_dtype(parents, 'parents', ['int32', 'int64'],
                             'gather_tree')
G
Guo Sheng 已提交
14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991
    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


14992
@deprecated(since="2.0.0", update_to="paddle.uniform")
14993
@templatedoc()
14994 14995
def uniform_random(shape, dtype='float32', min=-1.0, max=1.0, seed=0,
                   name=None):
14996
    """
14997 14998
    This OP returns a Tensor filled with random values sampled from a uniform
    distribution in the range [``min``, ``max``), with ``shape`` and ``dtype``.
14999 15000 15001

    Examples:
    ::
15002

15003 15004
        Input:
          shape = [1, 2]
15005

15006 15007 15008 15009
        Output:
          result=[[0.8505902, 0.8397286]]

    Args:
15010 15011 15012 15013 15014 15015 15016 15017 15018 15019 15020 15021 15022
        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
15023 15024
            use a seed generated by the system. Note that if seed is not 0,
            this operator will always generate the same random numbers every
15025
            time. Default is 0.
15026 15027 15028
        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`.
15029

15030
    Returns:
15031 15032
        Tensor: A Tensor filled with random values sampled from a uniform
        distribution in the range [``min``, ``max``), with ``shape`` and ``dtype``.
15033

15034
    Raises:
15035 15036
        TypeError: If ``shape`` is not list, tuple, Tensor.
        TypeError: If ``dtype`` is not float32, float64.
15037

15038 15039 15040 15041 15042 15043
    Examples:
        .. code-block:: python

            import paddle.fluid as fluid

            # example 1:
15044
            # attr shape is a list which doesn't contain Tensor.
15045
            result_1 = fluid.layers.uniform_random(shape=[3, 4])
15046 15047 15048
            # [[ 0.84524226,  0.6921872,   0.56528175,  0.71690357],
            #  [-0.34646994, -0.45116323, -0.09902662, -0.11397249],
            #  [ 0.433519,    0.39483607, -0.8660099,   0.83664286]]
15049 15050

            # example 2:
15051 15052 15053
            # 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)
15054
            result_2 = fluid.layers.uniform_random(shape=[dim_1, dim_2])
15055 15056
            # [[-0.9951253,   0.30757582, 0.9899647 ],
            #  [ 0.5864527,   0.6607096,  -0.8886161 ]]
15057 15058

            # example 3:
15059
            # attr shape is a Tensor, the data type must be int64 or int32.
15060
            var_shape = fluid.data(name='var_shape', shape=[2], dtype="int64")
15061
            result_3 = fluid.layers.uniform_random(var_shape)
15062 15063 15064 15065
            # if var_shape's value is [2, 3]
            # result_3 is:
            # [[-0.8517412,  -0.4006908,   0.2551912 ],
            #  [ 0.3364414,   0.36278176, -0.16085452]]
15066

15067 15068 15069
    """
    if not isinstance(dtype, core.VarDesc.VarType):
        dtype = convert_np_dtype_to_dtype_(dtype)
15070

15071
    if in_dygraph_mode():
15072
        shape = utils.convert_shape_to_list(shape)
15073 15074 15075
        return core.ops.uniform_random('shape', shape, 'min',
                                       float(min), 'max',
                                       float(max), 'seed', seed, 'dtype', dtype)
15076

15077 15078
    check_type(shape, 'shape', (list, tuple, Variable), 'uniform_random/rand')
    check_dtype(dtype, 'dtype', ('float32', 'float64'), 'uniform_random/rand')
15079 15080

    inputs = dict()
15081
    attrs = {'seed': seed, 'min': min, 'max': max, 'dtype': dtype}
15082
    utils.get_shape_tensor_inputs(
15083
        inputs=inputs, attrs=attrs, shape=shape, op_type='uniform_random/rand')
15084

15085
    helper = LayerHelper("uniform_random", **locals())
15086 15087 15088 15089
    out = helper.create_variable_for_type_inference(dtype)
    helper.append_op(
        type="uniform_random", inputs=inputs, attrs=attrs,
        outputs={"Out": out})
15090
    utils.try_set_static_shape_tensor(out, shape)
15091
    return out
myq406450149's avatar
myq406450149 已提交
15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145


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