Package topo :: Package transferfn :: Module basic :: Class ScalingTF

Class ScalingTF

Scales input activity based on the current average activity (x_avg).

The scaling is calculated to bring x_avg for each unit closer to a specified target average. Calculates a scaling factor that is greater than 1 if x_avg is less than the target and less than 1 if x_avg is greater than the target, and multiplies the input activity by this scaling factor.

The plastic parameter allows the updating of the average values to be disabled temporarily, e.g. while presenting test patterns.

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

__init__(self, **params)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

__call__(self, x)

source code

Inherited from TransferFnWithState: override_plasticity_state, restore_plasticity_state, state_pop, state_push

Inherited from param.parameterized.Parameterized: __getstate__, __repr__, __setstate__, __str__, debug, defaults, force_new_dynamic_value, get_param_values, get_value_generator, inspect_value, message, print_param_values, script_repr, set_default, set_dynamic_time_fn, set_param, verbose, warning

Inherited from param.parameterized.Parameterized (private): _add_parameter, _instantiate_param, _set_name, _setup_params

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Methods

[hide private]

Inherited from param.parameterized.Parameterized: params, print_param_defaults

Class Variables

[hide private]

target = param.Number(default= 0.01, doc= ...
Target average activity for each unit.

step = param.Number(default= 1, doc= ...
How often to calculate the average activity and scaling factor.

smoothing = param.Number(default= 0.9997, doc= ...
Determines the degree of weighting of previous activity vs.

name = <param.parameterized.String object at 0xb589d6c>
String identifier for this object.

Inherited from TransferFnWithState: plastic

Inherited from base.functionfamily.TransferFn: norm_value

Inherited from param.parameterized.Parameterized: print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, **params)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

call(self, x)
(Call operator)

source code

Overrides: base.functionfamily.TransferFn.__call__

Class Variable Details

[hide private]

target

Target average activity for each unit.

Value:

param.Number(default= 0.01, doc= """
        Target average activity for each unit.""")

step

How often to calculate the average activity and scaling factor.

Value:

param.Number(default= 1, doc= """
        How often to calculate the average activity and scaling factor.""")

smoothing

Determines the degree of weighting of previous activity vs. current activity when calculating the average.

Value:

param.Number(default= 0.9997, doc= """
        Determines the degree of weighting of previous activity vs.
        current activity when calculating the average.""")

Class ScalingTF

__init__(self, **params) (Constructor)

__call__(self, x) (Call operator)

target

step

smoothing

init(self, **params)
(Constructor)

call(self, x)
(Call operator)