spinn_front_end_common.interface.profiling package

Submodules

spinn_front_end_common.interface.profiling.profile_utils module

spinn_front_end_common.interface.profiling.profile_utils.get_profile_region_size(n_samples)[source]

Get the size of the region of the profile data.

Parameters:n_samples (int) – number of different samples to record
Returns:the size in bytes used by the profile region
Return type:int
spinn_front_end_common.interface.profiling.profile_utils.get_profiling_data(profile_region, tag_labels, placement)[source]

Utility function to get profile data from a profile region.

Parameters:
  • profile_region (int) – DSG region to get profiling data out of SDRAM
  • tag_labels (list(str)) – labels for the profiling data
  • placement (Placement) – placement
Return type:

ProfileData
spinn_front_end_common.interface.profiling.profile_utils.reserve_profile_region(spec, region, n_samples)[source]

Reserves the profile region for recording the profile data.

Parameters:
  • spec (DataSpecificationGenerator) – the DSG specification writer
  • region (int) – region ID for the profile data
  • n_samples (int) – number of elements being sampled
Return type:

None
spinn_front_end_common.interface.profiling.profile_utils.write_profile_region_data(spec, region, n_samples)[source]

Writes the profile region data.

Parameters:
  • spec (DataSpecificationGenerator) – the DSG specification writer
  • region (int) – region ID for the profile data
  • n_samples (int) – number of elements being sampled
Return type:

None

Module contents

class spinn_front_end_common.interface.profiling.AbstractHasProfileData

Bases: object

Indicates a MachineVertex that can record a profile.

get_profile_data(placement)[source]

Get the profile data recorded during simulation

Parameters:placement (Placement) –
Return type:ProfileData
class spinn_front_end_common.interface.profiling.ProfileData(tag_labels)

Bases: object

A container for profile data

Parameters:tag_labels (list(str)) – A list of labels indexed by tag ID
DURATION = 1
START_TIME = 0
add_data(data)[source]

Add profiling data read from the profile section

Parameters:data (bytearray) – Data read from the profile section on the machine
get_mean_ms(tag)[source]
Get the mean time in milliseconds spent on operations with the
given tag
Parameters:tag (str) – The tag to get the mean time for
Return type:float
get_mean_ms_per_ts(tag)[source]

Get the mean time in milliseconds spent on operations with the given tag per timestep

Parameters:tag (str) – The tag to get the data for
Return type:float
get_mean_n_calls_per_ts(tag)[source]

Get the mean number of times the given tag was recorded per timestep

Parameters:tag (str) – The tag to get the data for
Return type:float
get_n_calls(tag)[source]

Get the number of times the given tag was recorded

Parameters:tag (str) – The tag to get the number of calls of
Return type:int
tags

The tags recorded as labels

Return type:list(str)