Evaluate a Harbor Task Suite
Harbor is a container-based harness for agentic tasks: it runs each
task in a Docker sandbox, lets an agent work in it, then runs a verifier that emits named
rewards
(see Harbor’s Core Concepts for its task, trial,
and job model). If you already have Harbor task datasets, the Harbor runner runs them and scores
the verifier rewards through agent-eval — the same
AgentEvaluator and the same result and bundle as the
quickstart. Only the runner changes.
Unlike the quickstart, this runner is not zero-dependency — it shells out to Harbor and Docker:
- Python
>=3.12,<3.14— the SDK’s own floor is>=3.12, matching Harbor’s. Harbor is still imported lazily, so importing the SDK and building a Harbor config work without the extra installed; execution and existing-result adaptation need it. The upper bound isnemo-helix’s own; a source checkout resolves up to 3.14. - A Docker-compatible container runtime — Harbor invokes the
dockerexecutable onPATH(docker infomust succeed) and usesdocker compose. - Harbor
>=0.20,<0.21— see Install Harbor.
Install Harbor
nhx-evals-sdk is not published as a standalone package, so how you add Harbor depends on how
you installed NeMo Helix.
Installed package
Source checkout
Harbor ships with the nemo-helix all extra — services and plugins include it as well:
To add Harbor to an environment you already have, install it against the same constraint the SDK declares:
Use pip install in place of uv pip install if you prefer; both work here.
uv sync has no pip equivalent — it resolves nhx-evals-sdk as a workspace member, which is
why the source-checkout path needs the repository. The runner raises an error naming both of these
install paths if harbor is missing.
The dataset
A Harbor dataset is a directory of task folders. For discovery, the runner needs two files per task — the rest of the task format (environment, verifier, and solution config) is Harbor’s own:
The standalone SDK’s discover_harbor_tasks() returns a HarborTaskCollection of
HarborAgentEvalTask objects. The Harbor framework task name becomes id and intent; normalized
instructions become inputs["instruction"]. Each HarborAgentEvalTask has an absolute source_dir pointing
at its original location. The same objects work locally and with platform task resources. See
Harbor’s task documentation for the full task format.
The collection supports repeatable iteration, indexing, and slicing; use list(tasks) if you
need a mutable list. Discovery validates private copies and then releases them, so the original
packages must remain available for execution or publication. To scaffold a complete package:
This writes a populated task.toml alongside instruction.md, environment, verifier, and solution
stubs, then prints the files to fill in. Add --steps N for a multi-step task, or use -d to
initialize a dataset. See Harbor’s documentation for
the full task format and the rest of its CLI.
A single run takes either all discovered tasks or all plain AgentEvalTask objects, not a mix.
To run plain tasks, including tasks reloaded from a results bundle, convert any discovered ones with
as_base_task() and tell the runner where the packages live:
as_base_task() is also the way to get a plain copy of a discovered task:
AgentEvalTask.model_validate(dict(task)) rejects the extra source_dir field.
The repo ships a one-task example dataset you can clone and point at (it is not shipped in the installed wheel). Or point the dataset path at your own Harbor suite.
Upload and Register Harbor Tasks
Discover local task packages, publish each task, then create a taskset from the returned IDs:
create requires a new name. replace creates or updates a task or taskset; identical content
reuses its revision. Registration names are bare names of at most 255 characters, using letters,
digits, underscores, hyphens or dots. Choose stable, distinct names for your tasks.
Task IDs identify stored records. A taskset pins their current revisions when it is published; concurrent task updates before that call may be included. Later task updates do not change the stored taskset. Task publication and taskset publication are separate operations.
To publish a single task, discover its directory and pass the task directly:
The resource creates or reuses the default fileset, uploads and verifies the archive, then registers the task.
To publish additional metrics or views, see Custom metrics and views.
The default location is <workspace>/harbor-tasks, with an independent content-addressed
path per task. Dataset directory names are not implicit storage prefixes. Archive references
use workspace/fileset#relative/path. Every upload is downloaded and checksum-verified;
registration and workers independently verify it. Existing archive bytes may be replaced by
ordinary Files uploads. Cleanup is caller-managed because archives may be shared.
Discovery accepts one task directory or a dataset directory and excludes task_template with
a warning. Regular files and hidden real directories at the dataset root are skipped. Special
entries, malformed visible directories, empty datasets, and duplicate native IDs fail discovery.
Each task is revalidated when published.
The publication loop is not atomic: earlier task writes survive later failures. If an entity
write fails after preparation, TaskPublicationError.prepared_task retains the prepared input
for retry through replace, without reuploading. The original error is available as its cause.
A lost task-write response remains an error; retrying create may conflict if it committed.
If you already have a typed platform client, use the supported factory:
Async resources provide the same workflow with awaited create and replace calls:
A verified multistep task may have no root instruction; the captured archive remains authoritative.
Submission snapshots and worker preparation
Both task references and taskset references expand at submission. Before a job is created, the service validates stored definitions, unique task identities, metric/model dependencies, and views. The canonical job embeds each selected definition and its resolved scoring. Republishing or deleting task/taskset records afterward does not change that job’s selected tasks.
Workers download the referenced archives through the Files service, verify hashes, safely extract and validate native Harbor packages, and construct the local dataset. Archive availability, permissions, and native-package failures remain execution-time checks. Saved-trial rescoring skips these archive operations; metric evidence must still be available.
Custom metrics and views
Stored Harbor tasks support additional SDK metrics and semantic views. The plugin always scores
HarborRewardMetric first, then the metrics you supply. An omitted or empty metrics list keeps
reward-only scoring. Keep the discovered HarborRewardMetric as is: publication rejects a missing,
duplicate, or customized one. To rename the primary reward, set reward_key on
HarborRuntimeConfig.
Supply additional metrics and views directly on the publication source. Built-in metrics need
no explicit packager; custom Python metrics require metric_bundle_packager=.
- Scoring resolution: Evaluator loads metrics and views from each selected task revision. The runner supplies the primary Harbor reward, even when additional metrics are empty.
- Task publication: Resource methods package, upload and verify Harbor sources before registering them.
- Views: Reference the primary output (
reward, or the target’sreward_key) and declared custom metric outputs.
Rescore saved Harbor trials
Pass saved trials to evaluator.submit(tasks=..., trials=...) instead of a live target.
Submit a stored taskset reference with saved SDK trials and omit target. Submission
snapshots the selected definitions and resolves their scoring. The worker applies HarborRewardMetric, additional metrics, and views without
looking up task/taskset records, downloading task archives, or running the agent or verifier. Metric evidence such as traces and
artifacts must still be accessible from the worker.
With no target, rescoring uses the deployment’s normal evaluator execution backend rather than Harbor’s host subprocess override. Its configured worker image and dependencies must be available.
- Change scoring: Publish task revisions with new metrics/views → update the taskset → submit with the same trials. Unknown trial tasks and selected tasks without trials fail.
- Resolution and size: New submissions resolve task/taskset selectors and metric/model dependencies again. Canonical jobs contain an ordered list of task definition snapshots, so job size grows with the selected definitions and inline metric bundles. Each snapshot retains its original entity name and revision digest as provenance.
- Reward key: Every trial must contain the same valid
metadata["harbor_primary_reward_key"](for example,"reward"). Rescoring preserves that primary selection and discovers secondary outputs from saved rewards; renaming an output does not reinterpret the primary value. - Older trials: Missing reward-key metadata is rejected. Re-import original results with the
current SDK’s
build_trials_from_job_dir(job_dir, tasks, reward_key="reward")fromnhx_evals_sdk.agent_eval.runtimes.harbor.runtime, using SDK tasks with the original native IDs and the original reward key ("reward"is illustrative). This rebuilds metadata without rerunning Harbor. Keep or publish referenced evidence where the scoring worker can read it.
Harbor Tasks and Taskset Grouping in Fileset
Task resource publication stores new archives in <workspace>/harbor-tasks for both
single-task and dataset directories. Existing archives in harbor-tasksets remain valid;
their stored references are unchanged.
workspaceselects where Tasks and Tasksets are registered and the default<workspace>/harbor-tasksfileset.fileset_refoverrides the destination workspace/fileset without changing the registration workspace.path_prefixdefaults to empty for every independent task publication. Set an explicit prefix to group archive paths under a dataset or release name.- The first argument to
tasks.create/replaceis the registered task name. - Publish a taskset separately with
tasksets.create/replace(..., tasks=remote_task_ids).
For example, a single task with path_prefix="release-1" is stored at
default/harbor-tasks#release-1/my_task/<H1>/task_archive.
H1, H2 are SHA-256 of completed compressed task_archive bytes.
Each task_archive contains one named directory:
Task Archiving Details
- The uploader captures a quiescent source and packages entries in sorted order.
- Tar timestamps are normalized, and the gzip header contains no timestamp. Compression is stable within the same tooling, but a compressor upgrade may produce a new hash.
- The uploader verifies the stored bytes and native structure after downloading the archive.
- The named task root, full permission bits (
0o7777), dotfiles, ignored files, and empty directories are preserved. - Original file ownership is not preserved. Archive UID and GID values are normalized to
0; extracted files remain owned by the worker process without usingchown. - Workers retain Harbor’s Docker transfer behavior.
- Symlinks inside a task are preserved as links when their target is relative and resolves inside the
task directory, for example
tests/run.sh -> test.sh. Absolute, escaping, dangling, and cyclic links are rejected, as are links attask.toml,instruction.md,.gitignore, and step directories. Harbor copies links as links, so a link that crosses directories Harbor transfers separately (such astests/data -> ../environment/data) dangles inside the container. - Special files and tar hard-link entries are rejected. A hard-linked regular file in the source task is archived as an ordinary file with its own copy of the content.
Constraints
Server registration and workers independently verify archive bytes, bounded extraction, native metadata and packaged step references. Initial limits are 100,000 entries, 4 GiB per file, 16 GiB payload, plus bounded compressed/expanded streams and tar metadata records.
Run it
Standalone SDK
A Harbor run is a normal agent-eval run: AgentEvaluator().run(tasks=..., target=runner), exactly like
the quickstart (a callable) and the
deployed-agent guide (an HTTP
target). Here the target is a HarborAgentTaskRunner.
The three pieces map onto the model: discover_harbor_tasks turns the suite into tasks,
HarborAgentTaskRunner runs the Harbor job and returns one trial per Harbor trial, and AgentEvaluator
scores each trial’s named rewards with HarborRewardMetric.
dataset_path is input; jobs_dir is output. The dataset is your read-only task suite. jobs_dir
is a directory the runner writes into — Harbor’s per-trial results land under jobs_dir/<job_name>/,
and that directory doubles as a re-run cache (see below).
The oracle agent is Harbor’s reference agent — it produces a passing trial on a well-formed task —
so for the one-task example above the verifier reward is 1.0:
Swap agent_name (or agent_import_path) for your own agent to get a real score.
Evals plugin submissions (nemo evals agent-evaluate) support the Harbor runner only
through the host subprocess executor. Standalone SDK runs using run_harbor_eval() or
HarborAgentTaskRunner invoke Harbor directly and do not use a Jobs execution profile.
Platform Plugin
After uploading and registering the tasks, submit their
taskset reference with a Harbor target. These examples use default/suite, matching the taskset
created above. Use workspace/name#<full-content-digest> to select a specific taskset revision. The oracle agent runs
the task’s reference solution without model credentials.
The job host needs Python 3.12+, Harbor, and a running Docker daemon. Local deployments with the
Docker or none runtime predefine a subprocess execution profile named default, unless the
subprocess executor is disabled. Harbor selects that provider explicitly. The examples use this
profile; CLI submissions can select another configured subprocess profile by name.
Running Harbor job in Kubernetes or Docker execution profile is not supported at this time.
SDK
CLI
Use evaluator.submit with HarborAgentTaskRunner. It uses the deployment’s default
execution profile, which must use the subprocess job executor.
Submission rejects local dataset/task selection overrides, offline runners, and non-default
settings that the job target cannot preserve, including named local runs, force_rerun,
quiet=False, agent_dir, and timeout multipliers. For an agent that needs credentials, set
env_secrets on HarborRuntimeConfig; the platform resolves each reference at submission.
Non-secret settings go in env_vars.
The example prints the generated job name, waits for completion, and retrieves the stored results.
Choosing an agent
HarborRuntimeConfig decides what runs inside each sandbox (see
Harbor’s agent documentation):
-
agent_name— a built-in Harbor agent (for example"oracle", Harbor’s reference agent, handy as a smoke test that the harness and dataset are wired up). -
agent_import_path— your own Harbor agent, e.g."my_agent_module:MyAgent". Setagent_diras well for a loose local source tree. Overridesagent_name. Platform-submitted jobs do not currently acceptagent_dir; see Standalone and submitted custom agents. -
agent_model_name— the model slug handed to the agent.On the platform’s
HarborRunnerTargetthese three are one field,source, so a spec names exactly one agent:{"name": "oracle", "model_name": ...}for a built-in agent or{"import_path": "my_agent_module:MyAgent", "model_name": ...}for your own. -
agent_kwargs— keyword arguments forwarded to the agent’s constructor, the equivalent of Harbor’s--ak key=valueflags. Values must be JSON (strings, numbers, booleans, lists, mappings). Do not put secrets here. Harbor copies its config into the job directory’sconfig.jsonandlock.jsonand into every trial’sconfig.json,lock.json,result.jsonand agent run spec, and needs the real value to construct the agent, so there is no later point at which the value can be taken back. Put credentials inenv_secretsinstead; a${NAME}template is fine here, since it carries no value.A credential-shaped value fails validation before the run starts — a credential-looking key (
api_key,token,secret,authorization, …) holding plaintext, or any value carrying a recognised issued-token shape (nvapi-,sk-,hf_, a PEM block, …). Treat that as a backstop, not a guarantee: a secret under a key of your own naming, in a format the check does not know, will pass straight through. The rule is still that secrets do not belong inagent_kwargs. -
env_secrets— credentials for the agent, as{ENV_NAME: secret-ref}. The same config runs standalone and on the platform:- Standalone submission:
- a workspace ref such as
my-workspace/openai-api-keyis read fromMY_WORKSPACE_OPENAI_API_KEY, falling back toOPENAI_API_KEY - a bare ref
openai-api-keyreadsOPENAI_API_KEY. When both are set, the workspace-prefixed variable wins.
- a workspace ref such as
- Platform submission:
- the platform resolves the provided secret reference (a bare ref in the job’s workspace) into the job’s environment.
- The agent receives each entry through Harbor’s agent env (
self.extra_env, and the env of itsenvironment.execcalls). A custom agent should read it from there, not fromos.getenv. - Harbor scrubs a secret’s value from trial files only under keys matching
KEY,SECRET,TOKEN,PASSWORD,CREDENTIALorAUTH; other keys log a warning. A very short or common secret value (for example1) is scrubbed everywhere it appears, which can corrupt JSON.
- Standalone submission:
-
env_vars— non-secret settings for the agent, as literal values that reach only the agent. Rejected:${MY_ENV_VAR}templates, credential-shaped values, and keys Harbor treats as secrets (matchingKEY,SECRET,TOKEN,PASSWORD,CREDENTIALorAUTH, case-insensitively, such asMAX_TOKENS), since Harbor would mask them inconfig.jsonand scrub their values from every trial file.
Harbor’s Docker task environments inherit the host environment. A task can read any variable you
export, including MY_WORKSPACE_* secrets meant for the agent. Run untrusted task suites only with
the variables they need exported.
The shared agent fields map onto Harbor’s AgentConfig, which Harbor’s agent factory unpacks into
the agent’s constructor. agent_dir is an SDK-only local import aid, not an AgentConfig field:
Standalone and submitted custom agents
Loose wrapper source through agent_dir is supported only by standalone nhx-evals-sdk runs.
It is not supported by submitted nemo-evals plugin jobs.
For example, NeMo Fabric’s
FabricAgent
is one of Harbor’s existing agents;
its constructor requires fabric_adapter_id and accepts fabric_package and fabric_telemetry. For a
complete, runnable version with a Nemotron model, see
Run a NeMo Fabric Agent inside Harbor.
The fields shared with platform submission appear on HarborRunnerTarget, the target of an
AgentEvalInputSpec submitted with nemo evals agent-evaluate, including env_secrets, a
mapping of environment variable name to NeMo Helix secret reference, and env_vars. The service
resolves each reference into the job’s environment at
compile time and the job hands Harbor a ${NAME} template, so the credential appears on neither the
spec, the run bundle, nor config.json. This installed NeMo Fabric adapter example needs no loose
source directory:
Built-in Codex agent
Harbor registers codex as a built-in installed agent. It installs the requested Codex CLI version
inside each task container, so neither an agent_import_path nor wrapper-source upload is required.
For a direct plugin job target:
Replace the model and secret reference with values available to your account. The task image needs network access and the system tools Harbor’s Codex adapter uses to install the CLI. The CLI version above is an explicit reproducibility pin, not a platform-wide default.
For a complete runnable example, see the Harbor taskset evaluation notebook.
How scoring works
- Harbor runs each task in its sandbox and writes a
<task>__<hash>/result.jsonper trial, including the reward mapping from the task’s verifier. reward_keyidentifies the primary reward by name. If not specified, it defaults toreward. Mapping order and alphabetical order never select the primary. TheHarborRewardMetricthatdiscover_harbor_tasksattaches to each task is a placeholder. The runner replaces it with one named afterreward_key, so changingoutput_name,descriptionorlabelson the task has no effect. When rescoring saved trials, the key recorded in those trials is used; if you rescore withAgentEvaluator.run(tasks, trials)and no runner, the task’s metric is used as is.- The primary output is required. On a scoreable trial, a finite numeric value is emitted unchanged;
a missing or unusable primary emits
0.0and a diagnostic instead of skipping the trial. - Other keys from that task’s Harbor-valid results become optional secondaries:
- Finite numbers are emitted.
- Missing or Boolean values are omitted with a diagnostic; usable siblings are kept.
- A
null, nonnumeric string, or object in the reward mapping fails Harbor’sTrialResultcheck, so the whole attempt is skipped and sibling rewards are not scored. Harbor writesNaNand infinity asnull, which hits this gate. - A secondary reward key discovered for one task does not apply to another task.
result.summaryaggregates each named output,result.trialsholds each trial’s status and evidence, andresult.persist()writes the standard run bundle.
What counts as a numeric reward
Harbor’s task format defines each reward.json value
as a float or integer (reward.txt is a single number, stored under the key reward). Harbor reads
and validates that file before writing result.json:
- Finite numbers are retained. Numeric strings such as
"1.25"are coerced to numbers. - A nonnumeric string,
null, or an object fails validation of the whole reward mapping. - A JSON Boolean is coerced to
1.0or0.0. NaNand infinity pass Harbor’s numeric validation, but serialize asnullinresult.json.
The SDK first validates the whole result.json with Harbor’s TrialResult. A null, nonnumeric
string, or object in the reward mapping invalidates the attempt; its sibling rewards are not scored
or cached. For a Harbor-valid result, the SDK parses each reward per key. It emits finite numbers,
including numeric strings normalized by Harbor, and omits Boolean or non-finite values with a
diagnostic while retaining usable siblings.
Emit finite JSON numbers from the verifier. Use 1 and 0 when a reward represents pass/fail; do
not rely on Harbor’s coercion of strings or Booleans.
Sparse secondary and errored reward examples
Missing secondary reward
For two attempts on task A:
Resulting aggregates and coverage
Omission means unmeasured, not failure:
- It does not create a null, NaN, or zero per-trial metric output.
- Coverage records the missing measurement.
- Derived aggregates can therefore be unestimable (
mean=None).
See Reading Results for denominator, failed-trial, semantic-view, and persistence behavior.
Errored attempt with a valid primary reward
For two attempts on task A:
Resulting statuses and aggregate
The error changes a2’s status and error rollup; it does not discard or replace its finite reward.
Attempts and concurrency
n_attempts— desired attempts per task. On resume, Harbor runs only the missing attempts.n_concurrent_trials— maximum trials Harbor runs concurrently.
Retries
max_retries— maximum extra attempts per trial during the current Harbor run; defaults to0.- Error policy — Harbor retries only allowed errors. Its
default non-retryable errors
include
AgentTimeoutError. - Repeated SDK calls —
max_retriesnever reopens cached errored trials. Cache behavior is described below.
Caching
Caching activates only when HarborRuntimeConfig.job_name is pinned. Without it, every call creates a
fresh timestamped job directory.
A cache hit requires both:
- A usable matching stamp for the requested inputs.
- At least
n_attemptsHarbor-valid results for every requested task.
On a repeated SDK call:
- Cache hit — skips Harbor and Docker, then re-scores existing results. Harbor-valid errored results
count as completed, become
PARTIAL, and are not rerun. - Incomplete matching cache — preserves valid results, including errored results, then runs only attempts with missing or invalid results.
- Stale or unusable cache — deletes the job directory and reruns every requested attempt. This includes changed inputs, a missing or malformed stamp, and an unresolved requested task directory.
force_rerun=True— deletes the entire pinned job directory, then reruns every requested attempt.- Selective cached-error rerun — unsupported. The SDK cannot rerun cached attempts by error type.
- Concurrent processes — must not share a pinned
job_name; neither the SDK nor Harbor locks the job directory.
Cache identity
The SDK stores the cache stamp in jobs_dir/<job_name>/.nemo-eval-harbor-cache.json:
version— stamp schema; must match exactly.options— SHA-256 of result-affectingHarborRuntimeConfigfields, includingagent_kwargs; must match exactly.agent— digest ofagent_dircontents, or"<none>"when unset; must match exactly.tasks— every requested task digest must match; extra cached tasks are ignored. Cached A, B, C can serve A, but cached A cannot serve A and B.- Scoring and scheduling settings —
reward_key, selected metrics,quiet, andn_concurrent_trialsdo not invalidate Harbor execution results. env_secretsandenv_vars—env_secretsparticipates by reference andenv_varsby value. Secret values are never fingerprinted, so rotating a credential keeps the cache valid. Job dirs stamped by an SDK release before these fields existed re-run once.- Installed agents — when
agent_diris unset, the stamp covers the agent selection or import path, not the installed package contents. Change the import path, useagent_dir, or force a rerun after changing installed agent code.
Force a complete rerun
- Keep the previous job — use a new
job_name, or omit it to create a fresh timestamped directory.
Shortcut: run_harbor_eval
When a run is exactly “one Harbor suite, scored by its reward,” run_harbor_eval collapses the three
steps above — discover, run, score — into a single call:
It uses the same AgentEvaluator and HarborRewardMetric under the hood. metrics= replaces the
task metrics, so keep HarborRewardMetric() in the list or the reward is not scored:
Prefer the explicit form above when you want to mix Harbor tasks with other tasks or metrics, or share one evaluator across targets.