spinn_front_end_common.interface.provenance package

Submodules

spinn_front_end_common.interface.provenance.router_prov_mapper module

class spinn_front_end_common.interface.provenance.router_prov_mapper.Plotter(db_filename: str, verbose: bool = False)[source]

Bases: ContextManager[SQLiteDB]

cmap
get_per_chip_prov_details(info: str) Tuple[str, int, int, ndarray][source]
get_per_chip_prov_types() FrozenSet[str][source]
get_per_core_prov_types() FrozenSet[str][source]
get_sum_chip_prov_details(info: str) Tuple[str, int, int, ndarray][source]
plot_per_chip_data(key: str, output_filename: str)[source]
plot_per_core_data(key: str, output_filename: str)[source]
spinn_front_end_common.interface.provenance.router_prov_mapper.main() None[source]

Module contents

class spinn_front_end_common.interface.provenance.AbstractProvidesLocalProvenanceData

Bases: object

Indicates an object that provides locally obtained provenance data.

GraphProvenanceGatherer will check all Vertices and all Edges in the ApplicationGraph

abstract get_local_provenance_data() None[source]

Get provenance data items and store them in the provenance DB.

class spinn_front_end_common.interface.provenance.AbstractProvidesProvenanceDataFromMachine

Bases: object

Indicates that an object provides provenance data retrieved from the machine.

abstract get_provenance_data_from_machine(placement: Placement)[source]

Get provenance data items for a placement and store them in the provenance DB.

Parameters:

placement (Placement) – the placement of the object

class spinn_front_end_common.interface.provenance.FecTimer(algorithm: str, work: TimerWork)

Bases: object

Timer.

APPLICATION_RUNNER = 'Application runner'
classmethod end_category(category: TimerCategory)[source]

This method should only be called via the View!

Parameters:

category (TimerCategory) – Stage to end

error(reason: str)[source]
classmethod setup(simulator: AbstractSpinnakerBase)[source]
skip(reason: str)[source]
skip_if_cfg_false(section: str, option: str) bool[source]
skip_if_cfgs_false(section: str, option1: str, option2: str) bool[source]
skip_if_empty(value: bool | int | str | Sized | None, name: str) bool[source]
skip_if_has_not_run() bool[source]
skip_if_virtual_board() bool[source]
classmethod start_category(category: TimerCategory, machine_on=None)[source]

This method should only be called via the View!

Parameters:
  • category (TimerCategory) – category to switch to

  • machine_on (None or bool) – What to change machine on too. Or None to leave as is

classmethod stop_category_timing() None[source]
class spinn_front_end_common.interface.provenance.GlobalProvenance(database_file: str | None = None, memory: bool = False)

Bases: SQLiteDB

Specific implementation of the Database for SQLite 3.

Note

Not thread safe on the same database file. Threads can access different DBs just fine.

Note

This totally relies on the way SQLite’s type affinities function. You can’t port to a different database engine without a lot of work.

Parameters:
  • database_file (str or None) – The name of a file that contains (or will contain) an SQLite database holding the data. If omitted, either the default file path or an unshared in-memory database will be used (suitable only for testing).

  • memory (bool) – Flag to say unshared in-memory can be used. Otherwise a None file will mean the default should be used

get_category_timer_sum(category: TimerCategory) int[source]

Get the total runtime for one category of algorithms

Parameters:

category (TimerCategory) –

Returns:

total off all run times with this category

Return type:

int

get_category_timer_sums(category: TimerCategory) Tuple[int, int][source]

Get the runtime for one category of algorithms split machine on, machine off

Parameters:

category (TimerCategory) –

Returns:

total on and off time of instances with this category

Return type:

int

classmethod get_global_provenace_path() str[source]

Get the path of the current provenance database of the last run

Warning

Calling this method between start/reset and run may result in a path to a database not yet created.

Raises:

ValueError – if the system is in a state where path can’t be retrieved, for example before run is called

get_run_time_of_BufferExtractor() str[source]

Gets the buffer extractor provenance item(s) from the last run

Returns:

A possibly multiline string with for each row which matches the LIKE %BufferExtractor

Return type:

str

get_run_times() str[source]

Gets the algorithm running times from the last run. If an algorithm is invoked multiple times in the run, its times are summed.

Returns:

A possibly multiline string with for each row which matches the like a line description_name: time. The times are in seconds.

Return type:

str

get_timer_provenance(algorithm: str) str[source]

Gets the timer provenance item(s) from the last run

Parameters:

algorithm (str) – The value to LIKE search for in the algorithm column. Can be the full name, or have % and _ wildcards.

Returns:

A possibly multiline string with for each row which matches the like a line algorithm: value

Return type:

str

get_timer_sum_by_algorithm(algorithm: str) int[source]

Get the total runtime for one algorithm

Parameters:

algorithm (str) –

Returns:

total off all runtimes with this algorithm

Return type:

int

get_timer_sum_by_category(category: TimerCategory) int[source]

Get the total runtime for one category of algorithms

Parameters:

category (TimerCategory) –

Returns:

total of all run times with this category

Return type:

int

get_timer_sum_by_work(work: TimerWork) int[source]

Get the total runtime for one work type of algorithms

Parameters:

work (TimerWork) –

Returns:

total off all runtimes with this category

Return type:

int

insert_category(category: TimerCategory, machine_on: bool)[source]

Inserts category into the category_timer_provenance returning id

Parameters:
  • category (TimerCategory) – Name of Category starting

  • machine_on (bool) – If the machine was done during all or some of the time

insert_category_timing(category_id: int, delta: timedelta)[source]

Inserts run time into the category

Parameters:
  • category_id (int) – id of the Category finished

  • delta (timedelta) – Time to be recorded

insert_timing(category: int, algorithm: str, work: TimerWork, delta: timedelta, skip_reason: str | None)[source]

Inserts algorithms run times into the timer_provenance table

Parameters:
  • category (int) – Category Id of the Algorithm

  • algorithm (str) – Algorithm name

  • work (TimerWork) – Type of work being done

  • delta (timedelta) – Time to be recorded

  • skip_reason (str or None) – The reason the algorithm was skipped or None if it was not skipped

insert_version(description: str, the_value: str)[source]

Inserts data into the version_provenance table

Parameters:
  • description (str) – The package for which the version applies

  • the_value (str) – The version to be recorded

retreive_log_messages(min_level: int = 0) List[Tuple[int, str]][source]

Retrieves all log messages at or above the min_level

Parameters:

min_level (int) –

Return type:

list(tuple(int, str))

run_query(query: str, params: Iterable[str | int | float | None | bytes] = ()) List[Row][source]

Opens a connection to the database, runs a query, extracts the results and closes the connection

The return type depends on the use_sqlite_rows parameter. By default this method returns tuples (lookup by index) but the advanced tuple type can be used instead, which supports lookup by name used in the query (use AS name in the query to set).

This method will not allow queries that change the database unless the read_only flag is set to False.

Note

This method is mainly provided as a support method for the later methods that return specific data. For new IntergationTests please add a specific method rather than call this directly.

Parameters:
  • query (str) – The SQL query to be run. May include ? wildcards

  • params (Iterable(str or int)) – The values to replace the ? wildcards with. The number and types must match what the query expects

Returns:

A list possibly empty of tuples/rows (one for each row in the database) where the number and type of the values corresponds to the where statement

Return type:

list(tuple or Row)

store_log(level: int, message: str, timestamp: datetime | None = None)[source]

Stores log messages into the database

Parameters:
  • level (int) –

  • message (str) –

class spinn_front_end_common.interface.provenance.LogStoreDB

Bases: LogStore

Log message storage mechanism that uses a database.

get_location() str[source]

Retrieves the location of the log store.

Return type:

str

retreive_log_messages(min_level: int = 0) List[Tuple[int, str]][source]

Retrieves all log messages at or above the min_level.

Parameters:

min_level (int) – Constraint on the minimum logging level to retrieve.

Returns:

A list of messages that satisfy the constraint.

Return type:

list(tuple(int, str))

store_log(level: int, message: str, timestamp: datetime | None = None)[source]

Writes the log message for later retrieval.

Parameters:
  • level (int) – The logging level.

  • message (str) – The logged message.

  • timestamp (datetime or None) – The time-stamp of the message.

class spinn_front_end_common.interface.provenance.ProvenanceReader(provenance_data_path: str | None = None)

Bases: BaseDatabase

Provides a connection to a database containing provenance for the current run and some convenience methods for extracting provenance data from it.

By default this will wrap around the database used to store the provenance of the last run. The path is not updated so this reader is not effected by a reset or an end.

The assumption is that the database is in the current provenance format. This includes both that DDL statements used to create the database but also the underlying database structure (currently sqlite3)

Warning

This class is only a wrapper around the database file so if the file is deleted the class will no longer work.

Create a wrapper around the database.

The suggested way to call this is without the provenance_data_path parameter, allowing get_last_run_database_path() to find the correct path.

Parameters:

provenance_data_path (None or str) – Path to the provenance database to wrap

cores_with_late_spikes() List[Tuple[int, int, int, int]][source]

Gets the x, y, p and count of the cores where late spikes arrived.

Cores that received spikes but where none were late are not included.

Returns:

A list hopefully empty of tuples (x, y, p, count) of cores where their where late arriving spikes.

Return type:

list(tuple(int, int, int, int))

static demo() None[source]

A demonstration of how to use this class.

See also unittests/interface/provenance/test_provenance_database.py

get_cores_with_provenace() List[Tuple[int, int, int]][source]

Gets the cores with provenance.

Returns:

A list tuples (x, y, p)

Return type:

list(tuple(int, int, int))

classmethod get_last_run_database_path() str[source]

Get the path of the current provenance database of the last run.

Warning

Calling this method between start/reset and run may result in a path to a database not yet created.

raises ValueError:

if the system is in a state where path can’t be retrieved, for example before run is called

get_monitor_by_chip(description: str) List[Tuple[int, int, str | int | float | bytes | None]][source]

Gets the monitor values for a specific item.

Parameters:

description (str) –

Returns:

list of tuples x, y, value)

Return type:

list(tuple(int, int, float))

get_provenance_for_router(x: int, y: int) str[source]

Gets the provenance item(s) from the last run relating to a chip.

Parameters:
  • x (int) – The X coordinate of the chip

  • y (int) – The Y coordinate of the chip

Returns:

A possibly multi-line string with for each row which matches the like a line description_name: value

Return type:

str

get_router_by_chip(description: str) List[Tuple[int, int, int | float]][source]

Gets the router values for a specific item.

Parameters:

description (str) –

Returns:

list of tuples (x, y, value)

Return type:

list(tuple(int, int, float))

messages() List[str][source]

List all the provenance messages.

Returns:

all messages logged or not; order is whatever the DB chooses

Return type:

list(str)

run_query(query: str, params: Iterable[str | int | float | None | bytes] = ()) List[Sequence[str | int | float | bytes | None]][source]

Opens a connection to the database, runs a query, extracts the results and closes the connection.

The return type depends on the use_sqlite_rows parameter. By default this method returns tuples (lookup by index) but the advanced tuple type can be used instead, which supports lookup by name used in the query (use AS name in the query to set).

This method will not allow queries that change the database unless the read_only flag is set to False.

Note

This method is mainly provided as a support method for the later methods that return specific data. For new IntergationTests please add a specific method rather than call this directly.

Parameters:
  • query (str) – The SQL query to be run. May include ? wildcards

  • params (Iterable(str or int)) – The values to replace the ? wildcards with. The number and types must match what the query expects

Returns:

A list possibly empty of tuples/rows (one for each row in the database) where the number and type of the values corresponds to the where statement

Return type:

list(tuple or Row)

class spinn_front_end_common.interface.provenance.ProvenanceWriter(database_file: str | None = None)

Bases: BaseDatabase

Specific implementation of the Database for SQLite 3.

Note

Not thread safe on the same database file. Threads can access different DBs just fine.

Note

This totally relies on the way SQLite’s type affinities function. You can’t port to a different database engine without a lot of work.

Parameters:
  • database_file (str or None) – The name of a file that contains (or will contain) an SQLite database holding the data. If omitted, either the default file path or an unshared in-memory database will be used (suitable only for testing).

  • memory (bool) – Flag to say unshared in-memory can be used. Otherwise a None file will mean the default should be used

insert_board_provenance(connections: Dict[Tuple[int, int], str] | None)[source]

Write the connection details retrieved from spalloc_client job to the boards_provenance table.

Parameters:

connections (dict((int, int): str) or None) – {(x, y): hostname, …} or None

insert_connector(pre_population: str, post_population: str, the_type: str, description: str, the_value: str | int | float | bytes | None)[source]

Inserts edge data into the connector_provenance

Parameters:
  • pre_population (str) – Name of the pre-population / vertex

  • post_population (str) – Name of the post-population / vertex

  • the_type (str) – Class of the connector

  • description (str) – type of value

  • the_value (int) – data

insert_core(x: int, y: int, p: int, description: str, the_value: str | int | float | bytes | None)[source]

Inserts data for a specific core into the core_provenance table.

Parameters:
  • x (int) – X coordinate of the chip

  • y (int) – Y coordinate of the chip

  • p (int) – ID of the core

  • description (str) – type of value

  • the_value (int) – data

insert_gatherer(x: int, y: int, address: int, bytes_read: int, run: int, description: str, the_value: str | int | float | bytes | None)[source]

Records provenance into the gatherer_provenance table.

Parameters:
  • x (int) – X coordinate of the chip

  • y (int) – Y coordinate of the chip

  • address (int) – SDRAM address read from

  • bytes_read (int) – number of bytes read

  • run (int) – run number

  • description (str) – type of value

  • the_value (float) – data

insert_monitor(x: int, y: int, description: str, the_value: str | int | float | bytes | None)[source]

Inserts data into the monitor_provenance table.

Parameters:
  • x (int) – X coordinate of the chip

  • y (int) – Y coordinate of the chip

  • description (str) – type of value

  • the_value (int) – data

insert_power(description: str, the_value: str | int | float | bytes | None)[source]

Inserts a general power value into the power_provenance table.

Parameters:
  • description (str) – Type of value

  • the_value (float) – data

insert_report(message: str)[source]

Save and if applicable logs a message to the reports table.

Only logs the messages up to the cut-off set by configuration provenance_report_cutoff

Parameters:

message (str) –

insert_router(x: int, y: int, description: str, the_value: int | float, expected: bool = True)[source]

Inserts data into the router_provenance table.

Parameters:
  • x (int) – X coordinate of the chip

  • y (int) – Y coordinate of the chip

  • description (str) – type of value

  • the_value (int or float) – data

  • expected (bool) – Flag to say this data was expected

class spinn_front_end_common.interface.provenance.ProvidesProvenanceDataFromMachineImpl

Bases: AbstractProvidesProvenanceDataFromMachine

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

N_SYSTEM_PROVENANCE_WORDS = 6
get_provenance_data_from_machine(placement: Placement)[source]

Retrieve the provenance data.

Parameters:

placement (Placement) – Which vertex are we retrieving from, and where was it

classmethod get_provenance_data_size(n_additional_data_items: int) int[source]
Parameters:

n_additional_data_items (int) –

Return type:

int

parse_extra_provenance_items(label: str, x: int, y: int, p: int, provenance_data: Sequence[int])[source]

Convert the remaining provenance words (those not in the standard set) into provenance items.

Called by get_provenance_data_from_machine()

Parameters:
  • label (str) – A descriptive label for the vertex (derived from label and placed position) to be used for provenance error reporting to the user.

  • x (int) – x coordinate of the chip where this core

  • y (int) – y coordinate of the core where this core

  • p (int) – virtual id of the core

  • provenance_data (list(int)) – The list of words of raw provenance data.

parse_system_provenance_items(label: str, x: int, y: int, p: int, provenance_data: Sequence[int])[source]

Given some words of provenance data, convert the portion of them that describes the system provenance into proper provenance items.

Called by get_provenance_data_from_machine()

Parameters:
  • label (str) – A descriptive label for the vertex (derived from label and placed position) to be used for provenance error reporting to the user.

  • x (int) – x coordinate of the chip where this core

  • y (int) – y coordinate of the core where this core

  • p (int) – virtual id of the core

  • provenance_data (list(int)) –

reserve_provenance_data_region(spec) None[source]
Parameters:

spec (DataSpecificationGenerator) – The data specification being written.

class spinn_front_end_common.interface.provenance.TimerCategory(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Different Categories a FecTimer can be in

DATA_GENERATION = 6
GET_MACHINE = 4
LOADING = 5
MAPPING = 7
RESETTING = 9
RUN_LOOP = 8
RUN_OTHER = 3
SETTING_UP = 2
SHUTTING_DOWN = 10
WAITING = 1
property category_name: str
class spinn_front_end_common.interface.provenance.TimerWork(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Different Work types an Algorithm could be doing

BITFIELD = 4
COMPRESSING = 5
CONTROL = 6
EXTRACTING = 9
EXTRACT_DATA = 10
GET_MACHINE = 2
LOADING = 3
OTHER = 1
REPORT = 11
RUNNING = 8
SYNAPSE = 7
property work_name: str