API ReferenceFull Library ReferenceNemo GymNemo GymEnvironment

nemo_gym.environment.onboarding

View as Markdown

Service-free checks for manifest-backed environment verifiers.

Module Contents

Classes

NameDescription
EnvironmentOnboardingErrorA manifest-backed onboarding check could not be completed.
VerifierReportSummary of an in-process verifier-fixture run.
VerifierRunSpec-

Functions

NameDescription
_import_resources_server-
_resources_server_app-
_runtime_component_paths-
exercise_verifier_runImport and exercise a prepared verifier inside its dependency environment.
prepare_verifier_runValidate a catalog entry and resolve the scorer process boundary.
verify_environmentValidate and exercise a verifier in the current Python environment.

Data

__all__

API

class nemo_gym.environment.onboarding.EnvironmentOnboardingError()

Bases: ConfigError

A manifest-backed onboarding check could not be completed.

class nemo_gym.environment.onboarding.VerifierReport(
    name: str,
    kind: str,
    resources_server: str,
    manifest_path: str,
    fixture_path: str,
    cases: tuple[nemo_gym.verifier_fixture.VerifierFixtureResult, ...]
)
Dataclass

Summary of an in-process verifier-fixture run.

cases
tuple[VerifierFixtureResult, ...]
fixture_path
str
kind
str
manifest_path
str
name
str
resources_server
str
nemo_gym.environment.onboarding.VerifierReport.from_dict(
    value: dict[str, typing.Any]
) -> 'VerifierReport'
classmethod
nemo_gym.environment.onboarding.VerifierReport.to_dict() -> dict[str, typing.Any]
class nemo_gym.environment.onboarding.VerifierRunSpec(
    name: str,
    kind: str,
    resources_server: str,
    manifest_path: str,
    app_path: str,
    component_root: str,
    server_dir: str,
    bundled_component: bool,
    reward_range: tuple[float, float],
    higher_is_better: bool,
    determinism: str
)
Dataclass
app_path
str
bundled_component
bool
component_root
str
determinism
str
higher_is_better
bool
kind
str
manifest_path
str
name
str
resources_server
str
reward_range
tuple[float, float]
server_dir
str
nemo_gym.environment.onboarding.VerifierRunSpec.to_dict() -> dict[str, typing.Any]
nemo_gym.environment.onboarding._import_resources_server(
    app_path: pathlib.Path,
    component_root: pathlib.Path,
    server_dir: pathlib.Path
) -> types.ModuleType
 
nemo_gym.environment.onboarding._resources_server_app(
    component: nemo_gym.environment.validation.ResolvedComponent
) -> tuple[pathlib.Path, pathlib.Path, pathlib.Path]
 
nemo_gym.environment.onboarding._runtime_component_paths(
    spec: nemo_gym.environment.onboarding.VerifierRunSpec
) -> tuple[pathlib.Path, pathlib.Path, pathlib.Path]
 
nemo_gym.environment.onboarding.exercise_verifier_run(
    spec: nemo_gym.environment.onboarding.VerifierRunSpec,
    update_expected: bool = False
) -> nemo_gym.environment.onboarding.VerifierReport
async

Import and exercise a prepared verifier inside its dependency environment.

Validate a catalog entry and resolve the scorer process boundary.

nemo_gym.environment.onboarding.verify_environment(
    entry: nemo_gym.registry.EnvironmentCatalogEntry,
    update_expected: bool = False
) -> nemo_gym.environment.onboarding.VerifierReport
async

Validate and exercise a verifier in the current Python environment.

nemo_gym.environment.onboarding.__all__ = ['EnvironmentOnboardingError', 'VerifierRunSpec', 'VerifierReport', 'exercise_ve...