It’s such an honor to have you on board!
We are proud of this project and have been trying to make this project great since day one. We believe you will love it, however, we know there’s room for improvement. We have to
- implement features that make what you want to do possible and/or easily.
- write more examples that help you get familiar with Optuna.
- make issues and pull requests on GitHub fruitful.
- have more conversations and discussions on Gitter.
We need your help heartily, everything about Optuna you have in your mind push this project forward. Join Us!
If you feel like giving your hand to us, here are some ways
- Implement a feature
- If you have some cool idea, please open an issue first to discuss design to make your idea in a better shape.
- Send a patch
- Dirty your hands by tackling issues with
contribution-welcome
label
- Dirty your hands by tackling issues with
- Report a bug
- If you find some bug, don't hesitate to report it! Your reports are really important!
- Fix/Improve documentation
- Documentation gets outdated easily, and can always be better, so feel free to fix & improve
- Let us & the Optuna community know your ideas, thought
- Contribution to Optuna includes not only sending pull requests, but also writing down your comments on issues and pull requests by others, and joining conversations/discussions on Gitter.
- Also, sharing how you enjoy Optuna is a huge contribution! If you write some blog, let us know it!
If you choose to write some code, we have some conventions as follows.
Coding style is checked with flake8. Additional conventions are described in the Wiki.
When adding a new feature to the framework, you also need to document it in the reference. The documentation source is stored under the docs directory and written in reStructuredText format.
To build the documentation, you need to run:
pip install -e ".[document]"
Then you can build the documentation in HTML format locally:
cd docs
make html
HTML files are generated under build/html
directory. Open index.html
with the browser and see
if it is rendered as expected.
Type hints, PEP484, are checked with mypy.
Code is formatted with black.
You have to install it first. This can be done with
pip install black
. The command to format a certain file
is black <filename_with_path> --line-length 99 --exclude="docs|tutorial"
.
To just check the file you can use
black <filename_with_path> --line-length 99 --check --exclude="docs|tutorial"
.
You can also apply these operations to all files by replacing
<filename_with_path>
with a simple .
.
When adding a new feature or fixing a bug, you also need to write sufficient test code. We use pytest as the testing framework and unit tests are stored under the tests directory.
You can run all your tests as follows:
# Run all the unit tests.
pytest
# Run all the unit tests defined in the specified test file.
pytest tests/${TARGET_TEST_FILE_NAME}
CircleCI is used for continuous integration.
By installing the circleci
local CLI and Docker, you can run tests locally.
circleci build --job <job_name>
You can run the following jobs.
tests-python35
- Runs unit tests under Python 3.5
tests-python36
- Runs unit tests under Python 3.6
tests-python37
- Runs unit tests under Python 3.7
tests-python38
- Runs unit tests under Python 3.8
checks
- Checks guidelines
document
- Checks documentation build
doctest
- Checks doctest validity
codecov
- Checks unit test code coverage
The following circleci
job runs all unit tests in Python 3.7:
Note that this job will download several hundred megabytes of data to install all the packages required for testing, and take several tens of minutes to complete all tests.
circleci build --job tests-python37
When you are ready to create a pull request, please try to keep the following in mind.
The title of your pull request should
- briefly describe and reflect the changes
- wrap any code with backticks
The title will be directly visible in the release notes.
Introduces Tree-structured Parzen Estimator to optuna.samplers
.
The description of your pull request should
- describe the motivation
- describe the changes
- if still work-in-progress, describe remaining tasks