add_env_api_docs

docs/source/env.rst

@@ -0,0 +1,11 @@
+oneflow.env
+===================================
+Environment
+----------------------------------
+.. currentmodule:: oneflow
+
+.. autofunction:: oneflow.env.get_world_size
+.. autofunction:: oneflow.env.get_rank
+.. autofunction:: oneflow.env.get_local_rank
+.. autofunction:: oneflow.env.get_node_size
+.. autofunction:: oneflow.env.is_multi_client

docs/source/index.rst

@@ -23,6 +23,7 @@ OneFlow API Reference
     optim
     utils
     cuda
+    env
     distributed
     comm
     placement

docs/source/oneflow.rst

@@ -154,4 +154,3 @@ oneflow
             from_numpy,
 
 .. autofunction:: oneflow.relu
-.. autofunction:: oneflow.env.get_rank

python/oneflow/env.py

@@ -28,11 +28,19 @@
 
 
 def get_local_rank():
+    """Returns the local rank of current machine.
+    Local rank is not globally unique. It is only unique per process on a machine. 
+
+    Returns:
+        The the local rank of process on current machine.
+
+    """
     return oneflow._oneflow_internal.GetLocalRank()
 
 
 def get_rank():
     """Returns the rank of current process group.
+    Rank is globally unique, range of which is [0, world_size). 
 
     Returns:
         The rank of the process group.
@@ -42,6 +50,12 @@ def get_rank():
 
 
 def get_node_size():
+    """Returns the number of machines in the current process group.
+
+    Returns:
+        The the number of machines in the process group.
+
+    """
     return oneflow._oneflow_internal.GetNodeSize()
 
 
@@ -56,4 +70,10 @@ def get_world_size():
 
 
 def is_multi_client():
+    """Returns whether it is currently in multi client mode.
+
+    Returns:
+        True if currently in multi client mode, otherwise returns Flase.
+
+    """
     return oneflow._oneflow_internal.IsMultiClient()