[GitHub] rahul003 opened a new pull request #9152: tutorial for distributed training

[GitBox <gi...@apache.org>]

rahul003 opened a new pull request #9152: tutorial for distributed training
URL: https://github.com/apache/incubator-mxnet/pull/9152
 
 
   ## Description ##
   This PR adds a tutorial for distributed training.
   It covers
   
   - how distributed training works
   - setting up a cluster
   - how to run distributed training using launch.py and different options it supports
   - how to run distributed training without launch.py
   - related environment variables
   
   Direct link:
   [docs/faq/distributed_training.md](https://github.com/rahul003/mxnet/blob/dist-pr2/docs/faq/distributed_training.md)
   
   I split the old PR to separate doc change and code change.
   Doc change is in this PR.
   The example referred to in this tutorial requires this [PR](https://github.com/apache/incubator-mxnet/pull/9151) to go in
   
   ## Checklist ##
   ### Essentials ###
   N/A Doc changes only
   - [ ] Passed code style checking (`make lint`)
   - [ ] Changes are complete (i.e. I finished coding on this PR)
   - [ ] All changes have test coverage:
   - Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
   - Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
   - Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
   - [ ] Code is well-documented: 
   - For user-facing API changes, API doc string has been updated. 
   - For new C++ functions in header files, their functionalities and arguments are documented. 
   - For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
   - [ ] To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change
   
   ### Changes ###
   - [x] Removed old section in multi_devices.md to a new page for distributed_training because it is long
   
   ### Comments ###
   - The example this refers to requires this [PR](https://github.com/apache/incubator-mxnet/pull/9151) to be merged. The reason for this is that the example currently uses a python path insert to fetch a file from tests/ folder. This causes few problems
       1. It requires the user to have the whole mxnet repository, with the directory structure intact
       2. It means the user can't run the example standalone
       3. For distributed training this means we would have to synchronize the whole mxnet directory across all machines. 
       This is unnecessary and bad user experience IMHO

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services