Merge branch 'develop' into feature/filter-converged

# Conflicts:
#	CHANGELOG.md
#	src/pydvl/reporting/plots.py

Author: mdbenito

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 - Faster semi-value computation with per-index check of stopping criteria (optional)
   [PR #437](https://github.com/aai-institute/pyDVL/pull/437)
+- Improvements and fixes to notebooks
+  [PR #436](https://github.com/aai-institute/pyDVL/pull/436)
+- Fix initialization of `data_names` in `ValuationResult.zeros()`
+  [PR #443](https://github.com/aai-institute/pyDVL/pull/443)
 - Using pytest-xdist for faster local tests
   [PR #440](https://github.com/aai-institute/pyDVL/pull/440)
 - Added `AntitheticPermutationSampler`

CONTRIBUTING.md

@@ -170,12 +170,29 @@ Or:
 ]
 ```
 
-To only hide the input 
+To only hide the input and
+
+```yaml
+"tags": [
+  "hide-output"
+]
+```
+for hiding the output only.
 
 It is important to leave a warning at the top of the document to avoid confusion.
 Examples for hidden imports and plots are available in the notebooks, e.g. in
-[Shapley for data valuation](https://aai-institute.github.io/pyDVL/examples/shapley_basic_spotify.ipynb).
+*notebooks/shapley_basic_spotify.ipynb*.
 
+### Plots in Notebooks
+If you add a plot to a notebook, which should also render nicely in browser
+dark mode, add the tag *invertible-output*, i.e.
+
+```yaml
+"tags": [
+  "invertible-output"
+]
+```
+This applies a simple CSS-filter to the output image of the cell.
 
 ## Documentation
 

README.md

@@ -52,7 +52,7 @@ methods from the following papers:
   Shapley Values](https://doi.org/10.1109/ICPR48806.2021.9412511). In 25th
   International Conference on Pattern Recognition (ICPR 2020), 7992–99. IEEE,
   2021.
-- Yan, T., & Procaccia, A. D. [If You Like Shapley Then You’ll Love the
+- Yan, T., and Procaccia, A. D. [If You Like Shapley Then You’ll Love the
   Core](https://ojs.aaai.org/index.php/AAAI/article/view/16721). Proceedings of
   the AAAI Conference on Artificial Intelligence, 35(6) (2021): 5751-5759.
 - Jia, Ruoxi, David Dao, Boxin Wang, Frances Ann Hubis, Nick Hynes, Nezihe Merve

docs/css/extra.css

@@ -107,14 +107,17 @@ a.autorefs-external:hover::after {
   color: black;
 }
 
-
 body[data-md-color-scheme="default"] .invertible img {
 }
 
 body[data-md-color-scheme="slate"] .invertible img {
     filter: invert(100%) hue-rotate(180deg);
 }
 
+body[data-md-color-scheme="slate"] .celltag_invertible-output img {
+    filter: invert(100%) hue-rotate(180deg);
+}
+
 /* Rendered dataframe from jupyter */
 table.dataframe {
     display: block;

mkdocs.yml

@@ -53,6 +53,8 @@ plugins:
           - hide
         remove_input_tags:
           - hide-input
+        remove_all_outputs_tags:
+          - hide-output
       binder: true
       binder_service_name: "gh"
       binder_branch: "develop"