osworld_docker Recipe automatically. OSWorld is Benchmark-driven: Benchmark.prepare_task() performs the VM readiness check and task setup, Benchmark.run_task() executes the dedicated CUA agent loop, Benchmark.evaluate() runs the native evaluator in the same Environment, and the generic Docker provider cleans up the container.
At a glance
Install and prepare
Install AgentCompass with the OSWorld evaluator dependencies:- Install and start Docker Engine. Make sure the current user can run
dockerdirectly, or configure non-interactivesudo -n docker. - Prepare the OSWorld Ubuntu qcow2 image. AgentCompass does not download this VM image automatically.
- Expose
/dev/kvmon the host when possible. Without KVM, the VM still works through software virtualization but starts and responds much more slowly.
Execution flow
Each task passes through these stages:- The Benchmark loads the instruction, setup configuration, and evaluator configuration.
- The
osworld_dockerRecipe translates OSWorld settings into generic Docker configuration, including the qcow2 mount, service ports, and KVM device. Benchmark.prepare_task()waits for the screenshot service, resets and sets up the task, and builds thePreparedTask.Benchmark.run_task()creates the selected CUA agent fromagent_style, runs the screenshot–inference–action loop, and produces aRunResult.Benchmark.evaluate()reuses the current desktop, runs the task’s getters and metrics, and writes the result tometrics.score.- The generic Docker Environment removes the container unless
--keep-environmentis enabled.
Benchmark parameters
Pass these fields through--benchmark-params '{...}':
The loader rejects duplicate IDs, missing task files, ID mismatches, and empty instructions. It retains task
proxy metadata, but this integration does not enable the OSWorld proxy during setup or evaluation.
Dataset location
Whendata_dir is empty and no valid local dataset exists, AgentCompass downloads:
<runtime.data_dir>/osworld, which is data/osworld by default. Existing valid data is reused. The loader accepts both tasks stored directly under osworld/ and the official repository layout with an evaluation_examples/ child.
You can reuse an OSWorld checkout instead:
/path/to/OSWorld repository root, the loader finds its evaluation_examples directory automatically.
Agent parameters
The OSWorld agent loop is Benchmark-specific, so configure these fields through--benchmark-params as well. agent_style is required and must match the Model protocol: qwen35 uses openai-chat, while claude uses anthropic.
Common parameters:
When
temperature and top_p are unset, Claude requests omit these fields, while Qwen3.5 continues to use its built-in defaults of temperature=0.0 and top_p=0.9.
Qwen3.5 parameters:
The Qwen3.5 agent uses XML
computer_use with smart image resizing, history folding, relative or absolute coordinates, and desktop actions including keyboard input, clicks, drag, scroll, wait, answer, and task termination.
Claude parameters:
The Claude agent is fixed to the Anthropic Messages API and a batched custom
computer tool. It does not declare a versioned native computer-use tool or support Bedrock and Vertex backends. Large max_tokens requests use streaming, and thinking_mode with thinking_budget controls thinking behavior.
Docker and Recipe parameters
Selecting--env docker automatically matches the osworld_docker Recipe, and all parameters are configured through --env-params. The Recipe first extracts OSWorld-specific fields. Desktop-control fields are stored in OSWorldRuntimeOptions and later used by the OSWorld Docker adapter; VM-startup fields are translated into generic Docker environment variables, mounts, and device settings. The Docker Environment handles the remaining generic fields directly.
The Recipe publishes OSWorld ports 5000, 8006, 9222, and 8080 and adds the
NET_ADMIN capability. The adapter uses Docker’s dynamically assigned host ports to connect to the screenshot, VNC, Chromium, and VLC services. Compatible explicit Docker settings are preserved. See Docker Environment for all generic fields.
Run examples
The three positional arguments toagentcompass run are Benchmark, Harness, and Model: osworld, none, and $MODEL_NAME here. none selects the Benchmark-driven desktop loop; choose the agent implementation with agent_style in --benchmark-params.
Complete Install and prepare, set OSWORLD_VM_PATH to the absolute path of your Ubuntu qcow2 image, and set MODEL_NAME, MODEL_BASE_URL, and MODEL_API_KEY for a Qwen3.5 Model using openai-chat. Pass Docker settings through --env-params; the osworld_docker Recipe is selected automatically.
To run the Claude example below, also set CLAUDE_MODEL_NAME, CLAUDE_MODEL_BASE_URL, and CLAUDE_MODEL_API_KEY for a Claude Model using anthropic. Both agent styles share the same VM preparation.
- Smoke test (single task end-to-end)
- Custom parameters
- AgentCompass recommended config
Run one Chrome task from the default
test_nogdrive split to verify the Model endpoint, desktop actions, and native scoring, using the default limit of 50 turns.agent_style: claude uses the Claude desktop loop, while the Harness argument remains none. This command evaluates the full test_nogdrive split through anthropic, using the default limit of 50 turns.
Evaluation Results
For shared result conventions, see Run Directory, Aggregate Scores, and Task Files and Shared Fields.Scoring Metrics
OSWorld’s primary metric is scalarscore, taken directly from the task’s native evaluator of the final desktop state; higher is better. The task JSON’s evaluator defines the checks. AgentCompass neither converts the floating-point result to a universal binary pass verdict nor clamps its range.
For multiple checks, and returns 0 if any check scores zero and otherwise takes the mean; avg takes the mean; or takes the maximum. A task marked infeasible succeeds when the agent’s last action is FAIL, so that label does not always indicate an incorrect outcome.
With the default configuration, the aggregate score is the mean over tasks with valid scores; task filters restrict it to the selected tasks. See Metrics and Aggregation for repeated attempts and scoring failure rules.
Task Results and Scoring Evidence
The attempt’smetrics.score stores the final evaluator score. Its final_answer stores the agent’s terminal action label, or MAX_STEPS when it reaches the turn limit. The termination label is not itself the evaluation score.
To inspect desktop actions, use each trajectory turn’s desktop actions and screenshot SHA-256 hash. The current loop identifies screenshots by hash and replaces image data in the trajectory with omission placeholders; it does not save viewable screenshot files or per-check evaluator scores. Consult evaluator in the original task JSON for the individual checks.
Troubleshooting
- qcow2 not found: pass an existing absolute
vm_paththrough--env-params. - VM startup timeout: inspect
docker logs <container>, verify that port 5000’s/screenshotservice returns non-empty content, and increasestartup_timeoutif necessary. - Docker permission denied: configure access as described in Docker Environment, or enable
use_sudo_dockeronly after passwordless sudo is available. - KVM unavailable: verify that
/dev/kvmexists and the executing user can access it; otherwise the container falls back to software virtualization. - Incorrect clicks: make sure the actual VM resolution matches
screen_widthandscreen_height. Both agent styles map model coordinates back to the original screenshot size. - Setup or evaluator failure: inspect the per-task error and container logs. The runtime reports prepare, run, and evaluation failures separately.
Add another CUA agent
Use the Benchmark-driven loop and the Claude and Qwen3.5 agent implementations under these paths as references:agent_style routing in OSWorldBenchmarkConfig, OSWorldBenchmarkPlan, and the _create_agent() method of OSWorldBenchmark, and convert model output into the shared OSWorldAction type.