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

Creates a report of the binaries used.

spinn_front_end_common.utilities.report_functions.reports.generate_comparison_router_report(compressed_routing_tables: MulticastRoutingTables) → None

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

Parameters:

compressed_routing_tables – the compressed routing tables

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

Creates a report of this routing table into the folder.

Parameters:

• routing_table – The routing table to describe

• top_level_folder

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 – The in-operation COMPRESSED routing tables.

Returns:

A summary of the routing information if the writing worked.

spinn_front_end_common.utilities.report_functions.reports.router_report_from_compressed_router_tables(routing_tables: MulticastRoutingTables) → None

Report the compressed routing tables.

Parameters:

routing_tables – 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.

Returns:

A summary of the routing information if the writing worked.

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

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

Parameters:

extra_allocations – 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.

Parameters:

• total_entries – Total entries in all routes

• max_per_chip – Largest number of routes on any Chip

• max_defaultable – Largest number of defaultable routes on any Chip

• max_link – Largest number of link only routes on any Chip

• unqiue_routes – Largest number of unique spinnaker routes on any Chip

property max_defaultable: int

The maximum number of defaultable routes per Chip

property max_link: int

The maximum number of links

property max_per_chip: int

The maximum number of routes per Chip

property total_entries: int

The total entries as passed into the init

property unqiue_routes: int

The number of unique routes

Module contents

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.

write_energy_report(power_used: PowerUsed) → None

Writes the report.

Parameters:

power_used

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.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 – the original routing tables

• compressed_routing_tables – the compressed routing tables

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.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(progress_bar: bool = True) → str

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

Warning

The file in this folder will be overwritten!

Parameters:

progress_bar – Flag if Progress Bar should be shown

Returns:

the name of the generated file

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 – Routing Tables to convert. Could be uncompressed or compressed

Returns:

Path to the json file