merge

Author: Christian-B

proxy_integration_tests/test_python_debug/check_debug.py

@@ -16,79 +16,37 @@
 from unittest.case import SkipTest
 from requests.exceptions import ConnectionError
 
-from spinn_utilities.config_holder import get_config_bool
+from spinn_utilities.config_holder import (
+    config_options, config_sections, get_report_path, get_timestamp_path)
 
-from spinn_front_end_common.interface.interface_functions \
-    import load_using_advanced_monitors
-import spinn_front_end_common.utilities.report_functions.reports as \
-    reports_names
-from spinn_front_end_common.utilities.report_functions.network_specification \
-    import _FILENAME as network_specification_file_name
-from spinn_front_end_common.utilities.report_functions.drift_report import (
-    CLOCK_DRIFT_REPORT)
-from spinn_front_end_common.utilities.report_functions.\
-    memory_map_on_host_report import _FOLDER_NAME as \
-    memory_map_on_host_report
-# from spinn_front_end_common.utilities.report_functions.energy_report \
-#    import EnergyReport
-from spinn_front_end_common.utilities.report_functions.board_chip_report \
-    import AREA_CODE_REPORT_NAME
-from spinn_front_end_common.utilities.report_functions.\
-    fixed_route_from_machine_report import REPORT_NAME as fixed_route_report
-from spinn_front_end_common.utility_models import \
-     DataSpeedUpPacketGatherMachineVertex
 from spinnaker_testbase import BaseTestCase
-from spynnaker.pyNN.data import SpynnakerDataView
-from spynnaker.pyNN.extra_algorithms.\
-    spynnaker_neuron_network_specification_report import (
-        _GRAPH_NAME)
+from spynnaker.pyNN.config_setup import cfg_paths_skipped
 import pyNN.spiNNaker as sim
 
 
 class CheckDebug(BaseTestCase):
     """
     that it does not crash in debug mode. All reports on.
     """
-    def debug(self):
-        # pylint: disable=protected-access
-        reports = [
-            # write_energy_report
-            # EnergyReport._DETAILED_FILENAME,
-            # EnergyReport._SUMMARY_FILENAME,
-            # write_text_specs = False
-            "data_spec_text_files",
-            # write_router_reports
-            reports_names._ROUTING_FILENAME,
-            # write_partitioner_reports
-            reports_names._PARTITIONING_FILENAME,
-            # write_application_graph_placer_report
-            reports_names._PLACEMENT_VTX_GRAPH_FILENAME,
-            reports_names._PLACEMENT_CORE_GRAPH_FILENAME,
-            reports_names._SDRAM_FILENAME,
-            # repeats reports_names._SDRAM_FILENAME,
-            # write_router_info_report
-            reports_names._VIRTKEY_FILENAME,
-            # write_routing_table_reports
-            reports_names._ROUTING_TABLE_DIR,
-            reports_names._C_ROUTING_TABLE_DIR,
-            reports_names._COMPARED_FILENAME,
-            # write_memory_map_report
-            memory_map_on_host_report,
-            # write_network_specification_report
-            network_specification_file_name,
-            "provenance_data",
-            # write_tag_allocation_reports
-            reports_names._TAGS_FILENAME,
-            # write_drift_report_end or start
-            CLOCK_DRIFT_REPORT,
-            # write_board_chip_report
-            AREA_CODE_REPORT_NAME,
-            _GRAPH_NAME,
-            # graphviz exe may not be installed so there will be no image file
-            # _GRAPH_NAME + "." + _GRAPH_FORMAT,
-            fixed_route_report,
-            ]
 
+    def assert_reports(self):
+        skipped = cfg_paths_skipped()
+        for section in config_sections():
+            for option in config_options(section):
+                if option in skipped:
+                    continue
+                if option.startswith("path"):
+                    path = get_report_path(section=section, option=option)
+                elif option.startswith("tpath"):
+                    path = get_timestamp_path(section=section, option=option)
+                else:
+                    continue
+                print(f"found {option} at {path}")
+                if not os.path.exists(path):
+                    raise AssertionError(
+                        f"Unable to find report for {option} {path}")
+
+    def debug(self):
         sim.setup(1.0)
         pop = sim.Population(100, sim.IF_curr_exp, {}, label="pop")
         pop.record("v")
@@ -102,23 +60,9 @@ def debug(self):
             raise SkipTest("DNS Error Monster!")
 
         pop.get_data("v")
-        run0 = SpynnakerDataView.get_run_dir_path()
-        found = os.listdir(run0)
-        if (get_config_bool("Machine", "enable_advanced_monitor_support")
-                and not get_config_bool("Java", "use_java")):
-            # write_data_speed_up_report
-            reports.append(
-                DataSpeedUpPacketGatherMachineVertex.OUT_REPORT_NAME)
-            if load_using_advanced_monitors():
-                reports.append(
-                    DataSpeedUpPacketGatherMachineVertex.IN_REPORT_NAME)
-        for report in reports:
-            self.assertIn(report, found)
-        self.assertIn("data.sqlite3", found)
-        self.assertIn("ds.sqlite3", found)
+        self.assert_reports()
 
         sim.run(10)  # second run
         pop.get_data("v")
-        self.assertEqual(run0, SpynnakerDataView.get_run_dir_path())
 
         sim.end()

spynnaker/pyNN/config_setup.py

@@ -13,10 +13,15 @@
 # limitations under the License.
 
 import os
+from typing import Set
+
 from spinn_utilities.config_holder import (
     clear_cfg_files, set_cfg_files)
 from spinn_front_end_common.interface.config_setup import (
     add_default_cfg, add_spinnaker_cfg)
+from spinn_front_end_common.interface.config_setup import (
+    fec_cfg_paths_skipped)
+
 from spynnaker.pyNN.data.spynnaker_data_writer import SpynnakerDataWriter
 
 CONFIG_FILE_NAME = "spynnaker.cfg"
@@ -62,3 +67,12 @@ def add_spynnaker_cfg() -> None:
     """
     add_spinnaker_cfg()  # This add its dependencies too
     add_default_cfg(os.path.join(os.path.dirname(__file__), CONFIG_FILE_NAME))
+
+
+def cfg_paths_skipped() -> Set[str]:
+    """
+    Set of cfg path that would not be found based on other cfg settings
+
+    Assuming mode = Debug
+    """
+    return fec_cfg_paths_skipped()

spynnaker/pyNN/extra_algorithms/redundant_packet_count_report.py

@@ -11,13 +11,16 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-import os
+
 import logging
 from typing import Final, TextIO, Tuple, cast
+
+from spinn_utilities.config_holder import get_report_path
 from spinn_utilities.log import FormatAdapter
+
 from spinn_front_end_common.interface.provenance import (
     ProvenanceReader, ProvenanceWriter)
-from spynnaker.pyNN.data import SpynnakerDataView
+
 from spynnaker.pyNN.models.neuron import PopulationMachineVertex
 
 logger = FormatAdapter(logging.getLogger(__name__))
@@ -70,7 +73,6 @@
     """
 
 
-_FILE_NAME = "redundant_packet_count.rpt"
 _N_PROV_ITEMS_NEEDED = 4
 _MAX = 100
 
@@ -79,7 +81,7 @@ def redundant_packet_count_report() -> None:
     """
     Writes a report detailing the redundant packet counts.
     """
-    file_name = os.path.join(SpynnakerDataView.get_run_dir_path(), _FILE_NAME)
+    file_name = get_report_path("path_redundant_packet_count_report")
 
     try:
         _create_views()

spynnaker/pyNN/extra_algorithms/spynnaker_neuron_network_specification_report.py

@@ -13,9 +13,10 @@
 # limitations under the License.
 from __future__ import annotations
 import logging
-import os
 from typing import Dict, Set, Tuple, Type, TypeVar, TYPE_CHECKING
-from spinn_utilities.config_holder import get_config_str_or_none
+
+from spinn_utilities.config_holder import (
+    get_config_str_or_none, get_report_path)
 from spinn_utilities.log import FormatAdapter
 from spinn_utilities.progress_bar import ProgressBar
 from pacman.model.graphs.application import ApplicationVertex
@@ -30,7 +31,6 @@
 
 CUTOFF = 100
 _GRAPH_TITLE = "The graph of the network in graphical form"
-_GRAPH_NAME = "network_graph.gv"
 _GRAPH_FORMAT = "png"
 
 
@@ -82,15 +82,15 @@ def spynnaker_neuron_graph_network_specification_report() -> None:
     _generate_edges(dot_diagram, vertex_ids, progress)
 
     # write dot file and generate PDF
-    file_to_output = os.path.join(
-        SpynnakerDataView.get_run_dir_path(), _GRAPH_NAME)
-    progress.end()
+    file_to_output = get_report_path("path_network_graph")
 
     logger.info(f"rendering dot diagram {file_to_output}")
     try:
         dot_diagram.render(file_to_output, view=False, format=graph_format)
     except exe_not_found_exn:
         logger.exception("could not render diagram in {}", file_to_output)
+    finally:
+        progress.end()
 
 
 def _generate_vertices(

spynnaker/pyNN/spynnaker.cfg

@@ -9,48 +9,68 @@
 # and SpiNNMachine/spinn_machine/spinn_machine.cfg
 
 [Reports]
+
 # Note: graphviz is required to draw the graph
 write_network_graph = Debug
-# Unless specified write_network_graph is ignored for large graphs
-# For small graph the default format is used
+@write_network_graph = Draws a grpah of the network using graphviz (Which most be installed)
+path_network_graph = network_graph.gv
+
 network_graph_format = None
-# Set to > 0 to allow profiler to gather samples (assuming enabled in the compiled aplx)
+@network_graph_format = Format to use to [draw](write_network_graph) a large graph
+    Unless specified [draw](write_network_graph) is disabled for large graphs
+    For small graph the [default format](path_network_graph) is used
+
 n_profile_samples = 0
+@n_profile_samples = Set to > 0 to allow profiler to gather samples (assuming enabled in the compiled aplx)
+
 write_expander_iobuf = Debug
+@write_expander_iobuf = Reads and writes the iobuff from the onchip synapse expander.
+  Will be written with [System iobuff](path_iobuf_system)
+
 write_redundant_packet_count_report = Info
+@write_redundant_packet_count_report = Writes a report showing how many redundant packets where recorded.
+path_redundant_packet_count_report = redundant_packet_count.rpt
 
 [Simulation]
-# Maximum spikes per second of any neuron (spike rate in Hertz)
+@ = The section covers settings which control how the models behave.
+
 spikes_per_second = 30
+@spikes_per_second = Maximum spikes per second of any neuron (spike rate in Hertz)
+   Used by all neurons that need this for planning, unless a different value is provided.
 
-# The number of standard deviations from the mean to account for in
-# the ring buffer in terms of how much safety in precision vs overflowing the
-# end user is willing to risk
 ring_buffer_sigma = 5
+@ring_buffer_sigma = The number of standard deviations from the mean to account for in
+   the ring buffer in terms of how much safety in precision vs overflowing the
+   end user is willing to risk
 
-# The amount of space to reserve for incoming spikes
 incoming_spike_buffer_size = 256
+@incoming_spike_buffer_size = The amount of space to reserve for incoming spikes
 
-# performance limiter to throw away packets not processed in a given time step
 drop_late_spikes = False
+@drop_late_spikes = performance limiter to throw away packets not processed in a given time step
 
-# The overhead to add to the transfer clocks
-# when using a split synapse neuron model
 transfer_overhead_clocks = 200
+@transfer_overhead_clocks = The overhead to add to the transfer clocks
+  when using a split synapse neuron model
 
-# The number of "colour" bits to use by default.  This is used to account for
-# delays over the network that are bigger than 1 time step
 n_colour_bits = 4
+@n_colour_bits = The number of "colour" bits to use by default.  This is used to account for
+  delays over the network that are bigger than 1 time step
 
-# Whether to error or just warn on non-spynnaker-compatible PyNN
 error_on_non_spynnaker_pynn = True
+@error_on_non_spynnaker_pynn = Whether to error or just warn on non-spynnaker-compatible PyNN
 
 [Mapping]
-# Setting delay_support_adder to None will skip the adder
 delay_support_adder = DelaySupportAdder
-
+@delay_support_adder = Algorthm for adding Delay verteices.</br>
+    Currently supported options:
+    * DelaySupportAdder: Adds the standard Delays Vertcies if needed
+    * None: will skip the adder (Not Recommended) </br></br>
 
 [Recording]
-# Uncomment the following to change from the defaults
+@ = Section for the sending of live spikes.
+
 live_spike_port = 17895
+@live_spike_port = Port for the Live Packet Gather
 live_spike_host = 0.0.0.0
+@live_spike_host = Host for the Live Packet Gather

spynnaker_integration_tests/test_0_1_time_steps/test_allow_violate/spynnaker.cfg

@@ -1,2 +1,2 @@
 [Machine]
-timeScaleFactor = 1
+time_scale_factor = 1