spinn_front_end_common.abstract_models package¶
Submodules¶
spinn_front_end_common.abstract_models.abstract_can_reset module¶
spinn_front_end_common.abstract_models.abstract_changable_after_run module¶
-
class
spinn_front_end_common.abstract_models.abstract_changable_after_run.
AbstractChangableAfterRun
[source]¶ 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
()[source]¶ 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
-
spinn_front_end_common.abstract_models.abstract_generates_data_specification module¶
spinn_front_end_common.abstract_models.abstract_has_associated_binary module¶
-
class
spinn_front_end_common.abstract_models.abstract_has_associated_binary.
AbstractHasAssociatedBinary
[source]¶ Bases:
object
Marks a machine graph vertex that can be launched on a SpiNNaker core.
-
get_binary_start_type
()[source]¶ Get the start type of the binary to be run.
Return type: ExecutableType
-
spinn_front_end_common.abstract_models.abstract_machine_allocation_controller module¶
spinn_front_end_common.abstract_models.abstract_provides_incoming_partition_constraints module¶
-
class
spinn_front_end_common.abstract_models.abstract_provides_incoming_partition_constraints.
AbstractProvidesIncomingPartitionConstraints
[source]¶ Bases:
object
A vertex that can provide constraints for its incoming edge partitions.
-
get_incoming_partition_constraints
(partition)[source]¶ Get constraints to be added to the given edge that goes in to a vertex of this vertex.
Parameters: partition ( OutgoingPartition
) – An partition that goes in to this vertexReturns: A list of constraints Return type: list( AbstractConstraint
)
-
spinn_front_end_common.abstract_models.abstract_provides_key_to_atom_mapping module¶
spinn_front_end_common.abstract_models.abstract_provides_n_keys_for_partition module¶
-
class
spinn_front_end_common.abstract_models.abstract_provides_n_keys_for_partition.
AbstractProvidesNKeysForPartition
[source]¶ 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)[source]¶ Get the number of keys required by the given partition of edges.
Parameters: - partition (
OutgoingPartition
) – 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
)- partition (
-
spinn_front_end_common.abstract_models.abstract_provides_outgoing_partition_constraints module¶
-
class
spinn_front_end_common.abstract_models.abstract_provides_outgoing_partition_constraints.
AbstractProvidesOutgoingPartitionConstraints
[source]¶ Bases:
object
A vertex that can provide constraints for its outgoing edge partitions.
-
get_outgoing_partition_constraints
(partition)[source]¶ Get constraints to be added to the given edge that comes out of this vertex.
Parameters: partition – An edge that comes out of this vertex Returns: A list of constraints Return type: list( AbstractConstraint
)
-
spinn_front_end_common.abstract_models.abstract_recordable module¶
spinn_front_end_common.abstract_models.abstract_rewrites_data_specification module¶
-
class
spinn_front_end_common.abstract_models.abstract_rewrites_data_specification.
AbstractRewritesDataSpecification
[source]¶ Bases:
object
Indicates an object that allows data to be changed after run, and so can rewrite the data specification
spinn_front_end_common.abstract_models.abstract_send_me_multicast_commands_vertex module¶
-
class
spinn_front_end_common.abstract_models.abstract_send_me_multicast_commands_vertex.
AbstractSendMeMulticastCommandsVertex
[source]¶ 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
-
start_resume_commands
¶ The commands needed when starting or resuming simulation
-
timed_commands
¶ The commands to be sent at given times in the simulation
-
spinn_front_end_common.abstract_models.abstract_supports_database_injection module¶
-
class
spinn_front_end_common.abstract_models.abstract_supports_database_injection.
AbstractSupportsDatabaseInjection
[source]¶ 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.
-
spinn_front_end_common.abstract_models.abstract_uses_memory_io module¶
-
class
spinn_front_end_common.abstract_models.abstract_uses_memory_io.
AbstractUsesMemoryIO
[source]¶ Bases:
object
Indicates that the class will write data using the MemoryIO interface
spinn_front_end_common.abstract_models.abstract_vertex_with_dependent_vertices module¶
Module contents¶
-
class
spinn_front_end_common.abstract_models.
AbstractChangableAfterRun
[source]¶ 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
()[source]¶ 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
[source]¶ Bases:
object
-
class
spinn_front_end_common.abstract_models.
AbstractHasAssociatedBinary
[source]¶ Bases:
object
Marks a machine graph vertex that can be launched on a SpiNNaker core.
-
get_binary_start_type
()[source]¶ Get the start type of the binary to be run.
Return type: ExecutableType
-
-
class
spinn_front_end_common.abstract_models.
AbstractMachineAllocationController
[source]¶ Bases:
object
An object that controls the allocation of a machine
-
class
spinn_front_end_common.abstract_models.
AbstractProvidesIncomingPartitionConstraints
[source]¶ Bases:
object
A vertex that can provide constraints for its incoming edge partitions.
-
get_incoming_partition_constraints
(partition)[source]¶ Get constraints to be added to the given edge that goes in to a vertex of this vertex.
Parameters: partition ( OutgoingPartition
) – An partition that goes in to this vertexReturns: A list of constraints Return type: list( AbstractConstraint
)
-
-
class
spinn_front_end_common.abstract_models.
AbstractProvidesKeyToAtomMapping
[source]¶ Bases:
object
Interface to provide a mapping between routing key partitions and atom IDs
-
class
spinn_front_end_common.abstract_models.
AbstractProvidesNKeysForPartition
[source]¶ 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)[source]¶ Get the number of keys required by the given partition of edges.
Parameters: - partition (
OutgoingPartition
) – 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
)- partition (
-
-
class
spinn_front_end_common.abstract_models.
AbstractProvidesOutgoingPartitionConstraints
[source]¶ Bases:
object
A vertex that can provide constraints for its outgoing edge partitions.
-
get_outgoing_partition_constraints
(partition)[source]¶ Get constraints to be added to the given edge that comes out of this vertex.
Parameters: partition – 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
[source]¶ Bases:
object
Indicates that an object might record some data in to SDRAM
-
class
spinn_front_end_common.abstract_models.
AbstractRewritesDataSpecification
[source]¶ Bases:
object
Indicates an object that allows data to be changed after run, and so can rewrite the data specification
-
class
spinn_front_end_common.abstract_models.
AbstractSendMeMulticastCommandsVertex
[source]¶ 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
-
start_resume_commands
¶ The commands needed when starting or resuming simulation
-
timed_commands
¶ The commands to be sent at given times in the simulation
-
-
class
spinn_front_end_common.abstract_models.
AbstractSupportsDatabaseInjection
[source]¶ 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.
-
-
class
spinn_front_end_common.abstract_models.
AbstractVertexWithEdgeToDependentVertices
[source]¶ Bases:
object
A vertex with a dependent vertices, which should be connected to this vertex by an edge directly to each of them
-
class
spinn_front_end_common.abstract_models.
AbstractUsesMemoryIO
[source]¶ Bases:
object
Indicates that the class will write data using the MemoryIO interface