optuna.cli¶

optuna
    [--version]
    [-v | -q]
    [--log-file LOG_FILE]
    [--debug]
    [--storage STORAGE]

--version¶: show program’s version number and exit

-v, --verbose¶: Increase verbosity of output. Can be repeated.

-q, --quiet¶: Suppress output except warnings and errors.

--log-file <LOG_FILE>¶: Specify a file to log output. Disabled by default.

--debug¶: Show tracebacks on errors.

--storage <STORAGE>¶: DB URL. (e.g. sqlite:///example.db)

create-study¶

Create a new study.

optuna create-study
    [--study-name STUDY_NAME]
    [--direction {minimize,maximize}]
    [--skip-if-exists]

--study-name <STUDY_NAME>¶: A human-readable name of a study to distinguish it from others.

--direction <DIRECTION>¶: Set direction of optimization to a new study. Set ‘minimize’ for minimization and ‘maximize’ for maximization.

--skip-if-exists¶: If specified, the creation of the study is skipped without any error when the study name is duplicated.

This command is provided by the optuna plugin.

dashboard¶

Launch web dashboard (beta).

optuna dashboard
    [--study STUDY]
    [--study-name STUDY_NAME]
    [--out OUT]
    [--allow-websocket-origin BOKEH_ALLOW_WEBSOCKET_ORIGINS]

--study <STUDY>¶: This argument is deprecated. Use –study-name instead.

--study-name <STUDY_NAME>¶: A human-readable name of a study to distinguish it from others.

--out <OUT>, -o <OUT>¶: Output HTML file path. If it is not given, a HTTP server starts and the dashboard is served.

--allow-websocket-origin <BOKEH_ALLOW_WEBSOCKET_ORIGINS>¶: Allow websocket access from the specified host(s).Internally, it is used as the value of bokeh’s –allow-websocket-origin option. Please refer to https://bokeh.pydata.org/en/latest/docs/reference/command/subcommands/serve.html for more details.

This command is provided by the optuna plugin.

delete-study¶

Delete a specified study.

optuna delete-study [--study-name STUDY_NAME]

--study-name <STUDY_NAME>¶: A human-readable name of a study to distinguish it from others.

This command is provided by the optuna plugin.

storage upgrade¶

Upgrade the schema of a storage.

optuna storage upgrade

This command is provided by the optuna plugin.

studies¶

Show a list of studies.

optuna studies
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the optuna plugin.

study optimize¶

Start optimization of a study. Deprecated since version 2.0.0.

optuna study optimize
    [--n-trials N_TRIALS]
    [--timeout TIMEOUT]
    [--n-jobs N_JOBS]
    [--study STUDY]
    [--study-name STUDY_NAME]
    file
    method

--n-trials <N_TRIALS>¶: The number of trials. If this argument is not given, as many trials run as possible.

--timeout <TIMEOUT>¶: Stop study after the given number of second(s). If this argument is not given, as many trials run as possible.

--n-jobs <N_JOBS>¶: The number of parallel jobs. If this argument is set to -1, the number is set to CPU counts.

--study <STUDY>¶: This argument is deprecated. Use –study-name instead.

--study-name <STUDY_NAME>¶: A human-readable name of a study to distinguish it from others.

file¶: Python script file where the objective function resides.

method¶: The method name of the objective function.

This command is provided by the optuna plugin.

study set-user-attr¶

Set a user attribute to a study.

optuna study set-user-attr
    [--study STUDY]
    [--study-name STUDY_NAME]
    --key KEY
    --value VALUE

--study <STUDY>¶: This argument is deprecated. Use –study-name instead.

--study-name <STUDY_NAME>¶: A human-readable name of a study to distinguish it from others.

--key <KEY>, -k <KEY>¶: Key of the user attribute.

--value <VALUE>, -v <VALUE>¶: Value to be set.

This command is provided by the optuna plugin.