From 5251bf03e4b808595fac7c3af5e381f8cd54df1d Mon Sep 17 00:00:00 2001 From: dongdaxiang Date: Thu, 10 Sep 2020 14:26:00 +0800 Subject: [PATCH] update fleet doc --- doc/fluid/api/distributed/all_gather.rst | 4 ++-- doc/fluid/api/distributed/all_reduce.rst | 4 ++-- doc/fluid/api/distributed/barrier.rst | 4 ++-- doc/fluid/api/distributed/broadcast.rst | 4 ++-- doc/fluid/api/distributed/get_rank.rst | 4 ++-- doc/fluid/api/distributed/get_world_size.rst | 4 ++-- doc/fluid/api/distributed/init_parallel_env.rst | 4 ++-- doc/fluid/api/distributed/prepare_context.rst | 4 ++-- doc/fluid/api/distributed/reduce.rst | 4 ++-- doc/fluid/api/distributed/scatter.rst | 4 ++-- doc/fluid/api/distributed/spawn.rst | 4 ++-- doc/fluid/api/fleet.rst | 2 +- doc/fluid/api/fleet/DatasetFactory.rst | 4 ++-- doc/fluid/api/fleet/DistributedStrategy.rst | 4 ++-- doc/fluid/api/fleet/Fleet.rst | 4 ++-- doc/fluid/api/fleet/PaddleCloudRoleMaker.rst | 4 ++-- doc/fluid/api/fleet/UserDefinedRoleMaker.rst | 4 ++-- doc/fluid/api/fleet/UtilBase.rst | 4 ++-- doc/fluid/api/index_en.rst | 1 + 19 files changed, 36 insertions(+), 35 deletions(-) diff --git a/doc/fluid/api/distributed/all_gather.rst b/doc/fluid/api/distributed/all_gather.rst index 5b27f6656..0672c1807 100644 --- a/doc/fluid/api/distributed/all_gather.rst +++ b/doc/fluid/api/distributed/all_gather.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_all_gather: +.. _api_distributed_all_gather: all_gather ---------- -.. autofunction:: paddle.distributed.paddle.all_gather +.. autofunction:: paddle.distributed.all_gather :noindex: diff --git a/doc/fluid/api/distributed/all_reduce.rst b/doc/fluid/api/distributed/all_reduce.rst index b57eda067..e03fbbbf6 100644 --- a/doc/fluid/api/distributed/all_reduce.rst +++ b/doc/fluid/api/distributed/all_reduce.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_all_reduce: +.. _api_distributed_all_reduce: all_reduce ---------- -.. autofunction:: paddle.distributed.paddle.all_reduce +.. autofunction:: paddle.distributed.all_reduce :noindex: diff --git a/doc/fluid/api/distributed/barrier.rst b/doc/fluid/api/distributed/barrier.rst index f8c4a9a31..07cc4059f 100644 --- a/doc/fluid/api/distributed/barrier.rst +++ b/doc/fluid/api/distributed/barrier.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_barrier: +.. _api_distributed_barrier: barrier ------- -.. autofunction:: paddle.distributed.paddle.barrier +.. autofunction:: paddle.distributed.barrier :noindex: diff --git a/doc/fluid/api/distributed/broadcast.rst b/doc/fluid/api/distributed/broadcast.rst index 2708dd524..183dbdd17 100644 --- a/doc/fluid/api/distributed/broadcast.rst +++ b/doc/fluid/api/distributed/broadcast.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_broadcast: +.. _api_distributed_broadcast: broadcast --------- -.. autofunction:: paddle.distributed.paddle.broadcast +.. autofunction:: paddle.distributed.broadcast :noindex: diff --git a/doc/fluid/api/distributed/get_rank.rst b/doc/fluid/api/distributed/get_rank.rst index 276a901ba..e170d613f 100644 --- a/doc/fluid/api/distributed/get_rank.rst +++ b/doc/fluid/api/distributed/get_rank.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_get_rank: +.. _api_distributed_get_rank: get_rank -------- -.. autofunction:: paddle.distributed.paddle.get_rank +.. autofunction:: paddle.distributed.get_rank :noindex: diff --git a/doc/fluid/api/distributed/get_world_size.rst b/doc/fluid/api/distributed/get_world_size.rst index 184227a7f..f8e65f548 100644 --- a/doc/fluid/api/distributed/get_world_size.rst +++ b/doc/fluid/api/distributed/get_world_size.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_get_world_size: +.. _api_distributed_get_world_size: get_world_size -------------- -.. autofunction:: paddle.distributed.paddle.get_world_size +.. autofunction:: paddle.distributed.get_world_size :noindex: diff --git a/doc/fluid/api/distributed/init_parallel_env.rst b/doc/fluid/api/distributed/init_parallel_env.rst index f72f11b85..67e267a0f 100644 --- a/doc/fluid/api/distributed/init_parallel_env.rst +++ b/doc/fluid/api/distributed/init_parallel_env.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_init_parallel_env: +.. _api_distributed_init_parallel_env: init_parallel_env ----------------- -.. autofunction:: paddle.distributed.paddle.init_parallel_env +.. autofunction:: paddle.distributed.init_parallel_env :noindex: diff --git a/doc/fluid/api/distributed/prepare_context.rst b/doc/fluid/api/distributed/prepare_context.rst index e9eee3d27..e81fbc5a2 100644 --- a/doc/fluid/api/distributed/prepare_context.rst +++ b/doc/fluid/api/distributed/prepare_context.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_prepare_context: +.. _api_distributed_prepare_context: prepare_context --------------- -.. autofunction:: paddle.distributed.paddle.prepare_context +.. autofunction:: paddle.distributed.prepare_context :noindex: diff --git a/doc/fluid/api/distributed/reduce.rst b/doc/fluid/api/distributed/reduce.rst index b7bcaf925..beccbee03 100644 --- a/doc/fluid/api/distributed/reduce.rst +++ b/doc/fluid/api/distributed/reduce.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_reduce: +.. _api_distributed_reduce: reduce ------ -.. autofunction:: paddle.distributed.paddle.reduce +.. autofunction:: paddle.distributed.reduce :noindex: diff --git a/doc/fluid/api/distributed/scatter.rst b/doc/fluid/api/distributed/scatter.rst index a61f52f8c..384899fd4 100644 --- a/doc/fluid/api/distributed/scatter.rst +++ b/doc/fluid/api/distributed/scatter.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_scatter: +.. _api_distributed_scatter: scatter ------- -.. autofunction:: paddle.distributed.paddle.scatter +.. autofunction:: paddle.distributed.scatter :noindex: diff --git a/doc/fluid/api/distributed/spawn.rst b/doc/fluid/api/distributed/spawn.rst index 34f5376d9..827041145 100644 --- a/doc/fluid/api/distributed/spawn.rst +++ b/doc/fluid/api/distributed/spawn.rst @@ -1,11 +1,11 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_distributed_paddle_spawn: +.. _api_distributed_spawn: spawn ----- -.. autofunction:: paddle.distributed.paddle.spawn +.. autofunction:: paddle.distributed.spawn :noindex: diff --git a/doc/fluid/api/fleet.rst b/doc/fluid/api/fleet.rst index eb8e46f22..ac94ad4d0 100644 --- a/doc/fluid/api/fleet.rst +++ b/doc/fluid/api/fleet.rst @@ -5,7 +5,7 @@ paddle.distributed.fleet .. toctree:: :maxdepth: 1 - fleet/Fleet.rst + fleet/Fleet.rst fleet/DistributedStrategy.rst fleet/PaddleCloudRoleMaker.rst fleet/DatasetFactory.rst diff --git a/doc/fluid/api/fleet/DatasetFactory.rst b/doc/fluid/api/fleet/DatasetFactory.rst index c16c4a070..208b6452c 100644 --- a/doc/fluid/api/fleet/DatasetFactory.rst +++ b/doc/fluid/api/fleet/DatasetFactory.rst @@ -1,12 +1,12 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_fleet_paddle_distributed_DatasetFactory: +.. _api_paddle_distributed_DatasetFactory: DatasetFactory -------------- -.. autoclass:: paddle.fleet.paddle.distributed.DatasetFactory +.. autoclass:: paddle.distributed.DatasetFactory :members: :inherited-members: :noindex: diff --git a/doc/fluid/api/fleet/DistributedStrategy.rst b/doc/fluid/api/fleet/DistributedStrategy.rst index 9518dfbff..7fe9ecf67 100644 --- a/doc/fluid/api/fleet/DistributedStrategy.rst +++ b/doc/fluid/api/fleet/DistributedStrategy.rst @@ -1,12 +1,12 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_fleet_paddle_distributed_DistributedStrategy: +.. _api_paddle_distributed_DistributedStrategy: DistributedStrategy ------------------- -.. autoclass:: paddle.fleet.paddle.distributed.DistributedStrategy +.. autoclass:: paddle.distributed.DistributedStrategy :members: :inherited-members: :noindex: diff --git a/doc/fluid/api/fleet/Fleet.rst b/doc/fluid/api/fleet/Fleet.rst index eed7bb0ca..52ecd8af5 100644 --- a/doc/fluid/api/fleet/Fleet.rst +++ b/doc/fluid/api/fleet/Fleet.rst @@ -1,12 +1,12 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_fleet_paddle_distributed_Fleet: +.. _api_paddle_distributed_Fleet: Fleet ----- -.. autoclass:: paddle.fleet.paddle.distributed.Fleet +.. autoclass:: paddle.distributed.Fleet :members: :inherited-members: :noindex: diff --git a/doc/fluid/api/fleet/PaddleCloudRoleMaker.rst b/doc/fluid/api/fleet/PaddleCloudRoleMaker.rst index 434b5afc4..f6f020ef6 100644 --- a/doc/fluid/api/fleet/PaddleCloudRoleMaker.rst +++ b/doc/fluid/api/fleet/PaddleCloudRoleMaker.rst @@ -1,12 +1,12 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_fleet_paddle_distributed_PaddleCloudRoleMaker: +.. _api_paddle_distributed_PaddleCloudRoleMaker: PaddleCloudRoleMaker -------------------- -.. autoclass:: paddle.fleet.paddle.distributed.PaddleCloudRoleMaker +.. autoclass:: paddle.distributed.PaddleCloudRoleMaker :members: :inherited-members: :noindex: diff --git a/doc/fluid/api/fleet/UserDefinedRoleMaker.rst b/doc/fluid/api/fleet/UserDefinedRoleMaker.rst index fe049764f..59c84b98a 100644 --- a/doc/fluid/api/fleet/UserDefinedRoleMaker.rst +++ b/doc/fluid/api/fleet/UserDefinedRoleMaker.rst @@ -1,12 +1,12 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_fleet_paddle_distributed_UserDefinedRoleMaker: +.. _api_paddle_distributed_UserDefinedRoleMaker: UserDefinedRoleMaker -------------------- -.. autoclass:: paddle.fleet.paddle.distributed.UserDefinedRoleMaker +.. autoclass:: paddle.distributed.UserDefinedRoleMaker :members: :inherited-members: :noindex: diff --git a/doc/fluid/api/fleet/UtilBase.rst b/doc/fluid/api/fleet/UtilBase.rst index 3f262574c..f238338df 100644 --- a/doc/fluid/api/fleet/UtilBase.rst +++ b/doc/fluid/api/fleet/UtilBase.rst @@ -1,12 +1,12 @@ .. THIS FILE IS GENERATED BY `gen_doc.{py|sh}` !DO NOT EDIT THIS FILE MANUALLY! -.. _api_fleet_paddle_distributed_UtilBase: +.. _api_paddle_distributed_UtilBase: UtilBase -------- -.. autoclass:: paddle.fleet.paddle.distributed.UtilBase +.. autoclass:: paddle.distributed.UtilBase :members: :inherited-members: :noindex: diff --git a/doc/fluid/api/index_en.rst b/doc/fluid/api/index_en.rst index e3ac0dc69..b22d5d8c2 100644 --- a/doc/fluid/api/index_en.rst +++ b/doc/fluid/api/index_en.rst @@ -9,6 +9,7 @@ API Reference dataset.rst declarative.rst distributed.rst + fleet.rst framework.rst imperative.rst io.rst -- GitLab