Merge pull request #24 from ishevche/setup

Refactoring the code

Author: joaopfonseca

experiments/0.0-benchmarks-demo.ipynb

@@ -2305,7 +2305,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from sharp.utils import scores_to_ordering\n",
+    "from xai_ranking.utils import scores_to_ordering\n",
     "\n",
     "\n",
     "def test_pd():\n",

experiments/0.2-basic-experiment.ipynb

@@ -57,7 +57,7 @@
     "import matplotlib.pyplot as plt\n",
     "from scipy.stats import kendalltau\n",
     "from mlresearch.utils import check_random_states, set_matplotlib_style\n",
-    "from sharp.utils import scores_to_ordering\n",
+    "from xai_ranking.utils import scores_to_ordering\n",
     "import seaborn as sns\n",
     "\n",
     "RNG_SEED = 42"
@@ -1678,10 +1678,10 @@
      "evalue": "name 'dataset' is not defined",
      "output_type": "error",
      "traceback": [
-      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
-      "\u001b[0;31mNameError\u001b[0m                                 Traceback (most recent call last)",
-      "Cell \u001b[0;32mIn[10], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m dataset[\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mscorer\u001b[39m\u001b[38;5;124m\"\u001b[39m]\n",
-      "\u001b[0;31mNameError\u001b[0m: name 'dataset' is not defined"
+      "\u001B[0;31m---------------------------------------------------------------------------\u001B[0m",
+      "\u001B[0;31mNameError\u001B[0m                                 Traceback (most recent call last)",
+      "Cell \u001B[0;32mIn[10], line 1\u001B[0m\n\u001B[0;32m----> 1\u001B[0m dataset[\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mscorer\u001B[39m\u001B[38;5;124m\"\u001B[39m]\n",
+      "\u001B[0;31mNameError\u001B[0m: name 'dataset' is not defined"
      ]
     }
    ],

experiments/0.2-basic-experiment.py

@@ -48,7 +48,7 @@
 import matplotlib.pyplot as plt
 from scipy.stats import kendalltau
 from mlresearch.utils import check_random_states, set_matplotlib_style
-from sharp.utils import scores_to_ordering
+from xai_ranking.utils import scores_to_ordering
 
 RNG_SEED = 42
 

experiments/0.3-NEW-Visualizations-time-experiment.ipynb

@@ -62,7 +62,7 @@
     "import matplotlib.pyplot as plt\n",
     "import seaborn as sns\n",
     "from mlresearch.utils import check_random_states, set_matplotlib_style\n",
-    "from sharp.utils import scores_to_ordering\n",
+    "from xai_ranking.utils import scores_to_ordering\n",
     "\n",
     "RNG_SEED = 42"
    ]

experiments/0.3-Visualizations-time-experiment.ipynb

@@ -62,7 +62,7 @@
     "import matplotlib.pyplot as plt\n",
     "import seaborn as sns\n",
     "from mlresearch.utils import check_random_states, set_matplotlib_style\n",
-    "from sharp.utils import scores_to_ordering\n",
+    "from xai_ranking.utils import scores_to_ordering\n",
     "\n",
     "RNG_SEED = 42"
    ]

experiments/0.3-time-experiment.py

@@ -15,7 +15,7 @@
 from sklearn.utils import check_random_state
 from lightgbm import LGBMRanker
 from sharp import ShaRP
-from sharp.utils import scores_to_ordering
+from xai_ranking.utils import scores_to_ordering
 from xai_ranking.preprocessing import preprocess_higher_education_data
 from xai_ranking.scorers import higher_education_score
 from mlresearch.utils import check_random_states

experiments/0.4-independence-experiment.ipynb

@@ -102,7 +102,7 @@
     "import numpy as np\n",
     "import matplotlib.pyplot as plt\n",
     "from mlresearch.utils import check_random_states, set_matplotlib_style\n",
-    "from sharp.utils import scores_to_ordering\n",
+    "from xai_ranking.utils import scores_to_ordering\n",
     "\n",
     "RNG_SEED = 42"
    ]

experiments/0.5-QoI-comparison.ipynb

@@ -60,7 +60,7 @@
     "import matplotlib.pyplot as plt\n",
     "import seaborn as sns\n",
     "from mlresearch.utils import check_random_states, set_matplotlib_style\n",
-    "from sharp.utils import scores_to_ordering\n",
+    "from xai_ranking.utils import scores_to_ordering\n",
     "\n",
     "RNG_SEED = 42"
    ]

experiments/0.6-Sensitivity.ipynb

@@ -30,7 +30,7 @@
     "from sklearn.preprocessing import normalize\n",
     "from lightgbm import LGBMRanker\n",
     "from sharp import ShaRP\n",
-    "from sharp.utils import scores_to_ordering\n",
+    "from xai_ranking.utils import scores_to_ordering\n",
     "from xai_ranking.preprocessing import preprocess_higher_education_data\n",
     "from xai_ranking.scorers import higher_education_score\n",
     "from mlresearch.utils import check_random_states, set_matplotlib_style\n",
@@ -496,10 +496,10 @@
      "evalue": "name 'df_correlations' is not defined",
      "output_type": "error",
      "traceback": [
-      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
-      "\u001b[0;31mNameError\u001b[0m                                 Traceback (most recent call last)",
-      "Cell \u001b[0;32mIn[5], line 1\u001b[0m\n\u001b[0;32m----> 1\u001b[0m sns\u001b[38;5;241m.\u001b[39mscatterplot(data\u001b[38;5;241m=\u001b[39m\u001b[43mdf_correlations\u001b[49m[(df_correlations[\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mmetric\u001b[39m\u001b[38;5;124m\"\u001b[39m]\u001b[38;5;241m==\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mSpearman\u001b[39m\u001b[38;5;124m\"\u001b[39m) \u001b[38;5;241m&\u001b[39m (df_correlations[\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mcomparison\u001b[39m\u001b[38;5;124m\"\u001b[39m] \u001b[38;5;241m==\u001b[39m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mranks\u001b[39m\u001b[38;5;124m\"\u001b[39m)], x\u001b[38;5;241m=\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mmethod\u001b[39m\u001b[38;5;124m\"\u001b[39m, y\u001b[38;5;241m=\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mcorrelation\u001b[39m\u001b[38;5;124m\"\u001b[39m, hue\u001b[38;5;241m=\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mdataset\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n\u001b[1;32m      2\u001b[0m plt\u001b[38;5;241m.\u001b[39mxticks(rotation\u001b[38;5;241m=\u001b[39m\u001b[38;5;241m90\u001b[39m)\n\u001b[1;32m      3\u001b[0m plt\u001b[38;5;241m.\u001b[39msavefig(\n\u001b[1;32m      4\u001b[0m     \u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mresults/sensitivity/sensitivity-plots/correlations/explanationNrank-spearman-EUCLIDEAN.pdf\u001b[39m\u001b[38;5;124m\"\u001b[39m,\n\u001b[1;32m      5\u001b[0m     \u001b[38;5;28mformat\u001b[39m\u001b[38;5;241m=\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mpdf\u001b[39m\u001b[38;5;124m\"\u001b[39m,\n\u001b[1;32m      6\u001b[0m     bbox_inches\u001b[38;5;241m=\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mtight\u001b[39m\u001b[38;5;124m\"\u001b[39m,\n\u001b[1;32m      7\u001b[0m     transparent\u001b[38;5;241m=\u001b[39m\u001b[38;5;28;01mTrue\u001b[39;00m\n\u001b[1;32m      8\u001b[0m     )\n",
-      "\u001b[0;31mNameError\u001b[0m: name 'df_correlations' is not defined"
+      "\u001B[0;31m---------------------------------------------------------------------------\u001B[0m",
+      "\u001B[0;31mNameError\u001B[0m                                 Traceback (most recent call last)",
+      "Cell \u001B[0;32mIn[5], line 1\u001B[0m\n\u001B[0;32m----> 1\u001B[0m sns\u001B[38;5;241m.\u001B[39mscatterplot(data\u001B[38;5;241m=\u001B[39m\u001B[43mdf_correlations\u001B[49m[(df_correlations[\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mmetric\u001B[39m\u001B[38;5;124m\"\u001B[39m]\u001B[38;5;241m==\u001B[39m\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mSpearman\u001B[39m\u001B[38;5;124m\"\u001B[39m) \u001B[38;5;241m&\u001B[39m (df_correlations[\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mcomparison\u001B[39m\u001B[38;5;124m\"\u001B[39m] \u001B[38;5;241m==\u001B[39m \u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mranks\u001B[39m\u001B[38;5;124m\"\u001B[39m)], x\u001B[38;5;241m=\u001B[39m\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mmethod\u001B[39m\u001B[38;5;124m\"\u001B[39m, y\u001B[38;5;241m=\u001B[39m\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mcorrelation\u001B[39m\u001B[38;5;124m\"\u001B[39m, hue\u001B[38;5;241m=\u001B[39m\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mdataset\u001B[39m\u001B[38;5;124m\"\u001B[39m)\n\u001B[1;32m      2\u001B[0m plt\u001B[38;5;241m.\u001B[39mxticks(rotation\u001B[38;5;241m=\u001B[39m\u001B[38;5;241m90\u001B[39m)\n\u001B[1;32m      3\u001B[0m plt\u001B[38;5;241m.\u001B[39msavefig(\n\u001B[1;32m      4\u001B[0m     \u001B[38;5;124mf\u001B[39m\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mresults/sensitivity/sensitivity-plots/correlations/explanationNrank-spearman-EUCLIDEAN.pdf\u001B[39m\u001B[38;5;124m\"\u001B[39m,\n\u001B[1;32m      5\u001B[0m     \u001B[38;5;28mformat\u001B[39m\u001B[38;5;241m=\u001B[39m\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mpdf\u001B[39m\u001B[38;5;124m\"\u001B[39m,\n\u001B[1;32m      6\u001B[0m     bbox_inches\u001B[38;5;241m=\u001B[39m\u001B[38;5;124m\"\u001B[39m\u001B[38;5;124mtight\u001B[39m\u001B[38;5;124m\"\u001B[39m,\n\u001B[1;32m      7\u001B[0m     transparent\u001B[38;5;241m=\u001B[39m\u001B[38;5;28;01mTrue\u001B[39;00m\n\u001B[1;32m      8\u001B[0m     )\n",
+      "\u001B[0;31mNameError\u001B[0m: name 'df_correlations' is not defined"
      ]
     }
    ],