syne_tune.report module

class syne_tune.report.Reporter(add_time=True, add_cost=True)

Bases: object

Callback for reporting metric values from a training script back to Syne Tune. Example:

from syne_tune import Reporter

report = Reporter()
for epoch in range(1, epochs + 1):
    # ...
    report(epoch=epoch, accuracy=accuracy)

Parameters:

• add_time (bool) – If True (default), the time (in secs) since creation of the Reporter object is reported automatically as ST_WORKER_TIME

• add_cost (bool) – If True (default), estimated dollar cost since creation of Reporter object is reported automatically as ST_WORKER_COST. This is available for SageMaker backend only. Requires add_time=True.

add_time: bool = True

add_cost: bool = True

syne_tune.report.retrieve(log_lines)

Retrieves metrics reported with _report_logger() given log lines.

Parameters:

log_lines (List[str]) – Lines in log file to be scanned for metric reports

Return type:

List[Dict[str, float]]

Returns:

list of metrics retrieved from the log lines.