allow static param to have None value

docs/source/notebooks/AdvancedGuide.ipynb

@@ -157,7 +157,7 @@
     "# Set individual param to dynamic\n",
     "G1.x0.to_dynamic()  # call function to set dynamic\n",
     "G1.q = None  # set to None to make fully dynamic\n",
-    "G1.q.dynamic_value(0.5)  # set with dynamic value\n",
+    "G1.q.to_dynamic(0.5)  # set with dynamic value\n",
     "C.to_dynamic()  # only sets immediate children to dynamic\n",
     "print(\"Individual params can be set to dynamic\")\n",
     "display(C.graphviz())\n",
@@ -173,7 +173,7 @@
     "G1.q.to_static()  # Setting to static, uses the earlier value\n",
     "\n",
     "# Setting a value and make it static\n",
-    "G1.I0.static_value(10.0)\n",
+    "G1.I0.to_static(10.0)\n",
     "print(\"Individual params can be set to static\")\n",
     "display(C.graphviz())\n",
     "\n",

docs/source/notebooks/BeginnersGuide.ipynb

@@ -298,10 +298,10 @@
     "thirdsim.x0 = lambda p: p.time.value * torch.tensor((1, 1)) - 0.5\n",
     "thirdsim.x0.link(simtime)\n",
     "\n",
-    "# Use `static_value` to set the value and set to static\n",
-    "# Similarly use `dynamic_value` to set value and set dynamic\n",
-    "secondsim.q.static_value(0.5)\n",
-    "secondsim.phi.static_value(3.14 / 3)\n",
+    "# Use `to_static(value)` to set the value and set to static\n",
+    "# Similarly use `to_dynamic(value)` to set value and set dynamic\n",
+    "secondsim.q.to_static(0.5)\n",
+    "secondsim.phi.to_static(3.14 / 3)\n",
     "\n",
     "combinedsim.graphviz()"
    ]

src/caskade/__init__.py

@@ -17,6 +17,7 @@
     ParamConfigurationError,
     ParamTypeError,
     ActiveStateError,
+    FillParamsError,
     FillDynamicParamsError,
     FillDynamicParamsArrayError,
     FillDynamicParamsSequenceError,
@@ -51,6 +52,7 @@
     "ParamConfigurationError",
     "ParamTypeError",
     "ActiveStateError",
+    "FillParamsError",
     "FillDynamicParamsError",
     "FillDynamicParamsArrayError",
     "FillDynamicParamsSequenceError",

src/caskade/collection.py

@@ -1,3 +1,5 @@
+from typing import Iterable
+
 from .base import Node
 
 
@@ -12,6 +14,10 @@ def to_static(self, **kwargs):
             if hasattr(node, "to_static"):
                 node.to_static(**kwargs)
 
+    def fill_values(self, values: Iterable):
+        for node, value in zip(self, values):
+            node.value = value
+
     def copy(self):
         raise NotImplementedError
 

src/caskade/errors.py

@@ -36,7 +36,11 @@ class ActiveStateError(CaskadeException):
     """Class for exceptions related to the active state of a node in ``caskade``."""
 
 
-class FillDynamicParamsError(CaskadeException):
+class FillParamsError(CaskadeException):
+    """Class for exceptions related to filling parameters in ``caskade``"""
+
+
+class FillDynamicParamsError(FillParamsError):
     """Class for exceptions related to filling dynamic parameters in ``caskade``."""
 
 

src/caskade/module.py

@@ -8,7 +8,7 @@
 from .errors import (
     ActiveStateError,
     ParamConfigurationError,
-    FillDynamicParamsError,
+    FillParamsError,
     FillDynamicParamsArrayError,
     FillDynamicParamsSequenceError,
     FillDynamicParamsMappingError,
@@ -165,7 +165,7 @@ def _fill_dict(self, node, params, dynamic_values=False):
         for key in params:
             if key in node.children and isinstance(node[key], Param) and node[key].dynamic:
                 if dynamic_values:
-                    node[key].dynamic_value(params[key])
+                    node[key].to_dynamic(params[key])
                 else:
                     node[key]._value = params[key]
             elif (
@@ -229,7 +229,7 @@ def _fill_values(
                 try:
                     val = backend.view(params[..., pos : pos + size], B + param.shape)
                     if dynamic_values:
-                        param.dynamic_value(val)
+                        param.to_dynamic(val)
                     else:
                         param._value = val
                 except (RuntimeError, IndexError, ValueError, TypeError):
@@ -244,7 +244,7 @@ def _fill_values(
             elif len(params) == len(dynamic_params):
                 for param, value in zip(dynamic_params, params):
                     if dynamic_values:
-                        param.dynamic_value(value)
+                        param.to_dynamic(value)
                     else:
                         param._value = value
             elif len(params) == len(self.dynamic_modules):
@@ -312,7 +312,7 @@ def fill_kwargs(self, keys: tuple[str]) -> dict[str, ArrayLike]:
             if key in self.children and isinstance(self[key], Param):
                 val = self.children[key].value
                 if val is None:
-                    raise FillDynamicParamsError(
+                    raise FillParamsError(
                         f"Param {key} in Module {self.name} has no value. "
                         "Ensure that the parameter is set before calling the forward method or provided with the params."
                     )
@@ -332,7 +332,7 @@ def _check_dynamic_values(self, params_type: str = "ArrayLike"):
         """Check if all dynamic values are set."""
         bad_params = []
         for param in self.dynamic_params:
-            if "value" not in param.node_type:
+            if param.value is None:
                 bad_params.append(param.name)
         if len(bad_params) > 0:
             raise ParamConfigurationError(