spinn_front_end_common.abstract_models package

Subpackages

• spinn_front_end_common.abstract_models.impl package
  • Module contents

Module contents

class spinn_front_end_common.abstract_models.AbstractChangableAfterRun

Bases: object

An item that can be changed after a call to run, the changes to which might or might not require mapping or data generation.

mark_no_changes()

Marks the point after which changes are reported, so that new changes can be detected before the next check.

requires_data_generation

True if changes that have been made require that data generation be performed. By default this returns False but can be overridden to indicate changes that require data regeneration.

Return type:bool

requires_mapping

True if changes that have been made require that mapping be performed. By default this returns False but can be overridden to indicate changes that require mapping.

Return type:bool

class spinn_front_end_common.abstract_models.AbstractGeneratesDataSpecification

Bases: object

generate_data_specification(spec, placement)

Generate a data specification.

Parameters:

• spec (DataSpecificationGenerator) – The data specification to write to
• placement (Placement) – the placement the vertex is located at

Return type:

None

class spinn_front_end_common.abstract_models.AbstractHasAssociatedBinary

Bases: object

Marks a machine graph vertex that can be launched on a SpiNNaker core.

get_binary_file_name()

Get the binary name to be run for this vertex.

Return type:str

get_binary_start_type()

Get the start type of the binary to be run.

Return type:ExecutableType

class spinn_front_end_common.abstract_models.AbstractMachineAllocationController

Bases: object

An object that controls the allocation of a machine

close()

Indicate that the use of the machine is complete.

extend_allocation(new_total_run_time)

Extend the allocation of the machine from the original run time.

Parameters:new_total_run_time (float) – The total run time that is now required starting from when the machine was first allocated

class spinn_front_end_common.abstract_models.AbstractProvidesIncomingPartitionConstraints

Bases: object

A vertex that can provide constraints for its incoming edge partitions.

get_incoming_partition_constraints(partition)

Get constraints to be added to the given edge that goes in to a vertex of this vertex.

Parameters:partition (AbstractOutgoingEdgePartition) – An partition that goes in to this vertex Returns:A list of constraints Return type:list(AbstractConstraint)

class spinn_front_end_common.abstract_models.AbstractProvidesKeyToAtomMapping

Bases: object

Interface to provide a mapping between routing key partitions and atom IDs

routing_key_partition_atom_mapping(routing_info, partition)

Returns a list of atom to key mapping.

Parameters:

• routing_info (RoutingInfo) – the routing info object to consider
• partition (AbstractOutgoingEdgePartition) – the routing partition to handle.

Returns:

a iterable of tuples of atom IDs to keys.

Return type:

iterable(tuple(int,int))

class spinn_front_end_common.abstract_models.AbstractProvidesNKeysForPartition

Bases: object

Allows a vertex to provide the number of keys for a partition of edges, rather than relying on the number of atoms in the pre-vertex.

get_n_keys_for_partition(partition, graph_mapper)

Get the number of keys required by the given partition of edges.

Parameters:

• partition (AbstractOutgoingEdgePartition) – An partition that comes out of this vertex
• graph_mapper (GraphMapper) – A mapper between the graphs

Returns:

A list of constraints

Return type:

list(AbstractConstraint)

class spinn_front_end_common.abstract_models.AbstractProvidesOutgoingPartitionConstraints

Bases: object

A vertex that can provide constraints for its outgoing edge partitions.

get_outgoing_partition_constraints(partition)

Get constraints to be added to the given edge that comes out of this vertex.

Parameters:partition (AbstractOutgoingEdgePartition) – An edge that comes out of this vertex Returns:A list of constraints Return type:list(AbstractConstraint)

class spinn_front_end_common.abstract_models.AbstractRecordable

Bases: object

Indicates that an object might record some data in to SDRAM

is_recording()

Deduce if the recorder is actually recording

Return type:bool

class spinn_front_end_common.abstract_models.AbstractRewritesDataSpecification

Bases: object

Indicates an object that allows data to be changed after run, and so can rewrite the data specification

mark_regions_reloaded()

Indicate that the regions have been reloaded

regenerate_data_specification(spec, placement)

Regenerate the data specification, only generating regions that have changed and need to be reloaded

Parameters:

• spec (DataSpecificationGenerator) – Where to write the regenerated spec
• placement (Placement) – Where are we regenerating for?

requires_memory_regions_to_be_reloaded()

Return true if any data region needs to be reloaded

Return type:bool

class spinn_front_end_common.abstract_models.AbstractSendMeMulticastCommandsVertex

Bases: object

A vertex which wants to commands to be sent to it as multicast packets at fixed points in the simulation

pause_stop_commands

The commands needed when pausing or stopping simulation

Return type:iterable(MultiCastCommand)

start_resume_commands

The commands needed when starting or resuming simulation

Return type:iterable(MultiCastCommand)

timed_commands

The commands to be sent at given times in the simulation

Return type:iterable(MultiCastCommand)

class spinn_front_end_common.abstract_models.AbstractSupportsDatabaseInjection

Bases: object

Marks a machine vertex as supporting injection of information via a database running on the controlling host.

is_in_injection_mode

Whether this vertex is actually in injection mode.

Return type:bool

class spinn_front_end_common.abstract_models.AbstractVertexWithEdgeToDependentVertices

Bases: object

A vertex with a dependent vertices, which should be connected to this vertex by an edge directly to each of them

dependent_vertices()

Return the vertices which this vertex depends upon

Return type:iterable(ApplicationVertex)

edge_partition_identifiers_for_dependent_vertex(vertex)

Return the dependent edge identifiers for a particular dependent vertex.

Parameters:vertex (ApplicationVertex) – Return type:iterable(str)

class spinn_front_end_common.abstract_models.AbstractUsesMemoryIO

Bases: object

Indicates that the class will write data using the MemoryIO interface.

get_memory_io_data_size()

Get the size of the data area to allocate for this vertex.

Returns:The size of the data area in bytes Return type:int

write_data_to_memory_io(memory, tag)

Write the data to the given memory object

Parameters:

• memory (MemoryIO) – The memory to write to (and handle to use to do the write)
• tag (int) – The tag given to the allocated memory

Return type:

None

class spinn_front_end_common.abstract_models.AbstractCanReset

Bases: object

Indicates an object that can be reset to time 0.

reset_to_first_timestep()

Reset the object to first time step.