修改COPY-FROM No.13 distributed

python/paddle/distributed/fleet/base/role_maker.py

@@ -544,6 +544,30 @@ def _barrier(self, comm_world):
 
 
 class PaddleCloudRoleMaker(RoleMakerBase):
+
+    """
+    PaddleCloudRoleMaker is an interface for distributed configuration initialization based on obtaining distributed related information from environment variables.
+
+    Examples:
+        .. code-block:: python
+
+            import os
+            import paddle.distributed.fleet as fleet
+
+            os.environ["PADDLE_PSERVER_NUMS"] = "2"
+            os.environ["PADDLE_TRAINERS_NUM"] = "2"
+
+            os.environ["POD_IP"] = "127.0.0.1"
+            os.environ["PADDLE_PORT"] = "36001"
+            os.environ["TRAINING_ROLE"] = "PSERVER"
+            os.environ["PADDLE_PSERVERS_IP_PORT_LIST"] = "127.0.0.1:36001,127.0.0.2:36001"
+
+            os.environ["PADDLE_TRAINER_ID"] = "0"
+
+            fleet.PaddleCloudRoleMaker(is_collective=False)
+
+    """
+
     def __init__(self, is_collective=False, **kwargs):
         super().__init__()
         self._is_collective = is_collective
@@ -1180,6 +1204,23 @@ def _generate_role(self):
 
 
 class UserDefinedRoleMaker(PaddleCloudRoleMaker):
+
+    """
+    UserDefinedRoleMaker is an interface for distributed configuration initialization based on obtaining distributed related information from user-defined parameters.
+
+    Examples:
+        .. code-block:: python
+
+            import paddle.distributed.fleet as fleet
+            from paddle.distributed.fleet.base.role_maker import Role
+
+            fleet.UserDefinedRoleMaker(
+                current_id=0,
+                role=Role.SERVER,
+                worker_num=2,
+                server_endpoints=["127.0.0.1:36011", "127.0.0.1:36012"])
+    """
+
     def __init__(self, is_collective=False, init_gloo=False, **kwargs):
         super().__init__(
             is_collective=is_collective, init_gloo=init_gloo, **kwargs

python/paddle/distributed/fleet/dataset/dataset.py

@@ -1279,10 +1279,11 @@ class QueueDataset(DatasetBase):
     QueueDataset, it will process data streamly.
 
     Examples:
-        .. code-block:: python
 
-          import paddle
-          dataset = paddle.distributed.QueueDataset()
+    .. code-block:: python
+
+    import paddle
+    dataset = paddle.distributed.QueueDataset()
 
     """
 
@@ -1298,6 +1299,7 @@ def init(self, **kwargs):
         :api_attr: Static Graph
 
         should be called only once in user's python scripts to initialize setings of dataset instance
+
         """
         super().init(**kwargs)
 

python/paddle/distributed/fleet/fleet.py

@@ -105,10 +105,11 @@ class Fleet:
     Returns:
         Fleet: A Fleet instance
 
-    Example for collective training:
 
         .. code-block:: python
+            :name: code-example1
 
+            # Example1: for collective training
             import paddle
             paddle.enable_static()
             import paddle.distributed.fleet as fleet
@@ -122,10 +123,11 @@ class Fleet:
             # do distributed training
 
 
-    Example for parameter server training:
 
         .. code-block:: python
+            :name: code-example2
 
+            # Example2: for parameter server training
             import paddle
             paddle.enable_static()
             import paddle.distributed.fleet as fleet
@@ -195,40 +197,39 @@ def init(
         Returns:
             None
 
-        Examples1:
+        Examples:
 
             .. code-block:: python
+                :name: code-example1
 
                 import paddle.distributed.fleet as fleet
                 fleet.init()
 
-        Examples2:
+
 
             .. code-block:: python
+                :name: code-example2
 
                 import paddle.distributed.fleet as fleet
                 fleet.init(is_collective=True)
 
-        Examples3:
 
             .. code-block:: python
-
+                :name: code-example3
                 import paddle.distributed.fleet as fleet
                 role = fleet.PaddleCloudRoleMaker()
                 fleet.init(role)
 
-        Examples4:
 
             .. code-block:: python
-
+                :name: code-example4
                 import paddle.distributed.fleet as fleet
                 strategy = fleet.DistributedStrategy()
                 fleet.init(strategy=strategy)
 
-        Examples5:
 
             .. code-block:: python
-
+                :name: code-example5
                 import paddle.distributed.fleet as fleet
                 strategy = fleet.DistributedStrategy()
                 fleet.init(log_level = "DEBUG")
@@ -627,6 +628,14 @@ def barrier_worker(self):
 
         Returns:
             None
+
+        Examples:
+
+            .. code-block:: python
+
+                import paddle.distributed.fleet as fleet
+                fleet.init()
+                fleet.barrier_worker()
         """
         self._role_maker._barrier("worker")