Testing documentation (#10)

* Adding testing documentation to README.md

* Add pytest to requirements.txt

README.md

-# Contributing
+
+# DeepSpeed
+
+## Installation
+
+
+## Testing
+
+DeepSpeed tracks two types of tests: unit tests and more costly model convergence tests.
+The model convergence tests train
+[DeepSpeedExamples](https://github.com/microsoft/DeepSpeedExamples/) and measure
+end-to-end convergence and related metrics.  Unit tests are found in `tests/unit/` and
+model convergence tests are found in `tests/model/`.
+
+### Unit Tests
+[PyTest](https://docs.pytest.org/en/latest/) is used to execute tests. PyTest can be
+installed from PyPI via `pip install pytest`. Simply invoke `pytest` to run the unit
+tests:
+
+    pytest tests/unit/
+
+You can also provide the `-v` flag to `pytest` to see additional information about the
+tests.
+
+### Model Tests
+To execute model tests, first [install DeepSpeed](#installation). The
+[DeepSpeedExamples](https://github.com/microsoft/DeepSpeedExamples/) repository is cloned
+as part of this process. Next, execute the model test driver:
+
+    cd tests/model/
+    pytest run_sanity_check.py
+
+
+
+## Contributing
 
 DeepSpeed welcomes your contributions!
 
-## Prerequisites
+### Prerequisites
+
+DeepSpeed uses [pre-commit](https://pre-commit.com/) to ensure that formatting is
+consistent across DeepSpeed.  First, ensure that `pre-commit` is installed from either
+installing DeepSpeed or `pip install pre-commit`.  Next, the pre-commit hooks must be
+installed once before commits can be made:
+
+    pre-commit install
+
+Afterwards, our suite of formatting tests run automatically before each `git commit`. You
+can also run these manually:
 
-We use [pre-commit](https://pre-commit.com/) to ensure that formatting is consistent across DeepSpeed.
-First, ensure that `pre-commit` is installed from either installing DeepSpeed or `pip install pre-commit`.
-Next, the pre-commit hooks must be installed once before commits can be made:
-```
-pre-commit install
-```
-Afterwards, our suite of formatting tests run automatically before each `git commit`. You can also
-run these manually:
-```
-pre-commit run --all-files
-```
+    pre-commit run --all-files
 
 
-## Contributor License Agreement
+### Contributor License Agreement
 
-This project welcomes contributions and suggestions.  Most contributions require you to agree to a
-Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+This project welcomes contributions and suggestions.  Most contributions require you to
+agree to a Contributor License Agreement (CLA) declaring that you have the right to, and
+actually do, grant us the rights to use your contribution. For details, visit
+https://cla.opensource.microsoft.com.
 
-When you submit a pull request, a CLA bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
+When you submit a pull request, a CLA bot will automatically determine whether you need
+to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply
+follow the instructions provided by the bot. You will only need to do this once across
+all repos using our CLA.
 
-## Code of Conduct
+### Code of Conduct
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+This project has adopted the [Microsoft Open Source Code of
+Conduct](https://opensource.microsoft.com/codeofconduct/).  For more information see the
+[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
+[opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or
+comments.

requirements.txt

@@ -5,4 +5,5 @@ psutil
 tensorboardX==1.8
 tensorflow-gpu==1.14.0
 nvidia-ml-py3
+pytest
 pre-commit