From 0257f3df46262bbd86c113e4712625df63513bc0 Mon Sep 17 00:00:00 2001 From: Anonymous-submission-repo Date: Sat, 15 Oct 2022 00:28:50 +0000 Subject: [PATCH] update --- website/docs/Use-Cases/Tune-User-Defined-Function.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/website/docs/Use-Cases/Tune-User-Defined-Function.md b/website/docs/Use-Cases/Tune-User-Defined-Function.md index 6a870a3a9..dc8aa8462 100644 --- a/website/docs/Use-Cases/Tune-User-Defined-Function.md +++ b/website/docs/Use-Cases/Tune-User-Defined-Function.md @@ -516,13 +516,14 @@ analysis = tune.run( ``` ### Lexicographic Objectives -We support tuning multiple objectives with lexicographic preference by providing argument `lexico_objectives` for `tune.tun()`. -`lexico_objectives` is a dictionary with four elements: +We support tuning multiple objectives with lexicographic preference by providing argument `lexico_objectives` for `tune.tun()`. +`lexico_objectives` is a dictionary that contains the following fields of key-value pairs: - `metrics`: a list of optimization objectives with the orders reflecting the priorities/preferences of the objectives. - `modes`: (optional) a list of optimization modes (each mode either "min" or "max") corresponding to the objectives in the metric list. If not provided, we use "min" as the default mode for all the objectives. - `tolerances`: (optional) a dictionary to specify the optimality tolerances on objectives. The keys are the metric names (provided in "metrics"), and the values are the numerical tolerances values. - `targets`: (optional) a dictionary to specify the optimization targets on the objectives. The keys are the metric names (provided in "metric"), and the values are the numerical target values. +When lexico_objectives is not None, the arguments metric, mode, will be invalid, and flaml's tune uses CFO as the `search_alg`, which makes the input (if provided) `search_alg' invalid. In the following example, we want to minimize `val_loss` and `pred_time` of the model where `val_loss` has high priority. The tolerances for `val_loss` and `pre_time` are 0.02 and 0 respectively. We do not set targets for these two objectives and we set them to -inf for both objectives. ```python