Skip to content

Commit

Permalink
Improve docstring on cost_attr and cost_budget in flaml.tune.run()
Browse files Browse the repository at this point in the history
Co-authored-by: Li Jiang <[email protected]>
  • Loading branch information
EgorKraevTransferwise and thinkall authored Dec 4, 2024
1 parent 969028f commit 082ea02
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions flaml/tune/tune.py
Original file line number Diff line number Diff line change
Expand Up @@ -464,8 +464,12 @@ def easy_objective(config):
overwritten by the value of `n_concurrent_trials` in AutoML. When <= 0, the concurrent trials
will be set to the number of executors.
extra_tag: dict, default=None | Extra tags to be added to the mlflow runs created by autologging.
cost_attr: str, default="auto" | name of an alternative cost metric, passed through to the search algorithm
cost_budget: Optional[float], default=None | The budget for the cost metric, passed through to the search algorithm
cost_attr: None or str to specify the attribute to evaluate the cost of different trials.
Default is "auto", which means that we will automatically choose the cost attribute to use (depending
on the nature of the resource budget). When cost_attr is set to None, cost differences between different trials will be omitted
in our search algorithm. When cost_attr is set to a str different from "auto" and "time_total_s",
this cost_attr must be available in the result dict of the trial.
cost_budget: A float of the cost budget. Only valid when cost_attr is a str different from "auto" and "time_total_s".
**ray_args: keyword arguments to pass to ray.tune.run().
Only valid when use_ray=True.
"""
Expand Down

0 comments on commit 082ea02

Please sign in to comment.