ProcessingMechanism¶
Contents¶
Overview¶
A ProcessingMechanism is a type of Mechanism
that transforms its input in some way. A ProcessingMechanism always
receives its input either from another Mechanism, or from the input to a Composition when it is
executed. Similarly, its output is generally conveyed to another Mechanism or used as the output for a Composition.
The ProcessingMechanism is the simplest mechanism in PsyNeuLink. It does not have any extra arguments or
specialized validation. Almost any PsyNeuLink Function, including the UserDefinedFunction, may be the function of a
ProcessingMechanism. Currently, the only exception is BackPropagation
. Subtypes of
ProcessingMechanism have more specialized state_features, and often have restrictions on which Functions are allowed.
The output of a ProcessingMechanism may also be used by a ModulatoryMechanism to modify the
parameters of other components (or its own parameters). ProcessingMechanisms are always executed before all
ModulatoryMechanisms in the Composition to which they belong, so that any modifications made by the ModulatoryMechanism
are available to all ProcessingMechanisms in the next TRIAL
.
Creating a ProcessingMechanism¶
A ProcessingMechanism is created by calling its constructor.
Its function
is specified in the function argument, which may be the name of a
Function class:
>>> import psyneulink as pnl
>>> my_linear_processing_mechanism = pnl.ProcessingMechanism(function=pnl.Linear)
in which case all of the function’s parameters will be set to their default values.
Alternatively, the function argument may be a call to a Function constructor, in which case values may be specified for the Function’s parameters:
>>> my_logistic_processing_mechanism = pnl.ProcessingMechanism(function=pnl.Logistic(gain=1.0, bias=-4))
Structure¶
A ProcessingMechanism has the same structure as a Mechanism, with the addition of several
StandardOutputPorts to its standard_output_ports
attribute.
See documentation for individual subtypes of ProcessingMechanism for more specific information about their structure.
Execution¶
The execution of a ProcessingMechanism follows the same sequence of actions as a standard Mechanism (see Execution).
Class Reference¶
- class psyneulink.core.components.mechanisms.processing.processingmechanism.ProcessingMechanism(default_variable=None, size=None, input_ports=None, output_ports=None, function=None, params=None, name=None, prefs=None, **kwargs)¶
Implements instance of ProcessingMechanism_Base subclass of Mechanism. See Mechanism and subclasses of ProcessingMechanism for arguments and additional attributes.
- standard_output_ports¶
list of the dictionary specifications for StandardOutputPorts that can be assigned as OutputPorts, in addition to the
standard_output_ports
of a Mechanism; each assigns as thevalue
of the OutputPort a quantity calculated over the elements of the first item in the outermost dimension (axis 0) of the Mechanism`svalue
. Subclasses of ProcessingMechanism may extend this list to include additional StandardOutputPorts.- MEANfloat
mean of the elements.
- MEDIANfloat
median of the elements.
- STANDARD_DEVIATIONfloat
standard deviation of the elements.
- VARIANCEfloat
variance of the elements.
- MAX_VALfloat
greatest signed value of the elements.
- MAX_ABS_VALfloat
greatest absolute value of the elements.
- MAX_ONE_HOTfloat
element with the greatest signed value is assigned that value, all others are assigned 0.
- MAX_ABS_ONE_HOTfloat
element with the greatest absolute value is assigned that value, all others are assigned 0.
- MAX_INDICATOR1d array
element with the greatest signed value is assigned 1, all others are assigned 0.
- MAX_ABS_INDICATOR1d array
element with the greatest absolute value is assigned 1, all others are assigned 0.
- PROBfloat
element chosen probabilistically based on softmax distribution is assigned its value, all others are assigned 0.
- Type
list[dict]
- exception psyneulink.core.components.mechanisms.processing.processingmechanism.ProcessingMechanismError(message, component=None)¶