spinn_front_end_common.utilities.report_functions package

Submodules

spinn_front_end_common.utilities.report_functions.energy_report module

class spinn_front_end_common.utilities.report_functions.energy_report.EnergyReport(report_default_directory, version, spalloc_server, remote_spinnaker_url)[source]

Bases: object

This class creates a report about the approximate total energy consumed by a SpiNNaker job execution.

Parameters:
  • report_default_directory (str) – location for reports
  • version (int) – version of machine
  • spalloc_server (str) – spalloc server IP
  • remote_spinnaker_url (str) – remote SpiNNaker URL
JOULES_TO_KILOWATT_HOURS = 3600000

converter between joules to kilowatt hours

write_energy_report(placements, machine, runtime, buffer_manager, power_used)[source]

Writes the report.

Parameters:
Return type:

None

Module contents

Much of the code in this module is intended primarily for being invoked via the PACMAN Executor.

class spinn_front_end_common.utilities.report_functions.BitFieldCompressorReport[source]

Bases: object

Generates a report that shows the impact of the compression of bitfields into the routing table.

__call__(report_default_directory, machine_graph, placements, provenance_items=None)[source]
Parameters:
Returns:

a summary, or None if the report file can’t be written

Return type:

BitFieldSummary

class spinn_front_end_common.utilities.report_functions.BitFieldSummary(total_merged, max_per_chip, lowest_per_chip, total_to_merge, max_to_merge_per_chip, low_to_merge_per_chip, average_per_chip_merged, average_per_chip_to_merge)[source]

Bases: object

Summary description of generated bitfields.

Parameters:
  • total_merged (int) –
  • max_per_chip (int) –
  • lowest_per_chip (int) –
  • total_to_merge (int) –
  • max_to_merge_per_chip (int) –
  • low_to_merge_per_chip (int) –
  • average_per_chip_merged (float) –
  • average_per_chip_to_merge (float) –
average_per_chip_merged
Return type:float
average_per_chip_to_merge
Return type:float
low_to_merge_per_chip
Return type:int
lowest_per_chip
Return type:int
max_per_chip
Return type:int
max_to_merge_per_chip
Return type:int
total_merged
Return type:int
total_to_merge
Return type:int
class spinn_front_end_common.utilities.report_functions.BoardChipReport[source]

Bases: object

Report on memory usage

AREA_CODE_REPORT_NAME = 'board_chip_report.txt'
__call__(report_default_directory, machine)[source]

Creates a report that states where in SDRAM each region is.

Parameters:
  • report_default_directory (str) – the folder where reports are written
  • machine (Machine) – python representation of the machine
Return type:

None

class spinn_front_end_common.utilities.report_functions.EnergyReport(report_default_directory, version, spalloc_server, remote_spinnaker_url)[source]

Bases: object

This class creates a report about the approximate total energy consumed by a SpiNNaker job execution.

Parameters:
  • report_default_directory (str) – location for reports
  • version (int) – version of machine
  • spalloc_server (str) – spalloc server IP
  • remote_spinnaker_url (str) – remote SpiNNaker URL
JOULES_TO_KILOWATT_HOURS = 3600000

converter between joules to kilowatt hours

write_energy_report(placements, machine, runtime, buffer_manager, power_used)[source]

Writes the report.

Parameters:
Return type:

None

class spinn_front_end_common.utilities.report_functions.FixedRouteFromMachineReport[source]

Bases: object

Generate a report of the fixed routes from the machine.

__call__(transceiver, machine, report_default_directory, app_id)[source]

Writes the fixed routes from the machine

Parameters:
  • transceiver (Transceiver) – spinnMan instance
  • machine (Machine) – SpiNNMachine instance
  • report_default_directory (str) – folder where reports reside
  • app_id (int) – the application ID the fixed routes were loaded with
class spinn_front_end_common.utilities.report_functions.NetworkSpecification[source]

Bases: object

Generate report on the user’s network specification.

__call__(report_folder, graph)[source]
Parameters:
  • report_folder (str) – the directory to which reports are stored
  • graph (ApplicationGraph) – the graph generated from the tools
Return type:

None

class spinn_front_end_common.utilities.report_functions.MemoryMapOnHostChipReport[source]

Bases: object

Report on memory usage. Creates a report that states where in SDRAM each region is (read from machine)

__call__(report_default_directory, dsg_targets, transceiver)[source]
Parameters:
  • report_default_directory (str) – the folder where reports are written
  • dsg_targets (dict(tuple(int,int,int),..)) – the map between placement and file writer
  • transceiver (Transceiver) – the spinnMan instance
class spinn_front_end_common.utilities.report_functions.MemoryMapOnHostReport[source]

Bases: object

Report on memory usage.

__call__(report_default_directory, processor_to_app_data_base_address)[source]
Parameters:
spinn_front_end_common.utilities.report_functions.report_xml()[source]
class spinn_front_end_common.utilities.report_functions.RoutingTableFromMachineReport[source]

Bases: object

Report the routing table that was actually on the machine.

__call__(report_default_directory, routing_tables)[source]
Parameters:
class spinn_front_end_common.utilities.report_functions.TagsFromMachineReport[source]

Bases: object

Describes what the tags actually present on the machine are.

__call__(report_default_directory, transceiver)[source]
Parameters: