Update documentation

Author: pockerman

docs/source/modules.rst

@@ -38,6 +38,9 @@ API
    API/utils/iteration_control
    API/utils/function_wraps
    API/utils/episode_info
+   API/utils/mixins
+   API/utils/reward_manager
+   API/utils/serial_hierarchy
 
 
 

src/utils/mixins.py

@@ -1,5 +1,6 @@
-"""
+"""module mixins.
 Various mixin classes to use for simplifying  code
+
 """
 
 import numpy as np

src/utils/reward_manager.py

@@ -1,4 +1,4 @@
-"""Module reward_manager specifies a class that handles
+"""module reward_manager specifies a class that handles
 the rewards awarded by the environment.
 
 """

src/utils/serial_hierarchy.py

@@ -1,57 +1,12 @@
-"""
-A SerialHierarchy represents a hierarchy of transformations
+"""module serial_hierarchy. A SerialHierarchy represents a hierarchy of transformations
 that are applied one after the other
+
 """
 
 from typing import List, Any
-from src.utils.hierarchy_base import HierarchyBase
-
-
-class SerialtHierarchyIterator(object):
-    """
-    SerialtHierarchyIterator class. Helper class to iterate over a
-    SerialHierarchy object
-    """
-
-    def __init__(self, values: List):
-        self.current_position = 0
-        self.values = values
-
-    @property
-    def at(self) -> Any:
-        """
-        Returns the value of the iterator at the current position
-        without incrementing the position of the iterator
-        :return: Any
-        """
-        return self.values[self.current_position]
-
-    @property
-    def finished(self) -> bool:
-        """
-        Returns true if the iterator is exhausted
-        :return:
-        """
-        return self.current_position >= len(self.values)
-
-    def __next__(self):
-
-        if self.current_position < len(self.values):
-            result = self.values[self.current_position]
-            self.current_position += 1
-            return result
-
-        raise StopIteration
-
-    def __len__(self):
-        """
-        Returns the total number of items in the iterator
-        :return:
-        """
-        return len(self.values)
 
 
-class SerialHierarchy(HierarchyBase):
+class SerialHierarchy(object):
 
     """
     A SerialHierarchy represents a hierarchy of transformations
@@ -66,7 +21,6 @@ def __init__(self, values: dict) -> None:
         list of the ensuing transformations.
         :param values:
         """
-        super(SerialHierarchy, self).__init__()
         self.hierarchy: dict = values
 
     def __getitem__(self, item):