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

Bases: object

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

JOULES_TO_KILOWATT_HOURS = 3600000

converter between joules to kilowatt hours

write_energy_report(placements, machine, runtime, buffer_manager, power_used)

Writes the report.

Parameters:

• placements (Placements) – the placements
• machine (Machine) – the machine
• runtime (int) –
• buffer_manager (BufferManager) –
• power_used (PowerUsed) –

Return type:

None

Module contents

spinn_front_end_common.utilities.report_functions.bitfield_compressor_report(machine_graph, placements)

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

Parameters:

• machine_graph (MachineGraph) – the machine graph
• placements (Placements) – the placements

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(machine)

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

Parameters:machine (Machine) – python representation of the machine 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

converter between joules to kilowatt hours

write_energy_report(placements, machine, runtime, buffer_manager, power_used)

Writes the report.

Parameters:

• placements (Placements) – the placements
• machine (Machine) – the machine
• runtime (int) –
• buffer_manager (BufferManager) –
• power_used (PowerUsed) –

Return type:

None

spinn_front_end_common.utilities.report_functions.fixed_route_from_machine_report(transceiver, machine, app_id)

Writes the fixed routes from the machine

Parameters:

• transceiver (Transceiver) – spinnMan instance
• machine (Machine) – SpiNNMachine instance
• app_id (int) – the application ID the fixed routes were loaded with

spinn_front_end_common.utilities.report_functions.network_specification(graph)

Generate report on the user’s network specification.

Parameters:graph (ApplicationGraph) – the graph generated from the tools Return type:None

spinn_front_end_common.utilities.report_functions.memory_map_on_host_chip_report(dsg_targets, transceiver)

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

Parameters:

• dsg_targets (dict(tuple(int,int,int),..)) – the map between placement and file writer
• transceiver (Transceiver) – the spinnMan instance

spinn_front_end_common.utilities.report_functions.memory_map_on_host_report(dsg_targets)

Report on memory usage.

Parameters:dsg_targets (dict(tuple(int,int,int),DataWritten)) –

spinn_front_end_common.utilities.report_functions.router_collision_potential_report(router_tables_by_partition, n_keys_map, machine)

Parameters:

• router_tables_by_partition (MulticastRoutingTableByPartition) –
• n_keys_map (AbstractMachinePartitionNKeysMap) –
• machine (Machine) –

spinn_front_end_common.utilities.report_functions.routing_table_from_machine_report(routing_tables)

Report the routing table that was actually on the machine.

Parameters:

• routing_tables (MulticastRoutingTables) –
• transceiver (Transceiver) –
• app_id (int) –

spinn_front_end_common.utilities.report_functions.tags_from_machine_report(transceiver)

Describes what the tags actually present on the machine are.

Parameters:

• report_default_directory (str) –
• transceiver (Transceiver) –

spinn_front_end_common.utilities.report_functions.write_json_machine(machine, json_folder, progress_bar)

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

Warning

The file in this folder will be overwritten!

Parameters:

• machine (Machine) – Machine to convert
• 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_partition_n_keys_map(partition_to_n_keys_map, json_folder)

Converter from MulticastRoutingTables to JSON.

Parameters:

• partition_to_n_keys_map (AbstractMachinePartitionNKeysMap) – The number of keys needed for each partition.
• json_folder (str) – the folder to which the JSON are being written

Returns:

the name of the generated file

Return type:

str

spinn_front_end_common.utilities.report_functions.write_json_placements(placements, json_folder)

Runs the code to write the placements in JSON.

Parameters:

• placements (Placements) – The placements to write.
• json_folder (str) – The folder to which the JSON are being written.

spinn_front_end_common.utilities.report_functions.write_json_routing_tables(router_tables, json_folder)

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

Parameters:

• router_tables (MulticastRoutingTables) – Routing Tables to convert
• json_folder (str) – the folder to which the JSON are being written