Resolve a sandbox provider reference into a provider config.

An agent selects a sandbox by name (sandbox_provider: sandbox). The named block lives in its own provider config file, so swapping providers is swapping a config_paths entry, not editing the agent config::

nemo_gym/sandbox/providers/opensandbox/configs/opensandbox.yaml

sandbox: opensandbox: connection: { … }

agent config

sandbox_provider: sandbox

An inline single-key mapping ({provider_name: {...}}) is also accepted for keeping everything in one file.

A block may also carry a reserved default_metadata key. Its entries are merged into the sandbox’s SandboxSpec.metadata as defaults (the agent’s own sandbox_spec.metadata overrides them), so provider-identifying tags live with the provider rather than the agent config::

sandbox: opensandbox: { connection: { … } } default_metadata: { sandbox-api: opensandbox-sdk }

Module Contents

Functions

Name	Description
`_candidate_sandbox_names`	List top-level config keys that look like named sandbox provider blocks.
`_provider_keys`	Return the provider keys in a block (everything but reserved keys).
`_resolve_block`	Resolve a `sandbox_provider` reference or inline mapping to a plain block.
`_to_plain_dict`	Return a plain `dict` for mappings, including OmegaConf `DictConfig`.
`resolve_provider_config`	Resolve a `sandbox_provider` field into a single-key provider config dict.
`resolve_provider_metadata`	Return a sandbox block’s `default_metadata`.

Data

SANDBOX_BLOCK_DEFAULT_METADATA_KEY

SANDBOX_BLOCK_RESERVED_KEYS

API

nemo_gym.sandbox.config._candidate_sandbox_names(
    named_configs: collections.abc.Mapping[str, typing.Any] | None
) -> list[str]

List top-level config keys that look like named sandbox provider blocks.

nemo_gym.sandbox.config._provider_keys(
    block: collections.abc.Mapping[str, typing.Any]
) -> list[str]

Return the provider keys in a block (everything but reserved keys).

nemo_gym.sandbox.config._resolve_block(
    sandbox_provider: str | collections.abc.Mapping[str, typing.Any],
    named_configs: collections.abc.Mapping[str, typing.Any] | None
) -> tuple[dict[str, typing.Any], str]

Resolve a sandbox_provider reference or inline mapping to a plain block.

nemo_gym.sandbox.config._to_plain_dict(
    value: typing.Any
) -> typing.Any

Return a plain dict for mappings, including OmegaConf DictConfig.

nemo_gym.sandbox.config.resolve_provider_config(
    sandbox_provider: str | collections.abc.Mapping[str, typing.Any],
    named_configs: collections.abc.Mapping[str, typing.Any] | None = None
) -> dict[str, typing.Any]

Resolve a sandbox_provider field into a single-key provider config dict.

Parameters:

sandbox_provider

str | Mapping[str, Any]

Either the name of a top-level sandbox config block (resolved from named_configs) or an inline single-key provider mapping of the form {provider_name: {...}}.

named_configs

Mapping[str, Any] | NoneDefaults to None

Mapping of top-level config name to config block, typically the merged global config dict. Required when sandbox_provider is a name reference.

Returns: dict[str, Any]

A plain {provider_name: provider_kwargs} dict suitable for

Raises:

TypeError: If sandbox_provider is neither a string nor a mapping.
ValueError: If a named reference cannot be found, or if the block does not hold exactly one provider key.

nemo_gym.sandbox.config.resolve_provider_metadata(
    sandbox_provider: str | collections.abc.Mapping[str, typing.Any],
    named_configs: collections.abc.Mapping[str, typing.Any] | None = None
) -> dict[str, typing.Any]

Return a sandbox block’s default_metadata.

These are provider-contributed defaults to merge into SandboxSpec.metadata. Returns an empty dict when the block has no default_metadata key. See :func:resolve_provider_config for argument semantics.

nemo_gym.sandbox.config.SANDBOX_BLOCK_DEFAULT_METADATA_KEY = 'default_metadata'

nemo_gym.sandbox.config.SANDBOX_BLOCK_RESERVED_KEYS = frozenset({SANDBOX_BLOCK_DEFAULT_METADATA_KEY})