From 0569ff78faf8cb68ba0c6cbee6e5e0b886304323 Mon Sep 17 00:00:00 2001 From: zhoukunsheng Date: Wed, 19 Jun 2019 15:20:37 +0800 Subject: [PATCH] Fix doc example for greater_equal, greater_than, less_equal, not_equal, rank, reduce_all, reduce_any, sign, where, diag (#18167) * test=develop fix greater_than, greater_equal, less_equal, not_equal, rank, reduce_all, reduce_any, sign, where, diag doc example * test=develop fix API.spec conflict --- paddle/fluid/API.spec | 20 ++++---- python/paddle/fluid/layers/control_flow.py | 17 ++++++ python/paddle/fluid/layers/nn.py | 60 +++++++++++++++------- python/paddle/fluid/layers/tensor.py | 5 +- 4 files changed, 73 insertions(+), 29 deletions(-) diff --git a/paddle/fluid/API.spec b/paddle/fluid/API.spec index bfc50175010..648bdf08ff1 100644 --- a/paddle/fluid/API.spec +++ b/paddle/fluid/API.spec @@ -110,8 +110,8 @@ paddle.fluid.layers.reduce_mean (ArgSpec(args=['input', 'dim', 'keep_dim', 'name paddle.fluid.layers.reduce_max (ArgSpec(args=['input', 'dim', 'keep_dim', 'name'], varargs=None, keywords=None, defaults=(None, False, None)), ('document', '10023caec4d7f78c3b901f023a1feaa7')) paddle.fluid.layers.reduce_min (ArgSpec(args=['input', 'dim', 'keep_dim', 'name'], varargs=None, keywords=None, defaults=(None, False, None)), ('document', '1a1c91625ce3c32646f69ca10d4d1da7')) paddle.fluid.layers.reduce_prod (ArgSpec(args=['input', 'dim', 'keep_dim', 'name'], varargs=None, keywords=None, defaults=(None, False, None)), ('document', 'b386471f0476c80c61d8c8672278063d')) -paddle.fluid.layers.reduce_all (ArgSpec(args=['input', 'dim', 'keep_dim', 'name'], varargs=None, keywords=None, defaults=(None, False, None)), ('document', '646ca4d4a2cc16084f59de44b6927eca')) -paddle.fluid.layers.reduce_any (ArgSpec(args=['input', 'dim', 'keep_dim', 'name'], varargs=None, keywords=None, defaults=(None, False, None)), ('document', 'f36661060aeeaf6c6b1331e41b3726fa')) +paddle.fluid.layers.reduce_all (ArgSpec(args=['input', 'dim', 'keep_dim', 'name'], varargs=None, keywords=None, defaults=(None, False, None)), ('document', '86420219be38e6e5c11f5fdf9dacb657')) +paddle.fluid.layers.reduce_any (ArgSpec(args=['input', 'dim', 'keep_dim', 'name'], varargs=None, keywords=None, defaults=(None, False, None)), ('document', 'cc1f965017029427832a05e31a5c759b')) paddle.fluid.layers.sequence_first_step (ArgSpec(args=['input'], varargs=None, keywords=None, defaults=None), ('document', '2b290d3d77882bfe9bb8d331cac8cdd3')) paddle.fluid.layers.sequence_last_step (ArgSpec(args=['input'], varargs=None, keywords=None, defaults=None), ('document', 'c16a892f44f7fe71bfa5afc32d3f34ce')) paddle.fluid.layers.sequence_slice (ArgSpec(args=['input', 'offset', 'length', 'name'], varargs=None, keywords=None, defaults=(None,)), ('document', 'fdcea0e8b5bc7d8d4b1b072c521014e6')) @@ -200,7 +200,7 @@ paddle.fluid.layers.gaussian_random_batch_size_like (ArgSpec(args=['input', 'sha paddle.fluid.layers.sum (ArgSpec(args=['x'], varargs=None, keywords=None, defaults=None), ('document', '4527fd90e222f67b5f7451fb0cf7c845')) paddle.fluid.layers.slice (ArgSpec(args=['input', 'axes', 'starts', 'ends'], varargs=None, keywords=None, defaults=None), ('document', '3ca6a761570d86e303e473afba99bb49')) paddle.fluid.layers.shape (ArgSpec(args=['input'], varargs=None, keywords=None, defaults=None), ('document', 'bf61c8f79d795a8371bdb3b5468aa82b')) -paddle.fluid.layers.rank (ArgSpec(args=['input'], varargs=None, keywords=None, defaults=None), ('document', 'ee1386c42ecc8f424fe3fb21862fefc2')) +paddle.fluid.layers.rank (ArgSpec(args=['input'], varargs=None, keywords=None, defaults=None), ('document', '096df0e0273145ab80ed119a4c294db3')) paddle.fluid.layers.logical_and (ArgSpec(args=['x', 'y', 'out', 'name'], varargs=None, keywords=None, defaults=(None, None)), ('document', 'cdcf20c494c92060d10feb9374532f42')) paddle.fluid.layers.logical_or (ArgSpec(args=['x', 'y', 'out', 'name'], varargs=None, keywords=None, defaults=(None, None)), ('document', '0eae3f726a4afe590757552fa3ced012')) paddle.fluid.layers.logical_xor (ArgSpec(args=['x', 'y', 'out', 'name'], varargs=None, keywords=None, defaults=(None, None)), ('document', 'b0daaa3fa4a0aa62f9b58c43d959eb25')) @@ -236,8 +236,8 @@ paddle.fluid.layers.npair_loss (ArgSpec(args=['anchor', 'positive', 'labels', 'l paddle.fluid.layers.pixel_shuffle (ArgSpec(args=['x', 'upscale_factor'], varargs=None, keywords=None, defaults=None), ('document', '132b6e74ff642a392bd6b14c10aedc65')) paddle.fluid.layers.fsp_matrix (ArgSpec(args=['x', 'y'], varargs=None, keywords=None, defaults=None), ('document', '20992b20d19c2e5983f366150827b4a6')) paddle.fluid.layers.continuous_value_model (ArgSpec(args=['input', 'cvm', 'use_cvm'], varargs=None, keywords=None, defaults=(True,)), ('document', '94e2819b7c9715ea71b62e9c78f36b29')) -paddle.fluid.layers.where (ArgSpec(args=['condition'], varargs=None, keywords=None, defaults=None), ('document', '3126e3039e752ce26077f1efaca355c6')) -paddle.fluid.layers.sign (ArgSpec(args=['x'], varargs=None, keywords=None, defaults=None), ('document', 'ccf6bb7912afd2818d24bc45461e807a')) +paddle.fluid.layers.where (ArgSpec(args=['condition'], varargs=None, keywords=None, defaults=None), ('document', 'a477a6434faaa1917b84e8e1e3e114c8')) +paddle.fluid.layers.sign (ArgSpec(args=['x'], varargs=None, keywords=None, defaults=None), ('document', 'fa2f457a81714430c5677c2d68744728')) paddle.fluid.layers.deformable_conv (ArgSpec(args=['input', 'offset', 'mask', 'num_filters', 'filter_size', 'stride', 'padding', 'dilation', 'groups', 'deformable_groups', 'im2col_step', 'param_attr', 'bias_attr', 'name'], varargs=None, keywords=None, defaults=(1, 0, 1, None, None, None, None, None, None)), ('document', 'c896b66265a60bd3c5510f66e6e02919')) paddle.fluid.layers.unfold (ArgSpec(args=['x', 'kernel_sizes', 'strides', 'paddings', 'dilations', 'name'], varargs=None, keywords=None, defaults=(1, 0, 1, None)), ('document', '3f884662ad443d9ecc2b3734b4f61ad6')) paddle.fluid.layers.deformable_roi_pooling (ArgSpec(args=['input', 'rois', 'trans', 'no_trans', 'spatial_scale', 'group_size', 'pooled_height', 'pooled_width', 'part_size', 'sample_per_part', 'trans_std', 'position_sensitive', 'name'], varargs=None, keywords=None, defaults=(False, 1.0, [1, 1], 1, 1, None, 1, 0.1, False, None)), ('document', '65b8dbe13e00c4dc8224652f6ff89540')) @@ -277,7 +277,7 @@ paddle.fluid.layers.isfinite (ArgSpec(args=['x'], varargs=None, keywords=None, d paddle.fluid.layers.range (ArgSpec(args=['start', 'end', 'step', 'dtype'], varargs=None, keywords=None, defaults=None), ('document', '2ec937ede953ded2fdff2675883900bb')) paddle.fluid.layers.linspace (ArgSpec(args=['start', 'stop', 'num', 'dtype'], varargs=None, keywords=None, defaults=None), ('document', '495e21e9a848c2d075a102802fc67756')) paddle.fluid.layers.zeros_like (ArgSpec(args=['x', 'out'], varargs=None, keywords=None, defaults=(None,)), ('document', 'c7e4cfffc93ae89c8f6f53b6d650f923')) -paddle.fluid.layers.diag (ArgSpec(args=['diagonal'], varargs=None, keywords=None, defaults=None), ('document', '2964d07340e32e47efb6e5db619875c7')) +paddle.fluid.layers.diag (ArgSpec(args=['diagonal'], varargs=None, keywords=None, defaults=None), ('document', '88a15e15f0098d549f07a01eaebf9ce3')) paddle.fluid.layers.While.__init__ (ArgSpec(args=['self', 'cond', 'is_test', 'name'], varargs=None, keywords=None, defaults=(False, None)), ('document', '6adf97f83acf6453d4a6a4b1070f3754')) paddle.fluid.layers.While.block (ArgSpec(args=['self'], varargs=None, keywords=None, defaults=None), ('document', '6adf97f83acf6453d4a6a4b1070f3754')) paddle.fluid.layers.Switch.__init__ (ArgSpec(args=['self', 'name'], varargs=None, keywords=None, defaults=(None,)), ('document', '6adf97f83acf6453d4a6a4b1070f3754')) @@ -287,11 +287,11 @@ paddle.fluid.layers.increment (ArgSpec(args=['x', 'value', 'in_place'], varargs= paddle.fluid.layers.array_write (ArgSpec(args=['x', 'i', 'array'], varargs=None, keywords=None, defaults=(None,)), ('document', '3f913b5069ad40bd85d89b33e4aa5939')) paddle.fluid.layers.create_array (ArgSpec(args=['dtype'], varargs=None, keywords=None, defaults=None), ('document', '2d4f20087080ba5105b55205ad5c5b6a')) paddle.fluid.layers.less_than (ArgSpec(args=['x', 'y', 'force_cpu', 'cond'], varargs=None, keywords=None, defaults=(None, None)), ('document', 'eb41e5993f705fcfa354024054a75f5f')) -paddle.fluid.layers.less_equal (ArgSpec(args=['x', 'y', 'cond'], varargs=None, keywords=None, defaults=(None,)), ('document', 'd6b173ae1a149e0bdfe7b8bf69285957')) -paddle.fluid.layers.greater_than (ArgSpec(args=['x', 'y', 'cond'], varargs=None, keywords=None, defaults=(None,)), ('document', '2c9bd414caa6c615539018d27001b44c')) -paddle.fluid.layers.greater_equal (ArgSpec(args=['x', 'y', 'cond'], varargs=None, keywords=None, defaults=(None,)), ('document', '62c667d24e7b07e166b47a53b61b2ff4')) +paddle.fluid.layers.less_equal (ArgSpec(args=['x', 'y', 'cond'], varargs=None, keywords=None, defaults=(None,)), ('document', '7b6d952a9f6340a044cfb91c16aad842')) +paddle.fluid.layers.greater_than (ArgSpec(args=['x', 'y', 'cond'], varargs=None, keywords=None, defaults=(None,)), ('document', '55710e2fafeda70cd1b53d7509712499')) +paddle.fluid.layers.greater_equal (ArgSpec(args=['x', 'y', 'cond'], varargs=None, keywords=None, defaults=(None,)), ('document', '14bff27b2be5e60eaa30e41925265beb')) paddle.fluid.layers.equal (ArgSpec(args=['x', 'y', 'cond'], varargs=None, keywords=None, defaults=(None,)), ('document', '788aa651e8b9fec79d16931ef3a33e90')) -paddle.fluid.layers.not_equal (ArgSpec(args=['x', 'y', 'cond'], varargs=None, keywords=None, defaults=(None,)), ('document', '56148fb1024687a08e96af79bdc5c929')) +paddle.fluid.layers.not_equal (ArgSpec(args=['x', 'y', 'cond'], varargs=None, keywords=None, defaults=(None,)), ('document', '57adebb8858ffab6be2d86d0522b85dc')) paddle.fluid.layers.array_read (ArgSpec(args=['array', 'i'], varargs=None, keywords=None, defaults=None), ('document', 'caf0d94349cdc28e1bda3b8a19411ac0')) paddle.fluid.layers.array_length (ArgSpec(args=['array'], varargs=None, keywords=None, defaults=None), ('document', '6f24a9b872027634ad758ea2826c9727')) paddle.fluid.layers.IfElse.__init__ (ArgSpec(args=['self', 'cond', 'name'], varargs=None, keywords=None, defaults=(None,)), ('document', '6adf97f83acf6453d4a6a4b1070f3754')) diff --git a/python/paddle/fluid/layers/control_flow.py b/python/paddle/fluid/layers/control_flow.py index d073c15b023..b13c4870664 100644 --- a/python/paddle/fluid/layers/control_flow.py +++ b/python/paddle/fluid/layers/control_flow.py @@ -1031,6 +1031,10 @@ def less_equal(x, y, cond=None): Examples: .. code-block:: python + import paddle.fluid as fluid + + label = fluid.layers.data(name='label', shape=[1], dtype='int64') + limit = fluid.layers.fill_constant(shape=[1], value=1, dtype='int64') out = fluid.layers.less_equal(x=label, y=limit) """ helper = LayerHelper("less_equal", **locals()) @@ -1067,6 +1071,10 @@ def greater_than(x, y, cond=None): Examples: .. code-block:: python + import paddle.fluid as fluid + + label = fluid.layers.data(name='label', shape=[1], dtype='int64') + limit = fluid.layers.fill_constant(shape=[1], value=1, dtype='int64') out = fluid.layers.greater_than(x=label, y=limit) """ helper = LayerHelper("greater_than", **locals()) @@ -1103,7 +1111,12 @@ def greater_equal(x, y, cond=None): Examples: .. code-block:: python + import paddle.fluid as fluid + + label = fluid.layers.data(name='label', shape=[1], dtype='int64') + limit = fluid.layers.fill_constant(shape=[1], value=1, dtype='int64') out = fluid.layers.greater_equal(x=label, y=limit) + """ helper = LayerHelper("greater_equal", **locals()) if cond is None: @@ -1169,6 +1182,10 @@ def not_equal(x, y, cond=None): Examples: .. code-block:: python + import paddle.fluid as fluid + + label = fluid.layers.data(name='label', shape=[1], dtype='int64') + limit = fluid.layers.fill_constant(shape=[1], value=1, dtype='int64') out = fluid.layers.not_equal(x=label, y=limit) """ helper = LayerHelper("not_equal", **locals()) diff --git a/python/paddle/fluid/layers/nn.py b/python/paddle/fluid/layers/nn.py index 1c5fa4aa3ff..184c550daab 100644 --- a/python/paddle/fluid/layers/nn.py +++ b/python/paddle/fluid/layers/nn.py @@ -4911,15 +4911,19 @@ def reduce_all(input, dim=None, keep_dim=False, name=None): Examples: .. code-block:: python + import paddle.fluid.layers as layers + import numpy as np + # x is a bool Tensor variable with following elements: # [[True, False] # [True, True]] - # Each example is followed by the correspending output tensor. - fluid.layers.reduce_all(x) # False - fluid.layers.reduce_all(x, dim=0) # [True, False] - fluid.layers.reduce_all(x, dim=-1) # [False, True] - fluid.layers.reduce_all(x, dim=1, - keep_dim=True) # [[False], [True]] + x = layers.assign(np.array([[1, 0], [1, 1]], dtype='int32')) + x = layers.cast(x, 'bool') + + out = layers.reduce_all(x) # False + out = layers.reduce_all(x, dim=0) # [True, False] + out = layers.reduce_all(x, dim=-1) # [False, True] + out = layers.reduce_all(x, dim=1, keep_dim=True) # [[False], [True]] """ helper = LayerHelper('reduce_all', **locals()) @@ -4961,14 +4965,19 @@ def reduce_any(input, dim=None, keep_dim=False, name=None): Examples: .. code-block:: python + import paddle.fluid.layers as layers + import numpy as np + # x is a bool Tensor variable with following elements: # [[True, False] # [False, False]] - # Each example is followed by the correspending output tensor. - fluid.layers.reduce_any(x) # True - fluid.layers.reduce_any(x, dim=0) # [True, False] - fluid.layers.reduce_any(x, dim=-1) # [True, False] - fluid.layers.reduce_any(x, dim=1, + x = layers.assign(np.array([[1, 0], [0, 0]], dtype='int32')) + x = layers.cast(x, 'bool') + + out = layers.reduce_any(x) # True + out = layers.reduce_any(x, dim=0) # [True, False] + out = layers.reduce_any(x, dim=-1) # [True, False] + out = layers.reduce_any(x, dim=1, keep_dim=True) # [[True], [False]] """ @@ -9791,9 +9800,10 @@ def rank(input): Examples: .. code-block:: python - input = layers.data( - name="input", shape=[3, 100, 100], dtype="float32") - rank = layers.rank(input) # 4 + import paddle.fluid as fluid + + input = fluid.layers.data(name="input", shape=[3, 100, 100], dtype="float32") + rank = fluid.layers.rank(input) # 4 """ ndims = len(input.shape) @@ -11876,14 +11886,24 @@ def where(condition): Examples: .. code-block:: python + import paddle.fluid.layers as layers + import numpy as np + # condition is a tensor [True, False, True] - out = fluid.layers.where(condition) # [[0], [2]] + condition = layers.assign(np.array([1, 0, 1], dtype='int32')) + condition = layers.cast(condition, 'bool') + out = layers.where(condition) # [[0], [2]] # condition is a tensor [[True, False], [False, True]] - out = fluid.layers.where(condition) # [[0, 0], [1, 1]] + condition = layers.assign(np.array([[1, 0], [0, 1]], dtype='int32')) + condition = layers.cast(condition, 'bool') + out = layers.where(condition) # [[0, 0], [1, 1]] # condition is a tensor [False, False, False] - out = fluid.layers.where(condition) # [[]] + condition = layers.assign(np.array([0, 0, 0], dtype='int32')) + condition = layers.cast(condition, 'bool') + out = layers.where(condition) # [[]] + """ helper = LayerHelper("where", **locals()) @@ -11910,8 +11930,12 @@ def sign(x): Examples: .. code-block:: python + import paddle.fluid as fluid + import numpy as np + # [1, 0, -1] - data = fluid.layers.sign(np.array([3, 0, -2])) + data = fluid.layers.sign(np.array([3, 0, -2], dtype='int32')) + """ helper = LayerHelper("sign", **locals()) diff --git a/python/paddle/fluid/layers/tensor.py b/python/paddle/fluid/layers/tensor.py index 92d5e819e5d..0450f2c4892 100644 --- a/python/paddle/fluid/layers/tensor.py +++ b/python/paddle/fluid/layers/tensor.py @@ -957,7 +957,10 @@ def diag(diagonal): # [[3, 0, 0] # [0, 4, 0] # [0, 0, 5] - data = fluid.layers.diag(np.arange(3, 6)) + + import paddle.fluid as fluid + import numpy as np + data = fluid.layers.diag(np.arange(3, 6, dtype='int32')) """ -- GitLab