Adds validation and guides (#26)

* Adds validation and guides

* Update compartment.py

---------

Co-authored-by: Alex Ororbia <agocse109@gmail.com>

Author: willgebhardt

ngcsimlib/compartment.py

@@ -6,16 +6,21 @@
 
 class Compartment:
     """
-    Compartments in ngcsimlib are container objects for storing the stateful values of components. Compartments are
-    tracked globaly and are automatically linked to components and methods during compiling to allow for stateful
-    mechanics to be run without the need for the class object. Compartments also provide an entry and exit point for
-    values inside of components allowing for cables to be connected for sending and receiving values.
+    Compartments in ngcsimlib are container objects for storing the stateful
+    values of components. Compartments are
+    tracked globaly and are automatically linked to components and methods
+    during compiling to allow for stateful
+    mechanics to be run without the need for the class object. Compartments
+    also provide an entry and exit point for
+    values inside of components allowing for cables to be connected for
+    sending and receiving values.
     """
 
     @classmethod
     def is_compartment(cls, obj):
         """
-        A method for verifying if a provided object is a compartment. All compartments have `_is_compartment` set to
+        A method for verifying if a provided object is a compartment. All
+        compartments have `_is_compartment` set to
         true by default and this is
 
         Args:
@@ -26,14 +31,18 @@ def is_compartment(cls, obj):
         """
         return hasattr(obj, "_is_compartment")
 
-    def __init__(self, initial_value=None, static=False):
+    def __init__(self, initial_value=None, static=False, is_input=False):
         """
-        Builds a compartment to be used inside a component. It is important to note that building compartments
-        outside of components may cause unexpected behavior as components interact with their compartments during
+        Builds a compartment to be used inside a component. It is important
+        to note that building compartments
+        outside of components may cause unexpected behavior as components
+        interact with their compartments during
         construction to finish initializing them.
         Args:
-            initial_value: The initial value of the compartment. As a general practice it is a good idea to
-                provide a value that is similar to the values that will normally be stored here, such as an array of
+            initial_value: The initial value of the compartment. As a general
+            practice it is a good idea to
+                provide a value that is similar to the values that will
+                normally be stored here, such as an array of
                 zeros of the correct length. (default: None)
 
             static: a flag to lock a compartment to be static (default: False)
@@ -45,11 +54,14 @@ def __init__(self, initial_value=None, static=False):
         self._uid = uuid.uuid4()
         self.name = None
         self.path = None
+        self.is_input = is_input
+        self._is_destination = False
 
     def _setup(self, current_component, key):
         """
-        Finishes initializing the compartment, called by the component that builds the compartment
-        (Handel automatically)
+        Finishes initializing the compartment, called by the component that
+        builds the compartment
+        (Handled automatically)
         """
         self.__add_connection = current_component.add_connection
         self.name = current_component.name + "/" + key
@@ -58,7 +70,8 @@ def _setup(self, current_component, key):
 
     def set(self, value):
         """
-        Sets the value of the compartment if it not static (Raises a runtime error)
+        Sets the value of the compartment if it not static (Raises a runtime
+        error)
         Args:
              value: the new value to be set
         """
@@ -89,8 +102,10 @@ def __str__(self):
 
     def __lshift__(self, other) -> None:
         """
-        Overrides the left shift operation to be used for wiring compartments into one another
-        if other is not an Operation it will create an overwrite operation with other as the argument,
+        Overrides the left shift operation to be used for wiring compartments
+        into one another
+        if other is not an Operation it will create an overwrite operation
+        with other as the argument,
         otherwise it will use the provided operation
 
         Args:
@@ -103,3 +118,16 @@ def __lshift__(self, other) -> None:
             op = overwrite(other)
             op.set_destination(self)
             self.__add_connection(op)
+
+        self._is_destination = True
+
+    def is_wired(self):
+        """
+        Returns: if this compartment not marked as an input, or is marked and
+        has an input
+
+        """
+        if not self.is_input:
+            return True
+
+        return self._is_destination

ngcsimlib/component.py

@@ -1,20 +1,22 @@
 from abc import abstractmethod
 from ngcsimlib.metaComponent import MetaComponent
 from ngcsimlib.compartment import Compartment
-
+from ngcsimlib.logger import warn
 
 class Component(metaclass=MetaComponent):
     """
     Components are a foundational part of ngclearn and its component/command
     structure. In ngclearn, all stateful parts of a model take the form of
     components. The internal storage of the state within a component takes one
     of two forms, either as a compartment or as a member variable. The member
-    variables are values such as hyperparameters and weights/synaptic efficacies,
+    variables are values such as hyperparameters and weights/synaptic
+    efficacies,
     where the transfer of their individual state from component to component is
     not needed.
     Compartments, on the other hand, are where the state information, both from
     and for other components, are stored. As the components are the stateful
-    pieces of the model, they also contain the methods and logic behind advancing
+    pieces of the model, they also contain the methods and logic behind
+    advancing
     their internal state (values) forward in time.
     """
 
@@ -28,13 +30,13 @@ def __init__(self, name, **kwargs):
         Args:
             name: the name of the component
 
-            kwargs: additional keyword arguments. These are not used in the base class,
+            kwargs: additional keyword arguments. These are not used in the
+            base class,
                 but this is here for future use if needed.
         """
         # Component Data
         self.name = name
 
-
     ##Intialization Methods
 
     ## Runtime Methods
@@ -47,9 +49,36 @@ def clamp(self, compartment, value):
 
             value: provided Value
         """
-        if hasattr(self, compartment) and Compartment.is_compartment(getattr(self, compartment)):
+        if hasattr(self, compartment) and Compartment.is_compartment(
+            getattr(self, compartment)):
             getattr(self, compartment).set(value)
 
+    def validate(self):
+        """
+        Validates that each compartment of the component is wired correctly
+
+        Returns: if it is valid
+        """
+        valid = True
+        for key, item in self.__dict__.items():
+            if Compartment.is_compartment(item):
+                if not item.is_wired():
+                    _help = self.help()
+                    _path = ("compartments/inputs/" + item.path.split("/")[-1])
+                    for _p in _path.split("/"):
+                        _help = _help.get(_p, None)
+                        if _help is None:
+                            break
+
+                    msg = (f"The compartment at the path \"{item.path}\" is "
+                           f"expected to have an incoming cable and it "
+                           f"currently does not.")
+                    if _help is not None:
+                        msg += f"\nCompartment Description:\t{_help}"
+                    warn(msg)
+                    valid = False
+        return valid
+
     ##Abstract Methods
     @abstractmethod
     def advance_state(self, **kwargs):
@@ -78,3 +107,9 @@ def save(self, directory, **kwargs):
             directory:  the directory to save the state to
         """
         pass
+
+    @classmethod
+    @abstractmethod
+    def help(cls):
+        pass
+