mkdocs.yml

site_name: "pyDVL"
site_dir: "docs_build"
site_url: "https://pydvl.org/"
repo_name: "aai-institute/pyDVL"
repo_url: "https://github.com/aai-institute/pyDVL"
copyright: "Copyright © AppliedAI Institute gGmbH"
remote_branch: gh-pages

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - First steps: getting-started/first-steps.md
    - Applications: getting-started/applications.md
    - Benchmarking: getting-started/benchmarking.md
    - Advanced usage: getting-started/advanced-usage.md
  - Data Valuation:
    - value/index.md
    - Leave-One-Out: value/loo.md
    - Shapley values: value/shapley.md
    - Class-wise Shapley: value/classwise-shapley.md
    - Semi-values: value/semi-values.md
    - Beta Shapley: value/beta-shapley.md
    - Data Banzhaf: value/data-banzhaf.md
    - Delta Shapley: value/delta-shapley.md
    - KNN-Shapley: value/knn-shapley.md
    - Group Testing Shapley: value/group-testing-shapley.md
    - Owen-Shapley values: value/owen.md
    - Least Core: value/the-core.md
    - Data-OOB: value/data-oob.md
    - Data Utility Learning: value/dul.md
    - Sampling strategies for semi-values: value/sampling-weights.md
  - The Influence Function:
    - influence/index.md
    - Influence Function Model: influence/influence_function_model.md
    - Scaling Computation: influence/scaling_computation.md
  - Examples:
    - examples/index.md
    - Data Valuation:
        - Shapley values: examples/shapley_basic_spotify.ipynb
        - KNN Shapley: examples/shapley_knn_flowers.ipynb
        - Data utility learning: examples/shapley_utility_learning.ipynb
        - Banzhaf semivalues: examples/msr_banzhaf_digits.ipynb
        - Least Core: examples/least_core_basic.ipynb
        - Data OOB: examples/data_oob.ipynb
    - Influence Function:
      - For CNNs: examples/influence_imagenet.ipynb
      - For mislabeled data: examples/influence_synthetic.ipynb
      - For outlier detection: examples/influence_wine.ipynb
      - For language models: examples/influence_sentiment_analysis.ipynb
  - Code:
    # We use literate-nav to generate the navigation sidebar for the API
    # by leaving the trailing slash. Do not remove it!
    - API Reference:
      - Intro: api/pydvl/
      - Data Valuation:
        - Intro: api/pydvl/valuation/index.md
        - Methods: api/pydvl/valuation/methods/
        - Samplers: api/pydvl/valuation/samplers/
        - Scorers: api/pydvl/valuation/scorers/
        - Utilities: api/pydvl/valuation/utility/
        - Datasets: api/pydvl/valuation/dataset.md
        - Stopping criteria: api/pydvl/valuation/stopping.md
        - Results: api/pydvl/valuation/result.md
        - Internals:
          - Base classes: api/pydvl/valuation/base.md
          - Parallelization: api/pydvl/valuation/parallel.md
          - Test games: api/pydvl/valuation/games.md
          - Types: api/pydvl/valuation/types.md
      - Influence Function: api/pydvl/influence/
      - Reporting: api/pydvl/reporting/
      - Utilities:
        # Manual list to exclude modules deprecated in 0.10.0
        - Intro: api/pydvl/utils/
        - Caching: api/pydvl/utils/caching/
        - Exceptions: api/pydvl/utils/exceptions.md
        - Functional: api/pydvl/utils/functional.md
        - Numeric: api/pydvl/utils/numeric.md
        - Progress: api/pydvl/utils/progress.md
        - Status: api/pydvl/utils/status.md
    - Contributing:
      - CONTRIBUTING.md
      - Changelog: CHANGELOG.md
    - Deprecated API:
      - deprecated/index.md
      - Data Valuation: deprecated/pydvl/value/
      - Parallelization: deprecated/pydvl/parallel/
  - Methods: getting-started/methods.md
  - Glossary: getting-started/glossary.md

watch:
  - src/pydvl
  - notebooks

hooks:
  - build_scripts/copy_notebooks.py
  - build_scripts/copy_changelog.py
  - build_scripts/copy_contributing_guide.py
  - build_scripts/modify_binder_link.py

plugins:
  - pub-debugger:
      file_log:
        enabled: false
      zip_log:
        enabled: false
      console_log:
        enabled: true
        log_level: WARNING
        show_code_link: false
        show_entry_time: false
        show_logger_name: true
        show_deprecation_warnings: false
        #filter_logger_names: ["mkdocs.plugins.griffe"]
  - search
  - autorefs
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - custom-skip-class-name
      auto_caption: true
      caption_position: bottom
  - macros
  - mike:
      canonical_version: stable
  - section-index
  - alias:
      verbose: true
  - gen-files:
      scripts:
        - build_scripts/generate_api_docs.py
  - literate-nav:
      nav_file: SUMMARY.md
      implicit_index: false
      tab_length: 2
  - mknotebooks:
      execute: false
      enable_default_jupyter_cell_styling: false
      tag_remove_configs:
        remove_cell_tags:
          - hide
        remove_input_tags:
          - hide-input
        remove_all_outputs_tags:
          - hide-output
      binder: true
      binder_service_name: "gh"
      binder_branch: "develop"
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
            - https://scikit-learn.org/stable/objects.inv
            - https://pytorch.org/docs/stable/objects.inv
            - https://pymemcache.readthedocs.io/en/latest/objects.inv
            - https://joblib.readthedocs.io/en/stable/objects.inv
            - https://loky.readthedocs.io/en/stable/objects.inv
            - https://docs.dask.org/en/latest/objects.inv
            - https://distributed.dask.org/en/latest/objects.inv
            - https://docs.ray.io/en/latest/objects.inv
          paths: [ src ]  # search packages in the src folder
          options:
            heading_level: 1
            inherited_members: true
            docstring_style: google
            docstring_section_style: spacy
            line_length: 80
            show_bases: true
            members_order: alphabetical
            modernize_annotations: true
            show_submodules: false
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: true
            docstring_options:
              ignore_init_summary: false
            show_symbol_type_toc: true
            show_symbol_type_heading: true
            show_root_full_path: true
            show_root_heading: true
            filters: ["!^_[^_]"]
  - bibtex:
      bib_file: "docs/assets/pydvl.bib"
      csl_file: "docs/assets/elsevier-harvard.csl"
  - git-revision-date-localized:
      enable_creation_date: true
      type: iso_date
      fallback_to_build_date: true
  - social:
      cards: !ENV [CI, True] # only build in CI
theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/signet.svg
  favicon: assets/signet.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - content.tooltips
    - navigation.indexes
    - navigation.instant
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      scheme: default
      primary: teal
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra_css:
  - css/extra.css
  - css/grid-cards.css

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra:
  transferlab:
    website: https://transferlab.ai/
  copyright_link: https://appliedai-institute.de
  version:
    provider: mike
    default: stable
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/aai-institute/pyDVL
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pyDVL/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/aai_transferlab
    - icon: fontawesome/brands/linkedin
      link: https://de.linkedin.com/company/appliedai-institute-for-europe-ggmbh
  analytics:
    provider: simpleanalytics
    hostname: pydvl.org
    script_domain: scripts.simpleanalyticscdn.com
    noscript_domain: queue.simpleanalyticscdn.com
    collect_dnt: true

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - markdown_captions
  - md_in_html
  - codehilite
  - toc:
      permalink: True
      toc_depth: 3
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
      line_spans: __span
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      auto_append:
        - docs_includes/abbreviations.md
  - pymdownx.superfences
  - pymdownx.details