inversion_ideas.conditions.CustomCondition

class inversion_ideas.conditions.CustomCondition(func)

Define a custom Condition object through a function.

Parameters:

funcCallable

Function to use as the condition. It should take a model as only argument and return a bool to evaluate whether the condition is valid or not for that particular model.

Methods

__call__(model)	Evaluate the condition on a given model.
create(func)	Create a CustomCondition object directly from a function.
info(model)	Display information about the condition for a given model.
initialize()	Initialize the condition.
update(model)	Update the condition.

Methods

Methods documentation

CustomCondition.__call__(model)

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.

---

classmethod CustomCondition.create(func)

Create a CustomCondition object directly from a function.

Parameters:

funcCallable

Function to use as the condition. It should take a model as only argument and return a bool to evaluate whether the condition is valid or not for that particular model.

Returns:

CustomCondition

Examples

>>> import numpy as np
>>>
>>> def is_all_positive(model):
...     return np.all(model > 0)
>>>
>>> condition = CustomCondition.create(is_all_positive)
>>> model = np.array([1, 2, 3])
>>> print(condition(model))
True

>>> model = np.array([-1, 2, 3])
>>> print(condition(model))
False

---

CustomCondition.info(model)

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.

---

CustomCondition.initialize()

Initialize the condition.

---

CustomCondition.update(model)

Update the condition.

Parameters:

model(n_params,) array

Array with model values.

---