FileResultTracker

class FileResultTracker(path: None | str | Path = None, name: str | None = None)[source]

Bases: ResultTracker

Tracking results to a file.

Also allows monitoring experiments, e.g. by

tail -f results.txt | grep "hits_at_10"

Initialize the tracker.

Parameters:
  • path (None | str | Path) – The path of the log file.

  • name (str | None) – The default file name for a file if no path is given. If no default is given, the current time is used.

Methods Summary

end_run([success])

End a run.

Methods Documentation

end_run(success: bool = True) None[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