change: all plot return a fig, ax objects if the user sets show_plot=…

…False

.github/workflows/publish_to_pypi.yml

@@ -33,12 +33,4 @@ jobs:
         run: python -m build
 
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-
-      - name: Create GitHub Release
-        if: startsWith(github.ref, 'refs/tags/v') && contains(github.ref, '.')
-        uses: softprops/action-gh-release@v1
-        with:
-          files: dist/*
-        env:
-          GITHUB_TOKEN: ${{ secrets.EFFECTOR_GITHUB_API_KEY }}
+        uses: pypa/gh-action-pypi-publish@release/v1

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [Unreleased]
+
+### Changed
+
+- all plots return a `fig, ax` tuple, if the user wants to modify the plot further.
+- default plot titles now display full method name, e.g., `Accumulated Local Effects` instead of `ALE`.
+- changed README.md to reflect the new changes.
+- license
+
+### Added 
+
+- codecov badge to README.md
+
 ## [0.1.1] - 2025-02-17
 
 ### Changed

docs/README.md

@@ -2,32 +2,38 @@
 
 ---
 
-## Copy changelog
+## TODO before publishing
+
+### Copy changelog
 
 ```bash
 cp ../CHANGELOG.md docs/changelog.md
 ```
 
+---
+
+### Update the notebooks
 
-If you want to clean everything first:
+#### (Optional) Remove the old notebooks
 
 ```bash
 rm -rf docs/notebooks
 mkdir docs/notebooks
 ```
 
-To update the docs with the latest tutorials:
+#### Convert the notebooks to markdown
 
 ```bash
 jupyter nbconvert --to markdown ./../notebooks/real-examples/* --output-dir docs/notebooks/real-examples/
 jupyter nbconvert --to markdown ./../notebooks/synthetic-examples/* --output-dir docs/notebooks/synthetic-examples/
 jupyter nbconvert --to markdown ./../notebooks/quickstart/* --output-dir docs/notebooks/quickstart/
 jupyter nbconvert --to markdown ./../notebooks/guides/* --output-dir docs/notebooks/guides/
 ```
+---
 
-Then copy some on the static folder:
+### Update the images on the `./static` folder
 
-First create dir, if it does not exist:
+#### Create the folders if they don't exist
 
 ```bash
 mkdir docs/static/quickstart/
@@ -37,15 +43,17 @@ mkdir docs/static/quickstart/flexible_api_files/
 mkdir docs/static/real-examples/01_bike_sharing_dataset_files/
 ```
 
-Then copy the files:
+#### Copy the images
 
 ```bash
 cp docs/notebooks/quickstart/simple_api_files/* docs/static/quickstart/simple_api_files/
 cp docs/notebooks/quickstart/flexible_api_files/* docs/static/quickstart/flexible_api_files/
 cp docs/notebooks/real-examples/01_bike_sharing_dataset_files/* docs/static/real-examples/01_bike_sharing_dataset_files/
 ```
 
-To launch the documentation locally:
+---
+
+## Run the documentation locally
 
 ```zsh
 mkdocs serve

effector/global_effect_ale.py

@@ -168,6 +168,7 @@ def plot(
         y_limits: Optional[List] = None,
         dy_limits: Optional[List] = None,
         show_only_aggregated: bool = False,
+        show_plot: bool = True,
     ):
         """
         Plot the (RH)ALE feature effect of feature `feature`.
@@ -206,6 +207,9 @@ def plot(
 
                 - If set to None, the limits of the dy-axis are set automatically
                 - If set to a tuple, the limits are manually set
+
+            show_only_aggregated: if True, only the main ale plot will be shown
+            show_plot: if True, the plot will be shown
         """
         heterogeneity = helpers.prep_confidence_interval(heterogeneity)
         centering = helpers.prep_centering(centering)
@@ -222,7 +226,7 @@ def plot(
         else:
             avg_output = None
 
-        vis.ale_plot(
+        ret = vis.ale_plot(
             self.feature_effect["feature_" + str(feature)],
             self.eval,
             feature,
@@ -237,8 +241,15 @@ def plot(
             y_limits=y_limits,
             dy_limits=dy_limits,
             show_only_aggregated=show_only_aggregated,
+            show_plot=show_plot,
         )
 
+        if not show_plot:
+            fig, ax = ret
+            return fig, ax
+
+
+
 
 class ALE(ALEBase):
     def __init__(

effector/global_effect_pdp.py

@@ -187,6 +187,7 @@ def _plot(
         show_avg_output: bool = False,
         y_limits: Optional[List] = None,
         use_vectorized: bool = True,
+        show_plot: bool = True,
     ):
         heterogeneity = helpers.prep_confidence_interval(heterogeneity)
         centering = helpers.prep_centering(centering)
@@ -212,7 +213,7 @@ def _plot(
             avg_output = None
 
         title = "PDP" if self.method_name == "pdp" else "d-PDP"
-        vis.plot_pdp_ice(
+        ret = vis.plot_pdp_ice(
             x,
             feature,
             yy=yy,
@@ -227,7 +228,11 @@ def _plot(
             target_name=self.target_name,
             nof_ice=nof_ice,
             y_limits=y_limits,
+            show_plot=show_plot,
         )
+        if not show_plot:
+            fig, ax = ret
+            return fig, ax
 
 class PDP(PDPBase):
     def __init__(
@@ -330,6 +335,7 @@ def plot(
         show_avg_output: bool = False,
         y_limits: Optional[List] = None,
         use_vectorized: bool = True,
+        show_plot: bool = True,
     ):
         """
         Plot the feature effect.
@@ -370,7 +376,7 @@ def plot(
 
             use_vectorized: whether to use the vectorized version of the PDP computation
         """
-        self._plot(
+        ret = self._plot(
             feature,
             heterogeneity,
             centering,
@@ -382,6 +388,9 @@ def plot(
             y_limits,
             use_vectorized,
         )
+        if not show_plot:
+            return ret
+
 
 
 class DerPDP(PDPBase):
@@ -492,6 +501,7 @@ def plot(
         show_avg_output: bool = False,
         dy_limits: Optional[List] = None,
         use_vectorized: bool = True,
+        show_plot: bool = True,
     ):
         """
         Plot the feature effect.
@@ -531,8 +541,9 @@ def plot(
                 - If set to a tuple, the limits are manually set
 
             use_vectorized: whether to use the vectorized version of the PDP computation
+            show_plot: whether to show the plot
         """
-        self._plot(
+        ret = self._plot(
             feature,
             heterogeneity,
             centering,
@@ -543,8 +554,13 @@ def plot(
             show_avg_output,
             dy_limits,
             use_vectorized,
+            show_plot,
         )
 
+        if not show_plot:
+            fig, ax = ret
+            return fig, ax
+
 
 def ice_non_vectorized(
     model: callable,

effector/global_effect_shap.py

@@ -292,7 +292,8 @@ def plot(
         show_avg_output: bool = False,
         y_limits: Optional[List] = None,
         only_shap_values: bool = False,
-    ) -> None:
+        show_plot: bool = True,
+    ) -> Union[Tuple, None]:
         """
         Plot the SHAP Dependence Plot (SDP) of the s-th feature.
 
@@ -317,6 +318,7 @@ def plot(
             show_avg_output: whether to show the average output of the model
             y_limits: limits of the y-axis
             only_shap_values: whether to plot only the shap values
+            show_plot: whether to show the plot
         """
         heterogeneity = helpers.prep_confidence_interval(heterogeneity)
 
@@ -354,7 +356,7 @@ def plot(
         else:
             avg_output = None
 
-        vis.plot_shap(
+        ret = vis.plot_shap(
             x,
             y,
             xx,
@@ -369,4 +371,7 @@ def plot(
             target_name=self.target_name,
             y_limits=y_limits,
             only_shap_values=only_shap_values,
+            show_plot=show_plot,
         )
+
+        return ret

effector/visualization.py

@@ -36,6 +36,7 @@ def ale_plot(
     y_limits: typing.Union[None, tuple] = None,
     dy_limits: typing.Union[None, tuple] = None,
     show_only_aggregated: bool = False,
+    show_plot: bool = True,
 ):
     """
 
@@ -115,7 +116,13 @@ def ale_plot(
         ax2.set_xlabel(x_name)
         ax2.set_ylabel("dy/dx")
 
-    plt.show(block=False)
+    if show_plot:
+        plt.show(block=False)
+    else:
+        if show_only_aggregated:
+            return fig, ax1
+        else:
+            return fig, (ax1, ax2)
 
 
 def ale_curve(ax1, x, y, avg_output=None):
@@ -158,6 +165,7 @@ def plot_pdp_ice(
     is_derivative: bool = False,
     nof_ice: typing.Union[str, int] = "all",
     y_limits: typing.Union[None, tuple] = None,
+    show_plot: bool = True,
 ):
 
     fig, ax = plt.subplots()
@@ -245,8 +253,11 @@ def plot_pdp_ice(
     if y_limits is not None:
         ax.set_ylim(y_limits[0], y_limits[1])
 
-    plt.show(block=False)
-    return fig, ax
+    if show_plot:
+        plt.show(block=False)
+    else:
+        return fig, ax
+
 
 
 def plot_shap(
@@ -264,6 +275,7 @@ def plot_shap(
     target_name: typing.Union[None, str] = None,
     y_limits: typing.Union[None, tuple] = None,
     only_shap_values: bool = False,
+    show_plot: bool = True,
 ):
 
     fig, ax = plt.subplots()
@@ -313,4 +325,8 @@ def plot_shap(
     ax.legend()
     if y_limits is not None:
         ax.set_ylim(y_limits[0], y_limits[1])
-    plt.show(block=False)
+
+    if show_plot:
+        plt.show(block=False)
+    else:
+        return fig, ax