inversion_ideas.base.Condition#

class inversion_ideas.base.Condition[source]#

Base abstract class for conditions.

Important

This class is not meant to be instantiated. Use it to create child classes in order to implement custom condition objects.

Methods

__call__(model)

Evaluate the condition on a given model.

info(model)

Display information about the condition for a given model.

initialize()

Initialize the condition.

update(model)

Update the condition.

Methods#

Methods documentation

abstractmethod Condition.__call__(model)[source]#

Evaluate the condition on a given model.

Parameters:
model(n_params,) array

Array with model values.

Returns:
bool

Whether the condition is True or False.

Condition.info(model)[source]#

Display information about the condition for a given model.

Parameters:
model(n_params,) array

Array with model values.

Returns:
rich.tree.Tree

rick.tree.Tree object containing information about the condition.

Condition.initialize()[source]#

Initialize the condition.

Condition.update(model)[source]#

Update the condition.

Parameters:
model(n_params,) array

Array with model values.