lightning/.github/workflows
awaelchli 2254bfee19 cheat 2024-07-01 02:13:03 +02:00
..
README.md Remove the Graphcore IPU integration (#19405) 2024-02-12 16:16:02 -05:00
_build-packages.yml Bump actions/setup-python from 4 to 5 (#19136) 2024-01-09 08:33:09 -05:00
_flagship-apps.yml Bump actions/checkout from 3 to 4 +TPU (#18518) 2023-10-03 21:42:18 +02:00
_legacy-checkpoints.yml Bump peter-evans/create-pull-request from 5 to 6 (#19407) 2024-02-06 12:04:25 +01:00
call-clear-cache.yml build(deps): bump Lightning-AI/utilities from 0.11.0 to 0.11.2 (#19719) 2024-04-01 10:38:05 -04:00
ci-check-md-links.yml build(deps): bump Lightning-AI/utilities from 0.11.0 to 0.11.2 (#19719) 2024-04-01 10:38:05 -04:00
ci-checkpoints.yml ci: adding missing requirements for generating legacy ckpt (#19353) 2024-01-28 11:22:07 +01:00
ci-examples-app.yml Add support for batch stop (#20017) 2024-06-26 17:20:10 +01:00
ci-flagship-apps.yml ci: cancel-in-progress if PR (#19204) 2023-12-21 17:49:18 -05:00
ci-pkg-install.yml ci: pin `pytest` for package doctests (#19567) 2024-03-04 15:09:04 +01:00
ci-rtfd.yml updating CI readme (#18443) 2023-08-31 23:53:43 +02:00
ci-schema.yml build(deps): bump Lightning-AI/utilities from 0.11.0 to 0.11.2 (#19719) 2024-04-01 10:38:05 -04:00
ci-tests-app.yml Add support for batch stop (#20017) 2024-06-26 17:20:10 +01:00
ci-tests-fabric.yml Drop PyTorch 2.0 from the test matrix (#20009) 2024-06-30 18:02:00 -04:00
ci-tests-pytorch.yml Drop PyTorch 2.0 from the test matrix (#20009) 2024-06-30 18:02:00 -04:00
ci-tests-store.yml Bump codecov/codecov-action from 3 to 4 (#19406) 2024-02-26 11:19:10 -05:00
cleanup-caches.yml Bump actions/checkout from 3 to 4 +TPU (#18518) 2023-10-03 21:42:18 +02:00
code-checks.yml Bump actions/cache from 3 to 4 (#19323) 2024-02-16 18:33:16 +01:00
docker-build.yml Drop PyTorch 2.0 from the test matrix (#20009) 2024-06-30 18:02:00 -04:00
docs-build.yml ci/docs: enable dispatch build without warning as errors (#19948) 2024-06-05 12:32:36 -04:00
docs-tutorials.yml Bump peter-evans/create-pull-request from 5 to 6 (#19407) 2024-02-06 12:04:25 +01:00
labeler-issue.yml Bump redhat-plumbers-in-action/advanced-issue-labeler from 2 to 3 (#19104) 2023-12-13 07:35:17 +01:00
labeler-pr.yml Bump actions/labeler from 4 to 5 (#19135) 2023-12-13 09:11:01 +01:00
probot-auto-cc.yml Change probot workflow source (#15492) 2022-11-03 15:10:55 +01:00
probot-check-group.yml Update probot-check-group.yml to v5.4 (#18782) 2023-10-11 18:10:02 +02:00
release-nightly.yml ci: disable package freeze for nightly pkgs (#19688) 2024-03-22 21:55:04 -04:00
release-pkg.yml ci: releasing `lightning` nighties (#19661) 2024-03-17 13:49:35 +01:00
tpu-tests.yml cheat 2024-07-01 02:13:03 +02:00

README.md

Continuous Integration and Delivery

Brief description of all our automation tools used for boosting development performances.

Unit and Integration Testing

workflow file action accelerator
.github/workflows/ci-tests-app.yml Run all tests (may need internet connectivity). CPU
.github/workflows/ci-tests-fabric.yml Run all tests except for accelerator-specific and standalone. CPU
.github/workflows/ci-tests-pytorch.yml Run all tests except for accelerator-specific and standalone. CPU
.github/workflows/ci-tests-data.yml Run unit and integration tests with data pipelining. CPU
.github/workflows/ci-tests-store.yml Run integration tests on uploading models to cloud. CPU
.azure-pipelines/gpu-tests-fabric.yml Run only GPU-specific tests, standalone*, and examples. GPU
.azure-pipelines/gpu-tests-pytorch.yml Run only GPU-specific tests, standalone*, and examples. GPU
.azure-pipelines/gpu-benchmarks.yml Run speed/memory benchmarks for parity with vanila PyTorch. GPU
.github/workflows/ci-examples-app.yml Run integration tests with App examples. CPU
.github/workflows/ci-flagship-apps.yml Run end-2-end tests with full applications, including deployment to the production cloud. CPU
.github/workflows/ci-tests-pytorch.yml Run all tests except for accelerator-specific, standalone and slow tests. CPU
.github/workflows/tpu-tests.yml Run only TPU-specific tests. Requires that the PR title contains '[TPU]' TPU

* Each standalone test needs to be run in separate processes to avoid unwanted interactions between test cases.

  • Accelerators used in CI

  • To check which versions of Python or PyTorch are used for testing in our CI, see the corresponding workflow files or checkgroup config file at .github/checkgroup.yml.

Documentation

workflow file action
.github/workflows/docs-build.yml Run doctest, linkcheck and full HTML build.
.github/workflows/ci-rtfd.yml Append link to the PR description with temporaty ReadTheDocs build docs.
.github/workflows/ci-check-md-links.yml
.github/markdown.links.config.json
Validate links in markdown files.

Code Quality

workflow file action
.codecov.yml Measure test coverage with codecov.io
.github/workflows/code-checks.yml Check Python typing with MyPy.
.github/workflows/ci-schema.yml Validate the syntax of workflow files.

Others

workflow file action
.github/workflows/docker-build.yml Build docker images used for testing in CI. If run on nightly schedule, push to the Docker Hub.
.github/workflows/ci-pkg-install.yml Test if pytorch-lightning is successfully installed using pip.
.github/workflows/ci-checkpoints.yml Build checkpoints that are will be tested on release to ensure backwards-compatibility

The published Docker Hub project is https://hub.docker.com/r/pytorchlightning/pytorch_lightning.

Deployment

workflow file action
.github/workflows/docs-build.yml Build the docs for each project and puch it to GCS with automatics deployment.
.github/workflows/docker-build.yml Build docker images used for releases and push them to the Docker Hub.
.github/workflows/release-pkg.yml Publish a release to PyPI and upload to the GH release page as artifact.
.github/workflows/_legacy-checkpoints.yml Add on request generate legacy checkpoints and upload them to AWS S3.

Bots

workflow file action
.github/mergify.yml Label PRs as conflicts or ready, and request reviews if needed.
.github/stale.yml Close inactive issues/PRs sometimes after adding the "won't fix" label to them.
.github/workflows/probot-auto-cc.yml
.github/lightning-probot.yml
Notify maintainers of interest depending on labels added to an issue We utilize lightning-probot forked from PyTorchs probot.
.github/workflows/probot-check-group.yml
.github/checkgroup.yml
Checks whether the relevant jobs were successfully run based on the changed files in the PR
.pre-commit-config.yaml It applies a set of linters and formatters and can be registered with your local dev. If needed bot pushc changes to each PRs.
.github/workflows/labeler-pr.yml, .github/label-change.yml Integration of https://github.com/actions/labeler
.github/workflows/labeler-issue.yml Parse user provided lightning version and set it as label.