spynnaker.pyNN package¶
Subpackages¶
- spynnaker.pyNN.connections package
- spynnaker.pyNN.external_devices_models package
- Subpackages
- spynnaker.pyNN.external_devices_models.push_bot package
- Subpackages
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_control_modules package
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet package
- Submodules
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet.push_bot_ethernet_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet.push_bot_ethernet_laser_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet.push_bot_ethernet_led_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet.push_bot_ethernet_motor_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet.push_bot_ethernet_retina_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet.push_bot_ethernet_speaker_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet.push_bot_retina_connection module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet.push_bot_translator module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_ethernet.push_bot_wifi_connection module
- Module contents
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_parameters package
- Submodules
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_parameters.push_bot_laser module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_parameters.push_bot_led module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_parameters.push_bot_motor module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_parameters.push_bot_retina_resolution module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_parameters.push_bot_retina_viewer module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_parameters.push_bot_speaker module
- Module contents
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_spinnaker_link package
- Submodules
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_spinnaker_link.push_bot_spinnaker_link_laser_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_spinnaker_link.push_bot_spinnaker_link_led_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_spinnaker_link.push_bot_spinnaker_link_motor_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_spinnaker_link.push_bot_spinnaker_link_retina_device module
- spynnaker.pyNN.external_devices_models.push_bot.push_bot_spinnaker_link.push_bot_spinnaker_link_speaker_device module
- Module contents
- Submodules
- spynnaker.pyNN.external_devices_models.push_bot.abstract_push_bot_output_device module
- spynnaker.pyNN.external_devices_models.push_bot.abstract_push_bot_retina_device module
- Module contents
- Subpackages
- spynnaker.pyNN.external_devices_models.push_bot package
- Submodules
- spynnaker.pyNN.external_devices_models.abstract_ethernet_controller module
- spynnaker.pyNN.external_devices_models.abstract_ethernet_sensor module
- spynnaker.pyNN.external_devices_models.abstract_ethernet_translator module
- spynnaker.pyNN.external_devices_models.abstract_multicast_controllable_device module
- spynnaker.pyNN.external_devices_models.arbitrary_fpga_device module
- spynnaker.pyNN.external_devices_models.external_device_lif_control module
- spynnaker.pyNN.external_devices_models.external_device_lif_control_vertex module
- spynnaker.pyNN.external_devices_models.external_spinnaker_link_cochlea_device module
- spynnaker.pyNN.external_devices_models.external_spinnaker_link_fpga_retina_device module
- spynnaker.pyNN.external_devices_models.munich_spinnaker_link_motor_device module
- spynnaker.pyNN.external_devices_models.munich_spinnaker_link_retina_device module
- spynnaker.pyNN.external_devices_models.threshold_type_multicast_device_control module
- Module contents
- Subpackages
- spynnaker.pyNN.model_binaries package
- spynnaker.pyNN.models package
- Subpackages
- spynnaker.pyNN.models.abstract_models package
- Submodules
- spynnaker.pyNN.models.abstract_models.abstract_accepts_incoming_synapses module
- spynnaker.pyNN.models.abstract_models.abstract_contains_units module
- spynnaker.pyNN.models.abstract_models.abstract_filterable_edge module
- spynnaker.pyNN.models.abstract_models.abstract_population_initializable module
- spynnaker.pyNN.models.abstract_models.abstract_population_settable module
- spynnaker.pyNN.models.abstract_models.abstract_read_parameters_before_set module
- spynnaker.pyNN.models.abstract_models.abstract_settable module
- spynnaker.pyNN.models.abstract_models.abstract_weight_updatable module
- Module contents
- spynnaker.pyNN.models.common package
- Submodules
- spynnaker.pyNN.models.common.abstract_neuron_recordable module
- spynnaker.pyNN.models.common.abstract_spike_recordable module
- spynnaker.pyNN.models.common.eieio_spike_recorder module
- spynnaker.pyNN.models.common.multi_spike_recorder module
- spynnaker.pyNN.models.common.neuron_recorder module
- spynnaker.pyNN.models.common.recording_utils module
- spynnaker.pyNN.models.common.simple_population_settable module
- Module contents
- spynnaker.pyNN.models.neural_projections package
- Subpackages
- spynnaker.pyNN.models.neural_projections.connectors package
- Submodules
- spynnaker.pyNN.models.neural_projections.connectors.abstract_connector module
- spynnaker.pyNN.models.neural_projections.connectors.abstract_generate_connector_on_machine module
- spynnaker.pyNN.models.neural_projections.connectors.all_to_all_connector module
- spynnaker.pyNN.models.neural_projections.connectors.array_connector module
- spynnaker.pyNN.models.neural_projections.connectors.csa_connector module
- spynnaker.pyNN.models.neural_projections.connectors.distance_dependent_probability_connector module
- spynnaker.pyNN.models.neural_projections.connectors.fixed_number_post_connector module
- spynnaker.pyNN.models.neural_projections.connectors.fixed_number_pre_connector module
- spynnaker.pyNN.models.neural_projections.connectors.fixed_probability_connector module
- spynnaker.pyNN.models.neural_projections.connectors.from_list_connector module
- spynnaker.pyNN.models.neural_projections.connectors.index_based_probability_connector module
- spynnaker.pyNN.models.neural_projections.connectors.kernel_connector module
- spynnaker.pyNN.models.neural_projections.connectors.multapse_connector module
- spynnaker.pyNN.models.neural_projections.connectors.one_to_one_connector module
- spynnaker.pyNN.models.neural_projections.connectors.small_world_connector module
- Module contents
- spynnaker.pyNN.models.neural_projections.connectors package
- Submodules
- spynnaker.pyNN.models.neural_projections.delay_afferent_application_edge module
- spynnaker.pyNN.models.neural_projections.delay_afferent_machine_edge module
- spynnaker.pyNN.models.neural_projections.delayed_application_edge module
- spynnaker.pyNN.models.neural_projections.delayed_machine_edge module
- spynnaker.pyNN.models.neural_projections.projection_application_edge module
- spynnaker.pyNN.models.neural_projections.projection_machine_edge module
- spynnaker.pyNN.models.neural_projections.synapse_information module
- Module contents
- Subpackages
- spynnaker.pyNN.models.neural_properties package
- spynnaker.pyNN.models.neuron package
- Subpackages
- spynnaker.pyNN.models.neuron.additional_inputs package
- spynnaker.pyNN.models.neuron.builds package
- Submodules
- spynnaker.pyNN.models.neuron.builds.eif_cond_alpha_isfa_ista module
- spynnaker.pyNN.models.neuron.builds.hh_cond_exp module
- spynnaker.pyNN.models.neuron.builds.if_cond_alpha module
- spynnaker.pyNN.models.neuron.builds.if_cond_exp_base module
- spynnaker.pyNN.models.neuron.builds.if_cond_exp_stoc module
- spynnaker.pyNN.models.neuron.builds.if_curr_alpha module
- spynnaker.pyNN.models.neuron.builds.if_curr_delta module
- spynnaker.pyNN.models.neuron.builds.if_curr_dual_exp_base module
- spynnaker.pyNN.models.neuron.builds.if_curr_exp_base module
- spynnaker.pyNN.models.neuron.builds.if_curr_exp_ca2_adaptive module
- spynnaker.pyNN.models.neuron.builds.if_curr_exp_semd_base module
- spynnaker.pyNN.models.neuron.builds.if_facets_hardware1 module
- spynnaker.pyNN.models.neuron.builds.izk_cond_exp_base module
- spynnaker.pyNN.models.neuron.builds.izk_curr_exp_base module
- Module contents
- spynnaker.pyNN.models.neuron.implementations package
- Submodules
- spynnaker.pyNN.models.neuron.implementations.abstract_neuron_impl module
- spynnaker.pyNN.models.neuron.implementations.abstract_standard_neuron_component module
- spynnaker.pyNN.models.neuron.implementations.neuron_impl_standard module
- spynnaker.pyNN.models.neuron.implementations.ranged_dict_vertex_slice module
- spynnaker.pyNN.models.neuron.implementations.struct module
- Module contents
- spynnaker.pyNN.models.neuron.input_types package
- Submodules
- spynnaker.pyNN.models.neuron.input_types.abstract_input_type module
- spynnaker.pyNN.models.neuron.input_types.input_type_conductance module
- spynnaker.pyNN.models.neuron.input_types.input_type_current module
- spynnaker.pyNN.models.neuron.input_types.input_type_current_semd module
- Module contents
- spynnaker.pyNN.models.neuron.master_pop_table_generators package
- spynnaker.pyNN.models.neuron.neuron_models package
- spynnaker.pyNN.models.neuron.plasticity package
- Subpackages
- spynnaker.pyNN.models.neuron.plasticity.stdp package
- Subpackages
- spynnaker.pyNN.models.neuron.plasticity.stdp.common package
- spynnaker.pyNN.models.neuron.plasticity.stdp.synapse_structure package
- Submodules
- spynnaker.pyNN.models.neuron.plasticity.stdp.synapse_structure.abstract_synapse_structure module
- spynnaker.pyNN.models.neuron.plasticity.stdp.synapse_structure.synapse_structure_weight_accumulator module
- spynnaker.pyNN.models.neuron.plasticity.stdp.synapse_structure.synapse_structure_weight_only module
- Module contents
- spynnaker.pyNN.models.neuron.plasticity.stdp.timing_dependence package
- Submodules
- spynnaker.pyNN.models.neuron.plasticity.stdp.timing_dependence.abstract_timing_dependence module
- spynnaker.pyNN.models.neuron.plasticity.stdp.timing_dependence.timing_dependence_pfister_spike_triplet module
- spynnaker.pyNN.models.neuron.plasticity.stdp.timing_dependence.timing_dependence_recurrent module
- spynnaker.pyNN.models.neuron.plasticity.stdp.timing_dependence.timing_dependence_spike_nearest_pair module
- spynnaker.pyNN.models.neuron.plasticity.stdp.timing_dependence.timing_dependence_spike_pair module
- spynnaker.pyNN.models.neuron.plasticity.stdp.timing_dependence.timing_dependence_vogels_2011 module
- Module contents
- spynnaker.pyNN.models.neuron.plasticity.stdp.weight_dependence package
- Submodules
- spynnaker.pyNN.models.neuron.plasticity.stdp.weight_dependence.abstract_has_a_plus_a_minus module
- spynnaker.pyNN.models.neuron.plasticity.stdp.weight_dependence.abstract_weight_dependence module
- spynnaker.pyNN.models.neuron.plasticity.stdp.weight_dependence.weight_dependence_additive module
- spynnaker.pyNN.models.neuron.plasticity.stdp.weight_dependence.weight_dependence_additive_triplet module
- spynnaker.pyNN.models.neuron.plasticity.stdp.weight_dependence.weight_dependence_multiplicative module
- Module contents
- Module contents
- Subpackages
- spynnaker.pyNN.models.neuron.plasticity.stdp package
- Module contents
- Subpackages
- spynnaker.pyNN.models.neuron.structural_plasticity package
- Subpackages
- spynnaker.pyNN.models.neuron.structural_plasticity.synaptogenesis package
- Subpackages
- spynnaker.pyNN.models.neuron.structural_plasticity.synaptogenesis.elimination package
- spynnaker.pyNN.models.neuron.structural_plasticity.synaptogenesis.formation package
- spynnaker.pyNN.models.neuron.structural_plasticity.synaptogenesis.partner_selection package
- Submodules
- spynnaker.pyNN.models.neuron.structural_plasticity.synaptogenesis.partner_selection.abstract_partner_selection module
- spynnaker.pyNN.models.neuron.structural_plasticity.synaptogenesis.partner_selection.last_neuron_selection module
- spynnaker.pyNN.models.neuron.structural_plasticity.synaptogenesis.partner_selection.random_selection module
- Module contents
- Module contents
- Subpackages
- spynnaker.pyNN.models.neuron.structural_plasticity.synaptogenesis package
- Module contents
- Subpackages
- spynnaker.pyNN.models.neuron.synapse_dynamics package
- Submodules
- spynnaker.pyNN.models.neuron.synapse_dynamics.abstract_generate_on_machine module
- spynnaker.pyNN.models.neuron.synapse_dynamics.abstract_plastic_synapse_dynamics module
- spynnaker.pyNN.models.neuron.synapse_dynamics.abstract_static_synapse_dynamics module
- spynnaker.pyNN.models.neuron.synapse_dynamics.abstract_synapse_dynamics module
- spynnaker.pyNN.models.neuron.synapse_dynamics.abstract_synapse_dynamics_structural module
- spynnaker.pyNN.models.neuron.synapse_dynamics.pynn_synapse_dynamics module
- spynnaker.pyNN.models.neuron.synapse_dynamics.synapse_dynamics_static module
- spynnaker.pyNN.models.neuron.synapse_dynamics.synapse_dynamics_stdp module
- spynnaker.pyNN.models.neuron.synapse_dynamics.synapse_dynamics_structural_common module
- spynnaker.pyNN.models.neuron.synapse_dynamics.synapse_dynamics_structural_static module
- spynnaker.pyNN.models.neuron.synapse_dynamics.synapse_dynamics_structural_stdp module
- Module contents
- spynnaker.pyNN.models.neuron.synapse_io package
- spynnaker.pyNN.models.neuron.synapse_types package
- Submodules
- spynnaker.pyNN.models.neuron.synapse_types.abstract_synapse_type module
- spynnaker.pyNN.models.neuron.synapse_types.synapse_type_alpha module
- spynnaker.pyNN.models.neuron.synapse_types.synapse_type_delta module
- spynnaker.pyNN.models.neuron.synapse_types.synapse_type_dual_exponential module
- spynnaker.pyNN.models.neuron.synapse_types.synapse_type_exponential module
- spynnaker.pyNN.models.neuron.synapse_types.synapse_type_semd module
- Module contents
- spynnaker.pyNN.models.neuron.threshold_types package
- Submodules
- spynnaker.pyNN.models.neuron.abstract_population_vertex module
- spynnaker.pyNN.models.neuron.abstract_pynn_neuron_model module
- spynnaker.pyNN.models.neuron.abstract_pynn_neuron_model_standard module
- spynnaker.pyNN.models.neuron.connection_holder module
- spynnaker.pyNN.models.neuron.generator_data module
- spynnaker.pyNN.models.neuron.population_machine_vertex module
- spynnaker.pyNN.models.neuron.synaptic_manager module
- Module contents
- Subpackages
- spynnaker.pyNN.models.spike_source package
- Submodules
- spynnaker.pyNN.models.spike_source.spike_source_array module
- spynnaker.pyNN.models.spike_source.spike_source_array_vertex module
- spynnaker.pyNN.models.spike_source.spike_source_from_file module
- spynnaker.pyNN.models.spike_source.spike_source_poisson module
- spynnaker.pyNN.models.spike_source.spike_source_poisson_machine_vertex module
- spynnaker.pyNN.models.spike_source.spike_source_poisson_variable module
- spynnaker.pyNN.models.spike_source.spike_source_poisson_vertex module
- Module contents
- spynnaker.pyNN.models.utility_models package
- Subpackages
- spynnaker.pyNN.models.utility_models.delays package
- Submodules
- spynnaker.pyNN.models.utility_models.delays.delay_block module
- spynnaker.pyNN.models.utility_models.delays.delay_extension_machine_vertex module
- spynnaker.pyNN.models.utility_models.delays.delay_extension_vertex module
- spynnaker.pyNN.models.utility_models.delays.delay_generator_data module
- Module contents
- spynnaker.pyNN.models.utility_models.spike_injector package
- spynnaker.pyNN.models.utility_models.synapse_expander package
- spynnaker.pyNN.models.utility_models.delays package
- Module contents
- Subpackages
- spynnaker.pyNN.models.abstract_models package
- Submodules
- spynnaker.pyNN.models.abstract_pynn_model module
- spynnaker.pyNN.models.defaults module
- spynnaker.pyNN.models.pynn_population_common module
- spynnaker.pyNN.models.pynn_projection_common module
- spynnaker.pyNN.models.recording_common module
- Module contents
- Subpackages
- spynnaker.pyNN.overridden_pacman_functions package
- spynnaker.pyNN.protocols package
- spynnaker.pyNN.utilities package
- Subpackages
- Submodules
- spynnaker.pyNN.utilities.constants module
- spynnaker.pyNN.utilities.extracted_data module
- spynnaker.pyNN.utilities.fake_HBP_Portal_machine_provider module
- spynnaker.pyNN.utilities.reports module
- spynnaker.pyNN.utilities.running_stats module
- spynnaker.pyNN.utilities.spynnaker_connection_holder_generations module
- spynnaker.pyNN.utilities.spynnaker_failed_state module
- spynnaker.pyNN.utilities.spynnaker_neuron_network_specification_report module
- spynnaker.pyNN.utilities.spynnaker_synaptic_matrix_report module
- spynnaker.pyNN.utilities.utility_calls module
- Module contents
Submodules¶
spynnaker.pyNN.abstract_spinnaker_common module¶
-
class
spynnaker.pyNN.abstract_spinnaker_common.
AbstractSpiNNakerCommon
(graph_label, database_socket_addresses, n_chips_required, n_boards_required, timestep, max_delay, min_delay, hostname, user_extra_algorithm_xml_path=None, user_extra_mapping_inputs=None, user_extra_algorithms_pre_run=None, time_scale_factor=None, extra_post_run_algorithms=None, extra_mapping_algorithms=None, extra_load_algorithms=None, front_end_versions=None)[source]¶ Bases:
spinn_front_end_common.interface.abstract_spinnaker_base.AbstractSpinnakerBase
,spynnaker.pyNN.spynnaker_simulator_interface.SpynnakerSimulatorInterface
Main interface for neural code.
-
CONFIG_FILE_NAME
= 'spynnaker.cfg'¶
-
add_application_vertex
(vertex)[source]¶ Parameters: vertex – the vertex to add to the graph
Type: ApplicationVertex
Return type: None
Raises: - ConfigurationException – when both graphs contain vertices
- PacmanConfigurationException – If there is an attempt to add the same vertex more than once
-
get_projections_data
(projection_to_attribute_map)[source]¶ Common data extractor for projection data. Allows fully exploitation of the ????
Parameters: projection_to_attribute_map (dict of projection with set of attributes) – the projection to attributes mapping Returns: a extracted data object with get method for getting the data Return type: spynnaker.pyNN.utilities.extracted_data.ExtractedData
-
id_counter
¶ Getter for id_counter, currently used by the populations.
Note
Maybe it could live in the pop class???
Returns: Return type: int
-
max_delay
¶ The maximum supported delay, in milliseconds.
-
min_delay
¶ The minimum supported delay, in milliseconds.
-
static
register_binary_search_path
(search_path)[source]¶ Register an additional binary search path for executables.
Parameters: search_path – absolute search path for binaries
-
run
(run_time)[source]¶ Run the model created.
Parameters: run_time – the time (in milliseconds) to run the simulation for
-
stop
(turn_off_machine=None, clear_routing_tables=None, clear_tags=None)[source]¶ Parameters: - turn_off_machine (bool) – decides if the machine should be powered down after running the execution. Note that this powers down all boards connected to the BMP connections given to the transceiver
- clear_routing_tables (bool) – informs the tool chain if it should turn off the clearing of the routing tables
- clear_tags (boolean) – informs the tool chain if it should clear the tags off the machine at stop
Return type: None
-
spynnaker.pyNN.exceptions module¶
-
exception
spynnaker.pyNN.exceptions.
DelayExtensionException
[source]¶ Bases:
spinn_front_end_common.utilities.exceptions.ConfigurationException
Raised when a delay extension vertex fails.
-
exception
spynnaker.pyNN.exceptions.
FilterableException
[source]¶ Bases:
spynnaker.pyNN.exceptions.SpynnakerException
Raised when it is not possible to determine if an edge should be filtered.
-
exception
spynnaker.pyNN.exceptions.
InvalidParameterType
[source]¶ Bases:
spynnaker.pyNN.exceptions.SpynnakerException
Raised when a parameter is not recognised.
-
exception
spynnaker.pyNN.exceptions.
MemReadException
[source]¶ Bases:
spynnaker.pyNN.exceptions.SpynnakerException
Raised when the PyNN front end fails to read a certain memory region.
-
exception
spynnaker.pyNN.exceptions.
SpynnakerException
[source]¶ Bases:
Exception
Superclass of all exceptions from the PyNN module.
-
exception
spynnaker.pyNN.exceptions.
SynapseRowTooBigException
(max_size, message)[source]¶ Bases:
spynnaker.pyNN.exceptions.SpynnakerException
Raised when a synapse row is bigger than is allowed.PyNN
-
max_size
¶ The maximum size allowed.
-
-
exception
spynnaker.pyNN.exceptions.
SynapticBlockGenerationException
[source]¶ Bases:
spinn_front_end_common.utilities.exceptions.ConfigurationException
Raised when the synaptic manager fails to generate a synaptic block.
-
exception
spynnaker.pyNN.exceptions.
SynapticBlockReadException
[source]¶ Bases:
spinn_front_end_common.utilities.exceptions.ConfigurationException
Raised when the synaptic manager fails to read a synaptic block or convert it into readable values.
-
exception
spynnaker.pyNN.exceptions.
SynapticConfigurationException
[source]¶ Bases:
spinn_front_end_common.utilities.exceptions.ConfigurationException
Raised when the synaptic manager fails for some reason.
-
exception
spynnaker.pyNN.exceptions.
SynapticMaxIncomingAtomsSupportException
[source]¶ Bases:
spinn_front_end_common.utilities.exceptions.ConfigurationException
Raised when a synaptic sublist exceeds the max atoms possible to be supported.
spynnaker.pyNN.spynnaker_external_device_plugin_manager module¶
-
class
spynnaker.pyNN.spynnaker_external_device_plugin_manager.
SpynnakerExternalDevicePluginManager
[source]¶ Bases:
object
User-level interface for the external device plugin manager.
-
static
activate_live_output_for
(population, database_notify_host=None, database_notify_port_num=None, database_ack_port_num=None, board_address=None, port=None, host=None, tag=None, strip_sdp=True, use_prefix=False, key_prefix=None, prefix_type=None, message_type=<EIEIOType.KEY_32_BIT: 2>, right_shift=0, payload_as_time_stamps=True, notify=True, use_payload_prefix=True, payload_prefix=None, payload_right_shift=0, number_of_packets_sent_per_time_step=0)[source]¶ Output the spikes from a given population from SpiNNaker as they occur in the simulation.
Parameters: - population (
spynnaker.pyNN.models.pynn_population_common.PyNNPopulationCommon
) – The population to activate the live output for - database_notify_host (str) – The hostname for the device which is listening to the database notification.
- database_ack_port_num (int) – The port number to which a external device will acknowledge that they have finished reading the database and are ready for it to start execution
- database_notify_port_num (int) – The port number to which a external device will receive the database is ready command
- board_address (str) – A fixed board address required for the tag, or None if any address is OK
- key_prefix (int or None) – the prefix to be applied to the key
- prefix_type – if the prefix type is 32 bit or 16 bit
- message_type – If the message is a EIEIO command message, or an EIEIO data message with 16 bit or 32 bit keys.
- payload_as_time_stamps –
- right_shift –
- use_payload_prefix –
- notify –
- payload_prefix –
- payload_right_shift –
- number_of_packets_sent_per_time_step –
- port (int) – The UDP port to which the live spikes will be sent. If not specified, the port will be taken from the “live_spike_port” parameter in the “Recording” section of the sPyNNaker configuration file.
- host (str) – The host name or IP address to which the live spikes will be sent. If not specified, the host will be taken from the “live_spike_host” parameter in the “Recording” section of the sPyNNaker configuration file.
- tag (int) – The IP tag to be used for the spikes. If not specified, one will be automatically assigned
- strip_sdp (bool) – Determines if the SDP headers will be stripped from the transmitted packet.
- use_prefix (bool) – Determines if the spike packet will contain a common prefix for the spikes
- label (str) – The label of the gatherer vertex
- partition_ids (list(str)) – The names of the partitions to create edges for
- population (
-
static
activate_live_output_to
(population, device)[source]¶ Activate the output of spikes from a population to an external device. Note that all spikes will be sent to the device.
Parameters: - population (
spynnaker.pyNN.models.pynn_population_common.PyNNPopulationCommon
) – The pyNN population object from which spikes will be sent. - device (
spynnaker.pyNN.models.pynn_population_common.PyNNPopulationCommon
orpacman.model.graphs.application.ApplicationVertex
) – The pyNN population or external device to which the spikes will be sent.
- population (
-
static
add_database_socket_address
(database_notify_host, database_notify_port_num, database_ack_port_num)[source]¶
-
static
add_edge
(vertex, device_vertex, partition_id)[source]¶ Add an edge between two vertices (often a vertex and a external device) on a given partition.
Parameters: - vertex – the pre vertex to connect the edge from
- device_vertex – the post vertex to connect the edge to
- partition_id – the partition identifier for making nets
Return type: None
-
static
add_poisson_live_rate_control
(poisson_population, control_label_extension='_control', receive_port=None, database_notify_host=None, database_notify_port_num=None, database_ack_port_num=None, notify=True, reserve_reverse_ip_tag=False)[source]¶ Add a live rate controller to a Poisson population.
Parameters: - poisson_population (
spynnaker.pyNN.models.pynn_population_common.PyNNPopulationCommon
) – The population to control - control_label_extension (str) – An extension to add to the label of the Poisson source. Must match up with the equivalent in the SpynnakerPoissonControlConnection
- receive_port (int) – The port that the SpiNNaker board should listen on
- database_notify_host (str) – the hostname for the device which is listening to the database notification.
- database_ack_port_num (int) – the port number to which a external device will acknowledge that they have finished reading the database and are ready for it to start execution
- database_notify_port_num (int) – The port number to which a external device will receive the database is ready command
- reserve_reverse_ip_tag (bool) – True if a reverse ip tag is to be used, False if SDP is to be used (default)
- poisson_population (
-
static
add_socket_address
(socket_address)[source]¶ Add a socket address to the list to be checked by the notification protocol.
Parameters: socket_address – the socket address Return type: None:
-
static
update_live_packet_gather_tracker
(vertex_to_record_from, lpg_label, port=None, hostname=None, board_address=None, tag=None, strip_sdp=True, use_prefix=False, key_prefix=None, prefix_type=None, message_type=<EIEIOType.KEY_32_BIT: 2>, right_shift=0, payload_as_time_stamps=True, use_payload_prefix=True, payload_prefix=None, payload_right_shift=0, number_of_packets_sent_per_time_step=0, partition_ids=None)[source]¶ Add an edge from a vertex to the live packet gatherer, builds as needed and has all the parameters for the creation of the live packet gatherer if needed.
-
static