Please follow these steps to open a pull request:
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
We use PyTest 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
pip install -r requirements.txt
pip install -r requirements_dev.txtThen, simply run:
pytest tests/We have some static checks when you commit your code change, please make sure you can pass all the tests and make sure the coding style follows our requirements. We use pre-commit hook to make sure the code is aligned with the writing standard. To set up the code style checking, you need to follow the steps below.
- pre-commit:
# Install pre-commit
pip install pre-commit
# Set up the hook, which may take some time
# Luckily, this step only needs to be performed once
pre-commit install
# Then each time before you run `git commit`,
# please run pre-commit to polish your code
pre-commit run -a
# For more usage about pre-commit,
# you may check: https://pre-commit.com/Code format checking will be automatically executed when you commit your changes.