ResultTracker

class ResultTracker

Bases: object

A class that tracks the results from a pipeline run.

Methods Summary

end_run()	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()

End a run.

HAS to be called after the experiment is finished.

Return type

None

log_metrics(metrics, step=None, prefix=None)

Log metrics to result store.

Parameters

• metrics (Dict[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)

Log parameters to result store.

Return type

None

start_run(run_name=None)

Start a run with an optional name.

Return type

None