dump#

statrl.experiments.utils.dump(values, filename, tag, root_folder)[source]#

Pickle a value to {root_folder}{filename}_{tag}.

Parameters:
  • values (object) – Anything picklable; in practice a score time series.

  • filename (str) – Filename prefix. "aux" marks a file clear_auxiliaryfiles() may later delete.

  • tag (str) – Suffix identifying the run, built from the environment, agent, horizon, and a timestamp.

  • root_folder (str) – Output directory. Must end with a separator and already exist.

Returns:

Path of the file written.

Return type:

str