Skip to content

Commit 9c27f74

Browse files
committed
remove types from docs
1 parent 3a35ded commit 9c27f74

99 files changed

Lines changed: 791 additions & 1831 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

spynnaker/pyNN/external_devices_models/push_bot/abstract_push_bot_retina_device.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def __init__(self, protocol: MunichIoSpiNNakerLinkProtocol,
3333
resolution: Optional[PushBotRetinaResolution]):
3434
"""
3535
:param protocol:
36-
:param PushBotRetinaResolution:
36+
:param resolution:
3737
"""
3838
self._protocol = protocol
3939
self._resolution = resolution

spynnaker/pyNN/external_devices_models/push_bot/ethernet/push_bot_retina_device.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ def __init__(
4242
retina_injector_label: str = "PushBotRetinaInjector"):
4343
"""
4444
:param protocol:
45-
:param PushBotRetinaResolution resolution:
45+
:param resolution:
4646
:param pushbot_ip_address:
4747
:param pushbot_port:
4848
:param injector_port:

spynnaker/pyNN/extra_algorithms/neuron_expander.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ def _fill_in_initial_data(expanded_pop_vertices: List[
8888
Once expander has run, fill in the connection data.
8989
9090
:param expanded_pop_vertices: List of machine vertices to read data from
91-
:param transceiver: How to talk to the machine
9291
"""
9392
progress = ProgressBar(
9493
len(expanded_pop_vertices), "Getting initial values")

spynnaker/pyNN/extra_algorithms/splitter_components/splitter_delay_vertex_slice.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,7 @@ def create_machine_vertex(
115115
"""
116116
Creates a delay extension machine vertex and adds to the tracker.
117117
118-
:param ~pacman.model.graphs.machine.MachineVertex source_vertex:
119-
The source of the delay
118+
:param source_app_vertex: The source of the delay
120119
:return: machine vertex
121120
"""
122121
label = f"Delay extension for {source_app_vertex}"
@@ -153,7 +152,6 @@ def get_machine_vertex(
153152
"""
154153
Get a delay extension machine vertex for a given vertex slice.
155154
156-
:param ~pacman.model.graphs.common.Slice vertex_slice:
157-
The slice to get the data for
155+
:param vertex_slice: The slice to get the data for
158156
"""
159157
return self._machine_vertex_by_slice[vertex_slice]

spynnaker/pyNN/extra_algorithms/splitter_components/splitter_population_vertex_neurons_synapses.py

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,6 @@ def __add_lead_synapse_core(
307307
back to S1615 values
308308
:param weight_scales:
309309
The scale to apply to weights to encode them in the 16-bit synapses
310-
:param synapse_vertices: A list to add the core to
311310
:param neuron_vertex:
312311
The neuron vertex the synapses will feed into
313312
:param atoms_per_core: The maximum atoms per core
@@ -351,8 +350,7 @@ def __add_shared_synapse_core(
351350
:param synapse_references: References to the synapse regions
352351
:param shared_synapse_sdram:
353352
:param feedback_partition:
354-
:param synapse_vertices: A list to add the core to
355-
:param PopulationNeuronsMachineVertex neuron_vertex:
353+
` :param neuron_vertex:
356354
The neuron vertex the synapses will feed into
357355
:return: The
358356
"""
@@ -582,8 +580,6 @@ def __get_neuron_sdram(
582580
"""
583581
Gets the resources of the neurons of a slice of atoms from a given
584582
application vertex.
585-
586-
:param vertex_slice: the slice
587583
"""
588584
n_record = len(self.governed_app_vertex.neuron_recordables)
589585
variable_sdram = \
@@ -641,7 +637,6 @@ def __get_synapse_sdram(
641637
Get the resources of the synapses of a slice of atoms from a
642638
given application vertex.
643639
644-
:param vertex_slice: the slice
645640
:param shared_sdram:
646641
The SDRAM shared between cores, if this is to be included
647642
"""
@@ -684,9 +679,6 @@ def __independent_synapse_sdram(self) -> MultiRegionSDRAM:
684679
def __proj_dependent_synapse_sdram(self) -> MultiRegionSDRAM:
685680
"""
686681
Get the SDRAM used by synapse cores dependent on the projections.
687-
688-
:param incoming_projections:
689-
The projections to consider in the calculations
690682
"""
691683
regions = PopulationSynapsesMachineVertexLead.SYNAPSE_REGIONS
692684
sdram = MultiRegionSDRAM()

spynnaker/pyNN/extra_algorithms/splitter_components/spynnaker_splitter_selector.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,7 @@ def spynnaker_vertex_selector(app_vertex: ApplicationVertex) -> None:
8181
Will delegate to the non-sPyNNaker selector if no heuristic is known for
8282
the application vertex.
8383
84-
:param ~pacman.model.graphs.application.ApplicationVertex app_vertex:
85-
application vertex to give a splitter object to
84+
:param app_vertex: application vertex to give a splitter object to
8685
"""
8786
if not app_vertex.has_splitter:
8887
if isinstance(app_vertex, PopulationVertex):

spynnaker/pyNN/extra_algorithms/spynnaker_neuron_network_specification_report.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,6 @@ def spynnaker_neuron_graph_network_specification_report() -> None:
5151
"""
5252
Produces a report describing the graph created from the neural
5353
populations and projections.
54-
55-
:param report_folder: the report folder to put figure into
5654
"""
5755
# create holders for data
5856
dot_diagram, exe_not_found_exn = _get_diagram(_GRAPH_TITLE)

spynnaker/pyNN/models/abstract_models/abstract_accepts_incoming_synapses.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def get_connections_from_machine(
6666
"""
6767
Get the connections from the machine post-run.
6868
69-
:param ApplicationEdge app_edge:
69+
:param app_edge:
7070
The edge for which the data is being read
7171
:param synapse_info:
7272
The specific projection within the edge

spynnaker/pyNN/models/common/local_only_2d_common.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def get_delay_for_source(incoming: "Projection") -> Tuple[
6868
""" Get the vertex which will send data from a given source projection,
6969
along with the delay stage and locally-handled delay value
7070
71-
:param Projection incoming: The incoming projection to get the delay from
71+
:param incoming: The incoming projection to get the delay from
7272
:return: The vertex, the local delay, the delay stage, the partition id
7373
"""
7474
# pylint: disable=protected-access
@@ -126,7 +126,7 @@ def get_sources_for_target(app_vertex: "PopulationVertex") -> Dict[
126126
Get all the application vertex sources that will hit the given application
127127
vertex.
128128
129-
:param PopulationVertex app_vertex: The vertex being targeted
129+
:param app_vertex: The vertex being targeted
130130
:return:
131131
A dict of source ApplicationVertex to list of source information
132132
"""

spynnaker/pyNN/models/common/neuron_recorder.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,6 @@ def _get_placement_matrix_data(
296296
"""
297297
Processes a placement for matrix data.
298298
299-
:param placements: the placements object
300299
:param vertex: the vertex to read from
301300
:param region: the recording region id
302301
:param expected_rows:

0 commit comments

Comments
 (0)