Skip to content

Commit 077d95c

Browse files
authored
📝 Fix total uplift docstring description (#85)
by: Irina Elisova
1 parent aeb9bec commit 077d95c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

sklift/metrics/metrics.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -569,7 +569,7 @@ def uplift_by_percentile(y_true, uplift, treatment, strategy='overall',
569569
std (bool): If True, add columns with the uplift standard deviation and the response rate standard deviation.
570570
Default is False.
571571
total (bool): If True, add the last row with the total values. Default is False.
572-
The total uplift is a weighted average uplift. See :func:`.weighted_average_uplift`.
572+
The total uplift computes as a total response rate treatment - a total response rate control.
573573
The total response rate is a response rate on the full data amount.
574574
bins (int): Determines the number of bins (and the relative percentile) in the data. Default is 10.
575575
string_percentiles (bool): type of percentiles in the index: float or string. Default is True (string).

0 commit comments

Comments
 (0)