Comment Styling Fix

Author: willgebhardt

ngcsimlib/compartment.py

@@ -7,13 +7,12 @@
 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.
+    values of components. Compartments are tracked globally 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
@@ -31,19 +30,18 @@ def is_compartment(cls, obj):
         """
         return hasattr(obj, "_is_compartment")
 
-    def __init__(self, initial_value=None, static=False, is_input=False, display_name=None, units=None):
+    def __init__(self, initial_value=None, static=False, is_input=False,
+                 display_name=None, units=None):
         """
         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.
+        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
-                zeros of the correct length. (default: None)
+            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)
         """
@@ -105,10 +103,9 @@ 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,
-        otherwise it will use the provided operation
+        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:
             other: Either another component or an instance of BaseOp
@@ -136,9 +133,9 @@ def is_wired(self):
 
     @property
     def display_name(self):
-        return self._display_name if self._display_name is not None else self.name
+        return self._display_name if self._display_name is not None else (
+            self.name)
 
     @property
     def units(self):
         return self._units if self._units is not None else "dimensionless"
-

ngcsimlib/compilers/command_compiler.py

@@ -1,44 +1,58 @@
 """
 This is the file that contains the code to compile a given command on a model.
 
-There are a few ways to compile the commands for a model, firstly if there is a command object already initialized
-that has a valid compile key and a list of components the base method of `compile_command(command)` can be used to produce
-the desired output. If no command object has been initialized then the `dynamic_compile(*components, compile_key=None)`
-can be used to produce the desired output without the need to first go through a command object. The output of either
-compile method will be the same.
+There are a few ways to compile the commands for a model, firstly if there is
+a command object already initialized that has a valid compile key and a list
+of components the base method of `compile_command(command)` can be used to
+produce the desired output. If no command object has been initialized then
+the `dynamic_compile(*components, compile_key=None)` can be used to produce
+the desired output without the need to first go through a command object. The
+output of either compile method will be the same.
 
 The output produced by compiling a command will be two objects.
 
-The first object produced by compiling a command is the compiled method itself. This method requires at least one
-positional argument and then any number of additional arguments. The first argument that is provided to the compiled
-method is a python dictionary that contains the state for all compartments this method will need to access,
-as discerning this can be a challenge it is normal to just pass it all compartments present on your model. The
-remaining list of arguments are all the run time arguments that the various compiled methods need to run properly.
-The return value of this compiled method is the final state of all compartments after running through the compiled
-command. Note here that the value on the compartments are not automatically updated and that will need to be done after.
-
-The second object produced by compiling a command is the list of arguments that the compile command is expecting to
-be passed in alongside the initial state of all the compartments. It is a good habit to get into printing this list
-out after compiling as it can help catch typos present in the compiled methods that will not cause the compiling to
-fail but will produce unknown behavior.
-
-There is a wrapper method offered in this file we recommend using to assist with the design patterned required by the
-compiled command. This is done with `wrap_command(command)`. This method will return another method that removes the
-need for creating the initial state of the compartments and setting all the compartment values after running. Arguments
-are still required to be passed in at run time.
+The first object produced by compiling a command is the compiled method
+itself. This method requires at least one positional argument and then any
+number of additional arguments. The first argument that is provided to the
+compiled method is a python dictionary that contains the state for all
+compartments this method will need to access, as discerning this can be a
+challenge it is normal to just pass it all compartments present on your
+model. The remaining list of arguments are all the run time arguments that
+the various compiled methods need to run properly. The return value of this
+compiled method is the final state of all compartments after running through
+the compiled command. Note here that the value on the compartments are not
+automatically updated and that will need to be done after.
+
+The second object produced by compiling a command is the list of arguments
+that the compile command is expecting to be passed in alongside the initial
+state of all the compartments. It is a good habit to get into printing this
+list out after compiling as it can help catch typos present in the compiled
+methods that will not cause the compiling to fail but will produce unknown
+behavior.
+
+There is a wrapper method offered in this file we recommend using to assist
+with the design patterned required by the compiled command. This is done with
+`wrap_command(command)`. This method will return another method that removes
+the need for creating the initial state of the compartments and setting all
+the compartment values after running. Arguments are still required to be
+passed in at run time.
 
 """
-from ngcsimlib.compilers.component_compiler import parse as parse_component, compile as compile_component
+from ngcsimlib.compilers.component_compiler import parse as parse_component, \
+    compile as compile_component
 from ngcsimlib.compilers.op_compiler import parse as parse_connection
 from ngcsimlib.utils import Get_Compartment_Batch, Set_Compartment_Batch
 from ngcsimlib.logger import critical
 
+
 def _compile(compile_key, components):
     """
-    This is the top level compile method for commands. Note this does not actually require you to compile a
-    specific command object as it works purely off the compile key provided to the method.
-    The general process that this takes to compile down everything, is by producing an execution order that knows which
-    methods that are going to be called and where the results of the method are supposed to be stored.
+    This is the top level compile method for commands. Note this does not
+    actually require you to compile a specific command object as it works
+    purely off the compile key provided to the method. The general process
+    that this takes to compile down everything, is by producing an execution
+    order that knows which methods that are going to be called and where the
+    results of the method are supposed to be stored.
 
     The execution order is as follows:
 
@@ -47,8 +61,8 @@ def _compile(compile_key, components):
     | resolve the outputs of the compiled function
 
     Args:
-        compile_key: The key that is being compiled (mapped to each function that has the @resolver decorator
-                    above it)
+        compile_key: The key that is being compiled (mapped to each function
+        that has the @resolver decorator above it)
 
         components: The list of components to compile for this function
 
@@ -86,11 +100,17 @@ def _compile(compile_key, components):
     for c_name, component in components.items():
         exc_order.extend(compile_component(component, resolvers[c_name]))
 
-    def compiled(compartment_values, **kwargs):
+    def compiled(compartment_values=None, **kwargs):
+        if compartment_values is None:
+            critical(
+                f"Attempting to call a compiled method without the current "
+                f"state of the model. "
+                f"Verify the method is wrapped or a current state is provided")
         for n in needed_args:
             if n not in kwargs:
-                critical(f"Missing keyword argument \"{n}\" in compiled function."
-                         f"\tExpected keyword arguments {needed_args}")
+                critical(
+                    f"Missing keyword argument \"{n}\" in compiled function."
+                    f"\tExpected keyword arguments {needed_args}")
 
         for exc, outs, name, comp_ids in exc_order:
             _comps = {key: compartment_values[key] for key in comp_ids}
@@ -107,7 +127,8 @@ def compiled(compartment_values, **kwargs):
 
 def compile_command(command):
     """
-    Compiles a given command object to the spec described at the top of this file
+    Compiles a given command object to the spec described at the top of this
+    file
 
     Args:
         command: the command object
@@ -121,8 +142,8 @@ def compile_command(command):
 
 def dynamic_compile(*components, compile_key=None):
     """
-    Dynamically compiles a command without the need of a command object to produce
-    the spec described at the top of this file.
+    Dynamically compiles a command without the need of a command object to
+    produce the spec described at the top of this file.
 
     Args:
         *components: a list of components to be compiled
@@ -149,6 +170,7 @@ def wrap_command(command):
     Returns:
         the output of the command after it's been executed
     """
+
     def _wrapped(**kwargs):
         vals = command(Get_Compartment_Batch(), **kwargs)
         Set_Compartment_Batch(vals)

ngcsimlib/component.py

@@ -3,21 +3,20 @@
 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,
-    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
-    their internal state (values) forward in time.
+    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, 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 their internal state (values)
+    forward in time.
     """
 
     def __init__(self, name, **kwargs):
@@ -31,8 +30,7 @@ def __init__(self, name, **kwargs):
             name: the name of the component
 
             kwargs: additional keyword arguments. These are not used in the
-            base class,
-                but this is here for future use if needed.
+            base class, but this is here for future use if needed.
         """
         # Component Data
         self.name = name
@@ -112,4 +110,3 @@ def save(self, directory, **kwargs):
     @abstractmethod
     def help(cls):
         pass
-

ngcsimlib/configManager.py

@@ -55,7 +55,8 @@ def get_config(configName):
         configName: configuration section to get
 
     Returns:
-         dictionary representing the configuration section, None if section is not present
+         dictionary representing the configuration section, None if section
+         is not present
     """
     return _GlobalConfig.get_config(configName)
 
@@ -68,6 +69,7 @@ def provide_namespace(configName):
         configName: configuration section to get
 
     Returns:
-         simple namespace representing the configuration section, none if section is not present
+         simple namespace representing the configuration section, none if
+         section is not present
     """
     return _GlobalConfig.provide_namespace(configName)

ngcsimlib/context.py

@@ -52,10 +52,9 @@ def __new__(cls, name, *args, **kwargs):
     def __init__(self, name, should_validate=None):
         """
         Builds the initial context object, if `__new__` provides an already
-        initialized context do not continue with
-        construction as it is already initialized. This is where the path to
-        a context is assigned so their paths are
-        dependent on the current context path upon creation.
+        initialized context do not continue with construction as it is
+        already initialized. This is where the path to a context is assigned
+        so their paths are dependent on the current context path upon creation.
 
         Args:
              name: The name of the new context can not be empty
@@ -112,8 +111,8 @@ def get_components(self, *component_names, unwrap=True):
             a single component is retrieved
 
         Returns:
-             either a list of components or a single component depending on
-             the number of components being retrieved
+            either a list of components or a single component depending on
+            the number of components being retrieved
         """
         if len(component_names) == 0:
             return None
@@ -163,8 +162,7 @@ def register_command(self, klass, *args, components=None, command_name=None,
     def register_component(self, component, *args, **kwargs):
         """
         Adds a component to the local json storage for saving, will provide a
-        warning for all values it fails to
-        serialize into a json file
+        warning for all values it fails to serialize into a json file
 
         Args:
             component: the component object to save
@@ -235,10 +233,9 @@ def add_command(self, command, name=None):
     def save_to_json(self, directory, model_name=None, custom_save=True,
                      overwrite=False):
         """
-        Dumps all the required json files to rebuild the current controller
-        to a specified directory. If there is a
-        `save` command present on the controller and custom_save is True,
-        it will run that command as well.
+        Dumps all the required json files to rebuild the current controller to
+        a specified directory. If there is a `save` command present on the
+        controller and custom_save is True, it will run that command as well.
 
         Args:
             directory: The top level directory to save the model to
@@ -251,8 +248,7 @@ def save_to_json(self, directory, model_name=None, custom_save=True,
                 command if present on the controller (Default: True)
 
             overwrite: A boolean for if the saved model should be in a unique
-            folder or if it should overwrite
-            existing folders
+                folder or if it should overwrite existing folders
 
         Returns:
             a tuple where the first value is the path to the model, and the
@@ -372,9 +368,8 @@ def make_components(self, path_to_components_file, custom_file_dir=None):
                 and extension
 
             custom_file_dir: the path to the custom directory for custom load
-            methods,
-                this directory is named `custom` if the save_to_json method is
-                used. (Default: None)
+                methods, this directory is named `custom` if the save_to_json
+                method is used. (Default: None)
         """
         made_components = []
         with open(path_to_components_file, 'r') as file:
@@ -466,9 +461,8 @@ def _make_op(self, op_spec):
     def dynamicCommand(fn):
         """
         Provides a decorator that will automatically bind the decorated
-        method to the current context.
-        Note this if this is called from a context object it will still use
-        the current context not the object
+        method to the current context. Note this if this is called from a
+        context object it will still use the current context not the object
 
         Args:
             fn: The wrapped method
@@ -482,8 +476,8 @@ def dynamicCommand(fn):
 
     def compile_by_key(self, *components, compile_key, name=None):
         """
-        Compiles a given set of components with a given compile key.
-        It will automatically add it to the context after compiling
+        Compiles a given set of components with a given compile key. It will
+        automatically add it to the context after compiling
 
         Args:
             *components: positional arguments for all components
@@ -600,6 +594,7 @@ def view_guide(self, guide, skip=None):
         """
         Views the specified guide for each component class in the model,
         skipping over any classes in skip.
+
         Args:
             guide: A ngclearn.GuideList value
             skip: a list of classes to skip, will also skip component classes