Any kind of contribution to ChainerRL would be highly appreciated!
Contribution examples:
- Thumbing up to good issues or pull requests 👍
- Opening issues about questions, bugs, installation problems, feature requests, algorithm requests etc.
- Sending pull requests
If you could kindly send a PR to ChainerRL, please make sure all the tests successfully pass.
To test chainerrl modules, install and run pytest. Pass -m "not gpu" to skip tests that require gpu. E.g.
$ pip install pytest
$ pytest -m "not gpu"
To test examples, run test_examples.sh [gpu device id]. -1 would run examples with only cpu.
We use PEP8. To check your code, use autopep8 and flake8 packages.
$ pip install autopep8 flake8
$ autopep8 --diff path/to/your/code.py
$ flake8 path/to/your/code.py
To use Python 3 features as much as possible while keeping Python 2 support, add the following lines to the head of each file.
from __future__ import print_function
from __future__ import unicode_literals
from __future__ import division
from __future__ import absolute_import
from builtins import * # NOQA
from future import standard_library
standard_library.install_aliases()