spynnaker.pyNN.models.neuron.input_types package

Module contents

class spynnaker.pyNN.models.neuron.input_types.AbstractInputType(data_types)

Bases: spynnaker.pyNN.models.neuron.implementations.abstract_standard_neuron_component.AbstractStandardNeuronComponent

Represents a possible input type for a neuron model (e.g., current).

Parameters:data_types (list(DataType)) – A list of data types in the component structure, in the order that they appear

get_global_weight_scale()

Get the global weight scaling value.

Returns:The global weight scaling value Return type:float

class spynnaker.pyNN.models.neuron.input_types.InputTypeConductance(e_rev_E, e_rev_I)

Bases: spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType

The conductance input type

Parameters:

• e_rev_E (float, iterable(float), RandomDistribution or (mapping) function) – Reversal potential for excitatory input; \(E^{rev}_e\)
• e_rev_I (float, iterable(float), RandomDistribution or (mapping) function) – Reversal potential for inhibitory input; \(E^{rev}_i\)

add_parameters(parameters)

Add the initial values of the parameters to the parameter holder

Parameters:parameters (RangeDictionary) – A holder of the parameters

add_state_variables(state_variables)

Add the initial values of the state variables to the state variables holder

Parameters:state_variables (RangeDictionary) – A holder of the state variables

e_rev_E

\(E_{{rev}_e}\)

e_rev_I

\(E_{{rev}_i}\)

get_global_weight_scale()

Get the global weight scaling value.

Returns:The global weight scaling value Return type:float

get_n_cpu_cycles(n_neurons)

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)

Get the units of the given variable

Parameters:variable (str) – The name of the variable

get_values(parameters, state_variables, vertex_slice, ts)

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)

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)

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.input_types.InputTypeCurrent

Bases: spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType

The current input type.

add_parameters(parameters)

Add the initial values of the parameters to the parameter holder

Parameters:parameters (RangeDictionary) – A holder of the parameters

add_state_variables(state_variables)

Add the initial values of the state variables to the state variables holder

Parameters:state_variables (RangeDictionary) – A holder of the state variables

get_global_weight_scale()

Get the global weight scaling value.

Returns:The global weight scaling value Return type:float

get_n_cpu_cycles(n_neurons)

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)

Get the units of the given variable

Parameters:variable (str) – The name of the variable

get_values(parameters, state_variables, vertex_slice, ts)

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)

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)

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.input_types.InputTypeCurrentSEMD(multiplicator, inh_input_previous)

Bases: spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType

The current sEMD input type.

Parameters:

• multiplicator (float, iterable(float), RandomDistribution or (mapping) function) –
• inh_input_previous (float, iterable(float), RandomDistribution or (mapping) function) –

add_parameters(parameters)

Add the initial values of the parameters to the parameter holder

Parameters:parameters (RangeDictionary) – A holder of the parameters

add_state_variables(state_variables)

Add the initial values of the state variables to the state variables holder

Parameters:state_variables (RangeDictionary) – A holder of the state variables

get_global_weight_scale()

Get the global weight scaling value.

Returns:The global weight scaling value Return type:float

get_n_cpu_cycles(n_neurons)

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)

Get the units of the given variable

Parameters:variable (str) – The name of the variable

get_values(parameters, state_variables, vertex_slice, ts)

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)

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)

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.input_types.InputTypeDelta

Bases: spynnaker.pyNN.models.neuron.input_types.abstract_input_type.AbstractInputType

The delta input type

add_parameters(parameters)

Add the initial values of the parameters to the parameter holder

Parameters:parameters (RangeDictionary) – A holder of the parameters

add_state_variables(state_variables)

Add the initial values of the state variables to the state variables holder

Parameters:state_variables (RangeDictionary) – A holder of the state variables

get_global_weight_scale()

Get the global weight scaling value.

Returns:The global weight scaling value Return type:float

get_n_cpu_cycles(n_neurons)

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)

Get the units of the given variable

Parameters:variable (str) – The name of the variable

get_values(parameters, state_variables, vertex_slice, ts)

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)

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)

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