Add docstrings to optuna.termintor
#4675
Conversation
|
There are two points to discuss regarding this PR:
|
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## master #4675 +/- ##
==========================================
- Coverage 90.62% 90.60% -0.03%
==========================================
Files 187 187
Lines 14322 14286 -36
==========================================
- Hits 12980 12944 -36
Misses 1342 1342
... and 6 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
@eukaryo @contramundum53 Could you review this PR? |
|
Let me reassign the reviewer from @eukaryo to me, since he has day-off. |
|
I think we need some docstrings for classes/functions listed in https://github.com/optuna/optuna/blob/master/optuna/terminator/__init__.py. Concretely, it would be great to add docstrings of |
| terminator: | ||
| A terminator object which determines whether to terminate the optimization by | ||
| assessing the room for optimization and statistical error. Defaults to a | ||
| :class:`~optuna.terminator.Terminator` object with default |
There was a problem hiding this comment.
Maybe we should explain here what the default improvement_evluator and error_evaluator does, because for most users this is the only interface to touch?
There was a problem hiding this comment.
I think we should not explain them here. It is enough to explain them in the document of Terminator.
| :class:`~optuna.terminator.Terminator` object with default | ||
| improvement_evaluator and error_evaluator. | ||
|
|
||
| Example: |
There was a problem hiding this comment.
Maybe we can add another example to show how optuna.terminator module can be used when no cross-validation is performed?
There was a problem hiding this comment.
I think it can be done as a follow-up.
Co-authored-by: contramundum53 <contramundum53@outlook.com>
Co-authored-by: contramundum53 <contramundum53@outlook.com>
|
@HideakiImamura Sure! I'll add them. |
|
@HideakiImamura @contramundum53 |
Motivation
Resolve #4598
Description of the changes
TerminatorCallback(optuna/terminator/callback.py)CrossValidationErrorEvaluator(optuna/terminator/erroreval.py)report_cross_validation_scores(optuna/terminator/erroreval.py)StaticErrorEvaluator(optuna/terminator/erroreval.py)Terminator(optuna/terminator/terminator.py).rstfiles for terminator documentation