tlc.client.log#

Client-side logging functions.

Module Contents#

Functions#

Function

Description

log

Log output data to the active Run or a specified Run.

API#

tlc.client.log.log(data: dict[str, Any], run: tlc.core.objects.mutable_objects.run.Run | tlc.core.url.Url | None = None) → None#

Log output data to the active Run or a specified Run.

If keys ‘epoch’ or ‘iteration’ are present in the data, charts for the logged data will be created against those values in the Runs overview in the Dashboard.

Note

This function is intended for logging output data for a Run as a whole, or aggregated over an epoch or iteration. For logging data for individual samples, refer to the Collect Metrics section in the User Guide.

Parameters:

  • data – The data to log.

  • run – The Run to log the data to. If not provided, the active Run will be used.

Raises:

ValueError – If no Run is provided and there is no active Run.