Merge branch 'master' into allow_extra_synapse_data

Author: rowleya

spynnaker/pyNN/__init__.py

@@ -239,8 +239,6 @@ def distance(src_cell: IDMixin, tgt_cell: IDMixin,
              periodic_boundaries: Optional[Tuple[
                  Optional[Tuple[int, int]]]] = None) -> float:
     """
-    Return the Euclidean distance between two cells.
-
     :param src_cell: Measure from this cell
     :param tgt_cell: To this cell
     :param mask:
@@ -254,6 +252,7 @@ def distance(src_cell: IDMixin, tgt_cell: IDMixin,
         (the post-synaptic position is multiplied by this quantity).
     :param offset:
     :param periodic_boundaries:
+    :returns: The Euclidean distance between two cells.
     """
     return _pynn_distance(
         src_cell, tgt_cell, mask, scale_factor, offset, periodic_boundaries)
@@ -348,7 +347,7 @@ def setup(timestep: Optional[Union[float, Literal["auto"]]] = None,
 
 def name() -> str:
     """
-    Returns the name of the simulator.
+    :returns: The name of the simulator.
     """
     return SpynnakerDataView.get_sim_name()
 
@@ -437,8 +436,8 @@ def end(_: Any = True) -> None:
 
 def list_standard_models() -> List[str]:
     """
-    Return a list of all the StandardCellType classes available for this
-    simulator.
+    :returns: A list of all the StandardCellType classes available for this
+        simulator.
     """
     return [
         key
@@ -547,6 +546,7 @@ def create(
     :param cellclass: population class
     :param cellparams: population parameters.
     :param n: number of neurons
+    :returns: A new Population
     """
     SpynnakerDataView.check_user_can_act()
     return __pynn["create"](cellclass, cellparams, n)
@@ -591,6 +591,7 @@ def get_max_delay() -> int:
     Most likely value is timestep * 144
 
     :raises NotImplementedError: As there is no system wide max_delay
+    :returns: In SpyNNaker this method never returns
     """
     raise NotImplementedError(
         "sPyNNaker does not have a system wide max_delay")

spynnaker/pyNN/config_setup.py

@@ -74,5 +74,8 @@ def cfg_paths_skipped() -> Set[str]:
     Set of cfg path that would not be found based on other cfg settings
 
     Assuming mode = Debug
+
+    :returns:
+       List of cfg Option names that point to paths unlikely to be used.
     """
     return fec_cfg_paths_skipped()

spynnaker/pyNN/connections/spif_live_spikes_connection.py

@@ -135,6 +135,8 @@ def __init__(self, receive_labels: Optional[Iterable[str]],
 
     def add_receive_label(self, label: str) -> None:
         """
+        Adds this labels to the callbacks.
+
         :param label:
         """
         if label not in self.__receive_labels:

spynnaker/pyNN/connections/spynnaker_poisson_control_connection.py

@@ -74,6 +74,8 @@ def __init__(
 
     def add_poisson_label(self, label: str) -> None:
         """
+        Adds a send label.
+
         :param label: The label of the Poisson source population.
         """
         control = self.__convert_to_control_label(label)

spynnaker/pyNN/data/spynnaker_data_view.py

@@ -109,6 +109,7 @@ def get_min_delay(cls) -> float:
         Typically `simulation_time_step_per_ms` but may be a positive multiple
         of it.
 
+        :returns: the minimum delay in milliseconds.
         :raises ~spinn_utilities.exceptions.SpiNNUtilsException:
             If the min_delay is currently unavailable
         """
@@ -120,6 +121,10 @@ def get_min_delay(cls) -> float:
     def has_min_delay(cls) -> bool:
         """
         Report if there is a minimum supported delay available.
+
+        If there is no delay time step could be used.
+
+        :returns: True if get_min_delay method will work
         """
         if cls.__spy_data._min_delay is not None:
             return True
@@ -133,13 +138,15 @@ def iterate_projections(cls) -> Iterator[Projection]:
         The iteration will be empty if no projections added.
 
         Note: This method is backed by a set so does not guarantee order
+
+        :returns: Unordered iterator of projections.
         """
         return iter(cls.__spy_data._projections)
 
     @classmethod
     def get_n_projections(cls) -> int:
         """
-        The number of projections previously added.
+        :returns: The number of projections previously added.
         """
         return len(cls.__spy_data._projections)
 
@@ -174,13 +181,15 @@ def iterate_populations(cls) -> Iterator[Population]:
         The iteration will be empty if no populations added.
 
         Note: This method is backed by a set so does not guarantee order
+
+        :returns: Unordered iterator of Populations
         """
         return iter(cls.__spy_data._populations)
 
     @classmethod
     def get_n_populations(cls) -> int:
         """
-        The number of populations previously added.
+        :returns: The number of populations previously added.
         """
         return len(cls.__spy_data._populations)
 
@@ -221,6 +230,6 @@ def add_population(cls, population: Population) -> Tuple[int, int]:
     @classmethod
     def get_sim_name(cls) -> str:
         """
-        Gets the name to be returned by `pyNN.spiNNaker.name`.
+        :returns: The name to be returned by `pyNN.spiNNaker.name`.
         """
         return _version.NAME

spynnaker/pyNN/data/spynnaker_data_writer.py

@@ -62,6 +62,8 @@ def set_up_timings_and_delay(
             time_scale_factor: Optional[float],
             min_delay: Optional[Union[int, float]]) -> None:
         """
+        Setup the timings and delays for the simulation
+
         :param simulation_time_step_us:
             An explicitly specified time step for the simulation in
             microseconds.
@@ -73,7 +75,6 @@ def set_up_timings_and_delay(
             new value or `None` to say use simulation_time_step_ms
         """
         try:
-
             # If there isn't a time scale factor given, try to work it out
             # on the basis that we can do 0.1ms steps in real time
             if time_scale_factor is None:

spynnaker/pyNN/external_devices_models/abstract_ethernet_controller.py

@@ -31,21 +31,22 @@ class AbstractEthernetController(object, metaclass=AbstractBase):
     @abstractmethod
     def get_message_translator(self) -> AbstractEthernetTranslator:
         """
-        Get the translator of messages.
+        :returns: The translator of messages.
         """
         raise NotImplementedError
 
     @abstractmethod
     def get_external_devices(self) -> Iterable[
             AbstractMulticastControllableDevice]:
         """
-        Get the external devices that are to be controlled by the controller.
+        :returns:
+           The external devices that are to be controlled by the controller.
         """
         raise NotImplementedError
 
     @abstractmethod
     def get_outgoing_partition_ids(self) -> List[str]:
         """
-        Get the partition IDs of messages coming out of the controller.
+        :returns: The partition IDs of messages coming out of the controller.
         """
         raise NotImplementedError

spynnaker/pyNN/external_devices_models/abstract_ethernet_sensor.py

@@ -30,35 +30,36 @@ class AbstractEthernetSensor(object, metaclass=AbstractBase):
     @abstractmethod
     def get_n_neurons(self) -> int:
         """
-        Get the number of neurons that will be sent out by the device.
+        :returns: The number of neurons that will be sent out by the device.
         """
         raise NotImplementedError
 
     @abstractmethod
     def get_injector_parameters(self) -> Dict[str, Any]:
         """
-        Get the parameters of the Spike Injector to use with this device.
+        :returns:
+           The parameters of the Spike Injector to use with this device.
         """
         raise NotImplementedError
 
     @abstractmethod
     def get_injector_label(self) -> str:
         """
-        Get the label to give to the Spike Injector.
+        :returns: the label to give to the Spike Injector.
         """
         raise NotImplementedError
 
     @abstractmethod
     def get_translator(self) -> AbstractEthernetTranslator:
         """
-        Get a translator of multicast commands to Ethernet commands.
+        :returns: A translator of multicast commands to Ethernet commands.
         """
         raise NotImplementedError
 
     @abstractmethod
     def get_database_connection(self) -> SpynnakerLiveSpikesConnection:
         """
-        Get a Database Connection instance that this device uses to inject
-        packets.
+        :returns: A Database Connection instance that this device uses to
+             inject packets.
         """
         raise NotImplementedError

spynnaker/pyNN/external_devices_models/arbitrary_fpga_device.py

@@ -32,11 +32,13 @@ def __init__(
             chip_coords: Optional[XY] = None, label: Optional[str] = None):
         """
         :param n_neurons: Number of neurons
-        :param fpga_link_id:
-        :param fpga_id:
-        :param board_address:
-        :param chip_coords:
-        :param label:
+        :param fpga_link_id: The ID of the link of the FPGA (0-15)
+        :param fpga_id: The ID of the FPGA on the board (0, 1 or 2)
+        :param board_address: The IP address of the board with the FPGA,
+            or None for the default board or if using chip_coords
+        :param chip_coords: The coordinates of the chip connected to the FPGA,
+            or None for the default board or if using board_address
+        :param label: The optional name of the vertex.
         """
         conn = FPGAConnection(
             fpga_id, fpga_link_id, board_address, chip_coords)

spynnaker/pyNN/external_devices_models/external_spinnaker_link_fpga_retina_device.py

@@ -26,6 +26,7 @@ def get_y_from_fpga_retina(key: int, mode: int) -> Optional[int]:
     """
     :param key:
     :param mode:
+    :returns: y value if mode is expected otherwise None.
     """
     if mode == 128:
         return key & 0x7f
@@ -42,6 +43,7 @@ def get_x_from_fpga_retina(key: int, mode: int) -> Optional[int]:
     """
     :param key:
     :param mode:
+    :returns: x value if mode is expected otherwise None.
     """
     if mode == 128:
         return (key >> 7) & 0x7f
@@ -58,6 +60,7 @@ def get_spike_value_from_fpga_retina(key: int, mode: int) -> Optional[int]:
     """
     :param key:
     :param mode:
+    :returns: Spike value if mode is expected otherwise None.
     """
     if mode == 128:
         return (key >> 14) & 0x1
@@ -98,7 +101,7 @@ def __init__(
         :param spinnaker_link_id:
             The SpiNNaker link to which the retina is connected
         :param polarity: The "polarity" of the retina data
-        :param label:
+        :param label: The optional name of the vertex.
         :param board_address:
         """
         fixed_n_neurons = self.get_n_neurons(mode, polarity)
@@ -133,8 +136,13 @@ def _get_mask(self, mode: str) -> int:
     @staticmethod
     def get_n_neurons(mode: str, polarity: str) -> int:
         """
+        Calculate the number of neurons based on mode and polarity
+
         :param mode: ``128`` or ``64`` or ``32`` or ``16``
+        :param polarity: ``UP`` or ``DOWN``
+        :returns: The number of neurons in the retina
         """
+        # Uses mode and polarity to determine the number of neurons needed
         if mode == ExternalFPGARetinaDevice.MODE_128:
             if (polarity == ExternalFPGARetinaDevice.UP_POLARITY or
                     polarity == ExternalFPGARetinaDevice.DOWN_POLARITY):