Merge branch 'release/v0.2.0'

Author: mdbenito

.bumpversion.cfg

@@ -1,11 +1,11 @@
 [bumpversion]
-current_version = 0.1.0
+current_version = 0.2.0
 commit = False
 tag = False
 allow_dirty = False
-parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+)(?P<build>\d+))?
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<build>\d+))?
 serialize = 
-	{major}.{minor}.{patch}-{release}{build}
+	{major}.{minor}.{patch}.{release}{build}
 	{major}.{minor}.{patch}
 
 [bumpversion:part:release]

.github/workflows/publish.yaml

@@ -17,7 +17,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Set up Python 3.8
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: 3.8
           cache: 'pip'

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

@@ -19,7 +19,7 @@ jobs:
       with:
         fetch-depth: 0
     - name: Set up Python 3.8
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v4
       with:
         python-version: 3.8
         cache: 'pip'

.github/workflows/tox.yaml

@@ -1,4 +1,4 @@
-name: Run tests, build docs, release to TestPyPI
+name: Run tests, build docs, publish to TestPyPI
 
 on:
   push:
@@ -26,7 +26,7 @@ jobs:
       with:
         fetch-depth: 0
     - name: Set up Python 3.8
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v4
       with:
         python-version: 3.8
         cache: 'pip'
@@ -50,7 +50,7 @@ jobs:
       with:
         fetch-depth: 0
     - name: Set up Python 3.8
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v4
       with:
         python-version: 3.8
         cache: 'pip'
@@ -64,9 +64,7 @@ jobs:
         key: tox-${{ github.ref }}-${{ runner.os }}-${{ hashFiles('tox.ini') }}
         path: .tox
     - name: Build Docs
-      run: |
-        cp notebooks/*.ipynb docs/examples/
-        tox -e docs
+      run: tox -e docs
     - name: Save built docs
       uses: actions/upload-artifact@v3
       with:
@@ -102,7 +100,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Set up Python 3.8
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: 3.8
           cache: 'pip'
@@ -132,9 +130,8 @@ jobs:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.TEST_PYPI_PASSWORD }}
         run: |
-          git config user.name "${{ env.GITHUB_BOT_USERNAME }}"
-          git config user.email "${{ env.GITHUB_BOT_EMAIL }}"
-          tox -e bump-dev-version-and-create-tag
-          git push
-          git push --tags
+          set -x
+          export CURRENT_VERSION=$(python setup.py --version)
+          export BUILD_NUMBER=$GITHUB_RUN_NUMBER
+          tox -e bump-dev-version
           tox -e publish-test-package

.pre-commit-config.yaml

@@ -2,16 +2,16 @@ fail_fast: false
 
 repos:
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 22.10.0
     hooks:
       - id: black-jupyter
         language_version: python3
   - repo: https://github.com/PyCQA/isort
-    rev: 5.8.0
+    rev: 5.10.1
     hooks:
       - id: isort
   - repo: https://github.com/kynan/nbstripout
-    rev: 0.5.0
+    rev: 0.6.1
     hooks:
       - id: nbstripout
-        args: ["--keep-output", "--keep-count", "--strip-empty-cells", "--extra-keys", "metadata.pycharm cell.metadata.pycharm"]
+        args: ["--keep-output", "--keep-count", "--drop-empty-cells", "--extra-keys", "metadata.pycharm cell.metadata.pycharm"]

CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 0.2.0 - 📚 Better docs
+
+Mostly API documentation and notebooks, plus some bugfixes.
+
+### Added
+
+In [PR #161](https://github.com/appliedAI-Initiative/pyDVL/pull/161):
+- Support for $$ math in sphinx docs.
+- Usage of sphinx extension for external links (introducing new directives like
+  `:gh:`, `:issue:` and `:tfl:` to construct standardised links to external
+  resources).
+- Only update auto-generated documentation files if there are changes. Some
+  minor additions to `update_docs.py`.
+- Parallelization of exact combinatorial Shapley.
+- Integrated KNN shapley into the main interface `compute_shapley_values`.
+
+### Changed
+
+In [PR #161](https://github.com/appliedAI-Initiative/pyDVL/pull/161):
+- Improved main docs and Shapley notebooks. Added or fixed many docstrings,
+  readme and documentation for contributors. Typos, grammar and style in code,
+  documentation and notebooks.
+- Internal renaming and rearranging in the parallelization and caching modules.
+
+### Fixed
+
+- Bug in random matrix generation
+  [PR #161](https://github.com/appliedAI-Initiative/pyDVL/pull/161).
+- Bugs in MapReduceJob's `_chunkify` and `_backpressure` methods
+  [PR #176](https://github.com/appliedAI-Initiative/pyDVL/pull/176).
+
+
 ## 0.1.0 - 🎉 first release
 
 This is very first release of pyDVL.