Added in hyperparams to components

Author: willgebhardt

ngcsimlib/commands/seed.py

@@ -0,0 +1,45 @@
+from ngcsimlib.commands.command import Command
+from ngcsimlib.utils import extract_args
+
+
+class Seed(Command):
+    """
+    In many models there is a need to seed the randomness of a model. While many
+    components will take seeds in at construction these are not always serializable
+    or there might be a need to reseed the model after initialization. To solve
+    this problem ngcsimlib offers the Seed command. This command will simply go
+    through all the provided components and call see with the specified value.
+    """
+
+    def __init__(self, components=None, seed_name=None,
+                 command_name=None, **kwargs):
+        """
+        Required calls on Components: ['seed', 'name']
+
+        Args:
+            components: a list of components to call seed on
+
+            seed_name: a keyword to bind the input for this command do
+
+            command_name: the name of the command on the controller
+
+        """
+        super().__init__(components=components, command_name=command_name,
+                         required_calls=['seed'])
+        if seed_name is None:
+            raise RuntimeError(
+                self.name + " requires a \'seed_name\' to bind to for construction")
+
+        self.seed_name = seed_name
+
+    def __call__(self, *args, **kwargs):
+        try:
+            vals = extract_args([self.seed_name], *args, **kwargs)
+        except RuntimeError:
+            raise RuntimeError(self.name + ", " + str(
+                self.seed_name) + " is missing from keyword arguments or a positional "
+                                   "arguments can be provided")
+
+        for component in self.components:
+            self.components[component].seed(vals[self.seed_name])
+

ngcsimlib/controller.py

@@ -115,9 +115,21 @@ def make_components(self, path_to_components_file, custom_file_dir=None):
                 used. (Default: None)
         """
         with open(path_to_components_file, 'r') as file:
-            components = json.load(file)
+            componentsConfig = json.load(file)
+
+            parameterMap = {}
+            components = componentsConfig["components"]
+            if "hyperparameters" in componentsConfig.keys():
+                for component in components:
+                    for pKey, pValue in componentsConfig["hyperparameters"].items():
+                        for cKey, cValue in component.items():
+                            if pKey == cValue:
+                                component[cKey] = pValue
+                                parameterMap[cKey] = pKey
+
             for component in components:
-                self.add_component(**component, directory=custom_file_dir)
+                self.add_component(**component, directory=custom_file_dir,
+                                   parameterMap=parameterMap)
 
     def make_steps(self, path_to_steps_file):
         """
@@ -197,13 +209,11 @@ def add_component(self, component_type, match_case=False, absolute_path=False, *
             raise RuntimeError("Given component type " + str(component_type)
                                + " is not callable")
 
-
-
-        count = call.__code__.co_argcount - 1
-        named_args = call.__code__.co_varnames[1:count]
         try:
             component = Component_class(**kwargs)
         except TypeError as E:
+            count = call.__code__.co_argcount - 1
+            named_args = call.__code__.co_varnames[1:count]
             print(E)
             raise RuntimeError(str(E) + "\nProvided keyword arguments:\t" + str(list(kwargs.keys())) +
                                "\nRequired keyword arguments:\t" + str(list(named_args)))
@@ -217,6 +227,9 @@ def add_component(self, component_type, match_case=False, absolute_path=False, *
             del obj[key]
             print("Failed to serialize \"" + str(key) + "\" in " + component.name)
 
+        if "directory" in obj.keys():
+            del obj["directory"]
+
         self._json_objects['components'].append(obj)
 
         return component
@@ -347,7 +360,45 @@ def save_to_json(self, directory, model_name=None, custom_save=True):
             json.dump(self._json_objects['steps'], fp, indent=4)
 
         with open(path + "/components.json", 'w') as fp:
-            json.dump(self._json_objects['components'], fp, indent=4)
+            hyperparameters = {}
+
+            for idx, component in enumerate(self._json_objects['components']):
+                if component.get('parameterMap', None) is not None:
+                    for cKey, pKey in component['parameterMap'].items():
+                        pVal = component[cKey]
+                        if pKey not in hyperparameters.keys():
+                            hyperparameters[pKey] = []
+                        hyperparameters[pKey].append((idx, cKey, pVal))
+
+            hp = {}
+            for param in hyperparameters.keys():
+                matched = True
+                hp[param] = None
+                for _, _, pVal in hyperparameters[param]:
+                    if hp[param] is None:
+                        hp[param] = pVal
+                    elif hp[param] != pVal:
+                        del hp[param]
+                        matched = False
+                        break
+
+                for idx, cKey, _ in hyperparameters[param]:
+                    if matched:
+                        self._json_objects['components'][idx][cKey] = param
+
+                    else:
+                        warnings.warn("Unable to extract hyperparameter " + str(param) +
+                                      " as it is mismatched between components. Parameter will not be extracted")
+
+            for component in self._json_objects['components']:
+                if "parameterMap" in component.keys():
+                    del component["parameterMap"]
+
+            obj = {"components": self._json_objects['components']}
+            if len(hp.keys()) != 0:
+                obj["hyperparameters"] = hp
+
+            json.dump(obj, fp, indent=4)
 
         with open(path + "/connections.json", 'w') as fp:
             json.dump(self._json_objects['connections'], fp, indent=4)

ngcsimlib/json_schemas/components.schema

@@ -1,18 +1,32 @@
 {
-  title: "Components",
-  description: "A list of all components",
-  type: "array",
-  items: {
-    description: "The two required values for creating a components, and then all other keyword arguments needed for to build the components",
-    type: "object",
-    required: ["component_type", "name"],
-    properties: {
-      component_type: {
-        type: "string"
-      },
-      name: {
-        type: "string"
-      },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Components",
+  "description": "A collection of components for the model, and the hyperparameters needed to build them",
+  "type": "object",
+  "properties": {
+    "hyperparameters": {
+      "description": "A mapping of parameter keys to values. To use these simply put the key of the value parameter in for the value and it will automatically be picked up",
+      "type": "object"
+    },
+    "components":   {
+      "description": "A list of all components",
+      "type": "array",
+      "items": {
+        "description": "The two required values for creating a components, and then all other keyword arguments needed for to build the components",
+        "type": "object",
+        "required": [
+          "component_type",
+          "name"
+        ],
+        "properties": {
+          "component_type": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+        }
+      }
     }
   }
-}
+}