lightning/.github/checkgroup.yml

custom_service_name: "Lightning CI required checker"
subprojects:
  # SECTION: pytorch_lightning

  - id: "pytorch_lightning: Tests workflow"
    paths:
      - ".actions/*"
      - ".github/workflows/ci-tests-pytorch.yml"
      - "requirements/fabric/**"
      - "src/lightning/fabric/**"
      - "src/lightning_fabric/*"
      - "requirements/pytorch/**"
      - "src/lightning/pytorch/**"
      - "src/pytorch_lightning/*"
      - "tests/tests_pytorch/**"
      - "tests/legacy/**"
      - "pyproject.toml" # includes pytest config
      - "!requirements/*/docs.txt"
      - "!*.md"
      - "!**/*.md"
    checks:
      - "pl-cpu (macOS-13, lightning, 3.8, 2.1, oldest)"
      - "pl-cpu (macOS-14, lightning, 3.10, 2.1)"
      - "pl-cpu (macOS-14, lightning, 3.10, 2.2)"
      - "pl-cpu (macOS-14, lightning, 3.10, 2.3)"
      - "pl-cpu (ubuntu-20.04, lightning, 3.8, 2.1, oldest)"
      - "pl-cpu (ubuntu-20.04, lightning, 3.10, 2.1)"
      - "pl-cpu (ubuntu-20.04, lightning, 3.10, 2.2)"
      - "pl-cpu (ubuntu-20.04, lightning, 3.10, 2.3)"
      - "pl-cpu (windows-2022, lightning, 3.8, 2.1, oldest)"
      - "pl-cpu (windows-2022, lightning, 3.10, 2.1)"
      - "pl-cpu (windows-2022, lightning, 3.10, 2.2)"
      - "pl-cpu (windows-2022, lightning, 3.10, 2.3)"
      - "pl-cpu (macOS-14, pytorch, 3.8, 2.1)"
      - "pl-cpu (ubuntu-20.04, pytorch, 3.8, 2.1)"
      - "pl-cpu (windows-2022, pytorch, 3.8, 2.1)"
      - "pl-cpu (macOS-12, pytorch, 3.11, 2.1)"
      - "pl-cpu (ubuntu-22.04, pytorch, 3.11, 2.1)"
      - "pl-cpu (windows-2022, pytorch, 3.11, 2.1)"

  - id: "pytorch_lightning: Azure GPU"
    paths:
      - ".actions/*"
      - ".azure/gpu-tests-pytorch.yml"
      # only the azure GPU workflow runs the examples
      # all examples don't need to be added because they aren't used in CI, but these are
      - "examples/run_pl_examples.sh"
      - "examples/pytorch/basics/backbone_image_classifier.py"
      - "examples/pytorch/basics/autoencoder.py"
      - "requirements/pytorch/**"
      - "src/lightning/__init__.py"
      - "src/lightning/__setup__.py"
      - "src/lightning/__version__.py"
      - "src/lightning/pytorch/**"
      - "src/pytorch_lightning/*"
      - "tests/tests_pytorch/**"
      - "tests/run_standalone_*.sh"
      - "pyproject.toml" # includes pytest config
      - "requirements/fabric/**"
      - "src/lightning/fabric/**"
      - "src/lightning_fabric/*"
      - "!requirements/docs.txt"
      - "!requirements/*/docs.txt"
      - "!*.md"
      - "!**/*.md"
    checks:
      - "pytorch-lightning (GPUs) (testing Lightning | latest)"
      - "pytorch-lightning (GPUs) (testing PyTorch | latest)"

  - id: "pytorch_lightning: Benchmarks"
    paths:
      - ".azure/gpu-benchmarks.yml"
      - "requirements/fabric/**"
      - "requirements/pytorch/**"
      - "src/lightning/fabric/**"
      - "src/lightning/pytorch/**"
      - "tests/parity_fabric/**"
      - "tests/parity_pytorch/**"
      - "!requirements/fabric/docs.txt"
      - "!requirements/pytorch/docs.txt"
      - "!*.md"
      - "!**/*.md"
    checks:
      - "lightning.Benchmarks"

  - id: "pytorch-lightning: TPU workflow"
    paths:
      # tpu CI availability is very limited, so we only require tpu tests
      # to pass when their configurations are modified
      - ".github/workflows/tpu-tests.yml"
      - "tests/tests_pytorch/run_tpu_tests.sh"
    checks:
      - "test-on-tpus (pytorch, pjrt, v4-8)"

  - id: "fabric: Docs"
    paths:
      - "src/lightning/fabric/**"
      - "src/lightning_fabric/*"
      - "docs/source-fabric/**"
      - ".github/workflows/docs-build.yml"
      - "requirements/docs.txt"
      - "requirements/fabric/**"
      - "setup.py"
      - "pyproject.toml" # includes metadata used in the package creation
      - "!*.md"
      - "!**/*.md"
    checks:
      - "docs-make (fabric, doctest)"
      - "docs-make (fabric, html)"

  - id: "pytorch_lightning: Docs"
    paths:
      - "src/lightning/pytorch/**"
      - "src/pytorch_lightning/*"
      - "docs/source-pytorch/**"
      - "_notebooks"
      - ".actions/*"
      - ".github/workflows/docs-build.yml"
      - "requirements/docs.txt"
      - "requirements/pytorch/**"
      - "setup.py"
      - "pyproject.toml" # includes metadata used in the package creation
      - "!*.md"
      - "!**/*.md"
    checks:
      - "docs-make (pytorch, doctest)"
      - "docs-make (pytorch, html)"

  - id: "pytorch_lightning: Docker"
    paths:
      - ".actions/*"
      - ".github/workflows/docker-build.yml"
      - "dockers/**"
      - "requirements/pytorch/**"
      - "requirements/fabric/**"
      - "setup.py"
      - "!requirements/*/docs.txt"
      - "!*.md"
      - "!**/*.md"
    checks:
      - "build-cuda (3.10, 2.1, 12.1.0)"
      - "build-cuda (3.10, 2.2, 12.1.0)"
      - "build-cuda (3.11, 2.1, 12.1.0)"
      - "build-cuda (3.11, 2.2, 12.1.0)"
      - "build-cuda (3.11, 2.3, 12.1.0)"
      - "build-cuda (3.11, 2.4, 12.1.0)"
      #- "build-NGC"
      - "build-pl (3.10, 2.1, 12.1.0)"
      - "build-pl (3.10, 2.2, 12.1.0)"
      - "build-pl (3.11, 2.1, 12.1.0)"
      - "build-pl (3.11, 2.2, 12.1.0)"
      - "build-pl (3.11, 2.3, 12.1.0)"
      - "build-pl (3.11, 2.4, 12.1.0)"

  # SECTION: lightning_fabric

  - id: "lightning_fabric: CPU workflow"
    paths:
      - ".actions/*"
      - "requirements/fabric/**"
      - "src/lightning/fabric/**"
      - "src/lightning_fabric/*"
      - "tests/tests_fabric/**"
      - "pyproject.toml" # includes pytest config
      - ".github/workflows/ci-tests-fabric.yml"
      - "!requirements/*/docs.txt"
      - "!*.md"
      - "!**/*.md"
    checks:
      - "fabric-cpu (macOS-13, lightning, 3.8, 2.1, oldest)"
      - "fabric-cpu (macOS-14, lightning, 3.11, 2.1)"
      - "fabric-cpu (macOS-14, lightning, 3.11, 2.2)"
      - "fabric-cpu (macOS-14, lightning, 3.10, 2.3)"
      - "fabric-cpu (ubuntu-20.04, lightning, 3.8, 2.1, oldest)"
      - "fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.1)"
      - "fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.2)"
      - "fabric-cpu (ubuntu-20.04, lightning, 3.11, 2.3)"
      - "fabric-cpu (windows-2022, lightning, 3.8, 2.1, oldest)"
      - "fabric-cpu (windows-2022, lightning, 3.11, 2.1)"
      - "fabric-cpu (windows-2022, lightning, 3.11, 2.2)"
      - "fabric-cpu (windows-2022, lightning, 3.11, 2.3)"
      - "fabric-cpu (macOS-14, fabric, 3.8, 2.1)"
      - "fabric-cpu (ubuntu-20.04, fabric, 3.8, 2.1)"
      - "fabric-cpu (windows-2022, fabric, 3.8, 2.1)"
      - "fabric-cpu (macOS-12, fabric, 3.11, 2.1)"
      - "fabric-cpu (ubuntu-22.04, fabric, 3.11, 2.1)"
      - "fabric-cpu (windows-2022, fabric, 3.11, 2.1)"

  - id: "lightning_fabric: Azure GPU"
    paths:
      - ".actions/*"
      - ".azure/gpu-tests-fabric.yml"
      - "examples/fabric/**"
      - "examples/run_fabric_examples.sh"
      - "requirements/fabric/**"
      - "src/lightning/__init__.py"
      - "src/lightning/__setup__.py"
      - "src/lightning/__version__.py"
      - "src/lightning/fabric/**"
      - "src/lightning_fabric/*"
      - "tests/tests_fabric/**"
      - "tests/run_standalone_*.sh"
      - "pyproject.toml" # includes pytest config
      - "!requirements/*/docs.txt"
      - "!*.md"
      - "!**/*.md"
    checks:
      - "lightning-fabric (GPUs) (testing Fabric | latest)"
      - "lightning-fabric (GPUs) (testing Lightning | latest)"

  - id: "lightning_fabric: TPU workflow"
    paths:
      # tpu CI availability is very limited, so we only require tpu tests
      # to pass when their configurations are modified
      - ".github/workflows/tpu-tests.yml"
      - "tests/tests_fabric/run_tpu_tests.sh"
    checks:
      - "test-on-tpus (pytorch, pjrt, v4-8)"

  # SECTION: common

  - id: "mypy"
    paths:
      - ".actions/*"
      - ".github/workflows/code-checks.yml"
      - "requirements/**"
      - "src/**"
      - "pyproject.toml" # includes mypy config
      - "!requirements/docs.txt"
      - "!requirements/*/docs.txt"
      - "!*.md"
      - "!**/*.md"
    checks:
      - "mypy"

  - id: "install"
    paths:
      - ".actions/*"
      - ".github/actions/pkg-check/*"
      - ".github/actions/pkg-install/*"
      - ".github/workflows/_build-packages.yml"
      - ".github/workflows/ci-pkg-install.yml"
      - "setup.py"
      - "src/**"
      - "requirements/**"
      - "!requirements/docs.txt"
      - "!requirements/*/docs.txt"
      - "!*.md"
      - "!**/*.md"
    checks:
      - "install-pkg (ubuntu-22.04, fabric, 3.8)"
      - "install-pkg (ubuntu-22.04, fabric, 3.11)"
      - "install-pkg (ubuntu-22.04, pytorch, 3.8)"
      - "install-pkg (ubuntu-22.04, pytorch, 3.11)"
      - "install-pkg (ubuntu-22.04, lightning, 3.8)"
      - "install-pkg (ubuntu-22.04, lightning, 3.11)"
      - "install-pkg (ubuntu-22.04, notset, 3.8)"
      - "install-pkg (ubuntu-22.04, notset, 3.11)"
      - "install-pkg (macOS-12, fabric, 3.8)"
      - "install-pkg (macOS-12, fabric, 3.11)"
      - "install-pkg (macOS-12, pytorch, 3.8)"
      - "install-pkg (macOS-12, pytorch, 3.11)"
      - "install-pkg (macOS-12, lightning, 3.8)"
      - "install-pkg (macOS-12, lightning, 3.11)"
      - "install-pkg (macOS-12, notset, 3.8)"
      - "install-pkg (macOS-12, notset, 3.11)"
      - "install-pkg (windows-2022, fabric, 3.8)"
      - "install-pkg (windows-2022, fabric, 3.11)"
      - "install-pkg (windows-2022, pytorch, 3.8)"
      - "install-pkg (windows-2022, pytorch, 3.11)"
      - "install-pkg (windows-2022, lightning, 3.8)"
      - "install-pkg (windows-2022, lightning, 3.11)"
      - "install-pkg (windows-2022, notset, 3.8)"
      - "install-pkg (windows-2022, notset, 3.11)"