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(source, /)	Create an object from its JSON representation.
to_dict()	Create an object's dictionary representation.
to_json([sink, overwrite])	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, operator: str, tolerance=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, bound= SerialMixin)

Returns:

The reconstructed object.

classmethod from_json(source: str | Path | SupportsRead[str], /)

Create an object from its JSON representation.

Parameters:

source (str | Path | SupportsRead[str]) –

The JSON source. Can be:

• A string containing JSON content.

• A file path or Path object pointing to a JSON file.

• A file-like object with a read() method.

Raises:

ValueError – If source is not one of the allowed types.

Return type:

_T

Returns:

The reconstructed object.

to_dict()

Create an object’s dictionary representation.

Return type:

dict

Returns:

The dictionary representation of the object.

to_json(sink: str | Path | SupportsWrite[str] | None = None, /, *, overwrite: bool = False, **kwargs: Any)

Create an object’s JSON representation.

Parameters:

• sink (str | Path | SupportsWrite[str] | None) –

  The JSON sink. Can be:

  • None (only returns the JSON string).

  • A file path or Path object pointing to a location where to write the JSON content.

  • A file-like object with a write() method.

• overwrite (bool) – Boolean flag indicating if to overwrite the file if it already exists. Only relevant if sink is a file path or Path object.

• **kwargs (Any) – Additional keyword arguments to pass to json.dumps().

Raises:

FileExistsError – If sink points to an already existing file but overwrite is False.

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.