shap-gpu 0.0.1.dev0__tar.gz

shap_gpu-0.0.1.dev0/.git-blame-ignore-revs

@@ -0,0 +1,13 @@
+# This file helps clean up the git "blame" view, by ignoring repo-wide style & refactoring commits.
+# Sorted imports with isort
+6be5b996cc7f048bf04875a8dc7775b2233dbeb4
+# Removed trailing whitespace
+b2a60a31edcc22ed41778cbe3ef93a499d76277f
+# Fixed end-of-file line endings
+9438e81732d04f9e9c56d98074e6b35615e21a9a
+# Renormalised file endings
+edb34644a218127437f9e6bb1588bc3246a2c222
+# Bulk update of docstrings with pydocstyle
+56394f1c208e384ad3302d596e90f6818943c840
+# Applied ruff formatter
+fc8a60f9b0854279014ff668db3d84a1d11bbc7e

shap_gpu-0.0.1.dev0/.gitattributes

@@ -0,0 +1,5 @@
+# Ensure consistent treatment of line endings
+* text=auto
+
+# Do not raise merge conflicts for multiple changelog edits
+CHANGELOG.md merge=union

shap_gpu-0.0.1.dev0/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,75 @@
+name: Bug Report
+description: Report incorrect behavior in the shap library
+title: "BUG: "
+labels: ["bug"]
+
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: problem
+    attributes:
+      label: Issue Description
+      description: Please describe the issue.
+    validations:
+      required: true
+  - type: textarea
+    id: example
+    attributes:
+      label: Minimal Reproducible Example
+      description: |
+        Please provide a minimal, self-contained example that reproduces the issue.
+      placeholder: |
+        import shap
+
+        ...
+      render: python
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        **Note**: without a working Minimal Reproducible Example, the maintainers will not be able to help you and your issue will be closed!
+
+        Your example should be:
+
+        1. **Minimal**: Use as little code as possible that still produces the same problem.
+        2. **Self-contained**: Provide all minimal imports, data and code needed to reproduce the problem.
+        3. **Verifiable**: Test the example to make sure it reproduces the problem.
+
+        See [Matt's guide](https://matthewrocklin.com/minimal-bug-reports) for further information on how to write helpful bug reports.
+  - type: textarea
+    id: traceback
+    attributes:
+      label: Traceback
+      description: Copy & paste the traceback of the error (if relevant).
+      placeholder: |
+        Traceback (most recent call last):
+          File "/shap/__init__.py", line 4, in <module>
+            import foo
+        NameError: name 'foo' is not defined
+      render: shell
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: Please describe or show a code example of the expected behavior.
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Bug report checklist
+      options:
+        - label: I have checked that this issue has not already been reported.
+          required: true
+        - label: I have confirmed this bug exists on the [latest release](https://github.com/shap/shap/releases) of shap.
+          required: true
+        - label: I have confirmed this bug exists on the [master branch](https://github.com/shap/shap/blob/master/CONTRIBUTING.md#installing-from-the-master-branch) of shap.
+        - label: I'd be interested in making a PR to fix this bug
+  - type: textarea
+    id: version
+    attributes:
+      label: Installed Versions
+      description: What version of the shap library are you using?
+    validations:
+      required: true

shap_gpu-0.0.1.dev0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+# For reference, see
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/
+
+blank_issues_enabled: true  # In future, may disable to force use of standardised issue forms
+contact_links:
+  - name: Discussions and Q&A
+    url: https://github.com/shap/shap/discussions
+    about: Ask general questions about shap and get help from other users

shap_gpu-0.0.1.dev0/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,40 @@
+name: Feature Request
+description: Suggest an idea for shap
+title: "ENH: "
+labels: [enhancement]
+
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to fill out this feature request form!
+  - type: textarea
+    id: description
+    attributes:
+      label: Problem Description
+      description: >
+        Please describe what problem the feature would solve (e.g. "I wish I could
+        use shap to ..."), and how the new feature would be used. Use pseudo-code if relevant.
+    validations:
+      required: true
+  - type: textarea
+    id: alternative
+    attributes:
+      label: Alternative Solutions
+      description: >
+        Please describe any alternative solutions (existing functionality, workarounds,
+        3rd party packages, etc.) that would satisfy the feature request.
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: >
+        Please provide any relevant GitHub issues, code examples or references
+        that help describe and support the feature request.
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Feature request checklist
+      options:
+        - label: I have checked the issue tracker for duplicate issues.
+          required: true
+        - label: I'd be interested in making a PR to implement this feature

shap_gpu-0.0.1.dev0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Overview
+
+Closes #XXXX  <!--Add issue number here, or delete as appropriate-->
+
+Description of the changes proposed in this pull request:
+
+
+
+## Checklist
+
+- [ ] All [pre-commit checks](https://pre-commit.com/#install) pass.
+- [ ] Unit tests added (if fixing a bug or adding a new feature)

shap_gpu-0.0.1.dev0/.github/codecov.yml

@@ -0,0 +1,13 @@
+codecov:
+  notify:
+    after_n_builds: 7
+    wait_for_ci: yes
+coverage:
+  range: 70..90
+comment:
+  require_changes: true
+  after_n_builds: 7
+ignore:
+  # Ignore coverage on vendored code
+  - "shap/plots/colors/_colorconv.py"
+  - "shap/explainers/other/_maple.py"

shap_gpu-0.0.1.dev0/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/javascript/"
+    schedule:
+      interval: "monthly"
+    groups:
+      # Group all minor and patch updates in a single PR
+      js-minor:
+        update-types:
+        - "minor"
+        - "patch"

shap_gpu-0.0.1.dev0/.github/release.yml

@@ -0,0 +1,26 @@
+changelog:
+  exclude:
+    labels:
+      - skip-changelog
+    authors:
+      - dependabot
+      - pre-commit-ci
+  categories:
+    - title: Breaking changes
+      labels:
+        - BREAKING
+    - title: Added
+      labels:
+        - enhancement
+    - title: Fixed
+      labels:
+        - bug
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Maintenance
+      labels:
+        - ci
+    - title: Other Changes
+      labels:
+        - "*"

shap_gpu-0.0.1.dev0/.github/workflows/build_gpu.yml

@@ -0,0 +1,27 @@
+# Dummy release workflow to reserve the "shap-gpu" name on PyPI.
+# Builds an sdist (no CUDA/C compilation) with the name overridden to
+# "shap-gpu" and a placeholder version, then publishes via trusted publishing.
+name: release
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # for PyPI trusted publishing
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0          # setuptools_scm needs full history/tags
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Override package name to shap-gpu
+        run: sed -i 's/^name = "shap"/name = "shap-gpu"/' pyproject.toml
+      - name: Build sdist
+        env:
+          SETUPTOOLS_SCM_PRETEND_VERSION: "0.0.1.dev0"
+        run: uv build --sdist
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

shap_gpu-0.0.1.dev0/.github/workflows/build_wheels.yml

@@ -0,0 +1,188 @@
+name: Build wheels
+
+on:
+  release:
+    types: [published]
+
+  # Enable manual run
+  workflow_dispatch:
+
+jobs:
+  # we need this test since we run into 403 errors on MacOS, see GH #4179
+  prepare_data:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Install dependencies for dataset download
+        run: |
+          uv pip install --system '.[download_datasets]'
+      - name: Pre-download datasets
+        run: python tests/datasets_to_cache.py
+      - name: Create unified cache directory
+        run: |
+          mkdir -p /tmp/test_data_cache
+          cp -r ~/scikit_learn_data /tmp/test_data_cache/ || true
+          cp -r shap/cached_data /tmp/test_data_cache/ || true
+          ls -la /tmp/test_data_cache/
+      - name: Upload cached datasets
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-data-cache
+          path: /tmp/test_data_cache
+          retention-days: 1
+
+  build_wheels:
+    name: Build ${{ matrix.os }} wheels
+    needs: [prepare_data]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm, macos-14, macos-15-intel, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      # Ensure all git tags are present so version number is extracted.
+      # https://github.com/actions/checkout/issues/1471
+      # Careful: the "fetch-tags" option to the checkout action is broken
+      # when the workflow is triggered by a tag!
+      # https://github.com/actions/checkout/issues/1467
+      - name: Check out the repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Fetch all tags
+        run: git fetch --tags
+
+      - name: Download pre-cached datasets
+        uses: actions/download-artifact@v4
+        with:
+          name: test-data-cache
+          path: ${{ runner.temp }}/test_data_cache
+
+      - name: Install libomp (macOS)
+        if: runner.os == 'macOS'
+        run: |
+          brew install libomp
+          # Set DYLD_LIBRARY_PATH to avoid OpenMP conflicts, see https://github.com/unit8co/darts/pull/3050
+          _libomp_path=$(brew --prefix libomp 2>/dev/null)/lib
+          echo "DYLD_LIBRARY_PATH=$_libomp_path:$DYLD_LIBRARY_PATH" >> $GITHUB_ENV
+          unset _libomp_path
+
+      - name: "Install uv"
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.2.1
+        env:
+          CIBW_ARCHS_LINUX: ${{ contains(matrix.os, '-arm') && 'aarch64' || 'x86_64' }}
+          CIBW_ARCHS_MACOS: ${{ matrix.os == 'macos-14' && 'arm64' || 'x86_64' }}
+          CIBW_MANYLINUX_AARCH64_IMAGE: manylinux_2_28
+          CIBW_MUSLLINUX_AARCH64_IMAGE: musllinux_1_2
+          # Pass the cache location to cibuildwheel tests
+          CIBW_BEFORE_TEST: |
+            python -c "import os, shutil; cache_path = os.environ.get('CACHE_PATH', '${{ runner.temp }}/test_data_cache'); home = os.path.expanduser('~'); sklearn_cache = os.path.join(home, 'scikit_learn_data'); os.makedirs(sklearn_cache, exist_ok=True); shutil.copytree(os.path.join(cache_path, 'scikit_learn_data'), sklearn_cache, dirs_exist_ok=True) if os.path.exists(os.path.join(cache_path, 'scikit_learn_data')) else None"
+          CIBW_TEST_COMMAND_MACOS: |
+            python -c "import shap, os, shutil; cache_path = '${{ runner.temp }}/test_data_cache'; shap_cache = os.path.join(os.path.dirname(shap.__file__), 'cached_data'); os.makedirs(shap_cache, exist_ok=True); shutil.copytree(os.path.join(cache_path, 'cached_data'), shap_cache, dirs_exist_ok=True) if os.path.exists(os.path.join(cache_path, 'cached_data')) else None" && pytest -v {project}/tests --import-mode=append
+          CIBW_TEST_COMMAND_LINUX: |
+            python -c "import shap, os, shutil; cache_path = '${{ runner.temp }}/test_data_cache'; shap_cache = os.path.join(os.path.dirname(shap.__file__), 'cached_data'); os.makedirs(shap_cache, exist_ok=True); shutil.copytree(os.path.join(cache_path, 'cached_data'), shap_cache, dirs_exist_ok=True) if os.path.exists(os.path.join(cache_path, 'cached_data')) else None" && pytest -v {project}/tests --import-mode=append
+          CIBW_TEST_COMMAND_WINDOWS: |
+            python -c "import shap, os, shutil; cache_path = r'${{ runner.temp }}\test_data_cache'; shap_cache = os.path.join(os.path.dirname(shap.__file__), 'cached_data'); os.makedirs(shap_cache, exist_ok=True); shutil.copytree(os.path.join(cache_path, 'cached_data'), shap_cache, dirs_exist_ok=True) if os.path.exists(os.path.join(cache_path, 'cached_data')) else None" && pytest -v {project}/tests --import-mode=append
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: ./wheelhouse/*.whl
+          name: bdist_files_${{ matrix.os }}
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      # Ensure all git tags are present so version number is extracted.
+      # https://github.com/actions/checkout/issues/1471
+      # Careful: the "fetch-tags" option to the checkout action is broken
+      # when the workflow is triggered by a tag!
+      # https://github.com/actions/checkout/issues/1467
+      - name: Check out the repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Fetch all tags
+        run: git fetch --tags
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build sdist (pep517)
+        run: |
+          uv build --sdist
+
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdist_files
+          path: dist/*.tar.gz
+
+  publish_test_pypi:
+    name: Publish wheels to TestPyPI
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/shap
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          pattern: bdist_files_*
+          merge-multiple: true
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist_files
+          path: dist
+
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          repository-url: https://test.pypi.org/legacy/
+
+  publish_pypi:
+    name: Publish wheels to PyPI
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    # Only publish tagged releases to PyPI
+    if: startsWith(github.ref, 'refs/tags')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/shap
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          pattern: bdist_files_*
+          merge-multiple: true
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: sdist_files
+          path: dist
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

shap_gpu-0.0.1.dev0/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,86 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+    paths:
+      - "shap/**"
+      - "javascript/**"
+      - "tests/**"
+      - "data/**"
+      - ".github/workflows/codeql-analysis.yml"
+      - "**.py"
+      - "**.js"
+      - "**.cc"
+      - "**.cu"
+      - "**.h"
+  schedule:
+    - cron: '16 9 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'cpp', 'javascript', 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    # - name: Autobuild
+    #   uses: github/codeql-action/autobuild@v2
+
+    - name: Build python package
+      run: |
+        pip install build
+        python -m build
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

shap_gpu-0.0.1.dev0/.github/workflows/run_notebooks.yml

@@ -0,0 +1,41 @@
+name: notebooks
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+    paths:
+      - "shap/**"
+      - "notebooks/**"
+      - ".github/workflows/run_notebooks.yml"
+      - "scripts/**"
+      - "pyproject.toml"
+      - "CMakeLists.txt"
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  # Cancel only PR intermediate builds
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  run_notebooks:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade uv
+          uv pip install --system '.[test,plots,test_notebooks,nbtest]'
+      - name: Run notebooks
+        run: |
+          python scripts/run_notebooks_timeouts.py