ThresholdCondition

class baybe.constraints.conditions.ThresholdCondition

Bases: Condition

Class for modelling threshold-based conditions.

Public methods

__init__(threshold, operator[, tolerance])	Method generated by attrs for class ThresholdCondition.
evaluate(data)	Evaluate the condition on a given data series.
from_dict(dictionary)	Create an object from its dictionary representation.
from_json(string)	Create an object from its JSON representation.
to_dict()	Create an object's dictionary representation.
to_json()	Create an object's JSON representation.
to_polars(expr, /)	Apply the condition to a Polars expression.

Public attributes and properties

threshold	The threshold value used in the condition.
operator	The operator used in the condition.
tolerance	A numerical tolerance.

__init__(threshold: float, operator: str, tolerance: float | None = NOTHING)

Method generated by attrs for class ThresholdCondition.

For details on the parameters, see Public attributes and properties.

evaluate(data: Series)

Evaluate the condition on a given data series.

Parameters:

data (Series) – A series containing parameter values.

Return type:

Series

Returns:

A boolean series indicating which elements satisfy the condition.

classmethod from_dict(dictionary: dict)

Create an object from its dictionary representation.

Parameters:

dictionary (dict) – The dictionary representation.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

classmethod from_json(string: str)

Create an object from its JSON representation.

Parameters:

string (str) – The JSON representation of the object.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

to_dict()

Create an object’s dictionary representation.

Return type:

dict

to_json()

Create an object’s JSON representation.

Return type:

str

Returns:

The JSON representation as a string.

to_polars(expr: pl.Expr, /)

Apply the condition to a Polars expression.

Parameters:

expr (pl.Expr) – Input expression, for instance column selection etc.

Return type:

pl.Expr

Returns:

An expression that can be used for filtering.

operator: str

The operator used in the condition.

threshold: float

The threshold value used in the condition.

tolerance: float | None

A numerical tolerance. Set to a reasonable default tolerance.