Allow different sorters to work with Vis Object

lux/_config/config.py

@@ -6,6 +6,7 @@
 from typing import Any, Callable, Dict, Iterable, List, Optional, Union
 import lux
 import warnings
+from lux.utils.sorters import Sorter
 
 RegisteredOption = namedtuple("RegisteredOption", "name action display_condition args")
 
@@ -32,6 +33,7 @@ def __init__(self):
         self._plotting_backend = "vegalite"
         self._topk = 15
         self._sort = "descending"
+        self._sorter = Sorter.interestingness()
         self._pandas_fallback = True
         self._interestingness_fallback = True
         self.heatmap_bin_size = 40
@@ -83,6 +85,23 @@ def sort(self, flag: Union[str]):
                 stacklevel=2,
             )
 
+    @property
+    def sorter(self):
+        return self._sorter
+
+    @sorter.setter
+    def sorter(self, sorting_function):
+        """
+        Setting parameter to determine sort function of each action
+
+        Parameters
+        ----------
+        flag : Union[str]
+            "none", "ascending","descending"
+            No sorting, sort by ascending order, sort by descending order
+        """
+        self._sorter = sorting_function
+
     @property
     def pandas_fallback(self):
         return self._pandas_fallback

lux/utils/sorters.py

@@ -0,0 +1,31 @@
+#  Copyright 2019-2020 The Lux Authors.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+class Sorter:
+    @staticmethod
+    def interestingness():
+        return lambda x: x.score
+
+    @staticmethod
+    def title():
+        return lambda x: x.title
+
+    @staticmethod
+    def x_alpha():
+        return lambda x: x.get_attr_by_channel("x")[0].attribute
+
+    @staticmethod
+    def y_alpha():
+        return lambda x: x.get_attr_by_channel("y")[0].attribute

lux/vis/VisList.py

@@ -240,7 +240,7 @@ def sort(self, remove_invalid=True, descending=True):
         elif lux.config.sort == "descending":
             descending = True
         # sort in-place by “score” by default if available, otherwise user-specified field to sort by
-        self._collection.sort(key=lambda x: x.score, reverse=descending)
+        self._collection.sort(key=lux.config.sorter, reverse=descending)
 
     def showK(self):
         k = lux.config.topk

tests/test_config.py

@@ -17,6 +17,7 @@
 import pandas as pd
 import time
 from lux.vis.VisList import VisList
+from lux.utils.sorters import Sorter
 import lux
 
 
@@ -289,6 +290,33 @@ def test_sort(global_var):
     lux.config.sort = "descending"
 
 
+def test_sorter(global_var):
+    df = pd.read_csv("lux/data/college.csv")
+    lux.config.topk = 5
+    df._ipython_display_()
+    assert len(df.recommendation["Correlation"]) == 5, "Show top 5"
+    score = float("inf")
+    for vis in df.recommendation["Correlation"]:
+        assert vis.score <= score
+        score = vis.score
+    lux.config.sorter = Sorter.x_alpha()
+    df = pd.read_csv("lux/data/college.csv")
+    string = df.recommendation["Correlation"][0].get_attr_by_channel("x")[0].attribute
+    assert len(df.recommendation["Correlation"]) == 5, "Show top 5"
+    for vis in df.recommendation["Correlation"]:
+        assert vis.get_attr_by_channel("x")[0].attribute <= string
+        string = vis.get_attr_by_channel("x")[0].attribute
+    lux.config.sorter = Sorter.y_alpha()
+    df = pd.read_csv("lux/data/college.csv")
+    string = df.recommendation["Correlation"][0].get_attr_by_channel("y")[0].attribute
+    assert len(df.recommendation["Correlation"]) == 5, "Show top 5"
+    for vis in df.recommendation["Correlation"]:
+        assert vis.get_attr_by_channel("y")[0].attribute <= string
+        string = vis.get_attr_by_channel("y")[0].attribute
+    lux.config.sorter = Sorter.interestingness()
+    lux.config.topk = 15
+
+
 # TODO: This test does not pass in pytest but is working in Jupyter notebook.
 # def test_plot_setting(global_var):
 # 	df = pytest.car_df