lightning/tests
HT Liu d521c1b178
Fix: gather_all_tensors cross GPUs in DDP (#3319)
* Fix: gather_all_tensors cross GPUs in metrics

* add a test case for gather_all_tensors_ddp in #3253
2020-09-03 12:27:32 +02:00
..
base New modular metric interface (#2528) 2020-08-26 13:01:29 +02:00
callbacks callback method for on_save_checkpoint (#2501) 2020-08-28 16:50:52 +02:00
core ref: move prepare_data to data connector (#3307) 2020-09-01 14:59:09 -04:00
loggers ref: .tune() (temporary) (#3293) 2020-08-31 17:36:09 -04:00
metrics Fix: gather_all_tensors cross GPUs in DDP (#3319) 2020-09-03 12:27:32 +02:00
models bugfix/3185 transpose (#3252) 2020-09-01 09:17:52 -04:00
trainer ref: moving train loop to own object 2/n (intermediate steps) (#3313) 2020-09-01 21:06:40 -04:00
utilities callback method for on_save_checkpoint (#2501) 2020-08-28 16:50:52 +02:00
README.md test dockers & add AMP in pt-1.6 (#1584) 2020-07-31 08:23:13 -04:00
__init__.py changelogs clean (#3082) 2020-08-20 22:58:53 +00:00
collect_env_details.py cleaning (#2030) 2020-06-04 11:25:07 -04:00
conftest.py repair CI for Win (#2358) 2020-06-26 21:38:25 -04:00
install_AMP.sh update GPU to PT 1.5 (#2779) 2020-08-02 08:14:53 -04:00
test_deprecated.py remove deprecated in v0.9 (#2760) 2020-07-30 23:19:28 +02:00
test_profiler.py RC & Docs/changelog (#1776) 2020-05-11 21:57:53 -04:00

README.md

PyTorch-Lightning Tests

Most PL tests train a full MNIST model under various trainer conditions (ddp, ddp2+amp, etc...). This provides testing for most combinations of important settings. The tests expect the model to perform to a reasonable degree of testing accuracy to pass.

Running tests

The automatic travis tests ONLY run CPU-based tests. Although these cover most of the use cases, run on a 2-GPU machine to validate the full test-suite.

To run all tests do the following:

Install Open MPI or another MPI implementation. Learn how to install Open MPI on this page.

git clone https://github.com/PyTorchLightning/pytorch-lightning
cd pytorch-lightning

# install AMP support
bash tests/install_AMP.sh

# install dev deps
pip install -r requirements/devel.txt

# run tests
py.test -v

To test models that require GPU make sure to run the above command on a GPU machine. The GPU machine must have:

  1. At least 2 GPUs.
  2. NVIDIA-apex installed.
  3. Horovod with NCCL support: HOROVOD_GPU_ALLREDUCE=NCCL HOROVOD_GPU_BROADCAST=NCCL pip install horovod

Running Coverage

Make sure to run coverage on a GPU machine with at least 2 GPUs and NVIDIA apex installed.

cd pytorch-lightning

# generate coverage (coverage is also installed as part of dev dependencies under requirements/devel.txt)
coverage run --source pytorch_lightning -m py.test pytorch_lightning tests examples -v

# print coverage stats
coverage report -m

# exporting results
coverage xml

Building test image

You can build it on your own, note it takes lots of time, be prepared.

git clone <git-repository>
docker image build -t pytorch_lightning:devel-torch1.4 -f dockers/cuda-extras/Dockerfile --build-arg TORCH_VERSION=1.4 .

To build other versions, select different Dockerfile.

docker image list
docker run --rm -it pytorch_lightning:devel-torch1.4 bash
docker image rm pytorch_lightning:devel-torch1.4