From fdfd8644f27d68e7efea5063e3b62d844e32f660 Mon Sep 17 00:00:00 2001 From: Ning Date: Tue, 17 Aug 2021 04:18:03 -0700 Subject: [PATCH] Update contributing docs with pointers for legacy checkpoint testing (#8892) --- .github/CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 415b0200f0..f673411636 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -195,6 +195,15 @@ python -m pip install ".[dev, examples]" python -m pip install pre-commit ``` +Additionally, for testing backward compatibility with older versions of PyTorch Lightning, you also need to download all saved version-checkpoints from the public AWS storage. Run the following script to get all saved version-checkpoints: + +```bash +wget https://pl-public-data.s3.amazonaws.com/legacy/checkpoints.zip -P legacy/ +unzip -o legacy/checkpoints.zip -d legacy/ +``` + +Note: These checkpoints are generated to set baselines for maintaining backward compatibility with legacy versions of PyTorch Lightning. Details of checkpoints for back-compatibility can be found [here](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/legacy/README.md). + You can run the full test-case in your terminal via this make script: ```bash