lightning/.github/checkgroup.yml

custom_service_name: "Lightning CI required checker"
# For security reasons, configuration is only loaded from the repository's default branch,
# changes made in pull requests from different branches or forks are ignored. This means that changes to this file
# will only be used after they are merged.
subprojects:

  # SECTION: pytorch_lightning

  - id: "pytorch_lightning"
    paths:
      # all examples don't need to be added because they aren't used in CI, but these are
      - "examples/run_ddp_examples.sh"
      - "examples/convert_from_pt_to_pl/**"
      - "examples/run_pl_examples.sh"
      - "examples/pl_basics/backbone_image_classifier.py"
      - "examples/pl_basics/autoencoder.py"
      - "examples/pl_loops/mnist_lite.py"
      - "examples/pl_fault_tolerant/automatic.py"
      - "examples/test_pl_examples.py"
      - "examples/pl_integrations/dali_image_classifier.py"
      - "requirements/pytorch/**"
      - "src/pytorch_lightning/**"
      - "tests/tests_pytorch/**"
      - "setup.cfg"  # includes pytest config
      - ".actions/**"
    checks:
      # Note: updates here should be applied to the lightning_lite group
      - "pl-cpu (macOS-11, pytorch, 3.9, 1.11)"
      - "pl-cpu (macOS-11, pytorch, 3.8, 1.10)"
      - "pl-cpu (windows-2022, pytorch, 3.10, 1.11)"
      - "pl-cpu (windows-2022, pytorch, 3.9, 1.10)"
      - "pl-cpu (windows-2022, pytorch, 3.8, 1.9)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.8, 1.11)"
      - "pl-cpu (macOS-11, pytorch, 3.10, 1.12)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.10, 1.12)"
      - "pl-cpu (windows-2022, pytorch, 3.10, 1.12)"
      - "pl-cpu (macOS-11, pytorch, 3.7, 1.9, oldest)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.7, 1.9, oldest)"
      - "pl-cpu (windows-2022, pytorch, 3.7, 1.9, oldest)"
      - "pl-cpu (macOS-11, pytorch, 3.10, 1.13, pre)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.9, 1.13, pre)"
      - "pl-cpu (windows-2022, pytorch, 3.8, 1.13, pre)"
      - "make-doctest (pytorch)"
      - "make-html (pytorch)"
      - "mypy"
      - "pytorch-lightning (GPUs)"
      - "pytorch-lightning (HPUs)"
      - "pytorch-lightning (IPUs)"
      - "pl-slow (macOS-11, 3.7, 1.11)"
      - "pl-slow (ubuntu-20.04, 3.7, 1.11)"
      - "pl-slow (windows-2022, 3.7, 1.11)"
      # TODO: since this job has intermittent availability, it cannot be required or it will block all PL PRs from forks
      #- "test-on-tpus"

  - id: "pytorch_lightning: CPU"
    paths:
      - ".github/workflows/ci-pytorch-tests.yml"
    checks:
      - "pl-cpu (macOS-11, pytorch, 3.9, 1.11)"
      - "pl-cpu (macOS-11, pytorch, 3.8, 1.10)"
      - "pl-cpu (windows-2022, pytorch, 3.10, 1.11)"
      - "pl-cpu (windows-2022, pytorch, 3.9, 1.10)"
      - "pl-cpu (windows-2022, pytorch, 3.8, 1.9)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.8, 1.11)"
      - "pl-cpu (macOS-11, pytorch, 3.10, 1.12)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.10, 1.12)"
      - "pl-cpu (windows-2022, pytorch, 3.10, 1.12)"
      - "pl-cpu (macOS-11, pytorch, 3.7, 1.9, oldest)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.7, 1.9, oldest)"
      - "pl-cpu (windows-2022, pytorch, 3.7, 1.9, oldest)"
      - "pl-cpu (macOS-11, pytorch, 3.10, 1.13, pre)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.9, 1.13, pre)"
      - "pl-cpu (windows-2022, pytorch, 3.8, 1.13, pre)"

  - id: "pytorch_lightning: Slow"
    paths:
      - ".github/workflows/ci-pytorch-tests-slow.yml"
    checks:
      - "pl-slow (macOS-11, 3.7, 1.11)"
      - "pl-slow (ubuntu-20.04, 3.7, 1.11)"
      - "pl-slow (windows-2022, 3.7, 1.11)"

  - id: "pytorch_lightning: Azure GPU"
    paths:
      - ".azure/gpu-tests-pytorch.yml"
      - "tests/tests_pytorch/run_standalone_*.sh"
    checks:
      - "pytorch-lightning (GPUs)"

  - id: "pytorch_lightning: Azure HPU"
    paths:
      - ".azure/hpu-tests.yml"
    checks:
      - "pytorch-lightning (HPUs)"

  - id: "pytorch_lightning: Azure IPU"
    paths:
      - ".azure/ipu-tests.yml"
    checks:
      - "pytorch-lightning (IPUs)"

  - id: "pytorch-lightning: TPU"
    paths:
      - ".github/workflows/tpu-tests.yml"
    checks:
      - "test-on-tpus"

  - id: "pytorch_lightning: Docs"
    paths:
      - "docs/source-pytorch/**"
      - ".github/workflows/docs-*.yml"
      - "requirements/docs.txt"
      - "requirements/pytorch/**"
    checks:
      - "make-doctest (pytorch)"
      - "make-html (pytorch)"

  - id: "pytorch_lightning: Docker"
    paths:
      - "dockers/**"
      - ".github/workflows/ci-pytorch-dockers.yml"
      - "requirements.txt"
      - "requirements/*.txt"
      - "requirements/pytorch/*"
      - "environment.yml"
      - ".github/workflows/*docker*.yml"
      - "setup.py"
      - ".actions/**"
    checks:
      - "build-cuda (3.8, 1.9, 11.1.1)"
      - "build-cuda (3.9, 1.10, 11.3.1)"
      - "build-cuda (3.9, 1.11, 11.3.1)"
      - "build-cuda (3.9, 1.12, 11.6.1)"
      - "build-cuda (3.9, 1.9, 11.1.1)"
      - "build-hpu (1.5.0, 1.11.0)"
      - "build-ipu (3.9, 1.9)"
      - "build-NGC"
      - "build-pl (3.9, 1.10, 11.3.1)"
      - "build-pl (3.9, 1.11, 11.3.1)"
      - "build-pl (3.9, 1.12, 11.6.1)"
      - "build-pl (3.9, 1.9, 11.1.1)"
      - "build-xla (3.7, 1.12)"

  # SECTION: lightning_lite

  - id: "lightning_lite"
    paths:
      - "requirements/lite/**"
      - "src/lightning_lite/**"
      - "setup.cfg"  # includes pytest config
      - ".actions/**"
    checks:
      - "lite-cpu (macOS-11, lite, 3.7, latest, stable)"
      - "lite-cpu (macOS-11, lite, 3.7, oldest, stable)"
      - "lite-cpu (macOS-11, lite, 3.8, latest, stable)"
      - "lite-cpu (macOS-11, lite, 3.8, oldest, stable)"
      - "lite-cpu (macOS-11, lite, 3.9, latest, stable)"
      - "lite-cpu (macOS-11, lite, 3.10, latest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.7, latest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.7, oldest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.8, latest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.8, oldest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.9, latest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.10, latest, stable)"
      - "lite-cpu (windows-2022, lite, 3.7, latest, stable)"
      - "lite-cpu (windows-2022, lite, 3.7, oldest, stable)"
      - "lite-cpu (windows-2022, lite, 3.8, latest, stable)"
      - "lite-cpu (windows-2022, lite, 3.8, oldest, stable)"
      - "lite-cpu (windows-2022, lite, 3.9, latest, stable)"
      - "lite-cpu (windows-2022, lite, 3.10, latest, stable)"
      - "lightning-lite (GPUs)"
      - "mypy"
      # Lite also requires PL checks as it depends on Lite
      - "pl-cpu (macOS-11, pytorch, 3.9, 1.11)"
      - "pl-cpu (macOS-11, pytorch, 3.8, 1.10)"
      - "pl-cpu (windows-2022, pytorch, 3.10, 1.11)"
      - "pl-cpu (windows-2022, pytorch, 3.9, 1.10)"
      - "pl-cpu (windows-2022, pytorch, 3.8, 1.9)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.8, 1.11)"
      - "pl-cpu (macOS-11, pytorch, 3.10, 1.12)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.10, 1.12)"
      - "pl-cpu (windows-2022, pytorch, 3.10, 1.12)"
      - "pl-cpu (macOS-11, pytorch, 3.7, 1.9, oldest)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.7, 1.9, oldest)"
      - "pl-cpu (windows-2022, pytorch, 3.7, 1.9, oldest)"
      - "pl-cpu (macOS-11, pytorch, 3.10, 1.13, pre)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.9, 1.13, pre)"
      - "pl-cpu (windows-2022, pytorch, 3.8, 1.13, pre)"
      - "make-doctest (pytorch)"
      - "make-html (pytorch)"
      - "pytorch-lightning (GPUs)"
      - "pl-slow (macOS-11, 3.7, 1.11)"
      - "pl-slow (ubuntu-20.04, 3.7, 1.11)"
      - "pl-slow (windows-2022, 3.7, 1.11)"
      #- "test-on-tpus"

  - id: "lightning_lite: Tests"
    paths:
      - "tests/tests_lite/**"
    checks:
      - "lite-cpu (macOS-11, lite, 3.7, latest, stable)"
      - "lite-cpu (macOS-11, lite, 3.7, oldest, stable)"
      - "lite-cpu (macOS-11, lite, 3.8, latest, stable)"
      - "lite-cpu (macOS-11, lite, 3.8, oldest, stable)"
      - "lite-cpu (macOS-11, lite, 3.9, latest, stable)"
      - "lite-cpu (macOS-11, lite, 3.10, latest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.7, latest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.7, oldest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.8, latest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.8, oldest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.9, latest, stable)"
      - "lite-cpu (ubuntu-20.04, lite, 3.10, latest, stable)"
      - "lite-cpu (windows-2022, lite, 3.7, latest, stable)"
      - "lite-cpu (windows-2022, lite, 3.7, oldest, stable)"
      - "lite-cpu (windows-2022, lite, 3.8, latest, stable)"
      - "lite-cpu (windows-2022, lite, 3.8, oldest, stable)"
      - "lite-cpu (windows-2022, lite, 3.9, latest, stable)"
      - "lite-cpu (windows-2022, lite, 3.10, latest, stable)"
      - "lightning-lite (GPUs)"

  - id: "lightning_lite: Azure GPU"
    paths:
      - ".azure/gpu-tests-lite.yml"
      - "tests/tests_lite/run_standalone_*.sh"
      - "tests/tests_pytorch/run_standalone_tests.sh"  # used by Lite through a symlink
    checks:
      - "lightning-lite (GPUs)"

  # SECTION: lightning_app

  - id: "lightning_app"
    paths:
      - "requirements/app/**"
      - "src/lightning_app/**"
      - "tests/tests_app/**"
      - "tests/tests_app_examples/**"
      # the examples are used in the app CI
      - "examples/app_*"
      - ".actions/**"
    checks:
      - "App.cloud-e2e"
      - "make-doctest (app)"
      - "make-html (app)"
      - "app-examples (macOS-11, app, 3.8, latest)"
      - "app-examples (macOS-11, app, 3.8, oldest)"
      - "app-examples (ubuntu-20.04, app, 3.8, latest)"
      - "app-examples (ubuntu-20.04, app, 3.8, oldest)"
      - "app-examples (windows-2022, app, 3.8, latest)"
      - "app-examples (windows-2022, app, 3.8, oldest)"
      - "app-pytest (macOS-11, app, 3.8, latest)"
      - "app-pytest (macOS-11, app, 3.8, oldest)"
      - "app-pytest (ubuntu-20.04, app, 3.8, latest)"
      - "app-pytest (ubuntu-20.04, app, 3.8, oldest)"
      - "app-pytest (windows-2022, app, 3.8, latest)"
      - "app-pytest (windows-2022, app, 3.8, oldest)"

  - id: "lightning_app: Azure"
    paths:
      - ".azure/app-cloud-e2e.yml"
    checks:
      - "App.cloud-e2e"

  - id: "lightning_app: Docs"
    paths:
      - "docs/source-app/**"
      - ".github/workflows/docs-*.yml"
      - "requirements/docs.txt"
      - "requirements/app/**"
    checks:
      - "make-doctest (app)"
      - "make-html (app)"

  # SECTION: common

  - id: "mypy"
    paths:
      - ".github/workflows/code-checks.yml"
      - "pyproject.toml"  # includes mypy config
    checks:
      - "mypy"

  - id: "install"
    paths:
      - ".actions/**"
      - ".github/workflows/ci-pkg-install.yml"
      - "setup.py"
      - "src/**"
      - "requirements/**"
    checks:
      - "install-pkg (ubuntu-22.04, app, 3.7)"
      - "install-pkg (ubuntu-22.04, app, 3.10)"
      - "install-pkg (ubuntu-22.04, lite, 3.7)"
      - "install-pkg (ubuntu-22.04, lite, 3.10)"
      - "install-pkg (ubuntu-22.04, pytorch, 3.7)"
      - "install-pkg (ubuntu-22.04, pytorch, 3.10)"
      - "install-pkg (macOS-12, app, 3.7)"
      - "install-pkg (macOS-12, app, 3.10)"
      - "install-pkg (macOS-12, lite, 3.7)"
      - "install-pkg (macOS-12, lite, 3.10)"
      - "install-pkg (macOS-12, pytorch, 3.7)"
      - "install-pkg (macOS-12, pytorch, 3.10)"
      - "install-pkg (windows-2022, app, 3.7)"
      - "install-pkg (windows-2022, app, 3.10)"
      - "install-pkg (windows-2022, lite, 3.7)"
      - "install-pkg (windows-2022, lite, 3.10)"
      - "install-pkg (windows-2022, pytorch, 3.7)"
      - "install-pkg (windows-2022, pytorch, 3.10)"