lightning/tests
Jirka Borovec 41f5df18a4
move Trains logger to Bolts (#2384)
* move Trains logger

* chlog
2020-06-27 09:14:05 -04:00
..
base repair CI for Win (#2358) 2020-06-26 21:38:25 -04:00
callbacks repair CI for Win (#2358) 2020-06-26 21:38:25 -04:00
core Fix summary hook handles not getting removed (#2298) 2020-06-20 07:38:47 -04:00
loggers move Trains logger to Bolts (#2384) 2020-06-27 09:14:05 -04:00
metrics repair CI for Win (#2358) 2020-06-26 21:38:25 -04:00
models repair CI for Win (#2358) 2020-06-26 21:38:25 -04:00
trainer repair CI for Win (#2358) 2020-06-26 21:38:25 -04:00
utilities New metric classes (#1326) (#1877) 2020-05-19 11:05:07 -04:00
Dockerfile clean requirements (#2128) 2020-06-13 10:15:22 -04:00
README.md clean requirements (#2128) 2020-06-13 10:15:22 -04:00
__init__.py default test logger (#1478) 2020-04-21 20:33:10 -04: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
test_deprecated.py Add missing test for "multiple dataloader + percent_check fix" (#2226) 2020-06-23 11:21:24 -04: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-pt_1_4 -f tests/Dockerfile --build-arg TORCH_VERSION=1.4 .

To build other versions, select different Dockerfile.

docker image list
docker run --rm -it pytorch_lightning:devel-pt_1_4 bash
docker image rm pytorch_lightning:devel-pt_1_4