rhino_health.lib.metrics.base_metric#

Module Contents#

Classes#

DataFilter

A filter to be applied on the entire Cohort

GroupingData

Configuration for grouping metric results

BaseMetric

Parameters available for every metric

MetricResponse

Standardized response from querying metrics against a Cohort

Attributes#

MetricResultDataType

Dict[str, Any]

class rhino_health.lib.metrics.base_metric.DataFilter#

Bases: pydantic.BaseModel

A filter to be applied on the entire Cohort

filter_column :str#

The column in the remote cohort df to check against

filter_value :Union[Any, rhino_health.lib.metrics.filter_variable.FilterBetweenRange]#

The value to match against or a FilterBetweenRange if filter_type is FilterType.BETWEEN

filter_type :Optional[rhino_health.lib.metrics.filter_variable.FilterType]#

The type of filtering to perform. Defaults to FilterType.EQUAL

class rhino_health.lib.metrics.base_metric.GroupingData#

Bases: pydantic.BaseModel

Configuration for grouping metric results

See also

pandas.groupby

Implementation used for grouping. See documentation

groupings :List[str] = []#

A list of columns to group metric results by

dropna :Optional[bool] = True#

Should na values be dropped if in a grouping key

class rhino_health.lib.metrics.base_metric.BaseMetric#

Bases: pydantic.BaseModel

Parameters available for every metric

data_filters :Optional[List[DataFilter]] = []#
group_by :Optional[GroupingData]#
timeout_seconds :Optional[float] = 600.0#
data(self)#
rhino_health.lib.metrics.base_metric.MetricResultDataType#

Dict[str, Any]

class rhino_health.lib.metrics.base_metric.MetricResponse(**data)#

Bases: pydantic.BaseModel

Standardized response from querying metrics against a Cohort

output :MetricResultDataType#