Merge pull request #11 from lukassykora/fix/uplift

Fix/uplift
lukassykora · Jul 30, 2024 · 5718946 · 5718946
2 parents 8bbbb85 + 7526c2d
commit 5718946
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/src/action_rules/rules/rules.py b/src/action_rules/rules/rules.py
@@ -227,11 +227,13 @@ def calculate_uplift(self, undesired_support: int, undesired_confidence: float,
         -------
         float
             The uplift value calculated as:
-            ((desired_confidence - (1 - undesired_confidence)) * undesired_support) / self.count_transactions.
+            ((desired_confidence - (1 - undesired_confidence)) * (undesired_support / undesired_confidence))
+            / self.count_transactions.
 
         Notes
         -----
         Uplift measures the increase in the probability of achieving the desired state when applying the action rule
         compared to not applying it. It is used to assess the effectiveness of the rule.
         """
-        return ((desired_confidence - (1 - undesired_confidence)) * undesired_support) / self.count_transactions
+        return ((desired_confidence - (1 - undesired_confidence)) * (
+            undesired_support / undesired_confidence)) / self.count_transactions
diff --git a/tests/rules/test_rules.py b/tests/rules/test_rules.py
@@ -60,4 +60,4 @@ def test_calculate_confidence(rules):
 def test_calculate_uplift(rules):
     """Test the calculate_uplift method of Rules."""
     uplift = rules.calculate_uplift(10, 0.8, 0.6)
-    assert uplift == 0.2
+    assert uplift == 0.25