Unverified Commit d20cbb88 authored by Sylvain Gugger's avatar Sylvain Gugger Committed by GitHub
Browse files

Fix hyperparameter_search doc (#6695)

parent 0ebc9699
...@@ -780,9 +780,9 @@ class Trainer: ...@@ -780,9 +780,9 @@ class Trainer:
**kwargs **kwargs
) -> BestRun: ) -> BestRun:
""" """
Launch an hyperparameter search using ``optuna`` or ``Ray Tune``. The optimized quantity is determined by the Launch an hyperparameter search using ``optuna`` or ``Ray Tune``. The optimized quantity is determined by
method, which is the evaluation loss when no metric is provided, the sum of all metrics otherwise (you can :obj:`compute_objectie`, which defaults to a function returning the evaluation loss when no metric is provided,
change that behavior by subclassing and overriding this method). the sum of all metrics otherwise.
Args: Args:
hp_space (:obj:`Callable[["optuna.Trial"], Dict[str, float]]`, `optional`): hp_space (:obj:`Callable[["optuna.Trial"], Dict[str, float]]`, `optional`):
...@@ -805,7 +805,7 @@ class Trainer: ...@@ -805,7 +805,7 @@ class Trainer:
Additional keyword arguments passed along to :obj:`optuna.create_study` or :obj:`ray.tune.run`. For Additional keyword arguments passed along to :obj:`optuna.create_study` or :obj:`ray.tune.run`. For
more information see: more information see:
- the documentation of `optuna.create_stufy <https://optuna.readthedocs.io/en/stable/reference/alias_generated/optuna.create_study.html#optuna.create_study>`__ - the documentation of `optuna.create_study <https://optuna.readthedocs.io/en/stable/reference/alias_generated/optuna.create_study.html#optuna.create_study>`__
- the documentation of `tune.run <https://docs.ray.io/en/latest/tune/api_docs/execution.html#tune-run>`__ - the documentation of `tune.run <https://docs.ray.io/en/latest/tune/api_docs/execution.html#tune-run>`__
Returns: Returns:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment