pdstools.valuefinder.Aggregates

Classes

Aggregates

Aggregates.

Module Contents

class Aggregates(vf: pdstools.valuefinder.ValueFinder.ValueFinder)

Aggregates.

Parameters:

vf (pdstools.valuefinder.ValueFinder.ValueFinder)

vf

get_customer_summary(*, threshold: float | None = None) → polars.LazyFrame

Computes the summary of propensities for all customers

Parameters:

• th (Optional[float]) – The threshold to consider an action ‘good’. If a customer has actions with propensity above this, the customer has at least one relevant action. If not given, will default to 5th quantile.

• threshold (float | None)

Return type:

polars.LazyFrame

get_counts_per_stage(*, threshold: float | None = None)

Get counts per stage.

Parameters:

threshold (float | None)

property max_propensity_per_customer: polars.DataFrame

Max propensity per customer.

Return type:

polars.DataFrame

get_threshold_from_quantile(quantile: float) → float

Get threshold from quantile.

Parameters:

quantile (float)

Return type:

float

get_counts_for_threshold(threshold: float) → polars.DataFrame

Get counts for threshold.

Parameters:

threshold (float)

Return type:

polars.DataFrame