ray.tune.CLIReporter#

class ray.tune.CLIReporter(*, metric_columns: List[str] | Dict[str, str] | None = None, parameter_columns: List[str] | Dict[str, str] | None = None, total_samples: int | None = 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: bool | None = None, metric: str | None = None, mode: str | None = None, sort_by_metric: bool = False)[源代码]#

基类:TuneReporterBase

命令行报告器

参数:
  • metric_columns – 要在进度表中包含的指标名称。如果这是一个字典,键应该是指标名称,值应该是显示的名称。如果这是一个列表,则直接使用指标名称。

  • parameter_columns – 要在进度表中包含的参数名称。如果这是一个字典,键应该是参数名称,值应该是显示的名称。如果这是一个列表,则直接使用参数名称。如果为空,则默认为所有可用参数。

  • max_progress_rows – 进度表中打印的最大行数。进度表描述了每个试验的进度。默认为20。

  • max_error_rows – 错误表中打印的最大行数。错误表列出了每个试验对应的错误文件(如果有)。默认为 20。

  • max_column_length – 最大列长度(以字符为单位)。超过此长度的列标题和值将被缩写。

  • max_report_frequency – 最大报告频率,以秒为单位。默认为5秒。

  • infer_limit – 从调优结果中自动推断的最大指标数量。

  • print_intermediate_tables – 打印中间结果表。如果为 None(默认),将在详细程度级别高于 3 时设置为 True,否则为 False。如果为 True,中间表将随实验进度打印。如果为 False,表将仅在调优运行结束时打印,且详细程度级别大于 2。

  • metric – 用于确定最佳当前试验的指标。

  • mode – 其中之一 [min, max]。确定目标是最大化还是最小化指标属性。

  • sort_by_metric – 在中间表中按指标排序终止的试验。默认为 False。

方法

add_metric_column

向现有列添加一个指标。

add_parameter_column

向现有列添加一个参数。

属性

DEFAULT_COLUMNS

VALID_SUMMARY_TYPES