supplet several interface of static Variable to consistent with dygraph Tensor (#33330)

As the title

Author: CtfGo

paddle/fluid/operators/share_data_op.cc

@@ -0,0 +1,72 @@
+/* Copyright (c) 2021 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. */
+
+#include "paddle/fluid/operators/share_data_op.h"
+#include "paddle/fluid/framework/op_registry.h"
+
+namespace paddle {
+namespace operators {
+
+class ShareDataOp : public framework::OperatorWithKernel {
+ public:
+  using framework::OperatorWithKernel::OperatorWithKernel;
+
+  void InferShape(framework::InferShapeContext *ctx) const override {
+    OP_INOUT_CHECK(ctx->HasInput("X"), "Input", "X", "ShareData");
+    OP_INOUT_CHECK(ctx->HasOutput("Out"), "Output", "Out", "ShareData");
+    auto in_type = ctx->GetInputsVarType("X")[0];
+    auto out_type = ctx->GetOutputsVarType("Out")[0];
+
+    PADDLE_ENFORCE_EQ(
+        in_type == framework::proto::VarType::LOD_TENSOR ||
+            in_type == framework::proto::VarType::SELECTED_ROWS,
+        true, platform::errors::InvalidArgument(
+                  "Type of Variable[X] must be LoDTensor or SelectedRows!"));
+    PADDLE_ENFORCE_EQ(
+        in_type, out_type,
+        platform::errors::InvalidArgument(
+            "The type of input (X) and output (Out) are inconsistent."));
+
+    ctx->ShareDim("X", "Out");
+  }
+};
+
+class ShareDataOpMaker : public framework::OpProtoAndCheckerMaker {
+ public:
+  void Make() override {
+    AddInput("X", "(Tensor), The input tensor of share_data op");
+    AddOutput("Out", "(Tensor), The output tensor of share_data op");
+    AddComment(R"DOC(
+ShareData Operator.
+
+Return a tensor $Out$ that shares data with the input tensor $X$ and without tensor copy.
+)DOC");
+  }
+};
+
+}  // namespace operators
+}  // namespace paddle
+
+namespace ops = paddle::operators;
+REGISTER_OPERATOR(
+    share_data, ops::ShareDataOp, ops::ShareDataOpMaker,
+    paddle::framework::EmptyGradOpMaker<paddle::framework::OpDesc>,
+    paddle::framework::EmptyGradOpMaker<paddle::imperative::OpBase>);
+REGISTER_OP_CPU_KERNEL(share_data, ops::ShareDataKernel<bool>,
+                       ops::ShareDataKernel<int>, ops::ShareDataKernel<int8_t>,
+                       ops::ShareDataKernel<uint8_t>,
+                       ops::ShareDataKernel<paddle::platform::float16>,
+                       ops::ShareDataKernel<int64_t>,
+                       ops::ShareDataKernel<float>,
+                       ops::ShareDataKernel<double>)

paddle/fluid/operators/share_data_op.cu

@@ -0,0 +1,25 @@
+/* Copyright (c) 2021 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. */
+
+#include "paddle/fluid/operators/share_data_op.h"
+
+REGISTER_OP_CUDA_KERNEL(
+    share_data, paddle::operators::ShareDataKernel<bool>,
+    paddle::operators::ShareDataKernel<int>,
+    paddle::operators::ShareDataKernel<int8_t>,
+    paddle::operators::ShareDataKernel<uint8_t>,
+    paddle::operators::ShareDataKernel<paddle::platform::float16>,
+    paddle::operators::ShareDataKernel<int64_t>,
+    paddle::operators::ShareDataKernel<float>,
+    paddle::operators::ShareDataKernel<double>);

paddle/fluid/operators/share_data_op.h

@@ -0,0 +1,41 @@
+/* Copyright (c) 2021 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. */
+
+#pragma once
+#include "paddle/fluid/framework/op_registry.h"
+
+namespace paddle {
+namespace operators {
+
+template <typename T>
+class ShareDataKernel : public framework::OpKernel<T> {
+ public:
+  void Compute(const framework::ExecutionContext &ctx) const override {
+    auto *in_var = ctx.InputVar("X");
+    auto *out_var = ctx.OutputVar("Out");
+    if (in_var->IsType<framework::LoDTensor>()) {
+      const auto &origin_tensor = in_var->Get<framework::LoDTensor>();
+      auto *detach_tensor = out_var->GetMutable<framework::LoDTensor>();
+      detach_tensor->ShareDataWith(origin_tensor);
+    } else {
+      const auto &origin_selected_rows = in_var->Get<framework::SelectedRows>();
+      auto *detach_selected_rows =
+          out_var->GetMutable<framework::SelectedRows>();
+      detach_selected_rows->mutable_value()->ShareDataWith(
+          origin_selected_rows.value());
+    }
+  }
+};
+}  // namespace operators
+}  // namespace paddle

python/paddle/fluid/framework.py

@@ -947,35 +947,43 @@ def __init__(self,
         self._stop_gradient = stop_gradient
         self.is_data = is_data
 
-    @fake_interface_only
     def detach(self):
         """
-        **Notes**:
-            **This API is ONLY available in Dygraph mode**
-
         Returns a new Variable, detached from the current graph.
+        It will share data with origin Variable and without tensor copy.
+        In addition, the detached Variable doesn't provide gradient propagation.
 
         Returns:
              ( :ref:`api_guide_Variable_en` | dtype is same as current Variable): The detached Variable.
 
-
         Examples:
             .. code-block:: python
 
-                import paddle.fluid as fluid
-                from paddle.fluid.dygraph.base import to_variable
-                from paddle.fluid.dygraph import Linear
-                import numpy as np
+                import paddle
 
-                data = np.random.uniform(-1, 1, [30, 10, 32]).astype('float32')
-                with fluid.dygraph.guard():
-                    linear = Linear(32, 64)
-                    data = to_variable(data)
-                    x = linear(data)
-                    y = x.detach()
+                paddle.enable_static()
+
+                # create a static Variable
+                x = paddle.static.data(name='x', shape=[3, 2, 1])
 
+                # create a detached Variable
+                y = x.detach()
         """
-        pass
+
+        assert self.type == core.VarDesc.VarType.SELECTED_ROWS or \
+            self.type == core.VarDesc.VarType.LOD_TENSOR, \
+            "only support a variable with SELECTED_ROWS or LOD_TENSOR to be detached"
+
+        output = self.block.create_var(
+            name=unique_name.generate_with_ignorable_key("detach_" + self.name),
+            dtype=self.dtype,
+            type=self.type,
+            persistable=self.persistable,
+            stop_gradient=True)
+
+        self.block.append_op(
+            type='share_data', inputs={'X': [self]}, outputs={'Out': [output]})
+        return output
 
     @fake_interface_only
     def numpy(self):
@@ -1810,6 +1818,35 @@ def set_value(self, value, scope=None):
 
         t.set(value, place)
 
+    def size(self):
+        """
+        Returns the number of elements for current Variable, which is a int64 Variable with shape [1]
+
+        Returns:
+            Variable: the number of elements for current Variable
+
+        Examples:
+            .. code-block:: python
+
+                import paddle
+
+                paddle.enable_static()
+
+                # create a static Variable
+                x = paddle.static.data(name='x', shape=[3, 2, 1])
+
+                # get the number of elements of the Variable
+                y = x.size()
+        """
+
+        output = self.block.create_var(
+            name=unique_name.generate_with_ignorable_key(self.name + "_size"),
+            dtype=core.VarDesc.VarType.INT64)
+
+        self.block.append_op(
+            type='size', inputs={'Input': [self]}, outputs={'Out': [output]})
+        return output
+
 
 def get_all_op_protos():
     """

python/paddle/fluid/layers/math_op_patch.py

@@ -45,6 +45,7 @@
     "__rpow__": "A **= B",
     "__floordiv__": "A //B",
     "__mod__": "A % B",
+    "__matmul__": "A @ B",
     "__eq__": "A == B",
     "__ne__": "A != B",
     "__lt__": "A < B",
@@ -195,6 +196,28 @@ def _scalar_op_(var, scale, bias):
     def _neg_(var):
         return _scalar_op_(var, -1.0, 0.0)
 
+    @property
+    def _ndim_(self):
+        """
+        Returns the dimension of current Variable
+
+        Returns:
+            the dimension
+
+        Examples:
+            .. code-block:: python
+
+                import paddle
+
+                paddle.enable_static()
+
+                # create a static Variable
+                x = paddle.static.data(name='x', shape=[3, 2, 1])
+                # print the dimension of the Variable
+                print(x.ndim)
+        """
+        return len(self.shape)
+
     def _scalar_add_(var, value):
         return _scalar_op_(var, 1.0, value)
 
@@ -228,17 +251,17 @@ def __impl__(self, other_var):
                 other_var = float(other_var)
                 # division is a special case
                 # NOTE(chenweihang): because we cast tensor to float32 instead float64,
-                # the division result can only guarantee the numerical accuracy of 6 digits 
-                # after the decimal point. The result of numpy calculation is of float64 type, 
-                # so the calculation result here and the calculation result of numpy are 
+                # the division result can only guarantee the numerical accuracy of 6 digits
+                # after the decimal point. The result of numpy calculation is of float64 type,
+                # so the calculation result here and the calculation result of numpy are
                 # different after 6 decimal point. If necessary, we can also use float64 here.
                 # torch's behavior here is consistent with ours
                 if op_type == 'elementwise_div' and self.dtype in _supported_int_dtype_:
                     self = astype(self, 'float32')
                 # here use `scale` replace `elementwise` to get better performance
                 # but only +, -, * can use this method
                 # NOTE(chentianyu03): / can not use `scale` method，because the result of
-                # `scale` method (self*(1/other_var)) do not exactly equal with the result 
+                # `scale` method (self*(1/other_var)) do not exactly equal with the result
                 # of `elementwise_div` method.
                 if scalar_method is not None:
                     return scalar_method(self, other_var)
@@ -321,6 +344,9 @@ def __impl__(self, other_var):
         #   b=-a
         ('__neg__', _neg_),
         ('astype', astype),
+        ('dim', lambda x: len(x.shape)),
+        ('ndimension', lambda x: len(x.shape)),
+        ('ndim', _ndim_),
         ('__add__', _binary_creator_('__add__', 'elementwise_add', False,
                                      _scalar_add_)),
         #  a+b == b+a. Do not need to reverse explicitly
@@ -347,6 +373,8 @@ def __impl__(self, other_var):
                                           'elementwise_floordiv', False, None)),
         ('__mod__', _binary_creator_('__mod__', 'elementwise_mod', False,
                                      None)),
+        ('__matmul__', _binary_creator_('__matmul__', "matmul_v2", False,
+                                        None)),
         #  for logical compare
         ('__eq__', _binary_creator_('__eq__', 'equal', False, None)),
         ('__ne__', _binary_creator_('__ne__', 'not_equal', False, None)),

python/paddle/fluid/tests/unittests/test_detach.py

@@ -149,12 +149,6 @@ def test_NoDetachSingle_DetachMulti(self):
         array_detach_multi = self.detach_multi()
         assert np.array_equal(array_no_detach_single, array_detach_multi)
 
-    def test_detach_exception(self):
-        x = fluid.layers.data(name="a", shape=[3, 4], dtype='float32')
-        y = fluid.layers.fc(input=x, size=10, bias_attr=True)
-        with self.assertRaises(AssertionError):
-            y_detach = y.detach()
-
 
 class TestInplace(unittest.TestCase):
     def test_forward_version(self):

python/paddle/fluid/tests/unittests/test_math_op_patch.py

@@ -271,7 +271,6 @@ def test_astype(self):
                        fetch_list=[b])
         self.assertTrue(numpy.allclose(a_np.astype('float32'), b_np))
 
-    @prog_scope()
     def test_bitwise_and(self):
         x_np = np.random.randint(-100, 100, [2, 3, 5]).astype("int32")
         y_np = np.random.randint(-100, 100, [2, 3, 5]).astype("int32")
@@ -336,6 +335,28 @@ def test_bitwise_not(self):
                       fetch_list=[z])
         self.assertTrue(np.array_equal(out[0], out_np))
 
+    @prog_scope()
+    def test_ndim(self):
+        a = paddle.static.data(name="a", shape=[10, 1])
+        self.assertEqual(a.dim(), 2)
+        self.assertEqual(a.ndimension(), 2)
+        self.assertEqual(a.ndim, 2)
+
+    @prog_scope()
+    def test_matmul(self):
+        a = paddle.static.data(name='a', shape=[2, 3], dtype='float32')
+        b = paddle.static.data(name='b', shape=[3, 5], dtype='float32')
+        c = a @b  # __matmul__
+        a_np = numpy.random.uniform(-1, 1, size=[2, 3]).astype('float32')
+        b_np = numpy.random.uniform(-1, 1, size=[3, 5]).astype('float32')
+        place = paddle.CPUPlace()
+        exe = paddle.static.Executor(place)
+        c_np = exe.run(paddle.static.default_main_program(),
+                       feed={"a": a_np,
+                             "b": b_np},
+                       fetch_list=[c])
+        self.assertTrue(numpy.allclose(a_np @b_np, c_np))
+
 
 if __name__ == '__main__':
     unittest.main()