REF rename function to scores_to_ordering (#24)

DataResponsibly · Feb 27, 2024 · 3a7f393 · 3a7f393
1 parent 086256d
commit 3a7f393
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 6 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -68,4 +68,4 @@ This is the full API documentation of the `sharp` package.
     utils.check_inputs
     utils.check_measure
     utils.check_qoi
-    utils.scores_to_rank
+    utils.scores_to_ordering
diff --git a/sharp/utils/__init__.py b/sharp/utils/__init__.py
@@ -3,12 +3,12 @@
 """
 
 from ._checks import check_feature_names, check_inputs, check_measure, check_qoi
-from ._rank_utils import scores_to_rank
+from ._rank_utils import scores_to_ordering
 
 __all__ = [
     "check_feature_names",
     "check_inputs",
     "check_measure",
     "check_qoi",
-    "scores_to_rank",
+    "scores_to_ordering",
 ]
diff --git a/sharp/utils/_rank_utils.py b/sharp/utils/_rank_utils.py
@@ -1,7 +1,7 @@
 import numpy as np
 
 
-def scores_to_rank(y, direction=-1):
+def scores_to_ordering(y, direction=-1):
     """
     Converts an array with scores to a ranking.
 

diff --git a/sharp/visualization/_waterfall.py b/sharp/visualization/_waterfall.py
@@ -3,8 +3,6 @@
 import numpy as np
 from sharp.utils._utils import _optional_import
 
-# from sharp.utils import scores_to_rank
-
 
 blue_rgb = np.array([0, 0.54337757, 0.98337906])
 light_blue_rgb = np.array([127.0, 196, 252]) / 255