Skip to navigation
API ReferenceFull Library ReferenceNemo GymNemo GymArtifacts

nemo_gym.artifacts.run_artifacts

View as Markdown

Module Contents

Classes

NameDescription
RunArtifactsThe files gym eval run leaves for one run, all derived from the rollouts file’s path.

Functions

NameDescription
accepted_stage_omissionThe stage and policy that omitted a planned row, e.g. “(stage_index 1, tolerate_unresolved)”, else None.

Data

ACCEPTED_STAGE_OMISSION

API

class nemo_gym.artifacts.run_artifacts.RunArtifacts(
    rollouts_jsonl_fpath: pathlib.Path
)
Dataclass

The files gym eval run leaves for one run, all derived from the rollouts file’s path.

Paths are derived, not checked: any of the sidecars may be missing (for example a run from before resolved_config was saved), and it is up to each exporter to decide which ones it requires.

aggregate_metrics_json_fpath
Path
failures_jsonl_fpath
Path
materialized_inputs_jsonl_fpath
Path
resolved_config_yaml_fpath
Path
rollouts_jsonl_fpath
Path
nemo_gym.artifacts.run_artifacts.RunArtifacts.__post_init__() -> None
nemo_gym.artifacts.run_artifacts.RunArtifacts.export_done_fpath(
    exporter: str
) -> pathlib.Path

Receipt written after verified delivery of the whole run, either live or by a post-run export.

nemo_gym.artifacts.run_artifacts.RunArtifacts.exporter_run_id_fpath(
    exporter: str
) -> pathlib.Path

The run a live exporter logged this run to. It exists once the run opened, whether or not it finished.

nemo_gym.artifacts.run_artifacts.accepted_stage_omission(
    row: collections.abc.Mapping[str, object]
) -> typing.Optional[str]

The stage and policy that omitted a planned row, e.g. “(stage_index 1, tolerate_unresolved)”, else None.

nemo_gym.artifacts.run_artifacts.ACCEPTED_STAGE_OMISSION = 'accepted_stage_omission'