eager.cc 55.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
/* 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. */
// disable numpy compile error
12 13
#include "paddle/fluid/pybind/eager.h"

14
#include <Python.h>
15 16 17 18
// Avoid a problem with copysign defined in pyconfig.h on Windows.
#ifdef copysign
#undef copysign
#endif
19 20 21 22

#include <string>
#include <vector>

23
#include "paddle/fluid/eager/accumulation/accumulation_node.h"
24 25 26
#include "paddle/fluid/eager/api/all.h"
#include "paddle/fluid/eager/autograd_meta.h"
#include "paddle/fluid/eager/utils.h"
27
#include "paddle/fluid/framework/convert_utils.h"
28 29 30 31
#include "paddle/fluid/memory/allocation/allocator.h"
#include "paddle/fluid/memory/memcpy.h"
#include "paddle/fluid/platform/enforce.h"
#include "paddle/fluid/pybind/eager_utils.h"
32 33 34
#include "paddle/phi/common/data_type.h"
#include "paddle/phi/core/compat/convert_utils.h"
#include "paddle/phi/core/dense_tensor.h"
35
#include "pybind11/detail/internals.h"
36 37
#include "pybind11/numpy.h"
#include "pybind11/pybind11.h"
38
#pragma GCC diagnostic ignored "-Wmissing-field-initializers"
39
#include "paddle/fluid/framework/phi_utils.h"
40
#include "paddle/fluid/framework/python_headers.h"
41
#include "paddle/fluid/pybind/exception.h"
42
#include "paddle/fluid/pybind/tensor_py.h"
J
Jack Zhou 已提交
43
#include "paddle/phi/core/string_tensor.h"
L
LiYuRio 已提交
44 45 46 47

#ifdef PADDLE_WITH_DISTRIBUTE
#include "paddle/phi/core/distributed/auto_parallel/dist_attr.h"
#include "paddle/phi/core/distributed/auto_parallel/dist_tensor.h"
48
using phi::distributed::DistTensor;
49
using phi::distributed::TensorDistAttr;
L
LiYuRio 已提交
50 51
#endif

52 53 54 55 56
namespace paddle {
namespace pybind {

namespace py = ::pybind11;

57 58
extern PyTypeObject* p_tensor_type;
extern PyTypeObject* p_string_tensor_type;  // For StringTensor
59
extern PyTypeObject* g_vartype_pytype;
60
extern PyTypeObject* g_framework_tensor_pytype;
61

62
PyObject* TensorNew(PyTypeObject* type, PyObject* args, PyObject* kwargs) {
63 64
  PyObject* obj = type->tp_alloc(type, 0);
  if (obj) {
65
    auto v = reinterpret_cast<TensorObject*>(obj);
66
    new (&(v->tensor)) paddle::Tensor();
67 68 69 70
  }
  return obj;
}

71
// TODO(jiabin): Overload this once we need more constructor in Python
72 73
void EmptyTensorInitializer(TensorObject* self,
                            const std::string& name,
74
                            const paddle::platform::Place& place,
75 76
                            bool persistable = false,
                            int stop_gradient = -1,
77 78
                            framework::proto::VarType::Type dtype =
                                paddle::framework::proto::VarType::FP32,
79
                            const std::vector<int>& dims = {0},
80 81
                            framework::proto::VarType::Type var_type =
                                paddle::framework::proto::VarType::LOD_TENSOR) {
82
  auto ddims = phi::make_ddim(dims);
83 84
  self->tensor.set_name(name);
  auto autograd_meta = egr::EagerUtils::autograd_meta(&(self->tensor));
85
  autograd_meta->SetPersistable(persistable);
86 87 88
  if (stop_gradient != -1) {
    autograd_meta->SetStopGradient(static_cast<bool>(stop_gradient));
  }
89 90
  if (var_type == paddle::framework::proto::VarType::LOD_TENSOR) {
    // TODO(jiabin): Maybe support LOD later
91
    std::shared_ptr<phi::DenseTensor> dense_tensor = nullptr;
92
    if (dims.size() == 1 && dims[0] == 0) {
93 94 95 96 97 98 99 100
      std::shared_ptr<phi::Allocation> allocation_ptr = nullptr;
      dense_tensor = std::make_shared<phi::DenseTensor>(
          allocation_ptr,
          phi::DenseTensorMeta(paddle::framework::TransToPhiDataType(dtype),
                               ddims));
    } else {
      // TODO(dev): we need enhance check for ddims.
      dense_tensor = std::make_shared<phi::DenseTensor>(
Z
zyfncg 已提交
101
          std::make_shared<phi::Allocation>(),
102 103 104
          phi::DenseTensorMeta(paddle::framework::TransToPhiDataType(dtype),
                               ddims));
    }
105
    self->tensor.set_impl(dense_tensor);
106 107 108 109
  } else if (var_type == paddle::framework::proto::VarType::SELECTED_ROWS) {
    std::shared_ptr<phi::SelectedRows> tensor =
        std::make_shared<phi::SelectedRows>();
    self->tensor.set_impl(tensor);
110 111 112
  }

  if (!autograd_meta->GetMutableGradNode()) {
113 114
    autograd_meta->SetGradNode(
        std::make_shared<egr::GradNodeAccumulation>(autograd_meta));
115 116 117
    VLOG(3) << "Tensor(" << name
            << ") have not GradNode, add GradNodeAccumulation"
            << autograd_meta->GradNode() << " for it.";
118 119 120
  }
}

121 122
void EmptyStringTensorInitializer(TensorObject* self,
                                  const std::string& name,
J
Jack Zhou 已提交
123 124 125 126 127 128 129
                                  const paddle::platform::Place& place,
                                  const std::vector<int>& dims = {}) {
  auto ddims = phi::make_ddim(dims);
  self->tensor.set_name(name);
  // Note(zhoushunjie): Only support CPUPlace when create StringTensor
  auto actual_place = platform::CPUPlace();
  // Allocate memory
130
  paddle::experimental::DefaultAllocator string_allocator(actual_place);
J
Jack Zhou 已提交
131
  std::shared_ptr<phi::StringTensor> string_tensor =
132 133
      std::make_shared<phi::StringTensor>(&string_allocator,
                                          phi::StringTensorMeta{ddims});
J
Jack Zhou 已提交
134 135 136 137 138 139
  if (phi::product(ddims) > 0) {
    string_tensor->mutable_data(actual_place);
  }
  self->tensor.set_impl(string_tensor);
}

L
LiYuRio 已提交
140
#ifdef PADDLE_WITH_DISTRIBUTE
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
void CreateDistTensorWithNumpyValue(TensorObject* self,
                                    const std::string& name,
                                    const paddle::platform::Place& place,
                                    const TensorDistAttr& dist_attr,
                                    const py::object& array,
                                    bool persistable = false,
                                    int stop_gradient = -1,
                                    bool zero_copy = false,
                                    framework::proto::VarType::Type dtype =
                                        paddle::framework::proto::VarType::FP32,
                                    const std::vector<int>& dims = {0}) {
  auto ddims = phi::make_ddim(dims);
  self->tensor.set_name(name);
  auto autograd_meta = egr::EagerUtils::autograd_meta(&(self->tensor));
  autograd_meta->SetPersistable(persistable);
  if (stop_gradient != -1) {
    autograd_meta->SetStopGradient(static_cast<bool>(stop_gradient));
  }

  phi::DenseTensor dense_tensor;
  if (dims.size() == 1 && dims[0] == 0) {
    std::shared_ptr<phi::Allocation> allocation_ptr = nullptr;
    dense_tensor = phi::DenseTensor(
        nullptr,
        phi::DenseTensorMeta(paddle::framework::TransToPhiDataType(dtype),
                             ddims));
  } else {
    dense_tensor = phi::DenseTensor(
        std::make_shared<phi::Allocation>(),
        phi::DenseTensorMeta(paddle::framework::TransToPhiDataType(dtype),
                             ddims));
  }
L
LiYuRio 已提交
173 174

  if (platform::is_cpu_place(place)) {
175 176
    SetTensorFromPyArray<platform::CPUPlace>(
        &dense_tensor, array, place, zero_copy);
L
LiYuRio 已提交
177
  } else if (platform::is_xpu_place(place)) {
178 179
    SetTensorFromPyArray<platform::XPUPlace>(
        &dense_tensor, array, place, zero_copy);
L
LiYuRio 已提交
180 181
  } else if (platform::is_gpu_place(place)) {
    SetTensorFromPyArray<platform::CUDAPlace>(
182
        &dense_tensor, array, place, zero_copy);
L
LiYuRio 已提交
183 184
  } else if (platform::is_cuda_pinned_place(place)) {
    SetTensorFromPyArray<platform::CUDAPinnedPlace>(
185
        &dense_tensor, array, place, zero_copy);
L
LiYuRio 已提交
186 187
  } else if (platform::is_custom_place(place)) {
    SetTensorFromPyArray<platform::CustomPlace>(
188
        &dense_tensor, array, place, zero_copy);
L
LiYuRio 已提交
189 190 191 192 193 194
  } else {
    PADDLE_THROW(platform::errors::InvalidArgument(
        "Place should be one of "
        "CPUPlace/XPUPlace/CUDAPlace/CUDAPinnedPlace/CustomPlace"));
  }

195 196 197 198 199 200 201 202 203 204 205
  auto dist_tensor =
      std::make_shared<phi::distributed::DistTensor>(dense_tensor, dist_attr);
  self->tensor.set_impl(dist_tensor);

  if (!autograd_meta->GetMutableGradNode()) {
    autograd_meta->SetGradNode(
        std::make_shared<egr::GradNodeAccumulation>(autograd_meta));
    VLOG(3) << "Tensor(" << name
            << ") have not GradNode, add GradNodeAccumulation"
            << autograd_meta->GradNode() << " for it.";
  }
L
LiYuRio 已提交
206 207 208
}
#endif

209 210
void InitTensorWithNumpyValue(TensorObject* self,
                              const py::object& array,
211
                              const paddle::platform::Place& place,
212
                              bool zero_copy = false) {
213
  PADDLE_ENFORCE_EQ(
214 215
      self->tensor.defined(),
      true,
216
      paddle::platform::errors::Unavailable(
217 218
          "Calling InitTensorWithNumpyValue of Eager Tensor without "
          "EmptyTensorInitializer is "
219 220
          "forbidden. Please check your code and make sure you new a "
          "eager tensor before init it with NumPy."));
221 222
  phi::DenseTensor* impl_ptr =
      static_cast<phi::DenseTensor*>(self->tensor.impl().get());
L
LiYuRio 已提交
223

224
  if (platform::is_cpu_place(place)) {
225
    SetTensorFromPyArray<platform::CPUPlace>(impl_ptr, array, place, zero_copy);
226
  } else if (platform::is_xpu_place(place)) {
227
    SetTensorFromPyArray<platform::XPUPlace>(impl_ptr, array, place, zero_copy);
228
  } else if (platform::is_gpu_place(place)) {
229 230
    SetTensorFromPyArray<platform::CUDAPlace>(
        impl_ptr, array, place, zero_copy);
231
  } else if (platform::is_cuda_pinned_place(place)) {
232 233
    SetTensorFromPyArray<platform::CUDAPinnedPlace>(
        impl_ptr, array, place, zero_copy);
234
  } else if (platform::is_custom_place(place)) {
235 236
    SetTensorFromPyArray<platform::CustomPlace>(
        impl_ptr, array, place, zero_copy);
237 238 239
  } else {
    PADDLE_THROW(platform::errors::InvalidArgument(
        "Place should be one of "
张春乔 已提交
240
        "CPUPlace/XPUPlace/CUDAPlace/CUDAPinnedPlace/CustomPlace"));
241 242 243
  }
}

J
Jack Zhou 已提交
244 245
void InitStringTensorWithNumpyValue(TensorObject* self, const py::object& obj) {
  PADDLE_ENFORCE_EQ(
246 247
      self->tensor.defined(),
      true,
J
Jack Zhou 已提交
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
      paddle::platform::errors::Fatal(
          "Calling InitStringTensorWithNumpyValue of Eager StringTensor "
          "without "
          "EmptyStringTensorInitializer is "
          "forbidden. Please check your code and make sure you new a "
          "eager tensor before init it with NumPy."));
  phi::StringTensor* impl_ptr =
      static_cast<phi::StringTensor*>(self->tensor.impl().get());
  paddle::platform::Place place = impl_ptr->place();
  auto array = obj.cast<py::array>();
  if (platform::is_cpu_place(place)) {
    SetStringTensorFromPyArray<platform::CPUPlace>(impl_ptr, array, place);
  } else {
    PADDLE_THROW(platform::errors::InvalidArgument(
        "StringTensor only support CPUPlace now, but receive %s",
        place.DebugString()));
  }
}

L
LiYuRio 已提交
267
#ifdef PADDLE_WITH_DISTRIBUTE
268 269 270 271 272
void InitDistTensorWithTensor(TensorObject* self,
                              const paddle::Tensor& src,
                              const paddle::platform::Place& place,
                              const std::string& name,
                              const TensorDistAttr& dist_attr) {
L
LiYuRio 已提交
273 274 275 276 277 278 279
  PADDLE_ENFORCE(src.is_dense_tensor(),
                 paddle::platform::errors::InvalidArgument(
                     "DistTensor can only initialize by DenseTensor"));
  self->tensor.set_name(name);
  if (place == src.place()) {
    std::shared_ptr<phi::DenseTensor> tensor =
        std::static_pointer_cast<phi::DenseTensor>(src.impl());
280
    self->tensor.set_impl(std::make_shared<DistTensor>(*tensor, dist_attr));
281
    VLOG(4) << "Same place, do ShareDataWith for DistTensor.";
L
LiYuRio 已提交
282 283 284 285
  } else {
    std::shared_ptr<phi::DenseTensor> tensor =
        std::static_pointer_cast<phi::DenseTensor>(
            src.copy_to(place, true).impl());
286
    self->tensor.set_impl(std::make_shared<DistTensor>(*tensor, dist_attr));
287
    VLOG(4) << "Different place, do TensorCopy for DistTensor.";
L
LiYuRio 已提交
288 289 290 291 292 293 294 295 296 297 298
  }
  if (src.get_autograd_meta()) {
    egr::EagerUtils::autograd_meta(&(self->tensor))
        ->SetPersistable(
            egr::EagerUtils::unsafe_autograd_meta(src)->Persistable());
  } else {
    egr::EagerUtils::autograd_meta(&(self->tensor))->SetPersistable(false);
  }
}
#endif

299
void InitTensorWithTensor(TensorObject* self,
300
                          const paddle::Tensor& src,
301 302
                          const paddle::platform::Place& place,
                          const std::string& name) {
303
  self->tensor.set_name(name);
C
Chen Weihang 已提交
304
  if (place == src.place()) {
305
    self->tensor.set_impl(src.impl());
306 307
    VLOG(4) << "Same place, do ShareDataWith";
  } else {
308
    self->tensor.set_impl(src.copy_to(place, true).impl());
309 310 311
    VLOG(4) << "Different place, do TensorCopy";
  }
  if (src.get_autograd_meta()) {
312
    egr::EagerUtils::autograd_meta(&(self->tensor))
313 314 315
        ->SetPersistable(
            egr::EagerUtils::unsafe_autograd_meta(src)->Persistable());
  } else {
316
    egr::EagerUtils::autograd_meta(&(self->tensor))->SetPersistable(false);
317 318 319
  }
}

320
void InitTensorWithFrameworkTensor(TensorObject* self,
321
                                   const phi::DenseTensor& src,
322 323
                                   const paddle::platform::Place& place,
                                   const std::string& name) {
324
  self->tensor.set_name(name);
325
  if (place == src.place()) {
326
    self->tensor.set_impl(std::make_shared<phi::DenseTensor>(src));
327 328
    VLOG(4) << "Same place, do ShareDataWith";
  } else {
329
    auto temp = paddle::Tensor(std::make_shared<phi::DenseTensor>(src));
330
    self->tensor.set_impl(temp.copy_to(place, true).impl());
331 332
    VLOG(4) << "Different place, do TensorCopy";
  }
333
  egr::EagerUtils::autograd_meta(&(self->tensor))->SetPersistable(false);
334
}
335

J
Jack Zhou 已提交
336
void InitStringTensorWithStringTensor(TensorObject* self,
337
                                      const paddle::Tensor& src,
J
Jack Zhou 已提交
338 339 340 341 342 343 344 345 346
                                      const paddle::platform::Place& place,
                                      const std::string& name) {
  self->tensor.set_name(name);
  auto impl = std::static_pointer_cast<phi::StringTensor>(src.impl());
  self->tensor.set_impl(impl);
  VLOG(4)
      << "Do ShareDataWith when using StringTensor to initialize StringTensor";
}

347 348
py::object ParsePyArray(
    std::unordered_map<std::string, PyObject*> kws_map,
349 350 351 352
    std::unordered_map<std::string, Py_ssize_t> kw_order_map,
    PyObject* args,
    bool flag_kwargs,
    Py_ssize_t args_num) {
353 354 355 356 357 358
  py::object numpy_value = py::object();

  if (kw_order_map["value"] <= args_num) {
    numpy_value = py::object(
        py::handle(PyTuple_GET_ITEM(args, kw_order_map["value"] - 1)), true);
  } else {
359
    if (flag_kwargs && kws_map["value"] != nullptr) {
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
      numpy_value = py::object(py::handle(kws_map["value"]), true);
    } else {
      PADDLE_THROW(platform::errors::InvalidArgument(
          "The first expected arguments is {value: PyArray}, "
          "but could not parse the first argument {value: PyArray} "
          "successfully. "
          "Please check your input first and make sure you are on the right "
          "way."));
    }
  }
  return numpy_value;
}

paddle::platform::Place ParsePlace(
    std::unordered_map<std::string, PyObject*> kws_map,
375 376 377 378
    std::unordered_map<std::string, Py_ssize_t> kw_order_map,
    PyObject* args,
    bool flag_kwargs,
    Py_ssize_t args_num) {
379 380 381 382 383 384 385
  paddle::platform::Place place =
      egr::Controller::Instance().GetExpectedPlace();

  if (kw_order_map["place"] <= args_num) {
    place = CastPyArg2Place(PyTuple_GET_ITEM(args, kw_order_map["place"] - 1),
                            kw_order_map["place"] - 1);
  } else {
386
    if (flag_kwargs && kws_map["place"] != nullptr) {
387 388 389 390 391 392 393 394 395
      place = CastPyArg2Place(kws_map["place"], 0);
    } else {
      // default
      return place;
    }
  }
  return place;
}

L
LiYuRio 已提交
396
#ifdef PADDLE_WITH_DISTRIBUTE
397
TensorDistAttr ParseDistAttrArgs(
L
LiYuRio 已提交
398 399 400 401 402
    std::unordered_map<std::string, PyObject*> kws_map,
    std::unordered_map<std::string, Py_ssize_t> kw_order_map,
    PyObject* args,
    bool flag_kwargs,
    Py_ssize_t args_num) {
403
  TensorDistAttr dist_attr;
L
LiYuRio 已提交
404 405 406 407
  if (kw_order_map["dist_attr"] <= args_num) {
    dist_attr = CastPyArg2DistAttr(
        PyTuple_GET_ITEM(args, kw_order_map["dist_attr"] - 1),
        kw_order_map["dist_attr"] - 1);
408
  } else if (flag_kwargs && kws_map["dist_attr"] != nullptr) {
L
LiYuRio 已提交
409 410 411 412 413 414
    dist_attr = CastPyArg2DistAttr(kws_map["dist_attr"], 0);
  }
  return dist_attr;
}
#endif

415
// boolean arguments: zero_copy, stop_gradient, persistable
416 417 418
int ParseBooleanArgs(std::string key,
                     std::unordered_map<std::string, PyObject*> kws_map,
                     std::unordered_map<std::string, Py_ssize_t> kw_order_map,
419 420 421
                     PyObject* args,
                     bool flag_kwargs,
                     Py_ssize_t args_num) {
422
  int res = -1;
423 424

  if (kw_order_map[key] <= args_num) {
425 426
    res = static_cast<int>(CastPyArg2AttrBoolean(
        PyTuple_GET_ITEM(args, kw_order_map[key] - 1), kw_order_map[key] - 1));
427
  } else {
428
    if (flag_kwargs && kws_map[key] != nullptr) {
429
      res = static_cast<int>(CastPyArg2AttrBoolean(kws_map[key], 0));
430 431 432 433 434 435 436
    }
  }
  return res;
}

std::string ParseName(std::unordered_map<std::string, PyObject*> kws_map,
                      std::unordered_map<std::string, Py_ssize_t> kw_order_map,
437 438 439
                      PyObject* args,
                      bool flag_kwargs,
                      Py_ssize_t args_num,
J
Jack Zhou 已提交
440
                      std::string unique_name_prefix = "generated_tensor") {
441 442 443 444 445
  std::string act_name = "";
  if (kw_order_map["name"] <= args_num) {
    PyObject* name_obj = PyTuple_GET_ITEM(args, kw_order_map["name"] - 1);
    if (name_obj == Py_None) {
      act_name =
J
Jack Zhou 已提交
446
          egr::Controller::Instance().GenerateUniqueName(unique_name_prefix);
447 448 449 450 451
    } else {
      act_name = CastPyArg2AttrString(name_obj, kw_order_map["name"] - 1);
    }
  } else {
    if (flag_kwargs) {
452
      if ((kws_map["name"] == nullptr) || (kws_map["name"] == Py_None)) {
453
        act_name =
J
Jack Zhou 已提交
454
            egr::Controller::Instance().GenerateUniqueName(unique_name_prefix);
455 456 457 458 459
      } else {
        act_name = CastPyArg2AttrString(kws_map["name"], 0);
      }
    } else {
      act_name =
J
Jack Zhou 已提交
460
          egr::Controller::Instance().GenerateUniqueName(unique_name_prefix);
461 462 463 464 465
    }
  }
  return act_name;
}

466
// initialize Tensor by PyArray(first argument is PyArray,
467
// mix args and kwargs) automatically.
468 469
void AutoInitTensorByPyArray(TensorObject* py_tensor_ptr,
                             std::unordered_map<std::string, PyObject*> kws_map,
470 471
                             PyObject* args,
                             bool flag_kwargs,
472 473 474
                             Py_ssize_t args_num) {
  // The first argument of the Tensor constructor is PyArray,
  // there are 6 arguments to construct the new Tensor,
475 476 477 478
  // kw_order_map's key is every arguments of the constructor,
  // kw_order_map's value is the position of the arguments respectively.
  // If u want to update this constructor with new arguments,
  // need to update this map and to add or change related code.
L
LiYuRio 已提交
479 480 481 482 483 484 485
  std::unordered_map<std::string, Py_ssize_t> kw_order_map{{"value", 1},
                                                           {"place", 2},
                                                           {"persistable", 3},
                                                           {"zero_copy", 4},
                                                           {"name", 5},
                                                           {"stop_gradient", 6},
                                                           {"dist_attr", 7}};
486 487 488 489 490 491 492

  py::object numpy_value = py::object();
  paddle::platform::Place place =
      egr::Controller::Instance().GetExpectedPlace();
  bool persistable = false;
  bool zero_copy = false;
  std::string act_name = "";
493
  int stop_gradient = -1;
494 495 496 497

  numpy_value =
      ParsePyArray(kws_map, kw_order_map, args, flag_kwargs, args_num);
  place = ParsePlace(kws_map, kw_order_map, args, flag_kwargs, args_num);
498 499 500 501 502 503 504 505
  persistable =
      (1 ==
       ParseBooleanArgs(
           "persistable", kws_map, kw_order_map, args, flag_kwargs, args_num));
  zero_copy =
      (1 ==
       ParseBooleanArgs(
           "zero_copy", kws_map, kw_order_map, args, flag_kwargs, args_num));
506
  act_name = ParseName(kws_map, kw_order_map, args, flag_kwargs, args_num);
507 508
  stop_gradient = ParseBooleanArgs(
      "stop_gradient", kws_map, kw_order_map, args, flag_kwargs, args_num);
509

L
LiYuRio 已提交
510
#ifdef PADDLE_WITH_DISTRIBUTE
511
  TensorDistAttr dist_attr =
L
LiYuRio 已提交
512 513
      ParseDistAttrArgs(kws_map, kw_order_map, args, flag_kwargs, args_num);

514 515 516 517 518 519 520 521 522
  if (!dist_attr.empty()) {
    CreateDistTensorWithNumpyValue(py_tensor_ptr,
                                   act_name,
                                   place,
                                   dist_attr,
                                   numpy_value,
                                   persistable,
                                   stop_gradient,
                                   zero_copy);
L
LiYuRio 已提交
523 524 525 526
    return;
  }
#endif

527 528
  EmptyTensorInitializer(
      py_tensor_ptr, act_name, place, persistable, stop_gradient);
529
  InitTensorWithNumpyValue(py_tensor_ptr, numpy_value, place, zero_copy);
530 531
}

532
// initialize Tensor by Tensor or phi::DenseTensor (mix args and
533
// kwargs) automatically.
534 535
void AutoInitTensorByTensor(TensorObject* py_tensor_ptr,
                            std::unordered_map<std::string, PyObject*> kws_map,
536 537
                            PyObject* args,
                            bool flag_kwargs,
538 539 540
                            Py_ssize_t args_num,
                            bool init_by_egr_tensor = true) {
  // The first argument of the Tensor constructor is Tensor or
541
  // framework Tensor,
542
  // there are 3 arguments to construct the new Tensor,
543 544 545 546 547
  // kw_order_map's key is every arguments of the constructor,
  // kw_order_map's value is the position of the arguments respectively.
  // If u want to update this constructor with new arguments,
  // need to update this map and to add or change related code.
  std::unordered_map<std::string, Py_ssize_t> kw_order_map{
L
LiYuRio 已提交
548
      {"value", 1}, {"place", 2}, {"name", 3}, {"dist_attr", 4}};
549 550 551 552 553 554 555 556

  paddle::platform::Place place =
      egr::Controller::Instance().GetExpectedPlace();
  std::string act_name = "";

  place = ParsePlace(kws_map, kw_order_map, args, flag_kwargs, args_num);
  act_name = ParseName(kws_map, kw_order_map, args, flag_kwargs, args_num);

L
LiYuRio 已提交
557
#ifdef PADDLE_WITH_DISTRIBUTE
558
  TensorDistAttr dist_attr =
L
LiYuRio 已提交
559 560 561
      ParseDistAttrArgs(kws_map, kw_order_map, args, flag_kwargs, args_num);
#endif

562
  if (init_by_egr_tensor) {
563
    paddle::Tensor src_tensor;
564
    if (kw_order_map["value"] <= args_num) {
565 566 567
      src_tensor =
          CastPyArg2Tensor(PyTuple_GET_ITEM(args, kw_order_map["value"] - 1),
                           kw_order_map["value"] - 1);
568
    } else {
569
      if (flag_kwargs && kws_map["value"] != nullptr) {
570
        src_tensor = CastPyArg2Tensor(kws_map["value"], 0);
571 572
      } else {
        PADDLE_THROW(platform::errors::InvalidArgument(
573 574
            "The first expected kwargs is {value: Tensor}, "
            "but could not parse the first argument {value: Tensor} "
575 576 577 578 579
            "successfully. "
            "Please check your input first and make sure you are on the right "
            "way."));
      }
    }
L
LiYuRio 已提交
580
#ifdef PADDLE_WITH_DISTRIBUTE
581
    if (!dist_attr.empty()) {
L
LiYuRio 已提交
582 583 584 585 586 587
      InitDistTensorWithTensor(
          py_tensor_ptr, src_tensor, place, act_name, dist_attr);
    } else {
      InitTensorWithTensor(py_tensor_ptr, src_tensor, place, act_name);
    }
#else
588
    InitTensorWithTensor(py_tensor_ptr, src_tensor, place, act_name);
L
LiYuRio 已提交
589
#endif
590 591
  } else {
    // init by framework tensor
592
    phi::DenseTensor src_tensor;
593 594 595 596 597
    if (kw_order_map["value"] <= args_num) {
      src_tensor = CastPyArg2FrameworkTensor(
          PyTuple_GET_ITEM(args, kw_order_map["value"] - 1),
          kw_order_map["value"] - 1);
    } else {
598
      if (flag_kwargs && kws_map["value"] != nullptr) {
599 600 601
        src_tensor = CastPyArg2FrameworkTensor(kws_map["value"], 0);
      } else {
        PADDLE_THROW(platform::errors::InvalidArgument(
602 603
            "The first expected arguments is {value: phi::DenseTensor}, "
            "but could not parse the first argument {value: phi::DenseTensor} "
604 605 606 607 608
            "successfully. "
            "Please check your input first and make sure you are on the right "
            "way."));
      }
    }
609
    InitTensorWithFrameworkTensor(py_tensor_ptr, src_tensor, place, act_name);
610 611 612
  }
}

J
Jack Zhou 已提交
613 614
void AutoInitStringTensorByPyArray(
    TensorObject* py_tensor_ptr,
615 616 617 618
    std::unordered_map<std::string, PyObject*> kws_map,
    PyObject* args,
    bool flag_kwargs,
    Py_ssize_t args_num) {
J
Jack Zhou 已提交
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
  // The first argument of the StringTensor constructor is PyArray,
  // there are 4 arguments to construct the new StringTensor,
  // kw_order_map's key is every arguments of the constructor,
  // kw_order_map's value is the position of the arguments respectively.
  // If u want to update this constructor with new arguments,
  // need to update this map and to add or change related code.
  std::unordered_map<std::string, Py_ssize_t> kw_order_map{{"value", 1},
                                                           {"name", 2}};
  py::object numpy_value = py::object();
  paddle::platform::Place place =
      egr::Controller::Instance().GetExpectedPlace();
  std::string act_name = "";

  numpy_value =
      ParsePyArray(kws_map, kw_order_map, args, flag_kwargs, args_num);
634 635 636 637 638
  act_name = ParseName(kws_map,
                       kw_order_map,
                       args,
                       flag_kwargs,
                       args_num,
J
Jack Zhou 已提交
639 640 641 642 643 644 645
                       "generated_string_tensor");
  EmptyStringTensorInitializer(py_tensor_ptr, act_name, place);
  InitStringTensorWithNumpyValue(py_tensor_ptr, numpy_value);
}

void AutoInitStringTensorByStringTensor(
    TensorObject* py_tensor_ptr,
646 647 648 649
    std::unordered_map<std::string, PyObject*> kws_map,
    PyObject* args,
    bool flag_kwargs,
    Py_ssize_t args_num) {
J
Jack Zhou 已提交
650 651 652 653 654 655 656 657 658 659 660 661 662
  // The first argument of the Tensor constructor is StringTensor,
  // there are 3 arguments to construct the new StringTensor,
  // kw_order_map's key is every arguments of the constructor,
  // kw_order_map's value is the position of the arguments respectively.
  // If u want to update this constructor with new arguments,
  // need to update this map and to add or change related code.
  std::unordered_map<std::string, Py_ssize_t> kw_order_map{{"value", 1},
                                                           {"name", 2}};

  paddle::platform::Place place =
      egr::Controller::Instance().GetExpectedPlace();
  std::string act_name = "";

663 664 665 666 667
  act_name = ParseName(kws_map,
                       kw_order_map,
                       args,
                       flag_kwargs,
                       args_num,
J
Jack Zhou 已提交
668
                       "generated_string_tensor");
669
  paddle::Tensor src_tensor;
J
Jack Zhou 已提交
670 671 672 673 674
  if (kw_order_map["value"] <= args_num) {
    src_tensor =
        CastPyArg2Tensor(PyTuple_GET_ITEM(args, kw_order_map["value"] - 1),
                         kw_order_map["value"] - 1);
  } else {
675
    if (flag_kwargs && kws_map["value"] != nullptr) {
J
Jack Zhou 已提交
676 677 678 679 680 681 682 683 684 685 686 687 688
      src_tensor = CastPyArg2Tensor(kws_map["value"], 0);
    } else {
      PADDLE_THROW(platform::errors::InvalidArgument(
          "The first expected kwargs is {value: Tensor}, "
          "but could not parse the first argument {value: Tensor} "
          "successfully. "
          "Please check your input first and make sure you are on the right "
          "way."));
    }
  }
  InitStringTensorWithStringTensor(py_tensor_ptr, src_tensor, place, act_name);
}

689
PyDoc_STRVAR(  // NOLINT
W
wanghuancoder 已提交
690 691 692 693 694 695 696 697 698 699 700 701 702
    TensorDoc,
    R"DOC(Tensor($self, /, value, place, persistable, zero_copy, name, stop_gradient, dims, dtype, type)
--

Tensor is the basic data structure in PaddlePaddle. There are some ways to create a Tensor:

- Use the exsiting ``data`` to create a Tensor, please refer to :ref:`api_paddle_to_tensor`.
- Create a Tensor with a specified ``shape``, please refer to :ref:`api_paddle_ones`,
  :ref:`api_paddle_zeros`, :ref:`api_paddle_full`.
- Create a Tensor with the same ``shape`` and ``dtype`` as other Tensor, please refer to
  :ref:`api_paddle_ones_like`, :ref:`api_paddle_zeros_like`, :ref:`api_paddle_full_like`.
)DOC");

703
/** We should have init function with signature:
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
 * 1.
 * def __init__ ()
 * 2.
 * def __init__ (
 * ** dtype: paddle::framework::proto::VarType::Type,
 * ** dims: vector<int>,
 * ** name: std::string,
 * ** type: paddle::framework::proto::VarType::LodTensor,
 * ** persistable: bool)
 * 3. (multi-place)
 * (should have at least one parameter, one parameter equals to case 4, zero
 * parameter equals to case 1)
 * def __init__ (
 * ** value: ndarray,
 * ** place: paddle::platform::Place,
 * ** persistable: bool,
 * ** zero_copy: bool,
 * ** name: std::string,
L
LiYuRio 已提交
722
 * ** stop_gradient: bool,
723
 * ** dist_attr: phi::distributed::TensorDistAttr)
724 725 726 727 728 729 730 731 732 733 734 735
 * 4.
 * def __init__ (
 * ** value: ndarray)
 * 5.
 * def __init__ (
 * ** tensor: Tensor)
 * 6. (multi-place)
 * (should have at least one parameter, one parameter equals to case 5, zero
 * parameter equals to case 1.)
 * def __init__ (
 * ** tensor: Tensor,
 * ** place: paddle::platform::Place,
L
LiYuRio 已提交
736
 * ** name: std::string,
737
 * ** dist_attr: phi::distributed::TensorDistAttr)
738 739 740 741 742 743 744
 * 7. (multi-place) (should have at least one parameter, one parameter similar
 * to case 5, zero parameter equals to case 1.)
 * def __init__ (
 * ** tensor: FrameworkTensor,
 * ** place: paddle::platform::Place,
 * ** name: std::string)
 *  **/
745
int TensorInit(PyObject* self, PyObject* args, PyObject* kwargs) {
0
0x45f 已提交
746
  EAGER_TRY
747 748 749 750 751
  // set a flag to record use kwargs or not
  bool flag_kwargs = false;
  if (kwargs) flag_kwargs = true;

  // all kwargs
752 753 754 755 756 757 758 759 760 761 762
  PyObject* kw_zero_copy = nullptr;
  PyObject* kw_persistable = nullptr;
  PyObject* kw_stop_gradient = nullptr;

  PyObject* kw_value = nullptr;  // receive PyArray or Tensor
  PyObject* kw_place = nullptr;
  PyObject* kw_name = nullptr;
  PyObject* kw_dims = nullptr;
  PyObject* kw_dtype = nullptr;
  PyObject* kw_type = nullptr;
  PyObject* kw_dist_attr = nullptr;
763 764

  // the keywords argument
765
  static char* kwlist[] = {const_cast<char*>("value"),  // NOLINT
766 767 768 769 770 771 772 773
                           const_cast<char*>("place"),
                           const_cast<char*>("persistable"),
                           const_cast<char*>("zero_copy"),
                           const_cast<char*>("name"),
                           const_cast<char*>("stop_gradient"),
                           const_cast<char*>("dims"),
                           const_cast<char*>("dtype"),
                           const_cast<char*>("type"),
L
LiYuRio 已提交
774
                           const_cast<char*>("dist_attr"),
775
                           nullptr};
776 777 778 779 780 781 782

  // 'O' Store a Python object (without any conversion) in a C object pointer,
  // '|' Indicates that the remaining arguments in the Python argument list are
  // optional.
  // PyArg_ParseTupleAndKeywords can Parse the parameters of a function that
  // takes both positional and keyword parameters into local variables,
  // which enhance case2, case3, case4, case5, case6, case7.
783 784
  bool flag_ = PyArg_ParseTupleAndKeywords(args,
                                           kwargs,
L
LiYuRio 已提交
785
                                           "|OOOOOOOOOO",
786 787 788 789 790 791 792 793 794
                                           kwlist,
                                           &kw_value,
                                           &kw_place,
                                           &kw_persistable,
                                           &kw_zero_copy,
                                           &kw_name,
                                           &kw_stop_gradient,
                                           &kw_dims,
                                           &kw_dtype,
L
LiYuRio 已提交
795 796
                                           &kw_type,
                                           &kw_dist_attr);
797 798 799 800 801 802 803 804 805 806 807

  // helper map
  std::unordered_map<std::string, PyObject*> kws_map{
      {"value", kw_value},
      {"place", kw_place},
      {"persistable", kw_persistable},
      {"zero_copy", kw_zero_copy},
      {"name", kw_name},
      {"stop_gradient", kw_stop_gradient},
      {"dims", kw_dims},
      {"dtype", kw_dtype},
L
LiYuRio 已提交
808 809
      {"type", kw_type},
      {"dist_attr", kw_dist_attr}};
810

811 812
  PADDLE_ENFORCE_EQ(flag_,
                    true,
813 814 815 816 817 818
                    paddle::platform::errors::PreconditionNotMet(
                        "Could not parse args and kwargs successfully, "
                        "please check your input first and make"
                        "sure you are on the right way. "
                        "The expected arguments as follow: ("
                        "value, place, persistable, zero_copy, "
L
LiYuRio 已提交
819
                        "name, stop_gradient, dims, dtype, type, dist_attr)"));
820

821
  PADDLE_ENFORCE_NOT_NULL(
822 823 824 825 826
      self,
      paddle::platform::errors::Fatal(
          "Calling __init__ of Eager Tensor without __new__ is "
          "forbidden. Please check your code and make sure you new a "
          "eager tensor before init it."));
827

828
  auto py_tensor_ptr = reinterpret_cast<TensorObject*>(self);
829 830

  Py_ssize_t args_num = PyTuple_Size(args);
831 832 833 834 835
  VLOG(6) << " args_num: " << args_num;

  // args_num = 0, means that there is no position arguments.
  if (args_num == (Py_ssize_t)0) {
    if (!flag_kwargs) {
836 837
      // case 1
      VLOG(6) << "Calling case1's initializer.";
838
      EmptyTensorInitializer(
839 840 841 842
          py_tensor_ptr,
          egr::Controller::Instance().GenerateUniqueName("generated_tensor"),
          egr::Controller::Instance().GetExpectedPlace());
      return 0;
843
    } else {  // no position args, all arguments are kwargs
844
      if (kw_value != nullptr) {
845 846
        if (pybind11::detail::npy_api::get().PyArray_Check_(kw_value)) {
          VLOG(6) << "Calling case3's or case4's initializer";
847 848
          AutoInitTensorByPyArray(
              py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
849
          return 0;
850
        } else if (PyObject_TypeCheck(kw_value, p_tensor_type)) {
851
          VLOG(6) << "Calling case5's or case6's initializer";
852 853
          AutoInitTensorByTensor(
              py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
854
          return 0;
855
        } else if (PyObject_TypeCheck(kw_value, g_framework_tensor_pytype)) {
856
          VLOG(6) << "Calling case7's initializer.";
857 858 859 860
          AutoInitTensorByTensor(py_tensor_ptr,
                                 kws_map,
                                 args,
                                 flag_kwargs,
861 862
                                 args_num,
                                 /* false means not init by egr tensor*/ false);
863
          return 0;
864
        } else {
865 866 867
          PADDLE_THROW(platform::errors::InvalidArgument(
              "Could not parse the first keyword argument successfully, "
              "the first keyword argument is value, but it should be PyArray "
868
              "or Tensor or phi::DenseTensor. "
869 870
              "Please check your input first and make sure you are on the "
              "right way."));
871
        }
872
      } else if (kw_dtype != nullptr &&
873
                 PyObject_TypeCheck(kw_dtype, g_vartype_pytype)) {
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
        VLOG(6) << "Calling case2's initializer";

        PADDLE_ENFORCE_NOT_NULL(
            kw_dims,
            paddle::platform::errors::InvalidArgument(
                "Calling __init__ of Eager Tensor with NULL dims is "
                "forbidden. Please check your code and make sure you new a "
                "dims before calling this constructor."));

        PADDLE_ENFORCE_NOT_NULL(
            kw_name,
            paddle::platform::errors::InvalidArgument(
                "Calling __init__ of Eager Tensor with NULL name is "
                "forbidden. Please check your code and make sure you new a "
                "name before calling this constructor."));

        PADDLE_ENFORCE_NOT_NULL(
            kw_dtype,
            paddle::platform::errors::InvalidArgument(
                "Calling __init__ of Eager Tensor with NULL dtype is "
                "forbidden. Please check your code and make sure you new a "
                "dtype before calling this constructor."));

        PADDLE_ENFORCE_NOT_NULL(
            kw_persistable,
            paddle::platform::errors::InvalidArgument(
                "Calling __init__ of Eager Tensor with NULL persistable is "
                "forbidden. Please check your code and make sure you new a "
                "persistable before calling this constructor."));

        paddle::framework::proto::VarType::Type dtype =
            CastPyArg2ProtoType(kw_dtype, 0);
        std::vector<int> dims = CastPyArg2VectorOfInt(kw_dims, 0);

908
        std::string act_name = "";
909
        if (kw_name == Py_None) {
910 911 912
          act_name = egr::Controller::Instance().GenerateUniqueName(
              "generated_tensor");
        } else {
913
          act_name = CastPyArg2AttrString(kw_name, 0);
914
        }
915 916 917 918 919

        paddle::framework::proto::VarType::Type var_type =
            CastPyArg2ProtoType(kw_type, 0);
        bool persistable = CastPyArg2AttrBoolean(kw_persistable, 0);

920 921
        EmptyTensorInitializer(py_tensor_ptr,
                               act_name,
922 923
                               egr::Controller::Instance().GetExpectedPlace(),
                               persistable,
924 925 926 927
                               /* stop_gradient */ -1,
                               dtype,
                               dims,
                               var_type);
928

929
        return 0;
930 931
      } else {
        PADDLE_THROW(platform::errors::InvalidArgument(
932
            "We not only support construct Tensor from numpy value "
933
            "or tensor(Tensor or phi::DenseTensor) "
934
            "with python kwargs by this initializer, "
935
            "but also even support dtype to init a empty Tensor. "
936 937
            "Please check your input first and make sure you call the existed "
            "constructor."));
938
      }
939 940 941
    }
  } else if (args_num == (Py_ssize_t)1 || args_num == (Py_ssize_t)2 ||
             args_num == (Py_ssize_t)3) {
C
co63oc 已提交
942
    // 1 to 3 position args, remaining arguments are kwargs
943 944 945
    PyObject* arg0_ptr = PyTuple_GET_ITEM(args, 0);
    if (pybind11::detail::npy_api::get().PyArray_Check_(arg0_ptr)) {
      VLOG(6) << "Calling case3's or case4's initializer.";
946 947
      AutoInitTensorByPyArray(
          py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
948
      return 0;
949
    } else if (PyObject_TypeCheck(arg0_ptr, p_tensor_type)) {
950
      VLOG(6) << "Calling case5's or case6's initializer.";
951 952
      AutoInitTensorByTensor(
          py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
953
      return 0;
954
    } else if (PyObject_TypeCheck(arg0_ptr, g_framework_tensor_pytype)) {
955
      VLOG(6) << "Calling case7's initializer.";
956 957 958 959
      AutoInitTensorByTensor(py_tensor_ptr,
                             kws_map,
                             args,
                             flag_kwargs,
960 961
                             args_num,
                             /* false means not init by egr tensor*/ false);
962 963 964
      return 0;
    } else {
      PADDLE_THROW(platform::errors::InvalidArgument(
965
          "We support construct Tensor from numpy value "
966
          "or tensor(Tensor or phi::DenseTensor) "
967
          "with python args and kwargs by this initializer, "
968
          "but the first argument should be PyArray or Tensor or "
969
          "phi::DenseTensor. "
970 971
          "Please check your input first and make sure you call the existed "
          "constructor."));
972
    }
973
  } else if (args_num == (Py_ssize_t)4) {
C
co63oc 已提交
974
    // 4 position args, remaining arguments are kwargs
975 976 977
    PyObject* arg0_ptr = PyTuple_GET_ITEM(args, 0);
    if (pybind11::detail::npy_api::get().PyArray_Check_(arg0_ptr)) {
      VLOG(6) << "Calling case3's or case4's initializer.";
978 979
      AutoInitTensorByPyArray(
          py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
980
      return 0;
981 982 983
    } else {
      PADDLE_THROW(platform::errors::InvalidArgument(
          "Incompatible constructor arguments, "
C
co63oc 已提交
984
          "there are 4 position args and remaining arguments arg kwargs,"
985 986 987
          "but the first position args should be PyArray. "
          "Please check your code and make sure the first position args is "
          "PyArray."));
988
    }
989 990
  } else if (args_num == (Py_ssize_t)5) {
    if (!flag_kwargs) {
991
      PyObject* arg0_ptr = PyTuple_GET_ITEM(args, 0);
992
      if (PyObject_TypeCheck(arg0_ptr, g_vartype_pytype)) {
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
        VLOG(6) << "Calling case2's initializer.";
        paddle::framework::proto::VarType::Type dtype =
            CastPyArg2ProtoType(PyTuple_GET_ITEM(args, 0), 0);
        std::vector<int> dims =
            CastPyArg2VectorOfInt(PyTuple_GET_ITEM(args, 1), 1);
        std::string act_name = "";
        PyObject* name_obj = PyTuple_GET_ITEM(args, 2);
        if (name_obj == Py_None) {
          act_name = egr::Controller::Instance().GenerateUniqueName(
              "generated_tensor");
        } else {
          act_name = CastPyArg2AttrString(PyTuple_GET_ITEM(args, 2), 2);
        }
        paddle::framework::proto::VarType::Type var_type =
            CastPyArg2ProtoType(PyTuple_GET_ITEM(args, 3), 3);
        bool persistable = CastPyArg2AttrBoolean(PyTuple_GET_ITEM(args, 4), 4);
1009 1010
        EmptyTensorInitializer(py_tensor_ptr,
                               act_name,
1011
                               egr::Controller::Instance().GetExpectedPlace(),
1012 1013 1014 1015 1016
                               persistable,
                               -1,
                               dtype,
                               dims,
                               var_type);
1017
        return 0;
1018 1019
      } else if (pybind11::detail::npy_api::get().PyArray_Check_(arg0_ptr)) {
        VLOG(6) << "Calling case3's initializer.";
1020 1021
        AutoInitTensorByPyArray(
            py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
1022 1023 1024
        return 0;
      } else {
        PADDLE_THROW(platform::errors::InvalidArgument(
1025 1026 1027 1028 1029
            "Incompatible constructor arguments, "
            "there are only 5 position args,"
            "but the first position args should be PyArray or dtype. "
            "Please check your code and make sure you call the existed "
            "constructor."));
1030
      }
C
co63oc 已提交
1031
    } else {  // five position args, remaining arguments are kwargs
1032
      PyObject* arg0_ptr = PyTuple_GET_ITEM(args, 0);
1033 1034
      if (pybind11::detail::npy_api::get().PyArray_Check_(arg0_ptr)) {
        VLOG(6) << "Calling case3's or case4's initializer";
1035 1036
        AutoInitTensorByPyArray(
            py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
1037
        return 0;
1038
      } else {
1039 1040
        PADDLE_THROW(platform::errors::InvalidArgument(
            "Incompatible constructor arguments, "
C
co63oc 已提交
1041
            "there are 5 position args and remaining arguments are kwargs,"
1042 1043 1044
            "but the first position args should be PyArray. "
            "Please check your code and make sure the first position args is "
            "PyArray."));
1045 1046
      }
    }
1047 1048 1049 1050
  } else if (args_num == (Py_ssize_t)6) {
    if (!flag_kwargs) {
      // case 3
      VLOG(6) << "Calling case3's initializer.";
1051 1052
      AutoInitTensorByPyArray(
          py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
1053
      return 0;
C
co63oc 已提交
1054
    } else {  // six position args, remaining arguments are kwargs, but this
1055 1056 1057
              // is not a right way
      PADDLE_THROW(platform::errors::InvalidArgument(
          "Incompatible constructor arguments, "
C
co63oc 已提交
1058
          "there are 6 position args and the remaining arguments are kwargs. "
1059 1060
          "Please check your code and make sure the first position args is "
          "PyArray."));
1061
    }
1062 1063 1064 1065
  } else {
    PADDLE_THROW(platform::errors::Fatal(
        "Can't not find expected num of args, please check your call, and "
        "make sure u call the existed constructor."));
1066
  }
1067

0
0x45f 已提交
1068 1069
  return -1;
  EAGER_CATCH_AND_THROW_RETURN_NEG
1070 1071
}

J
Jack Zhou 已提交
1072
/** We should have init function with signature:
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
 * 1.
 * def __init__ ()
 *
 * 2.
 * def __init__ (
 * ** dims: vector<int>,
 * ** name: std::string)
 *
 * 3.
 * (should have at least one parameter, one parameter equals to case 4, zero
 * parameter equals to case 1)
 * def __init__ (
 * ** value: ndarray,
 * ** zero_copy: bool,
 * ** name: std::string)
 *
 * 4.
 * def __init__ (
 * ** value: ndarray)
 *
 * 5.
 * def __init__ (
 * ** tensor: Tensor)
 *
 * 6.
 * (should have at least one parameter, one parameter equals to case 5, zero
 * parameter equals to case 1.)
 * def __init__ (
 * ** tensor: Tensor,
 * ** name: std::string)
 * **/
J
Jack Zhou 已提交
1104 1105 1106 1107 1108 1109
int StringTensorInit(PyObject* self, PyObject* args, PyObject* kwargs) {
  // set a flag to record use kwargs or not
  bool flag_kwargs = false;
  if (kwargs) flag_kwargs = true;

  // all kwargs
1110
  PyObject* kw_zero_copy = nullptr;
J
Jack Zhou 已提交
1111

1112 1113 1114
  PyObject* kw_value = nullptr;  // receive PyArray or Tensor
  PyObject* kw_name = nullptr;
  PyObject* kw_dims = nullptr;
J
Jack Zhou 已提交
1115 1116

  // the keywords argument
1117
  static char* kwlist[] = {const_cast<char*>("value"),  // NOLINT
1118 1119 1120
                           const_cast<char*>("zero_copy"),
                           const_cast<char*>("name"),
                           const_cast<char*>("dims"),
1121
                           nullptr};
J
Jack Zhou 已提交
1122 1123 1124 1125 1126 1127
  // 'O' Store a Python object (without any conversion) in a C object pointer,
  // '|' Indicates that the remaining arguments in the Python argument list are
  // optional.
  // PyArg_ParseTupleAndKeywords can Parse the parameters of a function that
  // takes both positional and keyword parameters into local variables,
  // which enhance case1, case2, case3, case4, case 5, case 6.
1128 1129 1130 1131 1132 1133 1134 1135
  bool flag_ = PyArg_ParseTupleAndKeywords(args,
                                           kwargs,
                                           "|OOOO",
                                           kwlist,
                                           &kw_value,
                                           &kw_zero_copy,
                                           &kw_name,
                                           &kw_dims);
J
Jack Zhou 已提交
1136 1137 1138 1139 1140 1141 1142 1143

  // helper map
  std::unordered_map<std::string, PyObject*> kws_map{
      {"value", kw_value},
      {"zero_copy", kw_zero_copy},
      {"name", kw_name},
      {"dims", kw_dims}};

1144 1145
  PADDLE_ENFORCE_EQ(flag_,
                    true,
J
Jack Zhou 已提交
1146 1147 1148 1149 1150 1151 1152 1153
                    paddle::platform::errors::PreconditionNotMet(
                        "Could not parse args and kwargs successfully, "
                        "please check your input first and make"
                        "sure you are on the right way. "
                        "The expected arguments as follow: ("
                        "value, zero_copy, name, dims)"));

  PADDLE_ENFORCE_NOT_NULL(
1154 1155 1156 1157 1158
      self,
      paddle::platform::errors::Fatal(
          "Calling __init__ of Eager Tensor without __new__ is "
          "forbidden. Please check your code and make sure you new a "
          "eager tensor before init it."));
J
Jack Zhou 已提交
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169

  auto py_tensor_ptr = reinterpret_cast<TensorObject*>(self);

  Py_ssize_t args_num = PyTuple_Size(args);
  VLOG(6) << " args_num: " << args_num;
  // args_num = 0, means that there is no position arguments.
  if (args_num == (Py_ssize_t)0) {
    if (!flag_kwargs) {
      // case 1
      VLOG(6) << "Calling case1's string initializer.";
      EmptyStringTensorInitializer(
1170 1171 1172
          py_tensor_ptr,
          egr::Controller::Instance().GenerateUniqueName(
              "generated_string_tensor"),
J
Jack Zhou 已提交
1173 1174 1175
          egr::Controller::Instance().GetExpectedPlace());
      return 0;
    } else {
1176
      if (kw_value != nullptr) {
J
Jack Zhou 已提交
1177 1178
        if (pybind11::detail::npy_api::get().PyArray_Check_(kw_value)) {
          VLOG(6) << "Calling case3's or case4's string initializer";
1179 1180
          AutoInitStringTensorByPyArray(
              py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
J
Jack Zhou 已提交
1181
          return 0;
1182
        } else if (PyObject_TypeCheck(kw_value, p_string_tensor_type)) {
J
Jack Zhou 已提交
1183
          VLOG(6) << "Calling case5's or case6's string initializer";
1184 1185
          AutoInitStringTensorByStringTensor(
              py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
J
Jack Zhou 已提交
1186 1187 1188 1189 1190 1191 1192 1193 1194
          return 0;
        } else {
          PADDLE_THROW(platform::errors::InvalidArgument(
              "Could not parse the first keyword argument successfully, "
              "the first keyword argument is value, but it should be PyArray "
              "or StringTensor."
              "Please check your input first and make sure you are on the "
              "right way."));
        }
1195
      } else if (kw_dims != nullptr) {
J
Jack Zhou 已提交
1196 1197 1198 1199 1200
        VLOG(6) << "Calling case2's string initializer.";
        std::unordered_map<std::string, Py_ssize_t> kw_order_map{{"dims", 1},
                                                                 {"name", 2}};

        std::vector<int> dims = CastPyArg2VectorOfInt(kw_dims, 0);
1201 1202 1203 1204 1205 1206
        std::string act_name = ParseName(kws_map,
                                         kw_order_map,
                                         args,
                                         flag_kwargs,
                                         args_num,
                                         "generated_string_tensor");
J
Jack Zhou 已提交
1207
        EmptyStringTensorInitializer(
1208 1209 1210 1211
            py_tensor_ptr,
            act_name,
            egr::Controller::Instance().GetExpectedPlace(),
            dims);
J
Jack Zhou 已提交
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
        return 0;
      } else {
        PADDLE_THROW(platform::errors::InvalidArgument(
            "We not only support construct Tensor from numpy value "
            "or StringTensor with python kwargs by this initializer, "
            "but also even support dtype to init a empty StringTensor. "
            "Please check your input first and make sure you call the existed "
            "constructor."));
      }
    }
  } else if (args_num == (Py_ssize_t)1) {  // case 3 ~ 6
C
co63oc 已提交
1223
    // 1 position args, remaining arguments are kwargs
J
Jack Zhou 已提交
1224 1225 1226
    PyObject* arg0_ptr = PyTuple_GET_ITEM(args, 0);
    if (pybind11::detail::npy_api::get().PyArray_Check_(arg0_ptr)) {
      VLOG(6) << "Calling case3's or case4's string initializer.";
1227 1228
      AutoInitStringTensorByPyArray(
          py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
J
Jack Zhou 已提交
1229
      return 0;
1230
    } else if (PyObject_TypeCheck(arg0_ptr, p_string_tensor_type)) {
J
Jack Zhou 已提交
1231
      VLOG(6) << "Calling case5's or case6's string initializer.";
1232 1233
      AutoInitStringTensorByStringTensor(
          py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
J
Jack Zhou 已提交
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246
      return 0;
    } else {
      PADDLE_THROW(platform::errors::InvalidArgument(
          "Could not parse the first keyword argument successfully, "
          "the first keyword argument is value, but it should be PyArray "
          "or StringTensor."
          "Please check your input first and make sure you are on the "
          "right way."));
    }
  } else if (args_num == (Py_ssize_t)2) {  // case 2
    // 2 position args
    if (!flag_kwargs) {
      PyObject* arg0_ptr = PyTuple_GET_ITEM(args, 0);
1247
      if (PyObject_TypeCheck(arg0_ptr, p_string_tensor_type)) {
J
Jack Zhou 已提交
1248
        VLOG(6) << "Calling case6's string initializer.";
1249 1250
        AutoInitStringTensorByStringTensor(
            py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
J
Jack Zhou 已提交
1251 1252 1253
        return 0;
      } else if (pybind11::detail::npy_api::get().PyArray_Check_(arg0_ptr)) {
        VLOG(6) << "Calling case3's string initializer.";
1254 1255
        AutoInitStringTensorByPyArray(
            py_tensor_ptr, kws_map, args, flag_kwargs, args_num);
J
Jack Zhou 已提交
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
        return 0;
      } else {
        VLOG(6) << "Calling case2's string initializer.";
        std::vector<int> dims = CastPyArg2VectorOfInt(arg0_ptr, 0);
        std::string act_name = "";
        PyObject* name_obj = PyTuple_GET_ITEM(args, 1);
        if (name_obj == Py_None) {
          act_name = egr::Controller::Instance().GenerateUniqueName(
              "generated_string_tensor");
        } else {
          act_name = CastPyArg2AttrString(PyTuple_GET_ITEM(args, 1), 1);
        }
        EmptyStringTensorInitializer(
1269 1270 1271 1272
            py_tensor_ptr,
            act_name,
            egr::Controller::Instance().GetExpectedPlace(),
            dims);
J
Jack Zhou 已提交
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
        return 0;
      }
    } else {
      PADDLE_THROW(platform::errors::Fatal(
          "Can't not find expected num of args, please check your call, and "
          "make sure u call the existed constructor."));
    }
  }
  return 1;
}

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
void AddPyMethodDefs(std::vector<PyMethodDef>* vector, PyMethodDef* methods) {
  if (!vector->empty()) {
    // remove nullptr terminator
    vector->pop_back();
  }
  while (true) {
    vector->push_back(*methods);
    if (!methods->ml_name) {
      break;
    }
    methods++;
  }
}

1298
static void TensorDealloc(TensorObject* self) {
1299
  if (self->weakrefs != nullptr)
1300
    PyObject_ClearWeakRefs(reinterpret_cast<PyObject*>(self));
1301
  self->tensor.~Tensor();
1302 1303 1304
  Py_TYPE(self)->tp_free(reinterpret_cast<PyObject*>(self));
}

1305 1306
extern struct PyGetSetDef variable_properties[];                // NOLINT
extern struct PyGetSetDef string_tensor_variable_properties[];  // NOLINT
1307

1308 1309 1310
extern PyMethodDef variable_methods[];                // NOLINT
extern PyMethodDef math_op_patch_methods[];           // NOLINT
extern PyMethodDef string_tensor_variable_methods[];  // NOLINT
1311

W
wanghuancoder 已提交
1312 1313 1314 1315
PyNumberMethods number_methods;
PySequenceMethods sequence_methods;
PyMappingMethods mapping_methods;

1316 1317 1318
void BindEager(pybind11::module* module) {
  auto m = module->def_submodule("eager");

1319 1320 1321 1322
  static std::vector<PyMethodDef> methods;
  AddPyMethodDefs(&methods, variable_methods);
  AddPyMethodDefs(&methods, math_op_patch_methods);

1323
  auto heap_type = reinterpret_cast<PyHeapTypeObject*>(
1324
      PyType_Type.tp_alloc(&PyType_Type, 0));
1325 1326
  heap_type->ht_name = ToPyObject("Tensor");
  heap_type->ht_qualname = ToPyObject("Tensor");
1327
  auto type = &heap_type->ht_type;
1328
  type->tp_name = "Tensor";
1329
  type->tp_basicsize = sizeof(TensorObject);
1330
  type->tp_dealloc = (destructor)TensorDealloc;
1331 1332 1333
  type->tp_as_number = &number_methods;
  type->tp_as_sequence = &sequence_methods;
  type->tp_as_mapping = &mapping_methods;
1334
  type->tp_methods = methods.data();
1335
  type->tp_getset = variable_properties;
1336 1337
  type->tp_init = TensorInit;
  type->tp_new = TensorNew;
W
wanghuancoder 已提交
1338
  type->tp_doc = TensorDoc;
1339
  type->tp_weaklistoffset = offsetof(TensorObject, weakrefs);
1340 1341
  Py_INCREF(&PyBaseObject_Type);
  type->tp_base = reinterpret_cast<PyTypeObject*>(&PyBaseObject_Type);
1342 1343 1344 1345 1346
  type->tp_flags |=
      Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE;
#if PY_VERSION_HEX >= 0x03050000
  type->tp_as_async = &heap_type->as_async;
#endif
1347
  p_tensor_type = type;
1348 1349

  if (PyType_Ready(type) < 0) {
1350
    PADDLE_THROW(platform::errors::Fatal(
1351
        "Init Paddle error in BindEager(PyType_Ready)."));
1352 1353 1354
    return;
  }

1355
  Py_INCREF(type);
1356 1357
  if (PyModule_AddObject(m.ptr(), "Tensor", reinterpret_cast<PyObject*>(type)) <
      0) {
1358
    Py_DECREF(type);
1359 1360
    Py_DECREF(m.ptr());
    PADDLE_THROW(platform::errors::Fatal(
1361
        "Init Paddle error in BindEager(PyModule_AddObject)."));
1362 1363 1364 1365
    return;
  }

  BindFunctions(m.ptr());
W
wanghuancoder 已提交
1366
  BindEagerPyLayer(m.ptr());
1367
  BindEagerOpFunctions(&m);
1368 1369
}

J
Jack Zhou 已提交
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
void BindEagerStringTensor(pybind11::module* module) {
  auto m = module->def_submodule("eager");

  auto heap_type = reinterpret_cast<PyHeapTypeObject*>(
      PyType_Type.tp_alloc(&PyType_Type, 0));
  heap_type->ht_name = ToPyObject("StringTensor");
  heap_type->ht_qualname = ToPyObject("StringTensor");
  auto type = &heap_type->ht_type;
  type->tp_name = "StringTensor";
  type->tp_basicsize = sizeof(TensorObject);
  type->tp_dealloc = (destructor)TensorDealloc;
  type->tp_as_number = &number_methods;
  type->tp_as_sequence = &sequence_methods;
  type->tp_as_mapping = &mapping_methods;
  type->tp_methods = string_tensor_variable_methods;
  type->tp_getset = string_tensor_variable_properties;
  type->tp_init = StringTensorInit;
  type->tp_new = TensorNew;
  Py_INCREF(&PyBaseObject_Type);
  type->tp_base = reinterpret_cast<PyTypeObject*>(&PyBaseObject_Type);
  type->tp_flags |=
      Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE;
#if PY_VERSION_HEX >= 0x03050000
  type->tp_as_async = &heap_type->as_async;
#endif
  p_string_tensor_type = type;

  if (PyType_Ready(type) < 0) {
    PADDLE_THROW(platform::errors::Fatal(
        "Init Paddle error in BindEager(PyType_Ready)."));
    return;
  }

  Py_INCREF(type);
1404 1405
  if (PyModule_AddObject(
          m.ptr(), "StringTensor", reinterpret_cast<PyObject*>(type)) < 0) {
J
Jack Zhou 已提交
1406 1407 1408 1409 1410 1411 1412 1413
    Py_DECREF(type);
    Py_DECREF(m.ptr());
    PADDLE_THROW(platform::errors::Fatal(
        "Init Paddle error in BindEagerStringTensor(PyModule_AddObject)."));
    return;
  }
}

1414 1415
}  // namespace pybind
}  // namespace paddle