spinn_front_end_common.utilities.report_functions package

Submodules

spinn_front_end_common.utilities.report_functions.reports module

spinn_front_end_common.utilities.report_functions.reports.generate_comparison_router_report(compressed_routing_tables)[source]

Make a report on comparison of the compressed and uncompressed routing tables

Parameters:compressed_routing_tables (MulticastRoutingTables) – the compressed routing tables
Return type:None
spinn_front_end_common.utilities.report_functions.reports.generate_routing_table(routing_table, top_level_folder)[source]
Parameters:
  • routing_table (AbstractMulticastRoutingTable) –
  • top_level_folder (str) –
spinn_front_end_common.utilities.report_functions.reports.partitioner_report()[source]

Generate report on the placement of vertices onto cores.

spinn_front_end_common.utilities.report_functions.reports.placement_report_with_application_graph_by_core()[source]

Generate report on the placement of vertices onto cores by core.

spinn_front_end_common.utilities.report_functions.reports.placement_report_with_application_graph_by_vertex()[source]

Generate report on the placement of vertices onto cores by vertex.

spinn_front_end_common.utilities.report_functions.reports.placer_reports_with_application_graph()[source]

Reports that can be produced from placement given a application graph’s existence

Return type:None
spinn_front_end_common.utilities.report_functions.reports.router_compressed_summary_report(routing_tables)[source]

Generates a text file of routing summaries

Parameters:routing_tables (MulticastRoutingTables) – The in-operation COMPRESSED routing tables.
Return type:RouterSummary
spinn_front_end_common.utilities.report_functions.reports.router_report_from_compressed_router_tables(routing_tables)[source]
Parameters:routing_tables (MulticastRoutingTables) – the compressed routing tables
Return type:None
spinn_front_end_common.utilities.report_functions.reports.router_report_from_paths()[source]

Generates a text file of routing paths

Return type:None
spinn_front_end_common.utilities.report_functions.reports.router_report_from_router_tables()[source]
Return type:None
spinn_front_end_common.utilities.report_functions.reports.router_summary_report()[source]

Generates a text file of routing summaries

Return type:RouterSummary
spinn_front_end_common.utilities.report_functions.reports.routing_info_report(extra_allocations)[source]

Generates a report which says which keys is being allocated to each vertex

spinn_front_end_common.utilities.report_functions.reports.sdram_usage_report_per_chip()[source]

Reports the SDRAM used per chip

Return type:None
spinn_front_end_common.utilities.report_functions.reports.tag_allocator_report()[source]

Reports the tags that are being used by the tool chain for this simulation

Return type:None

spinn_front_end_common.utilities.report_functions.router_summary module

class spinn_front_end_common.utilities.report_functions.router_summary.RouterSummary(total_entries, max_per_chip, max_defaultable, max_link, unqiue_routes)[source]

Bases: object

max_defaultable
Return type:int
Return type:int
max_per_chip
Return type:int
total_entries
Return type:int
unqiue_routes
Return type:int

spinn_front_end_common.utilities.report_functions.routing_compression_report module

spinn_front_end_common.utilities.report_functions.routing_compression_report.generate_routing_compression_checker_report(routing_tables, compressed_routing_tables)[source]

Make a full report of how the compressed covers all routes in the and uncompressed routing table

Parameters:
  • report_folder (str) – the folder to store the resulting report
  • routing_tables (MulticastRoutingTables) – the original routing tables
  • compressed_routing_tables (MulticastRoutingTables) – the compressed routing tables
Return type:

None

Module contents

spinn_front_end_common.utilities.report_functions.bitfield_compressor_report()

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

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)

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
spinn_front_end_common.utilities.report_functions.board_chip_report()

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

Return type:None
class spinn_front_end_common.utilities.report_functions.EnergyReport

Bases: object

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

JOULES_TO_KILOWATT_HOURS = 3600000
write_energy_report(power_used)[source]

Writes the report.

Parameters:
Return type:

None
spinn_front_end_common.utilities.report_functions.fixed_route_from_machine_report()

Writes the fixed routes from the machine

Parameters:app_id (int) – the application ID the fixed routes were loaded with
spinn_front_end_common.utilities.report_functions.network_specification()

Generate report on the user’s network specification.

Return type:None
spinn_front_end_common.utilities.report_functions.memory_map_on_host_chip_report()

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

spinn_front_end_common.utilities.report_functions.memory_map_on_host_report()

Report on memory usage.

spinn_front_end_common.utilities.report_functions.router_collision_potential_report()
spinn_front_end_common.utilities.report_functions.routing_table_from_machine_report(routing_tables)

Report the routing table that was actually on the machine.

folder_name = os.path.join(FecDataView().run_dir_path, _FOLDER_NAME) os.mkdir(folder_name)
Parameters:
spinn_front_end_common.utilities.report_functions.tags_from_machine_report()

Describes what the tags actually present on the machine are.

spinn_front_end_common.utilities.report_functions.write_json_machine(json_folder=None, progress_bar=True)

Runs the code to write the machine in Java readable JSON.

Warning

The file in this folder will be overwritten!

Parameters:
  • json_folder (str) – the folder to which the JSON are being written
  • progress_bar (bool) – Flag if Progress Bar should be shown
Returns:

the name of the generated file
Return type:

str
spinn_front_end_common.utilities.report_functions.write_json_placements()

Runs the code to write the placements in JSON.

spinn_front_end_common.utilities.report_functions.write_json_routing_tables(router_tables)

Runs the code to write the machine in Java readable JSON.

Parameters:
  • router_tables (MulticastRoutingTables) – Routing Tables to convert. Could be uncompressed or compressed
  • json_folder (str) – the folder to which the JSON are being written
spinn_front_end_common.utilities.report_functions.drift_report()

A report on the clock drift as reported by each chip