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.
- 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:
- Return type:
- 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
- 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
Module contents¶
- class spinn_front_end_common.interface.profiling.AbstractHasProfileData[source]¶
Bases:
object
Indicates a
MachineVertex
that can record a profile.
- class spinn_front_end_common.interface.profiling.ProfileData(tag_labels)[source]¶
Bases:
object
A container for profile data.
- 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_per_ts(tag)[source]¶
Get the mean time in milliseconds spent on operations with the given tag per timestep.
- get_mean_n_calls_per_ts(tag)[source]¶
Get the mean number of times the given tag was recorded per timestep.