ConsoleResultTracker

class ConsoleResultTracker(*, track_parameters: bool = True, parameter_filter: None | str | Pattern[str] = None, track_metrics: bool = True, metric_filter: None | str | Pattern[str] = None, start_end_run: bool = False, writer: str = 'tqdm')[source]

基础类:ResultTracker

一个直接打印到控制台的类。

初始化跟踪器。

Parameters:
  • track_parameters (bool) – 是否打印参数。

  • parameter_filter (None | str | Pattern[str]) – 用于过滤参数的正则表达式。如果为None,则打印所有参数。

  • track_metrics (bool) – 是否打印指标。

  • metric_filter (None | str | Pattern[str]) – 用于过滤指标的正则表达式。如果为None,则打印所有参数。

  • start_end_run (bool) – 是否打印开始/结束运行消息。

  • writer (str) – 使用的写入器 - 可以是“tqdm”、“builtin”或“logger”之一。

方法总结

end_run([success])

结束运行。

log_metrics(metrics[, step, prefix])

将指标记录到结果存储中。

log_params(params[, prefix])

将日志参数记录到结果存储中。

start_run([run_name])

使用可选名称启动运行。

方法文档

end_run(success: bool = True) None[源代码]

结束运行。

必须在实验结束后调用。

Parameters:

success (bool) – 可用于表示运行失败。可能会被忽略。

Return type:

log_metrics(metrics: Mapping[str, float], step: int | None = None, prefix: str | None = None) None[source]

将指标记录到结果存储中。

Parameters:
  • metrics (Mapping[str, float]) – 要记录的指标。

  • step (int | None) – 一个可选的步骤,用于附加指标(例如,epoch)。

  • prefix (str | None) – 一个可选的前缀,用于在指标中的每个键前添加。

Return type:

log_params(params: Mapping[str, Any], prefix: str | None = None) None[source]

将日志参数记录到结果存储中。

Parameters:
Return type:

start_run(run_name: str | None = None) None[来源]

使用可选名称启动运行。

Parameters:

run_name (str | None)

Return type: