-
Notifications
You must be signed in to change notification settings - Fork 244
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
26 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,7 +9,7 @@ Contribution examples: | |
|
||
## Development Guide | ||
|
||
### build from source | ||
### Build from source | ||
``` | ||
$ git clone [email protected]:takuseno/d3rlpy | ||
$ cd d3rlpy | ||
|
@@ -18,25 +18,27 @@ $ pip install -e . | |
|
||
Before making your nice PR, please run the follwing commands to inspect code qualities. | ||
|
||
### testing | ||
### Install additional dependencies for development | ||
``` | ||
$ pip install -r dev.requirements.txt | ||
``` | ||
|
||
### Testing | ||
``` | ||
$ pip install pytest-cov onnxruntime onnx # dependencies used in unit tests | ||
$ ./scripts/test | ||
``` | ||
|
||
### coding style | ||
### Coding style check | ||
This repository is styled with [black](https://github.com/psf/black) formatter. | ||
Also, [isort](https://github.com/PyCQA/isort) is used to format package imports. | ||
[docformatter](https://github.com/PyCQA/docformatter) is additionally used to format docstrings. | ||
``` | ||
$ pip install black isort docformatter # formatters | ||
$ ./scripts/format | ||
``` | ||
|
||
### linter | ||
### Linter | ||
This repository is fully type-annotated and checked by [mypy](https://github.com/python/mypy). | ||
Also, [pylint](https://github.com/PyCQA/pylint) checks code consistency. | ||
``` | ||
$ pip install mypy pylint==2.13.5 # linters | ||
$ ./scripts/lint | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
pytest | ||
pytest-cov | ||
onnxruntime | ||
onnx | ||
matplotlib | ||
tensorboardX | ||
black | ||
mypy | ||
pylint==2.13.5 | ||
isort | ||
docformatter | ||
minari==0.4.2 | ||
gymnasium_robotics |