Module `Kaun_board.Run`Source

Training runs.

A run is a directory on disk containing a run.json manifest and an append-only events.jsonl log. Runs are created by Log and read back here for dashboards and analysis.

Run IDs follow the format YYYY-MM-DD_HH-MM-SS_XXXX where XXXX is a random hex suffix. When an experiment name is given, it is appended: YYYY-MM-DD_HH-MM-SS_XXXX_experiment.

Types

Sourcetype t

The type for training run handles.

Accessors

Sourceval run_id : t -> string

run_id r is r's unique identifier.

Sourceval dir : t -> string

dir r is the absolute path to r's directory.

Sourceval created_at : t -> float

created_at r is the Unix timestamp when r was created.

Sourceval experiment_name : t -> string option

experiment_name r is r's experiment name, if any.

Sourceval tags : t -> string list

tags r is the metadata tags associated with r.

Sourceval total_epochs : t -> int option

total_epochs r is r's expected total number of epochs, if specified in the manifest.

Constructors

Source

val create : 
  ?base_dir:string ->
  ?experiment:string ->
  ?tags:string list ->
  ?config:(string * Jsont.json) list ->
  unit ->
  t

create () is a new run with a unique ID and an on-disk directory containing a run.json manifest.

base_dir defaults to the value of RAVEN_RUNS_DIR, or XDG_CACHE_HOME/raven/runs when unset. experiment is appended to the run ID when given. tags defaults to []. config defaults to [] and is written to the manifest as-is.

Raises Sys_error if the directory or manifest cannot be created.

Events

Sourceval append_event : t -> Event.t -> unit

append_event r ev appends ev as a JSON line to r's events.jsonl.

Incremental reading

Sourcetype event_stream

The type for incremental event readers. Tracks the file position and detects log rotation or truncation.

Sourceval open_events : t -> event_stream

open_events r is a stream positioned at the beginning of r's event log.

package kaun-board