Merge pull request #543 from aai-institute/fix/lfs-images-for-docs

Fix/lfs images for docs

.gitattributes

@@ -1,2 +1,3 @@
 notebooks/*.ipynb -linguist-detectable
 *.png filter=lfs diff=lfs merge=lfs -text
+*.svg filter=lfs diff=lfs merge=lfs -text

.github/workflows/main.yaml

@@ -57,6 +57,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        lfs: true
     - name: Setup Python 3.8
       uses: ./.github/actions/python
       with:

.github/workflows/publish.yaml

@@ -1,4 +1,4 @@
-name: Publish Python Package to PyPI
+name: Publish package and docs
 
 on:
   release:
@@ -29,11 +29,16 @@ jobs:
       - name: Checking out last commit in release
         if: ${{ github.event_name != 'workflow_dispatch' }}
         uses: actions/checkout@v4
+        with:
+          lfs: true
+          fetch-depth: 0
       - name: Checking out last commit for tag ${{ inputs.tag_name }}
-        uses: actions/checkout@v4
         if: ${{ github.event_name == 'workflow_dispatch' }}
+        uses: actions/checkout@v4
         with:
           ref: ${{ inputs.tag_name }}
+          lfs: true
+          fetch-depth: 0
       - name: Fail if running locally
         if: ${{ env.ACT }} # skip during local actions testing
         run: |

CHANGELOG.md

@@ -1,36 +1,41 @@
 # Changelog
 
-## Unreleased
+## Unreleased 🆕 New influence method, better docs and bugfixes 📚🐞
 
 ### Added
 
-- Many improvements to the documentation: fixes, links, text, example gallery
-  and more. [PR #532](https://github.com/aai-institute/pyDVL/pull/532)
-- Glossary of data valuation and influence terms in the docs.
-  [PR #537](https://github.com/aai-institute/pyDVL/pull/537
-- Implement new method: `NystroemSketchInfluence` 
+- New method: `NystroemSketchInfluence`
   [PR #504](https://github.com/aai-institute/pyDVL/pull/504)
-- Add property `model_dtype` to instances of type `TorchInfluenceFunctionModel`
-- Implement a preconditioned block variant of conjugate gradient 
+- New preconditioned block variant of conjugate gradient
   [PR #507](https://github.com/aai-institute/pyDVL/pull/507)
+- Improvements to documentation: fixes, links, text, example gallery, LFS and
+  more. [PR #532](https://github.com/aai-institute/pyDVL/pull/532), 
+  [PR #543](https://github.com/aai-institute/pyDVL/pull/543)
+- Glossary of data valuation and influence terms in the documentation
+  [PR #537](https://github.com/aai-institute/pyDVL/pull/537
 
 ### Fixed
 
-- Bug in `LissaInfluence`, when not using CPU device 
+- Bug in `LissaInfluence`, when not using CPU device
   [PR #495](https://github.com/aai-institute/pyDVL/pull/495)
 - Memory issue with `CgInfluence` and `ArnoldiInfluence`
   [PR #498](https://github.com/aai-institute/pyDVL/pull/498)
 - Raising specific error message with install instruction, when trying to load 
-  `pydvl.utils.cache.memcached` without `pymemcache` installed. 
+  `pydvl.utils.cache.memcached` without `pymemcache` installed.
   If `pymemcache` is available, all symbols from `pydvl.utils.cache.memcached` 
   are available through `pydvl.utils.cache`
   [PR #509](https://github.com/aai-institute/pyDVL/pull/509)  
 
 ### Changed
 
-- Bump versions of CI actions to avoid warnings [PR #502](https://github.com/aai-institute/pyDVL/pull/502)
-- Add Python Version 3.11 to supported versions [PR #510](https://github.com/aai-institute/pyDVL/pull/510)
-- Documentation improvements and cleanup [PR #521](https://github.com/aai-institute/pyDVL/pull/521) [PR #522](https://github.com/aai-institute/pyDVL/pull/522)
+- Add property `model_dtype` to instances of type `TorchInfluenceFunctionModel`
+- Bump versions of CI actions to avoid warnings
+  [PR #502](https://github.com/aai-institute/pyDVL/pull/502)
+- Add Python Version 3.11 to supported versions
+  [PR #510](https://github.com/aai-institute/pyDVL/pull/510)
+- Documentation improvements and cleanup
+  [PR #521](https://github.com/aai-institute/pyDVL/pull/521),
+  [PR #522](https://github.com/aai-institute/pyDVL/pull/522)
 
 ## 0.8.1 - 🆕 🏗  New method and notebook, Games with exact shapley values, bug fixes and cleanup
 

CONTRIBUTING.md

@@ -27,6 +27,12 @@ Run the following to set up the pre-commit git hook to run before pushes:
 pre-commit install --hook-type pre-push
 ```
 
+Additionally, we use Git LFS for some files like images. Install with
+
+```shell
+git lfs install
+```
+
 ## Setting up your environment
 
 We strongly suggest using some form of virtual environment for working with the

README.md

@@ -32,7 +32,7 @@ pyDVL focuses on model-dependent methods.
         width="70%"
         align="center"
         style="display: block; margin-left: auto; margin-right: auto;"
-        src="https://raw.githubusercontent.com/aai-institute/pyDVL/develop/docs/value/img/mclc-best-removal-10k-natural.svg"
+        src="https://pydvl.org/devel/value/img/mclc-best-removal-10k-natural.svg"
         alt="best sample removal"
     />
     <p align="center" style="text-align:center;">
@@ -51,7 +51,7 @@ of training samples over individual test points.
         width="70%"
         align="center"
         style="display: block; margin-left: auto; margin-right: auto;"
-        src="https://raw.githubusercontent.com/aai-institute/pyDVL/develop/docs/assets/influence_functions_example.png"
+        src="https://pydvl.org/devel/examples/img/influence_functions_example.png"
         alt="best sample removal"
     />
     <p align="center" style="text-align:center;">