spynnaker.pyNN.models.neuron.synapse_types package¶
Module contents¶
-
class
spynnaker.pyNN.models.neuron.synapse_types.
AbstractSynapseType
(data_types)[source]¶ Bases:
spynnaker.pyNN.models.neuron.implementations.abstract_standard_neuron_component.AbstractStandardNeuronComponent
Represents the synapse types supported.
Parameters: data_types (list(DataType)) – A list of data types in the component structure, in the order that they appear -
get_n_synapse_types
()[source]¶ Get the number of synapse types supported.
Returns: The number of synapse types supported Return type: int
-
-
class
spynnaker.pyNN.models.neuron.synapse_types.
SynapseTypeDualExponential
(tau_syn_E, tau_syn_E2, tau_syn_I, isyn_exc, isyn_exc2, isyn_inh)[source]¶ Bases:
spynnaker.pyNN.models.neuron.synapse_types.abstract_synapse_type.AbstractSynapseType
Parameters: - tau_syn_E (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_{e_1}\)
- tau_syn_E2 (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_{e_2}\)
- tau_syn_I (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_i\)
- isyn_exc (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_{e_1}\)
- isyn_exc2 (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_{e_2}\)
- isyn_inh (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_i\)
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters (RangeDictionary) – A holder of the parameters
-
add_state_variables
(state_variables)[source]¶ Add the initial values of the state variables to the state variables holder
Parameters: state_variables (RangeDictionary) – A holder of the state variables
-
get_n_cpu_cycles
(n_neurons)[source]¶ Get the number of CPU cycles required to update the state
Parameters: n_neurons (int) – The number of neurons to get the cycles for Return type: int
-
get_n_synapse_types
()[source]¶ Get the number of synapse types supported.
Returns: The number of synapse types supported Return type: int
-
get_synapse_id_by_target
(target)[source]¶ Get the ID of a synapse given the name.
Returns: The ID of the synapse Return type: int
-
get_synapse_targets
()[source]¶ Get the target names of the synapse type.
Returns: an array of strings Return type: array(str)
-
get_units
(variable)[source]¶ Get the units of the given variable
Parameters: variable (str) – The name of the variable
-
get_values
(parameters, state_variables, vertex_slice, ts)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (RangeDictionary) – The holder of the parameters
- state_variables (RangeDictionary) – The holder of the state variables
- vertex_slice (Slice) – The slice of variables being retrieved
- ts (int) – The time to be advanced in one call to the update of this component
- ts – machine time step
Returns: A list with the same length as self.struct.field_types
Return type: list(int or float or list(int) or list(float) or RangedList)
-
has_variable
(variable)[source]¶ Determine if this component has a variable by the given name
Parameters: variable (str) – The name of the variable Return type: bool
-
isyn_exc
¶
-
isyn_exc2
¶
-
isyn_inh
¶
-
tau_syn_E
¶
-
tau_syn_E2
¶
-
tau_syn_I
¶
-
update_values
(values, parameters, state_variables)[source]¶ Update the parameters and state variables with the given struct values that have been read from the machine
Parameters: - values (list(list)) – The values read from the machine, one for each struct element
- parameters (RangeDictionary) – The holder of the parameters to update
- state_variables (RangeDictionary) – The holder of the state variables to update
-
class
spynnaker.pyNN.models.neuron.synapse_types.
SynapseTypeExponential
(tau_syn_E, tau_syn_I, isyn_exc, isyn_inh)[source]¶ Bases:
spynnaker.pyNN.models.neuron.synapse_types.abstract_synapse_type.AbstractSynapseType
Parameters: - tau_syn_E (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_e\)
- tau_syn_I (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_i\)
- isyn_exc (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_e\)
- isyn_inh (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_i\)
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters (RangeDictionary) – A holder of the parameters
-
add_state_variables
(state_variables)[source]¶ Add the initial values of the state variables to the state variables holder
Parameters: state_variables (RangeDictionary) – A holder of the state variables
-
get_n_cpu_cycles
(n_neurons)[source]¶ Get the number of CPU cycles required to update the state
Parameters: n_neurons (int) – The number of neurons to get the cycles for Return type: int
-
get_n_synapse_types
()[source]¶ Get the number of synapse types supported.
Returns: The number of synapse types supported Return type: int
-
get_synapse_id_by_target
(target)[source]¶ Get the ID of a synapse given the name.
Returns: The ID of the synapse Return type: int
-
get_synapse_targets
()[source]¶ Get the target names of the synapse type.
Returns: an array of strings Return type: array(str)
-
get_units
(variable)[source]¶ Get the units of the given variable
Parameters: variable (str) – The name of the variable
-
get_values
(parameters, state_variables, vertex_slice, ts)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (RangeDictionary) – The holder of the parameters
- state_variables (RangeDictionary) – The holder of the state variables
- vertex_slice (Slice) – The slice of variables being retrieved
- ts (int) – The time to be advanced in one call to the update of this component
- ts – machine time step
Returns: A list with the same length as self.struct.field_types
Return type: list(int or float or list(int) or list(float) or RangedList)
-
has_variable
(variable)[source]¶ Determine if this component has a variable by the given name
Parameters: variable (str) – The name of the variable Return type: bool
-
isyn_exc
¶
-
isyn_inh
¶
-
tau_syn_E
¶
-
tau_syn_I
¶
-
update_values
(values, parameters, state_variables)[source]¶ Update the parameters and state variables with the given struct values that have been read from the machine
Parameters: - values (list(list)) – The values read from the machine, one for each struct element
- parameters (RangeDictionary) – The holder of the parameters to update
- state_variables (RangeDictionary) – The holder of the state variables to update
-
class
spynnaker.pyNN.models.neuron.synapse_types.
SynapseTypeDelta
(isyn_exc, isyn_inh)[source]¶ Bases:
spynnaker.pyNN.models.neuron.synapse_types.abstract_synapse_type.AbstractSynapseType
This represents a synapse type with two delta synapses
Parameters: - isyn_exc (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_e\)
- isyn_inh (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_i\)
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters (RangeDictionary) – A holder of the parameters
-
add_state_variables
(state_variables)[source]¶ Add the initial values of the state variables to the state variables holder
Parameters: state_variables (RangeDictionary) – A holder of the state variables
-
get_n_cpu_cycles
(n_neurons)[source]¶ Get the number of CPU cycles required to update the state
Parameters: n_neurons (int) – The number of neurons to get the cycles for Return type: int
-
get_n_synapse_types
()[source]¶ Get the number of synapse types supported.
Returns: The number of synapse types supported Return type: int
-
get_synapse_id_by_target
(target)[source]¶ Get the ID of a synapse given the name.
Returns: The ID of the synapse Return type: int
-
get_synapse_targets
()[source]¶ Get the target names of the synapse type.
Returns: an array of strings Return type: array(str)
-
get_units
(variable)[source]¶ Get the units of the given variable
Parameters: variable (str) – The name of the variable
-
get_values
(parameters, state_variables, vertex_slice, ts)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (RangeDictionary) – The holder of the parameters
- state_variables (RangeDictionary) – The holder of the state variables
- vertex_slice (Slice) – The slice of variables being retrieved
- ts (float) – The time to be advanced in one call to the update of this component
Returns: A list with the same length as self.struct.field_types
Return type: list(int or float or list(int) or list(float) or RangedList)
-
has_variable
(variable)[source]¶ Determine if this component has a variable by the given name
Parameters: variable (str) – The name of the variable Return type: bool
-
isyn_exc
¶
-
isyn_inh
¶
-
update_values
(values, parameters, state_variables)[source]¶ Update the parameters and state variables with the given struct values that have been read from the machine
Parameters: - values (list(list)) – The values read from the machine, one for each struct element
- parameters (RangeDictionary) – The holder of the parameters to update
- state_variables (RangeDictionary) – The holder of the state variables to update
-
class
spynnaker.pyNN.models.neuron.synapse_types.
SynapseTypeAlpha
(exc_response, exc_exp_response, tau_syn_E, inh_response, inh_exp_response, tau_syn_I)[source]¶ Bases:
spynnaker.pyNN.models.neuron.synapse_types.abstract_synapse_type.AbstractSynapseType
Parameters: - exc_response (float, iterable(float), RandomDistribution or (mapping) function) – \(response^\mathrm{linear}_e\)
- exc_exp_response (float, iterable(float), RandomDistribution or (mapping) function) – \(response^\mathrm{exponential}_e\)
- tau_syn_E (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_e\)
- inh_response (float, iterable(float), RandomDistribution or (mapping) function) – \(response^\mathrm{linear}_i\)
- inh_exp_response (float, iterable(float), RandomDistribution or (mapping) function) – \(response^\mathrm{exponential}_i\)
- tau_syn_I (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_i\)
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters (RangeDictionary) – A holder of the parameters
-
add_state_variables
(state_variables)[source]¶ Add the initial values of the state variables to the state variables holder
Parameters: state_variables (RangeDictionary) – A holder of the state variables
-
exc_response
¶
-
get_n_cpu_cycles
(n_neurons)[source]¶ Get the number of CPU cycles required to update the state
Parameters: n_neurons (int) – The number of neurons to get the cycles for Return type: int
-
get_n_synapse_types
()[source]¶ Get the number of synapse types supported.
Returns: The number of synapse types supported Return type: int
-
get_synapse_id_by_target
(target)[source]¶ Get the ID of a synapse given the name.
Returns: The ID of the synapse Return type: int
-
get_synapse_targets
()[source]¶ Get the target names of the synapse type.
Returns: an array of strings Return type: array(str)
-
get_units
(variable)[source]¶ Get the units of the given variable
Parameters: variable (str) – The name of the variable
-
get_values
(parameters, state_variables, vertex_slice, ts)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (RangeDictionary) – The holder of the parameters
- state_variables (RangeDictionary) – The holder of the state variables
- vertex_slice (Slice) – The slice of variables being retrieved
- ts (int) – The time to be advanced in one call to the update of this component
- ts – machine time step
Returns: A list with the same length as self.struct.field_types
Return type: list(int or float or list(int) or list(float) or RangedList)
-
has_variable
(variable)[source]¶ Determine if this component has a variable by the given name
Parameters: variable (str) – The name of the variable Return type: bool
-
inh_response
¶
-
tau_syn_E
¶
-
tau_syn_I
¶
-
update_values
(values, parameters, state_variables)[source]¶ Update the parameters and state variables with the given struct values that have been read from the machine
Parameters: - values (list(list)) – The values read from the machine, one for each struct element
- parameters (RangeDictionary) – The holder of the parameters to update
- state_variables (RangeDictionary) – The holder of the state variables to update
-
class
spynnaker.pyNN.models.neuron.synapse_types.
SynapseTypeExpIzhikevichNeuromodulated
(tau_syn_E, tau_syn_I, isyn_exc, isyn_inh)[source]¶ Bases:
spynnaker.pyNN.models.neuron.synapse_types.abstract_synapse_type.AbstractSynapseType
Parameters: -
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters (RangeDictionary) – A holder of the parameters
-
add_state_variables
(state_variables)[source]¶ Add the initial values of the state variables to the state variables holder
Parameters: state_variables (RangeDictionary) – A holder of the state variables
-
get_n_cpu_cycles
(n_neurons)[source]¶ Get the number of CPU cycles required to update the state
Parameters: n_neurons (int) – The number of neurons to get the cycles for Return type: int
-
get_n_synapse_types
()[source]¶ Get the number of synapse types supported.
Returns: The number of synapse types supported Return type: int
-
get_synapse_id_by_target
(target)[source]¶ Get the ID of a synapse given the name.
Returns: The ID of the synapse Return type: int
-
get_synapse_targets
()[source]¶ Get the target names of the synapse type.
Returns: an array of strings Return type: array(str)
-
get_units
(variable)[source]¶ Get the units of the given variable
Parameters: variable (str) – The name of the variable
-
get_values
(parameters, state_variables, vertex_slice, ts)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (RangeDictionary) – The holder of the parameters
- state_variables (RangeDictionary) – The holder of the state variables
- vertex_slice (Slice) – The slice of variables being retrieved
- ts (int) – The time to be advanced in one call to the update of this component
- ts – machine time step
Returns: A list with the same length as self.struct.field_types
Return type: list(int or float or list(int) or list(float) or RangedList)
-
has_variable
(variable)[source]¶ Determine if this component has a variable by the given name
Parameters: variable (str) – The name of the variable Return type: bool
-
isyn_exc
¶
-
isyn_inh
¶
-
tau_syn_E
¶
-
tau_syn_I
¶
-
update_values
(values, parameters, state_variables)[source]¶ Update the parameters and state variables with the given struct values that have been read from the machine
Parameters: - values (list(list)) – The values read from the machine, one for each struct element
- parameters (RangeDictionary) – The holder of the parameters to update
- state_variables (RangeDictionary) – The holder of the state variables to update
-
-
class
spynnaker.pyNN.models.neuron.synapse_types.
SynapseTypeSEMD
(tau_syn_E, tau_syn_E2, tau_syn_I, isyn_exc, isyn_exc2, isyn_inh, multiplicator, exc2_old, scaling_factor)[source]¶ Bases:
spynnaker.pyNN.models.neuron.synapse_types.abstract_synapse_type.AbstractSynapseType
Parameters: - tau_syn_E (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_{e_1}\)
- tau_syn_E2 (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_{e_2}\)
- tau_syn_I (float, iterable(float), RandomDistribution or (mapping) function) – \(\tau^{syn}_i\)
- isyn_exc (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_{e_1}\)
- isyn_exc2 (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_{e_2}\)
- isyn_inh (float, iterable(float), RandomDistribution or (mapping) function) – \(I^{syn}_i\)
- multiplicator (float, iterable(float), RandomDistribution or (mapping) function) –
- exc2_old (float, iterable(float), RandomDistribution or (mapping) function) –
- scaling_factor (float, iterable(float), RandomDistribution or (mapping) function) –
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters (RangeDictionary) – A holder of the parameters
-
add_state_variables
(state_variables)[source]¶ Add the initial values of the state variables to the state variables holder
Parameters: state_variables (RangeDictionary) – A holder of the state variables
-
exc2_old
¶
-
get_n_cpu_cycles
(n_neurons)[source]¶ Get the number of CPU cycles required to update the state
Parameters: n_neurons (int) – The number of neurons to get the cycles for Return type: int
-
get_n_synapse_types
()[source]¶ Get the number of synapse types supported.
Returns: The number of synapse types supported Return type: int
-
get_synapse_id_by_target
(target)[source]¶ Get the ID of a synapse given the name.
Returns: The ID of the synapse Return type: int
-
get_synapse_targets
()[source]¶ Get the target names of the synapse type.
Returns: an array of strings Return type: array(str)
-
get_units
(variable)[source]¶ Get the units of the given variable
Parameters: variable (str) – The name of the variable
-
get_values
(parameters, state_variables, vertex_slice, ts)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (RangeDictionary) – The holder of the parameters
- state_variables (RangeDictionary) – The holder of the state variables
- vertex_slice (Slice) – The slice of variables being retrieved
- ts (int) – The time to be advanced in one call to the update of this component
- ts – machine time step
Returns: A list with the same length as self.struct.field_types
Return type: list(int or float or list(int) or list(float) or RangedList)
-
has_variable
(variable)[source]¶ Determine if this component has a variable by the given name
Parameters: variable (str) – The name of the variable Return type: bool
-
isyn_exc
¶
-
isyn_exc2
¶
-
isyn_inh
¶
-
multiplicator
¶
-
scaling_factor
¶
-
tau_syn_E
¶
-
tau_syn_E2
¶
-
tau_syn_I
¶
-
update_values
(values, parameters, state_variables)[source]¶ Update the parameters and state variables with the given struct values that have been read from the machine
Parameters: - values (list(list)) – The values read from the machine, one for each struct element
- parameters (RangeDictionary) – The holder of the parameters to update
- state_variables (RangeDictionary) – The holder of the state variables to update