Refactor dygraph to eager -- Autograd info (PaddlePaddle#37406)

* Add EagerTensor and tests

* remove useless enforce

* remove comment in cmake

* support autograd meta

* support grad node info test

* support grad_node_info

* add more edge test

* remove Python.h

* refine error code

* add error type in error msg

* given default null name for tensor

paddle/fluid/CMakeLists.txt

@@ -12,6 +12,5 @@ add_subdirectory(operators)
 add_subdirectory(string)
 add_subdirectory(pybind)
 add_subdirectory(eager)
-
 # NOTE: please add subdirectory inference at last.
 add_subdirectory(inference)

paddle/fluid/eager/CMakeLists.txt

@@ -1 +1,3 @@
 add_subdirectory(tests)
+cc_library(grad_node_info SRCS grad_node_info.cc DEPS pten pten_api)
+cc_library(autograd_meta SRCS autograd_meta.cc DEPS pten pten_api)

paddle/fluid/eager/autograd_meta.cc

@@ -0,0 +1,17 @@
+// 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/eager/autograd_meta.h"
+// We Leave this to make autograd meta can be compiled as a single target.
+namespace egr {}  // namespace egr

paddle/fluid/eager/autograd_meta.h

@@ -0,0 +1,155 @@
+// 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/eager/grad_node_info.h"
+
+namespace egr {
+
+using AbstractAutogradMeta = paddle::experimental::AbstractAutogradMeta;
+/**
+ *
+ * AutogradMeta is what record the backward info for tensor. When we run
+ * computation
+ * graph eagerly, we can not build a static paddle program like static mode do,
+ * so we
+ * need a new method to record forward info to trace backward when we finish all
+ * forward
+ * computation. This require our AutogradMeta class record following main
+ * members
+ *
+ * 1. grad_op:
+ * Grad_op indicate the grad operation of the forward op
+ *
+ * 2. grad:
+ * Grad is the gradient of forward Tensor, which should be compute after
+ * backward computation
+ *
+ * NOTE: grad should only be available when current tensor is a leaf tensor, and
+ * for non-leaf
+ * tensor grad is only available while user set `retain_grad` option as `true`.
+ *
+ * TODO(jiabin) : support hooks
+ * 3. hooks:
+ * Hooks are some computation logic which only attached with backward operation,
+ * it registered
+ * by user and run before accumulator.
+ *
+ * 4.overrided_stop_gradient_
+ * This member is used to finish some auto-prune related work, which indicate
+ * user set stop_gradient
+ * should overrided the result indicated by framework. All non-parameter
+ * tensor's stop_gradient
+ * properties should be true. We will pass stop_gradient when we find one who
+ * need it.
+ *
+ * NOTE: AutogradMeta is inherited from AbstractAutogradMeta which is defined
+ * in tensor's deps,
+ * we did this to avoid additional dependency on Autograd. In eager execution,
+ * we will cast
+ * AbstractAutogradMeta as AutogradMeta to use it.
+ *
+ * **/
+
+// No other AutogradMeta class should be derivated from AbstractAutogradMeta.
+// It's only used by
+class AutogradMeta : public AbstractAutogradMeta {
+ public:
+  explicit AutogradMeta(const Edge& edge = Edge()) {
+    out_slot_id_ = edge.GetEdgeRankInfo().first;
+    out_rank_ = edge.GetEdgeRankInfo().second;
+    grad_node_ = edge.GetMutableGradNode();
+  }
+
+  ~AutogradMeta() override = default;
+
+  const egr::EagerTensor& Grad() const { return grad_; }
+
+  egr::EagerTensor* MutableGrad() { return &grad_; }
+
+  void SetGradNode(const std::shared_ptr<GradNodeBase>& grad_node) {
+    PADDLE_ENFORCE_NOT_NULL(
+        grad_node.get(),
+        paddle::platform::errors::InvalidArgument(
+            "Should Not set NULL as GradNode pointer, since "
+            "our default Edge and autogradMeta has nullptr for "
+            "grad node. Set Nullptr will lead error."));
+    grad_node_ = grad_node;
+  }
+
+  std::shared_ptr<GradNodeBase> GetMutableGradNode() const {
+    return grad_node_;
+  }
+
+  GradNodeBase* GradNode() const { return grad_node_.get(); }
+
+  void SetSingleOutRankWithSlot(size_t slot_id, size_t rank) {
+    out_slot_id_ = slot_id;
+    out_rank_ = rank;
+  }
+
+  std::pair</* slot id */ size_t, /* rank in slot */ size_t> OutRankInfo()
+      const {
+    return std::make_pair(out_slot_id_, out_rank_);
+  }
+
+  bool IsInitialized() { return grad_node_.get(); }
+
+  // TODO(jiabin): This may cause error, since -1 still can indication true;
+  bool StopGradient() const { return stop_gradient_ != 0; }
+
+  int NumericStopGradient() const { return stop_gradient_; }
+
+  void SetStopGradient(bool stop_gradient) {
+    stop_gradient_ = static_cast<int>(stop_gradient);
+  }
+
+  bool Persistable() const { return persistable_; }
+
+  void SetPersistable(bool persistable) { persistable_ = persistable; }
+
+ private:
+  // TODO(jiabin) :Should we use pointer instead of object?
+  egr::EagerTensor grad_;
+
+  // GradNodeBase is base class of all grad op which is a
+  // wrapper for grad op. This class will make grad op easy
+  // to be traced.
+  std::shared_ptr<GradNodeBase> grad_node_;
+
+  /**
+   * Why we need slot id here?
+   * Because in paddle most of our operators inputs and outputs
+   * are assemble in form of {"slot name", vector<tensor>}.
+   * So its better for us to set a slot id to fit this format. **/
+  size_t out_slot_id_;
+
+  // output rank of forward op, this is a vital num, since
+  // we are now trying to make our forward output is as same
+  // sequence as backward input. In case of tracing backward
+  // sequence we need to record output rank in slot here.
+  size_t out_rank_;
+
+  // TODO(jiabin) :Support hooks here and store it in AutogradMeta
+
+  // Stop gradient flag to indicate should we compute backward
+  int stop_gradient_{-1};
+
+  bool persistable_{false};
+
+  // TODO(jiabin) :Support Quantum here and add cache mechanism as
+  // VarCache defined in VarBase
+};
+}  // namespace egr