spinn_front_end_common.interface.provenance package

Module contents

class spinn_front_end_common.interface.provenance.AbstractProvidesLocalProvenanceData[source]

Bases: object

Indicates an object that provides locally obtained provenance data

get_local_provenance_data()[source]

Get an iterable of provenance data items

Returns:iterable of ProvenanceDataItem
class spinn_front_end_common.interface.provenance.AbstractProvidesProvenanceDataFromMachine[source]

Bases: object

Indicates that an object provides provenance data retrieved from the machine

get_provenance_data_from_machine(transceiver, placement)[source]

Get an iterable of provenance data items

Parameters:
  • transceiver (Transceiver) – the SpinnMan interface object
  • placement (Placement) – the placement of the object
Returns:

the provenance items
Return type:

iterable(ProvenanceDataItem)
class spinn_front_end_common.interface.provenance.PacmanProvenanceExtractor[source]

Bases: object

Extracts Provenance data from a PACMANAlgorithmExecutor

clear()[source]

Clears the provenance data store

Return type:None
data_items

Returns the provenance data items

Returns:list of provenance data items.
Return type:iterable(ProvenanceDataItem)
extract_provenance(executor)[source]

Acquires the timings from PACMAN algorithms (provenance data)

Parameters:executor – the PACMAN workflow executor
Return type:None
class spinn_front_end_common.interface.provenance.ProvidesProvenanceDataFromMachineImpl[source]

Bases: spinn_front_end_common.interface.provenance.abstract_provides_provenance_data_from_machine.AbstractProvidesProvenanceDataFromMachine

An implementation that gets provenance data from a region of ints on the machine.

NUM_PROVENANCE_DATA_ENTRIES = 5
class PROVENANCE_DATA_ENTRIES[source]

Bases: enum.Enum

entries for the provenance data generated by models using provides provenance vertex

CALLBACK_QUEUE_OVERLOADED = 1
DMA_QUEUE_OVERLOADED = 2
MAX_NUMBER_OF_TIMER_TIC_OVERRUN = 4
TIMER_TIC_HAS_OVERRUN = 3
TRANSMISSION_EVENT_OVERFLOW = 0
get_provenance_data_from_machine(transceiver, placement)[source]

Get an iterable of provenance data items

Parameters:
  • transceiver (Transceiver) – the SpinnMan interface object
  • placement (Placement) – the placement of the object
Returns:

the provenance items
Return type:

iterable(ProvenanceDataItem)
static get_provenance_data_size(n_additional_data_items)[source]
reserve_provenance_data_region(spec)[source]