ray.tune.CLIReporter#

class ray.tune.CLIReporter(*, metric_columns: Optional[Union[List[str], Dict[str, str]]] = None, parameter_columns: Optional[Union[List[str], Dict[str, str]]] = None, total_samples: Optional[int] = None, max_progress_rows: int = 20, max_error_rows: int = 20, max_column_length: int = 20, max_report_frequency: int = 5, infer_limit: int = 3, print_intermediate_tables: Optional[bool] = None, metric: Optional[str] = None, mode: Optional[str] = None, sort_by_metric: bool = False)[source]#

Bases: ray.tune.progress_reporter.TuneReporterBase

Command-line reporter

Parameters
  • metric_columns – Names of metrics to include in progress table. If this is a dict, the keys should be metric names and the values should be the displayed names. If this is a list, the metric name is used directly.

  • parameter_columns – Names of parameters to include in progress table. If this is a dict, the keys should be parameter names and the values should be the displayed names. If this is a list, the parameter name is used directly. If empty, defaults to all available parameters.

  • max_progress_rows – Maximum number of rows to print in the progress table. The progress table describes the progress of each trial. Defaults to 20.

  • max_error_rows – Maximum number of rows to print in the error table. The error table lists the error file, if any, corresponding to each trial. Defaults to 20.

  • max_column_length – Maximum column length (in characters). Column headers and values longer than this will be abbreviated.

  • max_report_frequency – Maximum report frequency in seconds. Defaults to 5s.

  • infer_limit – Maximum number of metrics to automatically infer from tune results.

  • print_intermediate_tables – Print intermediate result tables. If None (default), will be set to True for verbosity levels above 3, otherwise False. If True, intermediate tables will be printed with experiment progress. If False, tables will only be printed at then end of the tuning run for verbosity levels greater than 2.

  • metric – Metric used to determine best current trial.

  • mode – One of [min, max]. Determines whether objective is minimizing or maximizing the metric attribute.

  • sort_by_metric – Sort terminated trials by metric in the intermediate table. Defaults to False.

PublicAPI: This API is stable across Ray releases.

Methods

add_metric_column

Adds a metric to the existing columns.

add_parameter_column

Adds a parameter to the existing columns.

Attributes

DEFAULT_COLUMNS

VALID_SUMMARY_TYPES