Source code for spynnaker.pyNN.extra_algorithms.splitter_components.spynnaker_splitter_selector

# Copyright (c) 2020-2021 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
from spinn_utilities.progress_bar import ProgressBar
from pacman.model.graphs.application import (
    ApplicationSpiNNakerLinkVertex, ApplicationFPGAVertex)
from pacman.model.partitioner_splitters.splitter_one_to_one_legacy import (
    SplitterOneToOneLegacy)
from spinn_front_end_common.interface.splitter_selectors import (
    vertex_selector)
from spynnaker.pyNN.models.abstract_models import (
    AbstractAcceptsIncomingSynapses)
from .splitter_abstract_pop_vertex_slice import (
    SplitterAbstractPopulationVertexSlice)
from .spynnaker_splitter_slice_legacy import SpynnakerSplitterSliceLegacy
from .splitter_poisson_delegate import SplitterPoissonDelegate
from spynnaker.pyNN.models.neuron import AbstractPopulationVertex
from spynnaker.pyNN.models.spike_source.spike_source_array_vertex import (
    SpikeSourceArrayVertex)
from spynnaker.pyNN.models.spike_source.spike_source_poisson_vertex import (
    SpikeSourcePoissonVertex)

PROGRESS_BAR_NAME = "Adding Splitter selectors where appropriate"


def spynnaker_splitter_selector(app_graph):
    """ Add a splitter to every vertex that doesn't already have one.

        default for APV is the SplitterAbstractPopulationVertexSlice\
        default for external device splitters are SplitterOneToOneLegacy\
        default for the rest is the SpynnakerSplitterSliceLegacy.

    :param ApplicationGraph app_graph: app graph
    :raises PacmanConfigurationException: If a bad configuration is set
    """
    progress_bar = ProgressBar(
        string_describing_what_being_progressed=PROGRESS_BAR_NAME,
        total_number_of_things_to_do=len(app_graph.vertices))

    for app_vertex in progress_bar.over(app_graph.vertices):
        spynakker_vertex_selector(app_vertex)


def spynakker_vertex_selector(app_vertex):
    """ main point for selecting a splitter object for a given app vertex.

    Will delegate to the none spynakker slector if no heuristic is known for
    the app vertex.

    :param ~pacman.model.graphs.application.ApplicationVertex app_vertex:
        app vertex to give a splitter object to
    :rtype: None
    """
    if app_vertex.splitter is None:
        if isinstance(app_vertex, AbstractPopulationVertex):
            app_vertex.splitter = \
                SplitterAbstractPopulationVertexSlice()
        elif isinstance(app_vertex, ApplicationSpiNNakerLinkVertex):
            app_vertex.splitter = SplitterOneToOneLegacy()
        elif isinstance(app_vertex, ApplicationFPGAVertex):
            app_vertex.splitter = SplitterOneToOneLegacy()
        elif isinstance(app_vertex, SpikeSourceArrayVertex):
            app_vertex.splitter = SpynnakerSplitterSliceLegacy()
        elif isinstance(app_vertex, SpikeSourcePoissonVertex):
            app_vertex.splitter = SplitterPoissonDelegate()
        else:  # go to basic selector. it might know what to do
            vertex_selector(app_vertex)
    if isinstance(app_vertex, AbstractAcceptsIncomingSynapses):
        app_vertex.verify_splitter(app_vertex.splitter)