From dec52f6bea8841ab359bb891cc7bdcbe5b99bdf6 Mon Sep 17 00:00:00 2001 From: Leo Chen Date: Fri, 11 Oct 2019 13:46:57 +0800 Subject: [PATCH] [cherry-pick] Polish en doc of LoDTensorArray, test=document_fix, test=release/1.6 (#19972) (#20426) --- paddle/fluid/API.spec | 2 +- paddle/fluid/pybind/pybind.cc | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/paddle/fluid/API.spec b/paddle/fluid/API.spec index 4160bc04e87..4b08e34de1d 100644 --- a/paddle/fluid/API.spec +++ b/paddle/fluid/API.spec @@ -1087,7 +1087,7 @@ paddle.fluid.LoDTensor.recursive_sequence_lengths recursive_sequence_lengths(sel paddle.fluid.LoDTensor.set_lod set_lod(self: paddle.fluid.core_avx.LoDTensor, lod: List[List[int]]) -> None paddle.fluid.LoDTensor.set_recursive_sequence_lengths set_recursive_sequence_lengths(self: paddle.fluid.core_avx.LoDTensor, recursive_sequence_lengths: List[List[int]]) -> None paddle.fluid.LoDTensor.shape shape(self: paddle.fluid.core_avx.Tensor) -> List[int] -paddle.fluid.LoDTensorArray ('paddle.fluid.core_avx.LoDTensorArray', ('document', 'e9895b67ba54438b9c0f7053e18966f5')) +paddle.fluid.LoDTensorArray ('paddle.fluid.core_avx.LoDTensorArray', ('document', '54b28e608be8c035f2bbe18a5c12cfd2')) paddle.fluid.LoDTensorArray.__init__ __init__(self: paddle.fluid.core_avx.LoDTensorArray) -> None paddle.fluid.LoDTensorArray.append append(self: paddle.fluid.core_avx.LoDTensorArray, tensor: paddle.fluid.core_avx.LoDTensor) -> None paddle.fluid.CPUPlace ('paddle.fluid.core_avx.CPUPlace', ('document', 'd269ec68ce9b102ab10610e89ffa06e1')) diff --git a/paddle/fluid/pybind/pybind.cc b/paddle/fluid/pybind/pybind.cc index fe519ba9882..721c6be2a1f 100644 --- a/paddle/fluid/pybind/pybind.cc +++ b/paddle/fluid/pybind/pybind.cc @@ -1249,7 +1249,7 @@ All parameter, weight, gradient are variables in Paddle. }); py::class_(m, "LoDTensorArray", R"DOC( - Array of LoDTensor. + LoDTensorArray is array of LoDTensor, it supports operator[], len() and for-loop iteration. Examples: .. code-block:: python @@ -1278,6 +1278,12 @@ All parameter, weight, gradient are variables in Paddle. }, py::arg("tensor"), R"DOC( Append a LoDensor to LoDTensorArray. + + Args: + tensor (LoDTensor): The LoDTensor to be appended. + + Returns: + None. Examples: .. code-block:: python -- GitLab