Create and fill in a PyNN Report

Author: rowleya

spynnaker/pyNN/data/spynnaker_data_view.py

@@ -13,13 +13,15 @@
 # limitations under the License.
 from __future__ import annotations
 import logging
-from typing import Iterator, Optional, Set, Tuple, TYPE_CHECKING
+from typing import (
+    Iterator, Optional, Set, Tuple, TYPE_CHECKING, List, Any, Dict)
 
 from spinn_utilities.log import FormatAdapter
 
 from spinn_front_end_common.data import FecDataView
 
 from spynnaker import _version
+from spinn_utilities.config_holder import get_config_bool, get_report_path
 
 if TYPE_CHECKING:
     from spynnaker.pyNN.models.projection import Projection
@@ -51,7 +53,8 @@ class _SpynnakerDataModel(object):
         "_id_counter",
         "_min_delay",
         "_populations",
-        "_projections")
+        "_projections",
+        "_pynn_report")
 
     def __new__(cls) -> '_SpynnakerDataModel':
         if cls.__singleton is not None:
@@ -70,6 +73,7 @@ def _clear(self) -> None:
         # Using a dict to verify if later could be stored here only
         self._populations: Set[Population] = set()
         self._projections: Set[Projection] = set()
+        self._pynn_report = None
 
     def _hard_reset(self) -> None:
         """
@@ -233,3 +237,24 @@ def get_sim_name(cls) -> str:
         :returns: The name to be returned by `pyNN.spiNNaker.name`.
         """
         return _version.NAME
+
+    @classmethod
+    def write_pynn_report(cls, text: str, *args: List[Any],
+                          **kwargs: Dict[str, Any]) -> None:
+        """
+        Writes text to the PyNN report file, or does nothing if the report is
+        disabled.
+
+        :param text: The text to write to the report file.
+        :param args: Any additional arguments to format into the text using
+            `str.format`.
+        :param kwargs: Any additional keyword arguments to format into the text
+            using `str.format`.
+        """
+        if not get_config_bool("Reports", "write_pynn_report"):
+            return
+        if cls.__spy_data._pynn_report is None:
+            cls.__spy_data._pynn_report = get_report_path("path_pynn_report")
+        with open(cls.__spy_data._pynn_report, "a", encoding="utf-8") as f:
+            f.write(text.format(*args, **kwargs))
+            f.write("\n")

spynnaker/pyNN/models/neural_projections/connectors/multapse_connector.py

@@ -276,7 +276,7 @@ def create_synaptic_block(
         return block
 
     def __repr__(self) -> str:
-        return f"MultapseConnector({self.__num_synapses})"
+        return f"FixedTotalNumberConnector({self.__num_synapses})"
 
     @property
     @overrides(AbstractGenerateConnectorOnMachine.gen_connector_id)

spynnaker/pyNN/models/neuron/abstract_pynn_neuron_model_standard.py

@@ -93,3 +93,6 @@ def create_vertex(
             splitter=splitter, seed=seed, n_colour_bits=n_colour_bits,
             neurons_per_core=neurons_per_core, n_synapse_cores=n_synapse_cores,
             allow_delay_extensions=allow_delay_extensions)
+
+    def __str__(self) -> str:
+        return f"{self._model}"

spynnaker/pyNN/models/neuron/additional_inputs/additional_input_ca2_adaptive.py

@@ -22,6 +22,7 @@
 from spynnaker.pyNN.data import SpynnakerDataView
 
 from .abstract_additional_input import AbstractAdditionalInput
+from typing import Dict
 
 I_ALPHA = "i_alpha"
 I_CA2 = "i_ca2"
@@ -56,6 +57,13 @@ def __init__(self, tau_ca2: ModelParameter, i_ca2: ModelParameter,
         self.__i_ca2 = i_ca2
         self.__i_alpha = i_alpha
 
+    @overrides(AbstractAdditionalInput.get_param_values)
+    def get_param_values(self) -> Dict[str, ModelParameter]:
+        return {
+            TAU_CA2: self.__tau_ca2,
+            I_ALPHA: self.__i_alpha,
+            TIME_STEP: SpynnakerDataView.get_simulation_time_step_ms()}
+
     @overrides(AbstractAdditionalInput.add_parameters)
     def add_parameters(self, parameters: RangeDictionary[float]) -> None:
         parameters[TAU_CA2] = self._convert(self.__tau_ca2)

spynnaker/pyNN/models/neuron/implementations/abstract_standard_neuron_component.py

@@ -109,3 +109,10 @@ def _convert(value: ModelParameter) -> \
             return value
         # TODO: Is this correct? Without this, things will only handle floats
         return SpynnakerRangedList(None, value)
+
+    @abstractmethod
+    def get_param_values(self) -> Dict[str, ModelParameter]:
+        """
+        The parameters of the component and their values
+        """
+        raise NotImplementedError

spynnaker/pyNN/models/neuron/implementations/neuron_impl_standard.py

@@ -197,3 +197,10 @@ def __getitem__(self, key: str) -> Any:
         # ... or fail
         raise AttributeError(
             f"'{self.__class__.__name__}' object has no attribute {key}")
+
+    def __str__(self) -> str:
+        param_values: str = "";
+        for component in self.__components:
+            for param, value in component.get_param_values().items():
+                param_values += f"{param}={value}, "
+        return f"{self.__class__.__name__}({param_values[:-2]})"

spynnaker/pyNN/models/neuron/implementations/neuron_impl_stoc_exp.py

@@ -163,3 +163,8 @@ def get_units(self, variable: str) -> str:
     @overrides(AbstractNeuronImpl.is_conductance_based)
     def is_conductance_based(self) -> bool:
         return False
+
+    def __str__(self) -> str:
+        return (
+            f"NeuronImplStocExp(tau={self._tau}, bias={self._bias}, "
+            f"refract_init={self._refract_init}, seed={self._random.seed})")

spynnaker/pyNN/models/neuron/implementations/neuron_impl_stoc_exp_stable.py

@@ -180,3 +180,10 @@ def get_units(self, variable: str) -> str:
     @overrides(AbstractNeuronImpl.is_conductance_based)
     def is_conductance_based(self) -> bool:
         return False
+
+    def __str__(self) -> str:
+        return (
+            f"{self.model_name}(v_init={self._v_init}, "
+            f"v_reset={self._v_reset}, tau={self._tau}, "
+            f"tau_refrac={self._tau_refrac}, bias={self._bias}, "
+            f"refract_init={self._refract_init}, seed={self._random.seed})")

spynnaker/pyNN/models/neuron/implementations/neuron_impl_stoc_sigma.py

@@ -166,3 +166,9 @@ def get_units(self, variable: str) -> str:
     @overrides(AbstractNeuronImpl.is_conductance_based)
     def is_conductance_based(self) -> bool:
         return False
+
+    def __str__(self) -> str:
+        return (f"NeuronImplStocSigma(tau_refrac={self._tau_refrac}, "
+                f"alpha={self._alpha}, bias={self._bias}, "
+                f"refract_init={self._refract_init}, "
+                f"seed={self._random.rng.seed})")

spynnaker/pyNN/models/neuron/input_types/input_type_conductance.py

@@ -21,6 +21,7 @@
 from spynnaker.pyNN.utilities.struct import Struct
 
 from .abstract_input_type import AbstractInputType
+from typing import Dict
 
 E_REV_E = "e_rev_E"
 E_REV_I = "e_rev_I"
@@ -49,6 +50,10 @@ def __init__(self, e_rev_E: ModelParameter, e_rev_I: ModelParameter):
         self.__e_rev_E = e_rev_E
         self.__e_rev_I = e_rev_I
 
+    @overrides(AbstractInputType.get_param_values)
+    def get_param_values(self) -> Dict[str, ModelParameter]:
+        return {E_REV_E: self.__e_rev_E, E_REV_I: self.__e_rev_I}
+
     @overrides(AbstractInputType.add_parameters)
     def add_parameters(self, parameters: RangeDictionary[float]) -> None:
         parameters[E_REV_E] = self._convert(self.__e_rev_E)