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: MulticastRoutingTables)

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

Parameters:

compressed_routing_tables (MulticastRoutingTables) – the compressed routing tables

spinn_front_end_common.utilities.report_functions.reports.generate_routing_table(routing_table: AbstractMulticastRoutingTable, top_level_folder: str)

Parameters:

• routing_table (AbstractMulticastRoutingTable) – The routing table to describe

• top_level_folder (str)

spinn_front_end_common.utilities.report_functions.reports.partitioner_report() → None

Generate report on the partitioning of vertices.

spinn_front_end_common.utilities.report_functions.reports.placement_report_with_application_graph_by_core() → None

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() → None

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

spinn_front_end_common.utilities.report_functions.reports.placer_reports_with_application_graph() → None

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

spinn_front_end_common.utilities.report_functions.reports.router_compressed_summary_report(routing_tables: MulticastRoutingTables) → RouterSummary | None

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: MulticastRoutingTables)

Report the compressed routing tables.

Parameters:

routing_tables (MulticastRoutingTables) – the compressed routing tables

spinn_front_end_common.utilities.report_functions.reports.router_report_from_paths() → None

Generates a text file of routing paths.

spinn_front_end_common.utilities.report_functions.reports.router_report_from_router_tables() → None

Report the uncompressed routing tables.

spinn_front_end_common.utilities.report_functions.reports.router_summary_report() → RouterSummary | None

Generates a text file of routing summaries.

Return type:

RouterSummary

spinn_front_end_common.utilities.report_functions.reports.routing_info_report(extra_allocations: Iterable[Tuple[ApplicationVertex, str]] = ())

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

Parameters:

extra_allocations (iterable(tuple(ApplicationVertex,str))) – Extra vertex/partition ID pairs to report on.

spinn_front_end_common.utilities.report_functions.reports.sdram_usage_report_per_chip() → None

Reports the SDRAM used per chip.

spinn_front_end_common.utilities.report_functions.reports.tag_allocator_report() → None

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

spinn_front_end_common.utilities.report_functions.router_summary module

class spinn_front_end_common.utilities.report_functions.router_summary.RouterSummary(total_entries: int, max_per_chip: int, max_defaultable: int, max_link: int, unqiue_routes: int)

Bases: object

Summary of information about a router.

property max_defaultable: int

Return type:

int

property max_link: int

Return type:

int

property max_per_chip: int

Return type:

int

property total_entries: int

Return type:

int

property unqiue_routes: int

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: MulticastRoutingTables, compressed_routing_tables: MulticastRoutingTables) → None

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

Parameters:

• routing_tables (MulticastRoutingTables) – the original routing tables

• compressed_routing_tables (MulticastRoutingTables) – the compressed routing tables

Module contents

class spinn_front_end_common.utilities.report_functions.BitFieldSummary(total_merged: int | str, max_per_chip: int | str, lowest_per_chip: int | str, total_to_merge: int, max_to_merge_per_chip: int | str, low_to_merge_per_chip: int | str, average_per_chip_merged: float | str, average_per_chip_to_merge: float)

Bases: object

Summary description of generated bitfields.

average_per_chip_merged: float | str

average_per_chip_to_merge: float

low_to_merge_per_chip: int | str

lowest_per_chip: int | str

max_per_chip: int | str

max_to_merge_per_chip: int | str

total_merged: int | str

total_to_merge: int

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: Final = 3600000

write_energy_report(power_used: PowerUsed)

Writes the report.

Parameters:

• machine (Machine) – the machine

• power_used (PowerUsed)

spinn_front_end_common.utilities.report_functions.bitfield_compressor_report() → BitFieldSummary | None

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

spinn_front_end_common.utilities.report_functions.board_chip_report() → None

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

spinn_front_end_common.utilities.report_functions.drift_report() → None

A report on the clock drift as reported by each chip

spinn_front_end_common.utilities.report_functions.fixed_route_from_machine_report() → None

Writes the fixed routes from the machine.

spinn_front_end_common.utilities.report_functions.memory_map_on_host_chip_report() → None

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() → None

Report on memory usage.

spinn_front_end_common.utilities.report_functions.network_specification() → None

Generate report on the user’s network specification.

spinn_front_end_common.utilities.report_functions.routing_table_from_machine_report(routing_tables: MulticastRoutingTables)

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:

• routing_tables (MulticastRoutingTables) – Compressed routing tables

• transceiver (Transceiver)

• app_id (int)

spinn_front_end_common.utilities.report_functions.tags_from_machine_report() → None

Describes what the tags actually present on the machine are.

spinn_front_end_common.utilities.report_functions.write_json_machine(json_folder: str | None = None, progress_bar: bool = True, validate: bool = True) → str

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

• validate (bool) – Flag to disable the validation.

Returns:

the name of the generated file

Return type:

str

spinn_front_end_common.utilities.report_functions.write_json_placements() → None

Runs the code to write the placements in JSON.

spinn_front_end_common.utilities.report_functions.write_json_routing_tables(router_tables: MulticastRoutingTables) → str

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

Parameters:

router_tables (MulticastRoutingTables) – Routing Tables to convert. Could be uncompressed or compressed