|
LIRRA
1.0.0
|
Functions | |
| dict[str, Any] | git_revision (Path repo_root=REPO_ROOT) |
| dict[str, str|None] | package_versions (tuple[str,...] packages=TRACKED_PACKAGES) |
| dict[str, Any] | hardware_info () |
| dict[str, Any] | run_metadata (int|Mapping[str, int]|None seed=None, **Any extra) |
| Path | create_run_dir (str experiment, Any config, int|Mapping[str, int]|None seed=None, str|Path|None root=None, str|None tag=None, **Any extra) |
| None | write_summary (str|Path run_dir, Mapping[str, Any] summary) |
Variables | |
| REPO_ROOT = Path(__file__).resolve().parents[3] | |
| tuple | TRACKED_PACKAGES |
Run directories with provenance: resolved config, seeds, git revision, versions, hardware. Every experiment script should call :func:`create_run_dir` before doing work and :func:`write_summary` at the end. Nothing here imports JAX, so it is safe to use before :func:`rl_stl.utils.device.configure_jax_device`.
| Path rl_stl.utils.provenance.create_run_dir | ( | str | experiment, |
| Any | config, | ||
| int | Mapping[str, int] | None | seed = None, |
||
| str | Path | None | root = None, |
||
| str | None | tag = None, |
||
| **Any | extra | ||
| ) |
Create ``runs/<experiment>/<timestamp>[_tag]/`` with config.yaml and metadata.json.
| dict[str, Any] rl_stl.utils.provenance.git_revision | ( | Path | repo_root = REPO_ROOT | ) |
| dict[str, Any] rl_stl.utils.provenance.hardware_info | ( | ) |
| dict[str, str | None] rl_stl.utils.provenance.package_versions | ( | tuple[str, ...] | packages = TRACKED_PACKAGES | ) |
| dict[str, Any] rl_stl.utils.provenance.run_metadata | ( | int | Mapping[str, int] | None | seed = None, |
| **Any | extra | ||
| ) |
| None rl_stl.utils.provenance.write_summary | ( | str | Path | run_dir, |
| Mapping[str, Any] | summary | ||
| ) |
| rl_stl.utils.provenance.REPO_ROOT = Path(__file__).resolve().parents[3] |
| tuple rl_stl.utils.provenance.TRACKED_PACKAGES |