ezmsg.sigproc.activation#

Functions

activation(function)[source]#

Transform the data with a simple activation function.

Parameters:

function (str | ActivationFunction) – An enum value from ActivationFunction or a string representing the activation function. Possible values are: SIGMOID, EXPIT, LOGIT, LOGEXPIT, “sigmoid”, “expit”, “logit”, “log_expit”. SIGMOID and EXPIT are equivalent. See scipy.special.expit for more details.

Return type:

ActivationTransformer

Returns: ActivationTransformer

Classes

class Activation(*args, settings=None, **kwargs)[source]#

Bases: BaseTransformerUnit[ActivationSettings, AxisArray, AxisArray, ActivationTransformer]

Parameters:

settings (Settings | None)

SETTINGS#

alias of ActivationSettings

class ActivationFunction(*values)[source]#

Bases: OptionsEnum

Activation (transformation) function.

NONE = 'none'#

None.

SIGMOID = 'sigmoid'#

scipy.special.expit

EXPIT = 'expit'#

scipy.special.expit

LOGIT = 'logit'#

scipy.special.logit

LOGEXPIT = 'log_expit'#

scipy.special.log_expit

class ActivationSettings(function: str | ezmsg.sigproc.activation.ActivationFunction = <ActivationFunction.NONE: 'none'>)[source]#

Bases: Settings

Parameters:

function (str | ActivationFunction)

__init__(function=ActivationFunction.NONE)#
Parameters:

function (str | ActivationFunction)

Return type:

None

function: str | ActivationFunction = 'none'#

An enum value from ActivationFunction or a string representing the activation function. Possible values are: SIGMOID, EXPIT, LOGIT, LOGEXPIT, “sigmoid”, “expit”, “logit”, “log_expit”. SIGMOID and EXPIT are equivalent. See scipy.special.expit for more details.

class ActivationTransformer(*args, settings=None, **kwargs)[source]#

Bases: BaseTransformer[ActivationSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

class ActivationFunction(*values)[source]#

Bases: OptionsEnum

Activation (transformation) function.

NONE = 'none'#

None.

SIGMOID = 'sigmoid'#

scipy.special.expit

EXPIT = 'expit'#

scipy.special.expit

LOGIT = 'logit'#

scipy.special.logit

LOGEXPIT = 'log_expit'#

scipy.special.log_expit

class ActivationSettings(function: str | ezmsg.sigproc.activation.ActivationFunction = <ActivationFunction.NONE: 'none'>)[source]#

Bases: Settings

Parameters:

function (str | ActivationFunction)

__init__(function=ActivationFunction.NONE)#
Parameters:

function (str | ActivationFunction)

Return type:

None

function: str | ActivationFunction = 'none'#

An enum value from ActivationFunction or a string representing the activation function. Possible values are: SIGMOID, EXPIT, LOGIT, LOGEXPIT, “sigmoid”, “expit”, “logit”, “log_expit”. SIGMOID and EXPIT are equivalent. See scipy.special.expit for more details.

class ActivationTransformer(*args, settings=None, **kwargs)[source]#

Bases: BaseTransformer[ActivationSettings, AxisArray, AxisArray]

Parameters:

settings (SettingsType)

class Activation(*args, settings=None, **kwargs)[source]#

Bases: BaseTransformerUnit[ActivationSettings, AxisArray, AxisArray, ActivationTransformer]

Parameters:

settings (Settings | None)

SETTINGS#

alias of ActivationSettings

activation(function)[source]#

Transform the data with a simple activation function.

Parameters:

function (str | ActivationFunction) – An enum value from ActivationFunction or a string representing the activation function. Possible values are: SIGMOID, EXPIT, LOGIT, LOGEXPIT, “sigmoid”, “expit”, “logit”, “log_expit”. SIGMOID and EXPIT are equivalent. See scipy.special.expit for more details.

Return type:

ActivationTransformer

Returns: ActivationTransformer