pymoto.Aggregation

class pymoto.Aggregation(scaling: AggScaling = None, active_set: AggActiveSet = None)

Abstract base-class for aggregation modules

This module cannot be used directly, but can only be used as superclass for specific implementations.

__init__(scaling: AggScaling = None, active_set: AggActiveSet = None)

Initialize the aggregation module

Parameters:

Methods

__init__([scaling, active_set])

Initialize the aggregation module

aggregation_derivative(x)

" Calculates df(x) / dx

aggregation_function(x)

Calculates f(x)

connect(sig_in[, sig_out])

Connect without automatic adding to a function network

get_input_sensitivities([as_list])

get_input_states([as_list])

get_output_sensitivities([as_list])

get_output_states([as_list])

reset()

Reset the state of the sensitivities (they are set to zero or to None)

response()

Calculate the response from sig_in and output this to sig_out

sensitivity()

Calculate sensitivities using backpropagation

Attributes

n_in

Get the number of input signals

n_out

Get the number of output signals

sig_in

sig_out

abstractmethod aggregation_function(x)

Calculates f(x)

abstractmethod aggregation_derivative(x)

“ Calculates df(x) / dx

connect(sig_in: Signal | Iterable[Signal], sig_out: Signal | Iterable[Signal] = None)

Connect without automatic adding to a function network

get_input_sensitivities(as_list=False)
get_input_states(as_list=False)
get_output_sensitivities(as_list=False)
get_output_states(as_list=False)
property n_in: int

Get the number of input signals

property n_out: int

Get the number of output signals

Note: Cannot be used in the initial __call__()

reset()

Reset the state of the sensitivities (they are set to zero or to None)

response()

Calculate the response from sig_in and output this to sig_out

sensitivity()

Calculate sensitivities using backpropagation

Based on the sensitivity we get from sig_out, reverse the process and output the new sensitivities to sig_in

sig_in: List = None
sig_out: List = None