Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 938 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (23 loc) · 938 Bytes
Raw

Contributing to PFRL

Any kind of contribution to PFRL 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 PFRL, please make sure all the tests successfully pass.

Testing

To test pfrl 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.

Coding style

We use PEP8. To check your code, use the black, isort, and flake8 packages.

$ pip install git+git://github.com/psf/black.git flake8 mypy isort
$ black path/to/your/code.py
$ flake8 path/to/your/code.py
$ isort path/to/your/code.py
$ mypy path/to/your/code.py