From 577295f5fae3dd17f0f8aa32464d3015a46b9aaf Mon Sep 17 00:00:00 2001 From: yuxionghe Date: Mon, 3 Feb 2020 10:53:53 -0800 Subject: [PATCH] Add files --- README.md | 22 +++++++++++++++++++++- requirements.txt | 8 ++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index b81a84e5..9eb14f27 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,24 @@ - # Contributing +DeepSpeed welcomes your contributions! + +## Prerequisites + +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 +``` + + +## 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. @@ -9,6 +27,8 @@ When you submit a pull request, a CLA bot will automatically determine whether y 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 + 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. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..c331700f --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +torch==1.2 +torchvision==0.4.0 +tqdm +psutil +tensorboardX==1.8 +tensorflow-gpu==1.14.0 +nvidia-ml-py3 +pre-commit -- GitLab