ConsoleResultTracker

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

Bases: ResultTracker

A class that directly prints to console.

Initialize the tracker.

Parameters:
  • track_parameters (bool) – Whether to print parameters.

  • parameter_filter (Union[None, str, Pattern[str]]) – A regular expression to filter parameters. If None, print all parameters.

  • track_metrics (bool) – Whether to print metrics.

  • metric_filter (Union[None, str, Pattern[str]]) – A regular expression to filter metrics. If None, print all parameters.

  • start_end_run (bool) – Whether to print start/end run messages.

  • writer (str) – The writer to use - one of “tqdm”, “builtin”, or “logger”.

Methods Summary

end_run([success])

End a run.

log_metrics(metrics[, step, prefix])

Log metrics to result store.

log_params(params[, prefix])

Log parameters to result store.

start_run([run_name])

Start a run with an optional name.

Methods Documentation

end_run(success=True)[source]

End a run.

HAS to be called after the experiment is finished.

Parameters:

success (bool) – Can be used to signal failed runs. May be ignored.

Return type:

None

log_metrics(metrics, step=None, prefix=None)[source]

Log metrics to result store.

Parameters:
  • metrics (Mapping[str, float]) – The metrics to log.

  • step (Optional[int]) – An optional step to attach the metrics to (e.g. the epoch).

  • prefix (Optional[str]) – An optional prefix to prepend to every key in metrics.

Return type:

None

log_params(params, prefix=None)[source]

Log parameters to result store.

Return type:

None

Parameters:
start_run(run_name=None)[source]

Start a run with an optional name.

Return type:

None

Parameters:

run_name (str | None) –