Test netlify

.circleci/config.yml

@@ -4,7 +4,11 @@ parameters:
   pytorch_stable_image:
     type: string
     # https://hub.docker.com/r/pytorch/pytorch/tags
-    default: "pytorch/pytorch:1.5-cuda10.1-cudnn7-runtime"
+    default: "pytorch/pytorch:1.6.0-cuda10.1-cudnn7-runtime"
+  pytorch_stable_image_devel:
+    type: string
+    # https://hub.docker.com/r/pytorch/pytorch/tags
+    default: "pytorch/pytorch:1.6.0-cuda10.1-cudnn7-devel"
   workingdir:
     type: string
     default: "/tmp/ignite"
@@ -40,6 +44,12 @@ pull_pytorch_stable_image: &pull_pytorch_stable_image
       command: |
         docker pull << pipeline.parameters.pytorch_stable_image >>
 
+pull_pytorch_stable_devel_image: &pull_pytorch_stable_devel_image
+  - run:
+      name: Pull PyTorch Stable Develop Image
+      command: |
+        docker pull << pipeline.parameters.pytorch_stable_image_devel >>
+
 
 run_pytorch_container: &run_pytorch_container
   - run:
@@ -51,6 +61,17 @@ run_pytorch_container: &run_pytorch_container
         docker exec -it pthd nvidia-smi
         docker exec -it pthd ls
 
+
+run_pytorch_devel_container: &run_pytorch_devel_container
+  - run:
+      name: Start Pytorch dev container
+      environment:
+        wd: << pipeline.parameters.workingdir >>
+      command: |
+        docker run --gpus=all --rm -itd --shm-size 16G -v ${wd}:/ignite -w /ignite --name pthd << pipeline.parameters.pytorch_stable_image_devel >>
+        docker exec -it pthd nvidia-smi
+        docker exec -it pthd ls
+
 install_dependencies: &install_dependencies
   - run:
       name: Install dependencies
@@ -194,6 +215,68 @@ jobs:
             docker exec -it pthd /bin/bash -c "${test_cmd} --num_epochs=7 ${resume_opt}"
 
 
+  two_gpus_hvd_tests:
+    <<: *two_gpus
+
+    working_directory: << pipeline.parameters.workingdir >>
+
+    steps:
+      - checkout
+      - <<: *pull_pytorch_stable_devel_image
+      - <<: *run_pytorch_devel_container
+      - <<: *install_dependencies
+      - run:
+          name: "Install Horovod with NCCL GPU ops"
+          command: |
+
+            # Following https://github.com/horovod/horovod/blob/master/Dockerfile.test.gpu
+            # and https://github.com/horovod/horovod/issues/1944#issuecomment-628192778
+            docker exec -it pthd /bin/bash -c "apt-get update && apt-get install -y git"
+            docker exec -it pthd /bin/bash -c "git clone --recursive https://github.com/horovod/horovod.git /horovod && cd /horovod && python setup.py sdist"
+            docker exec -it pthd /bin/bash -c "conda install -y cmake=3.16 nccl=2.7 -c conda-forge"
+            docker exec -it pthd /bin/bash -c 'cd /horovod && HOROVOD_GPU_OPERATIONS=NCCL HOROVOD_NCCL_LINK=SHARED HOROVOD_WITHOUT_MPI=1 HOROVOD_WITH_PYTORCH=1 pip install -v $(ls /horovod/dist/horovod-*.tar.gz) && ldconfig'
+            docker exec -it pthd horovodrun --check-build
+
+      - run:
+          name: Run 1 Node 2 GPUs Unit Tests
+          command: |
+            export test_cmd='sh tests/run_gpu_tests.sh'
+            docker exec -it pthd /bin/bash -c "${test_cmd}"
+            # no CUDA devices Horovod tests
+            export test_cmd='CUDA_VISIBLE_DEVICES="" py.test --cov ignite --cov-append --cov-report term-missing --cov-report xml -vvv tests/ -m distributed'
+            docker exec -it pthd /bin/bash -c "${test_cmd}"
+
+      - run:
+          name: Codecov upload
+          command: |
+            bash <(curl -s https://codecov.io/bash) -Z -F gpu-2-hvd
+
+      - run:
+          name: "Check CIFAR10 using horovodrun"
+          command: |
+            docker exec -it pthd pip install fire
+            export example_path="examples/contrib/cifar10"
+            # initial run
+            export stop_cmd="--stop_iteration=500"
+            export test_cmd="cd ${example_path} && CI=1 horovodrun -np 2 python -u main.py run --backend=horovod"
+            docker exec -it pthd /bin/bash -c "${test_cmd} ${stop_cmd}"
+            # resume
+            export resume_opt="--resume-from=/tmp/output-cifar10/resnet18_backend-horovod-2_stop-on-500/training_checkpoint_400.pt"
+            docker exec -it pthd /bin/bash -c "${test_cmd} --num_epochs=7 ${resume_opt}"
+
+      - run:
+          name: "Check CIFAR10 using spawn"
+          command: |
+            export example_path="examples/contrib/cifar10"
+            # initial run
+            export stop_cmd="--stop_iteration=500"
+            export test_cmd="cd ${example_path} && CI=1 python -u main.py run --backend=horovod --nproc_per_node=2"
+            docker exec -it pthd /bin/bash -c "${test_cmd} ${stop_cmd}"
+            # resume
+            export resume_opt="--resume-from=/tmp/output-cifar10/resnet18_backend-horovod-2_stop-on-500/training_checkpoint_400.pt"
+            docker exec -it pthd /bin/bash -c "${test_cmd} --num_epochs=7 ${resume_opt}"
+
+
 # -------------------------------------------------------------------------------------
 # Workflows
 # -------------------------------------------------------------------------------------
@@ -204,3 +287,4 @@ workflows:
       - one_gpu_tests
       - two_gpus_tests
       - two_gpus_check_dist_cifar10_example
+      - two_gpus_hvd_tests

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [vfdev-5, ] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/code-style.yml

@@ -9,7 +9,7 @@ jobs:
       with:
         python-version: '3.7'
     - run: |
-        python -m pip install autopep8 black isort
+        python -m pip install autopep8 "black==19.10b0" "isort==4.3.21"
         isort -rc .
         autopep8 --recursive --in-place --aggressive --aggressive .
         black .

.github/workflows/pytorch-version-tests.yml

@@ -1,7 +1,7 @@
 on: 
   schedule:
-    # Run at 00:00 UTC on Sunday
-    - cron:  '0 0 * * 0'
+    # Run at 00:00 UTC Every Day
+    - cron:  '0 0 * * *'
 
 jobs:
   build:
@@ -11,16 +11,10 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [3.5, 3.6, 3.7, 3.8]
-        pytorch-version: [1.4.0, 1.3.1, 1.2.0, 1.1.0, 1.0.1]
+        pytorch-version: [1.5.1, 1.4.0, 1.3.1]
         exclude:
           - pytorch-version: 1.3.1
             python-version: 3.8
-          - pytorch-version: 1.2.0
-            python-version: 3.8
-          - pytorch-version: 1.1.0
-            python-version: 3.8
-          - pytorch-version: 1.0.1
-            python-version: 3.8
 
     steps:
     - uses: actions/checkout@v2

.github/workflows/tpu-tests.yml

@@ -14,7 +14,7 @@ jobs:
     - name: Set up Python 3.6
       uses: actions/setup-python@v2
       with:
-        python-version: '3.6'
+        python-version: '3.6.10'
         architecture: 'x64'
 
     - name: Install Torch XLA and others

.github/workflows/unittests.yml

@@ -38,8 +38,9 @@ jobs:
       shell: bash -l {0}
       run: |
         conda install pytorch torchvision cpuonly -c ${{ matrix.pytorch-channel }}
-        # Keep fix in case of problem with torchvision nightly releases
         pip install -r requirements-dev.txt
+        # Fixes #1153
+        pip install --upgrade scipy==1.4.1
         python setup.py install
 
     - name: Run Tests

.travis.yml

@@ -51,11 +51,12 @@ jobs:
     - stage: Lint check
       python: "3.7"
       before_install: # Nothing to do
-      install: pip install flake8 black isort
+      install: pip install flake8 "black==19.10b0" "isort==4.3.21" "mypy==0.782"
       script:
         - flake8 .
         - black --check .
         - isort -rc -c .
+        - mypy --config-file mypy.ini
       after_success: # Nothing to do
 
     # GitHub Pages Deployment: https://docs.travis-ci.com/user/deployment/pages/

CITATION

@@ -0,0 +1,8 @@
+@misc{pytorch-ignite,
+  author = {V. Fomin and J. Anmol and S. Desroziers and J. Kriss and A. Tejani},
+  title = {High-level library to help with training neural networks in PyTorch},
+  year = {2020},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/pytorch/ignite}},
+}

CONTRIBUTING.md

@@ -26,6 +26,34 @@ If you find a typo in the documentation, do not hesitate to submit a GitHub pull
     - Pick an issue and comment on the task that you want to work on this feature.
     - If you need more context on a particular issue, please ask and we shall provide.
 
+
+## Developing Ignite
+
+### Installation
+
+To get the development installation with the necessary dependencies, run the following:
+```bash
+git clone https://github.com/pytorch/ignite.git
+cd ignite
+python setup.py develop
+pip install -r requirements-dev.txt
+pip install flake8 "black==19.10b0" "isort==4.3.21" "mypy==0.782"
+```
+
+### Code development
+
+#### Codebase structure
+
+- [ignite](ignite) - Core library files
+    - [engine](ignite/engine) - Module containing core classes like Engine, Events, State.
+    - [handlers](ignite/handlers) - Module containing out-of-the-box handlers
+    - [metrics](ignite/metrics) - Module containing out-of-the-box metrics
+    - [contrib](ignite/contrib) - Contrib module with other metrics, handlers classes that may require additional dependencies
+    - [distributed](ignite/distributed) - Module with helpers for distributed computations
+- [tests](tests) - Python unit tests
+- [examples](examples) - Examples and notebook tutorials
+- [docs](docs) - Documentation files
+
 If you modify the code, you will most probably also need to code some tests to ensure the correct behaviour. We are using 
 `pytest` to write our tests:
   - naming convention for files `test_*.py`, e.g. `test_precision.py`
@@ -34,25 +62,34 @@ If you modify the code, you will most probably also need to code some tests to e
 New code should be compatible with Python 3.X versions. Once you finish implementing a feature or bugfix and tests, 
 please run lint checking and tests:
 
-#### Formatting Code without pre-commit
-If you choose not to use pre-commit, you can take advantage of IDE extensions configured to black format or invoke black manually to format files and commit them.
+#### Formatting Code
+
+To ensure the codebase complies with a style guide, we use [flake8](https://flake8.pycqa.org/en/latest/),
+[black](https://black.readthedocs.io/en/stable/) and [isort](https://pycqa.github.io/isort/) tools to
+format and check codebase for compliance with PEP8.
+
+##### Formatting without pre-commit
+
+If you choose not to use pre-commit, you can take advantage of IDE extensions configured to black format or invoke 
+black manually to format files and commit them.
 
 ```bash
-pip install black
-black .
 # This should autoformat the files
+isort -rc .
+black .
+# Run lint checking
+flake8 ignite/ tests/ examples/
+# If everything is OK, then commit
 git add .
-git commit -m "....."
+git commit -m "Added awesome feature"
 ```
 
-#### with pre-commit
-
-To ensure the codebase complies with a style guide, we use [black](https://black.readthedocs.io/en/stable/) and [flake8](https://flake8.pycqa.org/en/latest/) to format and check codebase for compliance with PEP8. 
+#### Formatting with pre-commit
 
 To automate the process, we have configured the repo with [pre-commit hooks](https://pre-commit.com/) to use black to autoformat the staged files to ensure every commit complies with a style guide. This requires some setup, which is described below:
 
 1. Install pre-commit in your python environment.
-2. Run pre-commit install that configures a virtual environment to invoke black and flake8 on commits.
+2. Run pre-commit install that configures a virtual environment to invoke black, isort and flake8 on commits.
 
 ```bash
 pip install pre-commit
@@ -67,25 +104,20 @@ pre-commit install
 git add .
 git commit -m "Added awesome feature"
 # DONT'T WORRY IF ERRORS ARE RAISED.
-# YOUR CODE IS NOT COMPLIANT WITH FLAKE8 or BLACK
+# YOUR CODE IS NOT COMPLIANT WITH flake8, isort or black
 # Fix any flake8 errors by following their suggestions
-# black will automatically format the files so they might look different, but you'll need to stage the files again for committing
+# isort and black will automatically format the files so they might look different, but you'll need to stage the files 
+# again for committing
 # After fixing any flake8 errors
 git add .
 git commit -m "Added feature"
 ```
 
-
-#### Run lint checking
-```bash
-flake8 ignite/ tests/ examples/
-```
-
 #### Run tests:
 
 To run a specific test, for example `test_terminate` from `test_engine.py`
 ```bash
-pytest tests/ignite/engine/test_terminate -vvv -k test_terminate
+pytest tests/ignite/engine/test_engine.py -vvv -k test_terminate
 ```
 To run all tests with coverage (assuming installed `pytest-cov`):
 ```bash
@@ -94,6 +126,14 @@ CI_PYTHON_VERSION=<your python version, e.g 3.7> sh tests/run_cpu_tests.sh
 # CI_PYTHON_VERSION=3.7 sh tests/run_cpu_tests.sh
 ```
 
+#### Run Mypy checks:
+To run mypy to check the optional static type:
+```bash
+mypy --config-file mypy.ini
+```
+
+To change any config for specif folder, please see the file mypy.ini
+
 #### Send a PR
 
 If everything is OK, please send a Pull Request to https://github.com/pytorch/ignite
@@ -103,7 +143,36 @@ If you are not familiar with creating a Pull Request, here are some guides:
 - https://help.github.com/articles/creating-a-pull-request/
 
 
-## Writing documentation
+### Writing documentation
 
 Ignite uses [Google style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
 for formatting docstrings. Length of line inside docstrings block must be limited to 120 characters.
+
+#### Local documentation building and deploying
+
+Please, follow the instructions to build and deploy the documentation locally.
+
+##### Install requirements
+
+```bash
+cd docs
+pip install -r requirements.txt
+```
+
+##### Build
+
+```bash
+cd docs
+make html
+```
+
+##### Local deployment
+
+Please, use python 3.X for the command below:
+```bash
+cd docs/build
+python -m http.server <port>
+# python -m http.server 1234
+```
+Then open the browser at `0.0.0.0:<port>` (e.g. `0.0.0.0:1234`) and click to `html` folder.
+