Update contributing docs with pointers for legacy checkpoint testing (#8892)

This commit is contained in:
Ning 2021-08-17 04:18:03 -07:00 committed by GitHub
parent 14f1475c25
commit fdfd8644f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions

View File

@ -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