Skip to content

Commit

Permalink
[doc] add a note about unit-testing to CONTRIBUTING.md (hpcaitech#3970)
Browse files Browse the repository at this point in the history
  • Loading branch information
Baizhou Zhang authored Jun 14, 2023
1 parent 2925f47 commit e8ad3c8
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ pip install <options> -e .
### Unit Tests
We use [PyTest](https://docs.pytest.org/en/latest/) to execute tests. You can install pytest by `pip install pytest`. As some of the tests require initialization of the distributed backend, GPUs are needed to execute these tests.

To set up the environment for unit testing, first change your current directory to the root directory of your local ColossalAI repository, then run
```bash
pip install -r requirements/requirements-test.txt
```
If you encounter an error telling "Could not find a version that satisfies the requirement fbgemm-gpu==0.2.0", please downgrade your python version to 3.8 or 3.9 and try again.

If you only want to run CPU tests, you can run

```bash
Expand Down Expand Up @@ -138,4 +144,4 @@ You can now create a pull request on the GitHub webpage of your repository. The

Do write clearly the description of your pull request and [link the pull request to your target issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). This will automatically close the issue when the pull request is approved.

In case of code conflict, you should rebase your branch and resolve the conflicts manually.
In case of code conflict, you should rebase your branch and resolve the conflicts manually.

0 comments on commit e8ad3c8

Please sign in to comment.