Merge branch 'release/v0.7.1'

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.7.0
+current_version = 0.7.1
 commit = False
 tag = False
 allow_dirty = False

.github/actions/deploy-docs/action.yml

@@ -5,7 +5,7 @@ inputs:
     description: Version number to use
     required: true
   alias:
-    description: Alias to use (latest or stable)
+    description: Alias to use (stable or develop)
     required: true
   title:
     description: Alternative title to use

.github/workflows/tox.yaml → .github/workflows/main.yaml

@@ -1,4 +1,4 @@
-name: Run tests, build docs, publish to TestPyPI
+name: Tests, docs, package
 
 on:
   push:
@@ -25,8 +25,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
     - name: Setup Python 3.8
       uses: ./.github/actions/python
       with:
@@ -98,8 +96,6 @@ jobs:
       group: publish
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
       - name: Setup Python 3.8
         uses: ./.github/actions/python
         with:
@@ -123,6 +119,6 @@ jobs:
         run: |
           set -x
           export BUILD_NUMBER=$GITHUB_RUN_NUMBER
-          bump2version --no-tag --no-commit --verbose --serialize '\{major\}.\{minor\}.\{patch\}.\{release\}\{$BUILD_NUMBER\}' boguspart
+          bump2version --no-tag --no-commit --verbose --serialize '{major}.{minor}.{patch}.{release}{$BUILD_NUMBER}' boguspart
           python setup.py sdist bdist_wheel
           twine upload -r testpypi --verbose --non-interactive dist/*

.github/workflows/publish.yaml

@@ -13,9 +13,11 @@ on:
       tag_name:
         description: The name of the tag for which a package should be published
         type: string
-        required: false
+        required: true
 
 env:
+  GITHUB_BOT_USERNAME: github-actions[bot]
+  GITHUB_BOT_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
   PY_COLORS: 1
 
 jobs:
@@ -24,35 +26,14 @@ jobs:
     concurrency:
       group: publish
     steps:
-      - uses: actions/checkout@v3
+      - name: Checking out last commit in release
+        if: ${{ github.event_name != 'workflow_dispatch' }}
+        uses: actions/checkout@v3
+      - name: Checking out last commit for tag ${{ inputs.tag_name }}
+        uses: actions/checkout@v3
+        if: ${{ github.event_name == 'workflow_dispatch' }}
         with:
-          fetch-depth: 0
-      - name: Fail if manually triggered workflow does not have 'tag_name' input
-        if: github.event_name == 'workflow_dispatch' && inputs.tag_name == ''
-        run: |
-          echo "Input 'tag_name' should not be empty"
-          exit -1
-      - name: Extract branch name from input
-        id: get_branch_name_input
-        if: github.event_name == 'workflow_dispatch'
-        run: |
-          export BRANCH_NAME=$(git log -1 --format='%D' ${{ inputs.tag_name }} | sed -e 's/.*origin\/\(.*\).*/\1/')
-          echo "$BRANCH_NAME"
-          echo "branch_name=${BRANCH_NAME}" >> $GITHUB_OUTPUT
-      - name: Extract branch name from tag
-        id: get_branch_name_tag
-        if: github.release.tag_name != ''
-        run: |
-          export BRANCH_NAME=$(git log -1 --format='%D' ${{ github.release.tag_name }} | sed -e 's/.*origin\/\(.*\).*/\1/')
-          echo "$BRANCH_NAME"
-          echo "branch_name=${BRANCH_NAME}" >> $GITHUB_OUTPUT
-        shell: bash
-      - name: Fail if tag is not on 'master' branch
-        if: ${{ steps.get_branch_name_tag.outputs.branch_name != 'master' && steps.get_branch_name_input.outputs.branch_name != 'master' }}
-        run: |
-          echo "Tag is on branch ${{ steps.get_branch_name.outputs.branch_name }}"
-          echo "Should be on Master branch instead"
-          exit -1
+          ref: ${{ inputs.tag_name }}
       - name: Fail if running locally
         if: ${{ env.ACT }} # skip during local actions testing
         run: |
@@ -72,8 +53,8 @@ jobs:
         uses: ./.github/actions/deploy-docs
         with:
           version: ${{ env.CURRENT_VERSION }}
-          alias: latest
-          title: Latest
+          alias: stable
+          title: ${{ env.CURRENT_VERSION }}
           email: ${{ env.GITHUB_BOT_EMAIL }}
           username: ${{ env.GITHUB_BOT_USERNAME }}
           set-default: 'true'

.github/workflows/run-tests-workflow.yaml

@@ -31,8 +31,10 @@ jobs:
       with:
         key: tox-${{ github.ref }}-${{ runner.os }}-${{ hashFiles('tox.ini', 'requirements.txt') }}
         path: .tox
+    - name: Set up memcached
+      uses: niden/actions-memcached@v7
     - name: Test Base Modules
-      run: tox
+      run: tox -e base
       if: inputs.tests_to_run == 'base'
     - name: Test Modules that rely on PyTorch
       run: tox -e torch

.gitignore

@@ -110,6 +110,7 @@ celerybeat.pid
 .venv
 env/
 venv/
+venv38/
 ENV/
 env.bak/
 venv.bak/
@@ -139,6 +140,7 @@ pylint.html
 # Saved data
 runs/
 data/models/
+*.pkl
 
 # Docs
 docs_build

CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+
+## 0.7.1 - 🆕 New methods, bug fixes and improvements for local tests 🐞🧪
+
+### Added
+
+- New method: Class-wise Shapley values
+  [PR #338](https://github.com/aai-institute/pyDVL/pull/338)
+- New method: Data-OOB by @BastienZim 
+  [PR #426](https://github.com/aai-institute/pyDVL/pull/426), 
+  [PR $431](https://github.com/aai-institute/pyDVL/pull/431)
+- Added `AntitheticPermutationSampler`
+  [PR #439](https://github.com/aai-institute/pyDVL/pull/439)
+- Faster semi-value computation with per-index check of stopping criteria (optional)
+  [PR #437](https://github.com/aai-institute/pyDVL/pull/437)
+
+### Changed
+
+- No longer using docker within tests to start a memcached server
+  [PR #444](https://github.com/aai-institute/pyDVL/pull/444)
+- Using pytest-xdist for faster local tests
+  [PR #440](https://github.com/aai-institute/pyDVL/pull/440)
+- Improvements and fixes to notebooks
+  [PR #436](https://github.com/aai-institute/pyDVL/pull/436)
+- Refactoring of parallel module. Old imports will stop working in v0.9.0
+  [PR #421](https://github.com/aai-institute/pyDVL/pull/421)
+
+### Fixed
+
+- Fix initialization of `data_names` in `ValuationResult.zeros()`
+  [PR #443](https://github.com/aai-institute/pyDVL/pull/443)
+
+
 ## 0.7.0 - 📚🆕 Documentation and IF overhaul, new methods and bug fixes 💥🐞
 
 This is our first β release! We have worked hard to deliver improvements across
@@ -19,6 +51,13 @@ randomness.
   `pydvl.value.semivalues`. Introduced new type `Seed` and conversion function 
   `ensure_seed_sequence`.
   [PR #396](https://github.com/aai-institute/pyDVL/pull/396)
+- Added `batch_size` parameter to `compute_banzhaf_semivalues`,
+  `compute_beta_shapley_semivalues`, `compute_shapley_semivalues` and
+  `compute_generic_semivalues`.
+  [PR #428](https://github.com/aai-institute/pyDVL/pull/428)
+- Added classwise Shapley as proposed by (Schoch et al. 2021)
+  [https://arxiv.org/abs/2211.06800]
+  [PR #338](https://github.com/aai-institute/pyDVL/pull/338)
 
 ### Changed
 
@@ -240,3 +279,4 @@ It contains:
 - Parallelization of computations with Ray
 - Documentation
 - Notebooks containing examples of different use cases
+

CITATION.cff

@@ -27,5 +27,6 @@ keywords:
   - Banzhaf index
 license: LGPL-3.0
 commit: 0e929ae121820b0014bf245da1b21032186768cb
-version: v0.6.1
-date-released: '2023-04-13'
+version: v0.7.0
+doi: 10.5281/zenodo.8311583
+date-released: '2023-09-02'