From 881dd4389f3ea0eae58a84bd6a13dd84aab8268d Mon Sep 17 00:00:00 2001
From: danleifeng <52735331+danleifeng@users.noreply.github.com>
Date: Thu, 17 Sep 2020 14:53:34 +0800
Subject: [PATCH] add paddle.fleet all doc files  (#2646)

* add fleet cn_doc;test=develop
---
 .../fleet/DistributedStrategy_cn.rst          | 10 +++
 .../api/paddle/distributed/fleet/Fleet_cn.rst | 89 +++++++++++++++++++
 .../fleet/PaddleCloudRoleMaker_cn.rst         | 10 +++
 .../fleet/UserDefinedRoleMaker_cn.rst         | 10 +++
 .../paddle/distributed/fleet/UtilBase_cn.rst  | 10 +++
 .../fleet/utils/fs/ExecuteError_cn.rst        | 10 +++
 .../fleet/utils/fs/FSFileExistsError_cn.rst   | 10 +++
 .../utils/fs/FSFileNotExistsError_cn.rst      | 10 +++
 .../fleet/utils/fs/FSShellCmdAborted_cn.rst   | 10 +++
 .../fleet/utils/fs/FSTimeOut_cn.rst           | 10 +++
 .../distributed/fleet/utils/fs/FS_cn.rst      | 10 +++
 .../fleet/utils/fs/HDFSClient_cn.rst          | 10 +++
 .../distributed/fleet/utils/fs/LocalFS_cn.rst | 10 +++
 13 files changed, 209 insertions(+)
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/DistributedStrategy_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/Fleet_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/PaddleCloudRoleMaker_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/UserDefinedRoleMaker_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/UtilBase_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/utils/fs/ExecuteError_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/utils/fs/FSFileExistsError_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/utils/fs/FSFileNotExistsError_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/utils/fs/FSShellCmdAborted_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/utils/fs/FSTimeOut_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/utils/fs/FS_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/utils/fs/HDFSClient_cn.rst
 create mode 100644 doc/paddle/api/paddle/distributed/fleet/utils/fs/LocalFS_cn.rst

diff --git a/doc/paddle/api/paddle/distributed/fleet/DistributedStrategy_cn.rst b/doc/paddle/api/paddle/distributed/fleet/DistributedStrategy_cn.rst
new file mode 100644
index 000000000..1797fbe93
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/DistributedStrategy_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_DistributedStrategy:
+
+DistributedStrategy
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.DistributedStrategy
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/Fleet_cn.rst b/doc/paddle/api/paddle/distributed/fleet/Fleet_cn.rst
new file mode 100644
index 000000000..ab8adc12c
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/Fleet_cn.rst
@@ -0,0 +1,89 @@
+.. _cn_api_distributed_fleet_Fleet:
+
+Fleet
+-------------------------------
+
+
+.. py:class:: paddle.distributed.fleet.Fleet
+
+
+
+
+.. py:method:: init(role_maker=None, is_collective=False)
+
+
+.. py:method:: is_first_worker()
+
+
+.. py:method:: worker_index()
+
+
+.. py:method:: worker_num()
+
+
+.. py:method:: is_worker()
+
+
+.. py:method:: worker_endpoints(to_string=False)
+
+
+.. py:method:: server_num()
+
+
+.. py:method:: server_index()
+
+
+.. py:method:: server_endpoints(to_string=False)
+
+
+.. py:method:: is_server()
+
+
+.. py:method:: barrier_worker()
+
+
+.. py:method:: init_worker()
+
+
+.. py:method:: init_server(*args, **kwargs)
+
+
+.. py:method:: run_server()
+
+
+.. py:method:: stop_worker()
+
+
+.. py:method:: save_inference_model(executor, dirname, feeded_var_names, target_vars, main_program=None, export_for_deployment=True)
+
+
+.. py:method:: save_persistables(executor, dirname, main_program=None)
+
+
+.. py:method:: distributed_optimizer(optimizer, strategy=None)
+
+
+.. py:method:: distributed_model(model)
+
+
+.. py:method:: state_dict()
+
+
+.. py:method:: set_lr(value)
+
+
+.. py:method:: get_lr()
+
+
+.. py:method:: step()
+
+
+.. py:method:: clear_grad()
+
+
+.. py:method:: minimize(loss, startup_program=None, parameter_list=None, no_grad_set=None)
+
+
+.. py:attribute:: util
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/PaddleCloudRoleMaker_cn.rst b/doc/paddle/api/paddle/distributed/fleet/PaddleCloudRoleMaker_cn.rst
new file mode 100644
index 000000000..b2c01b050
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/PaddleCloudRoleMaker_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_PaddleCloudRoleMaker:
+
+PaddleCloudRoleMaker
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.PaddleCloudRoleMaker
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/UserDefinedRoleMaker_cn.rst b/doc/paddle/api/paddle/distributed/fleet/UserDefinedRoleMaker_cn.rst
new file mode 100644
index 000000000..aee570bc5
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/UserDefinedRoleMaker_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_UserDefinedRoleMaker:
+
+UserDefinedRoleMaker
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.UserDefinedRoleMaker
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/UtilBase_cn.rst b/doc/paddle/api/paddle/distributed/fleet/UtilBase_cn.rst
new file mode 100644
index 000000000..bb873da34
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/UtilBase_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_UtilBase:
+
+UtilBase
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.UtilBase
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/utils/fs/ExecuteError_cn.rst b/doc/paddle/api/paddle/distributed/fleet/utils/fs/ExecuteError_cn.rst
new file mode 100644
index 000000000..98359d848
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/utils/fs/ExecuteError_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_utils_fs_ExecuteError:
+
+ExecuteError
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.utils.fs.ExecuteError
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSFileExistsError_cn.rst b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSFileExistsError_cn.rst
new file mode 100644
index 000000000..5081d1ca7
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSFileExistsError_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_utils_fs_FSFileExistsError:
+
+FSFileExistsError
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.utils.fs.FSFileExistsError
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSFileNotExistsError_cn.rst b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSFileNotExistsError_cn.rst
new file mode 100644
index 000000000..1bebd7f44
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSFileNotExistsError_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_utils_fs_FSFileNotExistsError:
+
+FSFileNotExistsError
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.utils.fs.FSFileNotExistsError
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSShellCmdAborted_cn.rst b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSShellCmdAborted_cn.rst
new file mode 100644
index 000000000..bf48d0627
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSShellCmdAborted_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_utils_fs_FSShellCmdAborted:
+
+FSShellCmdAborted
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.utils.fs.FSShellCmdAborted
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSTimeOut_cn.rst b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSTimeOut_cn.rst
new file mode 100644
index 000000000..5de353c06
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FSTimeOut_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_utils_fs_FSTimeOut:
+
+FSTimeOut
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.utils.fs.FSTimeOut
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/utils/fs/FS_cn.rst b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FS_cn.rst
new file mode 100644
index 000000000..c290580ce
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/utils/fs/FS_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_utils_fs_FS:
+
+FS
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.utils.fs.FS
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/utils/fs/HDFSClient_cn.rst b/doc/paddle/api/paddle/distributed/fleet/utils/fs/HDFSClient_cn.rst
new file mode 100644
index 000000000..21fae916c
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/utils/fs/HDFSClient_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_utils_fs_HDFSClient:
+
+HDFSClient
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.utils.fs.HDFSClient
+
+
+
+
diff --git a/doc/paddle/api/paddle/distributed/fleet/utils/fs/LocalFS_cn.rst b/doc/paddle/api/paddle/distributed/fleet/utils/fs/LocalFS_cn.rst
new file mode 100644
index 000000000..5169d52c9
--- /dev/null
+++ b/doc/paddle/api/paddle/distributed/fleet/utils/fs/LocalFS_cn.rst
@@ -0,0 +1,10 @@
+.. _cn_api_distributed_fleet_utils_fs_LocalFS:
+
+LocalFS
+-------------------------------
+
+.. py:class:: paddle.distributed.fleet.utils.fs.LocalFS
+
+
+
+
-- 
GitLab