fix cli tests (#314)

* move to pyproject.toml

* delete old setup.py etc

* ruff format

* ruff check fixes

* limit deps

* missing imports

* squeeze skorch shap values tensors

* use ruff as gh actions linter

* update gh actions workflows

* install --system

* fix ci script installation

* fix cli tests

* add explainer.yaml to test assets

* further cli test fixes

Author: oegedijk

explainerdashboard/explainers.py

@@ -507,8 +507,8 @@ def to_yaml(
                 modelfile=modelfile,
                 datafile=datafile,
                 explainerfile=explainerfile,
-                data_target=self.target,
-                data_index=self.idxs.name,
+                data_target=target_col or self.target,
+                data_index=index_col or self.idxs.name,
                 explainer_type="classifier" if self.is_classifier else "regression",
                 dashboard_yaml=dashboard_yaml,
                 params=self._params_dict,

tests/hub/test_hub_cli.py

@@ -5,7 +5,7 @@
 
 def test_explainerhub_cli_help(explainer_hub_dump_folder, script_runner):
     ret = script_runner.run(
-        ["explainerhub", " --help"], cwd=str(explainer_hub_dump_folder)
+        ["explainerhub", "--help"], cwd=str(explainer_hub_dump_folder)
     )
     assert ret.success
     assert ret.stderr == ""

tests/test_cli.py

@@ -1,3 +1,4 @@
+import pickle
 import pytest
 from pathlib import Path
 
@@ -24,6 +25,7 @@ def generate_assets():
         cats=[{"Gender": ["Sex_female", "Sex_male", "Sex_nan"]}, "Deck", "Embarked"],
         labels=["Not survived", "Survived"],
     )
+    
 
     dashboard = ExplainerDashboard(
         explainer,
@@ -36,18 +38,30 @@ def generate_assets():
     )
 
     pkl_dir = Path.cwd() / "tests" / "test_assets"
-    explainer.to_yaml(pkl_dir / "explainer.yaml")
+    pkl_dir.mkdir(parents=True, exist_ok=True)
+    explainer_joblib_path = pkl_dir / "explainer.joblib"
+    model_path = pkl_dir / "model.pkl"
+
+    explainer_yaml_path = pkl_dir / "explainer.yaml"
+    dashboard_yaml_path = pkl_dir / "dashboard.yaml"
+    pickle.dump(model, open(model_path, "wb"))
+    explainer.to_yaml(explainer_yaml_path, index_col="Name", target_col="Survival")
+    explainer.dump(explainer_joblib_path)
     dashboard.to_yaml(
-        pkl_dir / "dashboard.yaml",
-        explainerfile=str(pkl_dir / "explainer.joblib"),
+        dashboard_yaml_path,
+        explainerfile=str(explainer_joblib_path),
         dump_explainer=True,
     )
-    return None
+    yield
 
+    explainer_joblib_path.unlink()
+    explainer_yaml_path.unlink()
+    dashboard_yaml_path.unlink()
+    model_path.unlink()
 
 def test_explainerdashboard_cli_help(generate_assets, script_runner):
     ret = script_runner.run(
-        ["explainerdashboard", " --help"],
+        ["explainerdashboard", "--help"],
         cwd=str(Path().cwd() / "tests" / "test_assets"),
     )
     assert ret.success
@@ -56,7 +70,7 @@ def test_explainerdashboard_cli_help(generate_assets, script_runner):
 
 def test_explainerdashboard_cli_explainer(generate_assets, script_runner):
     ret = script_runner.run(
-        ["explainerdashboard", " test explainer.joblib"],
+        ["explainerdashboard", "test", "explainer.joblib"],
         cwd=str(Path().cwd() / "tests" / "test_assets"),
     )
     assert ret.success
@@ -65,7 +79,7 @@ def test_explainerdashboard_cli_explainer(generate_assets, script_runner):
 
 def test_explainerdashboard_cli_yaml(generate_assets, script_runner):
     ret = script_runner.run(
-        ["explainerdashboard", " test dashboard.yaml"],
+        ["explainerdashboard", "test", "dashboard.yaml"],
         cwd=str(Path().cwd() / "tests" / "test_assets"),
     )
     assert ret.success
@@ -74,7 +88,7 @@ def test_explainerdashboard_cli_yaml(generate_assets, script_runner):
 
 def test_explainerdashboard_cli_build(generate_assets, script_runner):
     ret = script_runner.run(
-        ["explainerdashboard", " build"],
+        ["explainerdashboard", "build", "explainer.yaml"],
         cwd=str(Path().cwd() / "tests" / "test_assets"),
     )
     assert ret.success
@@ -83,7 +97,7 @@ def test_explainerdashboard_cli_build(generate_assets, script_runner):
 
 def test_explainerdashboard_cli_build_explainer(generate_assets, script_runner):
     ret = script_runner.run(
-        ["explainerdashboard", " build explainer.yaml"],
+        ["explainerdashboard", "build", "explainer.yaml"],
         cwd=str(Path().cwd() / "tests" / "test_assets"),
     )
     assert ret.success
@@ -94,7 +108,7 @@ def test_explainerdashboard_cli_build_explainer_dashboard(
     generate_assets, script_runner
 ):
     ret = script_runner.run(
-        ["explainerdashboard", " build explainer.yaml dashboard.yaml"],
+        ["explainerdashboard", "build", "explainer.yaml", "dashboard.yaml"],
         cwd=str(Path().cwd() / "tests" / "test_assets"),
     )
     assert ret.success