Update documentation

Author: pockerman

docs/source/API/replay_buffer.rst

@@ -30,9 +30,14 @@ API
    API/spaces/discrete_state_environment
    API/spaces/tiled_environment
    API/spaces/time_step
-   API/replay_buffer
+   API/spaces/multiprocess_env
+   API/utils/replay_buffer
    API/trainers/trainer
    API/trainers/pytorch_trainer
+   API/utils/replay_buffer
+   API/utils/iteration_control
+   API/utils/function_wraps
+   API/utils/episode_info
 
 
 

docs/source/modules.rst

@@ -22,6 +22,18 @@ def calculate(self, state1: Vector, state2: Vector) -> float:
 
 
 def _numeric_distance_calculator(state1: Vector, state2: Vector, dist_type: NumericDistanceType) -> float:
+    """
+
+    Parameters
+    ----------
+    state1
+    state2
+    dist_type
+
+    Returns
+    -------
+
+    """
 
     if len(state1) != len(state2):
         raise IncompatibleVectorSizesException(size1=len(state1), size2=len(state2))

src/maths/numeric_distance_calculator.py

@@ -19,6 +19,9 @@
 
 
 class MultiprocessEnv(object):
+    """MultiprocessEnv class
+
+    """
 
     def __init__(self, env_builder: Callable, env_args: dict, n_workers: int):
         self.env_builder = env_builder

src/spaces/multiprocess_env.py

@@ -1,5 +1,4 @@
-"""
-Utility to control iteration
+"""module iteration_control. Utility to control iteration
 """
 
 from src.utils import INFO, VERSION