fairlens.metrics.pearson

pearson(sr_a, sr_b)[source]

Metric that calculates Pearson’s correlation coefficent for numerical-numerical pairs of series, used in heatmap generation.

Parameters
  • sr_a (pd.Series) – First numerical series to analyze.

  • sr_b (pd.Series) – Second numerical series to analyze.

Returns

Value of the coefficient.

Return type

float