core module created (#115)

* feat: core metrics * position parity added * Delete holisticai/explainability/metrics/core/contrast_metrics.py * position parity added with pre-commit * deleted contrast metrics * returns added to the description * multiclass testing added * multiclass testing added with pre-commit. * vscode deleted * position parity changed to get fi dataframes, not indexes * bug fixed * rank alignment metric added. * changed * fixed. * explainability ease added. * fixed. * fixed. * changed core to be a module * init changed * fixed --------- Co-authored-by: crismunoz <cristian.munoz@holisticai.com>
holistic-ai · Apr 19, 2024 · e6c6ba7 · e6c6ba7
1 parent 743cadd
commit e6c6ba7
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/holisticai/explainability/metrics/core/__init__.py b/holisticai/explainability/metrics/core/__init__.py
@@ -0,0 +1,12 @@
+"""
+The :mod:`holisticai.explainability.metrics.core` module includes all explainability metrics.
+"""
+
+from ._all_metrics import explainability_ease, position_parity, rank_alignment
+
+# All explainability functions and classes
+__all__ = [
+    "position_parity",
+    "rank_alignment",
+    "explainability_ease",
+]
diff --git a/...xplainability/metrics/core/all_metrics.py → ...plainability/metrics/core/_all_metrics.py b/...xplainability/metrics/core/all_metrics.py → ...plainability/metrics/core/_all_metrics.py
diff --git a/tests/explainability/test_all_metrics.py b/tests/explainability/test_all_metrics.py
@@ -6,7 +6,7 @@
 from sklearn.model_selection import train_test_split
 
 from holisticai.datasets import load_dataset
-from holisticai.explainability.metrics.core.all_metrics import (
+from holisticai.explainability.metrics.core import (
     explainability_ease,
     position_parity,
     rank_alignment,