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¶
-
class
spynnaker.pyNN.models.neuron.input_types.input_type_conductance.
InputTypeConductance
(e_rev_E, e_rev_I)[source]¶ Bases:
spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType
The conductance input type
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters ( spinn_utilities.ranged.range_dictionary.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 ( spinn_utilities.ranged.range_dictionary.RangeDictionary
) – A holder of the state variables
-
e_rev_E
¶
-
e_rev_I
¶
-
get_global_weight_scale
()[source]¶ Get the global weight scaling value.
Returns: The global weight scaling value Return type: float
-
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_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)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the parameters - state_variables (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the state variables - vertex_slice – The slice of variables being retrieved
Returns: A list with the same length as self.struct.field_types
Return type: A list of (single value or list of values or RangedList)
- parameters (
-
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
-
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 – The values read from the machine, one for each struct element
- parameters – The holder of the parameters to update
- state_variables – The holder of the state variables to update
-
spynnaker.pyNN.models.neuron.input_types.input_type_current module¶
-
class
spynnaker.pyNN.models.neuron.input_types.input_type_current.
InputTypeCurrent
[source]¶ Bases:
spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType
The current input type
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters ( spinn_utilities.ranged.range_dictionary.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 ( spinn_utilities.ranged.range_dictionary.RangeDictionary
) – A holder of the state variables
-
get_global_weight_scale
()[source]¶ Get the global weight scaling value.
Returns: The global weight scaling value Return type: float
-
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_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)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the parameters - state_variables (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the state variables - vertex_slice – The slice of variables being retrieved
Returns: A list with the same length as self.struct.field_types
Return type: A list of (single value or list of values or RangedList)
- parameters (
-
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
-
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 – The values read from the machine, one for each struct element
- parameters – The holder of the parameters to update
- state_variables – The holder of the state variables to update
-
spynnaker.pyNN.models.neuron.input_types.input_type_current_semd module¶
-
class
spynnaker.pyNN.models.neuron.input_types.input_type_current_semd.
InputTypeCurrentSEMD
(multiplicator, inh_input_previous)[source]¶ Bases:
spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType
The current sEMD input type
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters ( spinn_utilities.ranged.range_dictionary.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 ( spinn_utilities.ranged.range_dictionary.RangeDictionary
) – A holder of the state variables
-
get_global_weight_scale
()[source]¶ Get the global weight scaling value.
Returns: The global weight scaling value Return type: float
-
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_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)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the parameters - state_variables (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the state variables - vertex_slice – The slice of variables being retrieved
Returns: A list with the same length as self.struct.field_types
Return type: A list of (single value or list of values or RangedList)
- parameters (
-
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_input_previous
¶
-
multiplicator
¶
-
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 – The values read from the machine, one for each struct element
- parameters – The holder of the parameters to update
- state_variables – The holder of the state variables to update
-
Module contents¶
-
class
spynnaker.pyNN.models.neuron.input_types.
AbstractInputType
(data_types)[source]¶ -
Represents a possible input type for a neuron model (e.g., current).
Parameters: data_types – A list of data types in the component structure, in the order that they appear
-
class
spynnaker.pyNN.models.neuron.input_types.
InputTypeConductance
(e_rev_E, e_rev_I)[source]¶ Bases:
spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType
The conductance input type
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters ( spinn_utilities.ranged.range_dictionary.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 ( spinn_utilities.ranged.range_dictionary.RangeDictionary
) – A holder of the state variables
-
e_rev_E
¶
-
e_rev_I
¶
-
get_global_weight_scale
()[source]¶ Get the global weight scaling value.
Returns: The global weight scaling value Return type: float
-
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_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)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the parameters - state_variables (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the state variables - vertex_slice – The slice of variables being retrieved
Returns: A list with the same length as self.struct.field_types
Return type: A list of (single value or list of values or RangedList)
- parameters (
-
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
-
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 – The values read from the machine, one for each struct element
- parameters – The holder of the parameters to update
- state_variables – The holder of the state variables to update
-
-
class
spynnaker.pyNN.models.neuron.input_types.
InputTypeCurrent
[source]¶ Bases:
spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType
The current input type
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters ( spinn_utilities.ranged.range_dictionary.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 ( spinn_utilities.ranged.range_dictionary.RangeDictionary
) – A holder of the state variables
-
get_global_weight_scale
()[source]¶ Get the global weight scaling value.
Returns: The global weight scaling value Return type: float
-
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_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)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the parameters - state_variables (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the state variables - vertex_slice – The slice of variables being retrieved
Returns: A list with the same length as self.struct.field_types
Return type: A list of (single value or list of values or RangedList)
- parameters (
-
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
-
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 – The values read from the machine, one for each struct element
- parameters – The holder of the parameters to update
- state_variables – The holder of the state variables to update
-
-
class
spynnaker.pyNN.models.neuron.input_types.
InputTypeCurrentSEMD
(multiplicator, inh_input_previous)[source]¶ Bases:
spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType
The current sEMD input type
-
add_parameters
(parameters)[source]¶ Add the initial values of the parameters to the parameter holder
Parameters: parameters ( spinn_utilities.ranged.range_dictionary.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 ( spinn_utilities.ranged.range_dictionary.RangeDictionary
) – A holder of the state variables
-
get_global_weight_scale
()[source]¶ Get the global weight scaling value.
Returns: The global weight scaling value Return type: float
-
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_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)[source]¶ Get the values to be written to the machine for this model
Parameters: - parameters (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the parameters - state_variables (
spinn_utilities.ranged.range_dictionary.RangeDictionary
) – The holder of the state variables - vertex_slice – The slice of variables being retrieved
Returns: A list with the same length as self.struct.field_types
Return type: A list of (single value or list of values or RangedList)
- parameters (
-
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_input_previous
¶
-
multiplicator
¶
-
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 – The values read from the machine, one for each struct element
- parameters – The holder of the parameters to update
- state_variables – The holder of the state variables to update
-