alckasoc
519 linhas
19 KiB
Python
519 linhas
19 KiB
Python
"""OSWorld's run.py with AgentS2."""
|
|
|
|
"""Script to run end-to-end evaluation on the benchmark.
|
|
Utils and basic architecture credit to https://github.com/web-arena-x/webarena/blob/main/run.py.
|
|
"""
|
|
|
|
import argparse
|
|
import datetime
|
|
import json
|
|
import logging
|
|
import os
|
|
import sys
|
|
import signal
|
|
import time
|
|
from multiprocessing import Process, Manager, current_process, Queue
|
|
|
|
|
|
import lib_run_single
|
|
from desktop_env.desktop_env import DesktopEnv
|
|
|
|
from dotenv import load_dotenv
|
|
load_dotenv()
|
|
|
|
|
|
# Logger Configs {{{ #
|
|
logger = logging.getLogger()
|
|
logger.setLevel(logging.DEBUG)
|
|
|
|
datetime_str: str = datetime.datetime.now().strftime("%Y%m%d@%H%M%S")
|
|
|
|
stdout_handler = logging.StreamHandler(sys.stdout)
|
|
|
|
stdout_handler.setLevel(logging.INFO)
|
|
|
|
formatter = logging.Formatter(
|
|
fmt="\x1b[1;33m[%(asctime)s \x1b[31m%(levelname)s \x1b[32m%(module)s/%(lineno)d-%(processName)s\x1b[1;33m] \x1b[0m%(message)s"
|
|
)
|
|
|
|
stdout_handler.setFormatter(formatter)
|
|
|
|
stdout_handler.addFilter(logging.Filter("desktopenv"))
|
|
|
|
logger.addHandler(stdout_handler)
|
|
# }}} Logger Configs #
|
|
|
|
logger = logging.getLogger("desktopenv.experiment")
|
|
|
|
|
|
# Global variables for signal handling
|
|
active_environments = []
|
|
processes = []
|
|
is_terminating = False
|
|
|
|
def distribute_tasks(test_all_meta: dict) -> list:
|
|
all_tasks = []
|
|
for domain, examples in test_all_meta.items():
|
|
for example_id in examples:
|
|
all_tasks.append((domain, example_id))
|
|
return all_tasks
|
|
|
|
def process_signal_handler(signum, frame, env_idx):
|
|
logger.info(f"Process {env_idx + 1} received signal {signum}. Shutting down...")
|
|
local_vars = frame.f_locals
|
|
active_environments = local_vars.get('active_environments', [])
|
|
for env in active_environments:
|
|
if env is not None:
|
|
try:
|
|
logger.info(f"Process {env_idx + 1} closing environment...")
|
|
env.close()
|
|
logger.info(f"Process {env_idx + 1} environment closed successfully")
|
|
except Exception as e:
|
|
logger.error(f"Process {env_idx + 1} error closing environment: {e}")
|
|
logger.info(f"Process {env_idx + 1} shutdown complete. Exiting.")
|
|
sys.exit(0)
|
|
|
|
def run_env_tasks(task_queue: Queue, args: argparse.Namespace, shared_scores: list, engine_params, engine_params_for_grounding):
|
|
active_environments = []
|
|
env = None
|
|
try:
|
|
# Use IMAGE_ID_MAP for AWS provider to get snapshot_name
|
|
snapshot_name = None
|
|
region = getattr(args, 'region', None)
|
|
if args.provider_name == 'aws' and region is not None:
|
|
try:
|
|
from desktop_env.providers.aws.manager import IMAGE_ID_MAP
|
|
screen_size = (args.screen_width, args.screen_height)
|
|
snapshot_name = IMAGE_ID_MAP[region].get(screen_size, IMAGE_ID_MAP[region][(1920, 1080)])
|
|
except Exception as e:
|
|
logger.error(f"Failed to get snapshot_name from IMAGE_ID_MAP: {e}")
|
|
snapshot_name = None
|
|
from gui_agents.s3.agents.agent_s import AgentS3
|
|
from gui_agents.s3.agents.grounding import OSWorldACI
|
|
env = DesktopEnv(
|
|
path_to_vm=args.path_to_vm,
|
|
action_space=args.action_space,
|
|
provider_name=args.provider_name,
|
|
region=region,
|
|
snapshot_name=snapshot_name,
|
|
screen_size=(args.screen_width, args.screen_height),
|
|
headless=args.headless,
|
|
os_type = "Ubuntu",
|
|
require_a11y_tree=args.observation_type in ["a11y_tree", "screenshot_a11y_tree", "som"],
|
|
enable_proxy=True,
|
|
client_password=getattr(args, 'client_password', ''),
|
|
)
|
|
grounding_agent = OSWorldACI(
|
|
env=env,
|
|
platform="linux",
|
|
engine_params_for_generation=engine_params,
|
|
engine_params_for_grounding=engine_params_for_grounding,
|
|
width=args.screen_width,
|
|
height=args.screen_height,
|
|
)
|
|
agent = AgentS3(
|
|
engine_params,
|
|
grounding_agent,
|
|
platform="linux",
|
|
)
|
|
|
|
active_environments.append(env)
|
|
logger.info(f"Process {current_process().name} started.")
|
|
while True:
|
|
try:
|
|
item = task_queue.get(timeout=5)
|
|
except Exception:
|
|
break
|
|
domain, example_id = item
|
|
try:
|
|
config_file = os.path.join(
|
|
args.test_config_base_dir, f"examples/{domain}/{example_id}.json"
|
|
)
|
|
with open(config_file, "r", encoding="utf-8") as f:
|
|
example = json.load(f)
|
|
instruction = example["instruction"]
|
|
example_result_dir = os.path.join(
|
|
args.result_dir,
|
|
args.action_space,
|
|
args.observation_type,
|
|
args.model,
|
|
domain,
|
|
example_id,
|
|
)
|
|
os.makedirs(example_result_dir, exist_ok=True)
|
|
logger.info(f"[{current_process().name}][Domain]: {domain}")
|
|
logger.info(f"[{current_process().name}][Example ID]: {example_id}")
|
|
logger.info(f"[{current_process().name}][Instruction]: {instruction}")
|
|
try:
|
|
lib_run_single.run_single_example(
|
|
agent,
|
|
env,
|
|
example,
|
|
args.max_steps,
|
|
instruction,
|
|
args,
|
|
example_result_dir,
|
|
shared_scores,
|
|
)
|
|
except Exception as e:
|
|
import traceback
|
|
logger.error(f"Exception in {current_process().name} {domain}/{example_id}: {e}")
|
|
logger.error(traceback.format_exc())
|
|
try:
|
|
env.controller.end_recording(
|
|
os.path.join(example_result_dir, "recording.mp4")
|
|
)
|
|
except Exception as rec_e:
|
|
logger.error(f"Failed to end recording: {rec_e}")
|
|
with open(os.path.join(example_result_dir, "traj.jsonl"), "a") as f:
|
|
f.write(
|
|
json.dumps(
|
|
{"Error": f"{domain}/{example_id} - {e}"}
|
|
)
|
|
)
|
|
f.write("\n")
|
|
except Exception as e:
|
|
logger.error(f"Task-level error in {current_process().name}: {e}")
|
|
import traceback
|
|
logger.error(traceback.format_exc())
|
|
except Exception as e:
|
|
logger.error(f"Process-level error in {current_process().name}: {e}")
|
|
import traceback
|
|
logger.error(traceback.format_exc())
|
|
finally:
|
|
logger.info(f"{current_process().name} cleaning up environment...")
|
|
try:
|
|
if env:
|
|
env.close()
|
|
logger.info(f"{current_process().name} environment closed successfully")
|
|
except Exception as e:
|
|
logger.error(f"{current_process().name} error during environment cleanup: {e}")
|
|
|
|
def signal_handler(signum, frame):
|
|
global is_terminating, active_environments, processes
|
|
if is_terminating:
|
|
return
|
|
is_terminating = True
|
|
logger.info(f"Received signal {signum}. Gracefully shutting down...")
|
|
for env in active_environments:
|
|
try:
|
|
logger.info(f"Closing environment...")
|
|
env.close()
|
|
logger.info(f"Environment closed successfully")
|
|
except Exception as e:
|
|
logger.error(f"Error closing environment: {e}")
|
|
for p in processes:
|
|
if p.is_alive():
|
|
try:
|
|
logger.info(f"Sending termination signal to process {p.name}...")
|
|
p.terminate()
|
|
except Exception as e:
|
|
logger.error(f"Error sending termination signal to process: {e}")
|
|
time.sleep(1)
|
|
for p in processes:
|
|
if p.is_alive():
|
|
try:
|
|
logger.info(f"Forcefully terminating process {p.name}...")
|
|
import signal as sig
|
|
os.kill(p.pid, sig.SIGKILL)
|
|
except Exception as e:
|
|
logger.error(f"Error forcefully terminating process: {e}")
|
|
logger.info("Shutdown complete. Exiting.")
|
|
sys.exit(0)
|
|
|
|
def config() -> argparse.Namespace:
|
|
parser = argparse.ArgumentParser(
|
|
description="Run end-to-end evaluation on the benchmark"
|
|
)
|
|
|
|
# environment config
|
|
parser.add_argument("--path_to_vm", type=str, default=None)
|
|
parser.add_argument(
|
|
"--provider_name", type=str, default="vmware",
|
|
help="Virtualization provider (vmware, docker, aws, azure, gcp, virtualbox)"
|
|
)
|
|
parser.add_argument(
|
|
"--headless", action="store_true", help="Run in headless machine"
|
|
)
|
|
parser.add_argument(
|
|
"--action_space", type=str, default="pyautogui", help="Action type"
|
|
)
|
|
parser.add_argument(
|
|
"--observation_type",
|
|
choices=["screenshot", "a11y_tree", "screenshot_a11y_tree", "som"],
|
|
default="screenshot",
|
|
help="Observation type",
|
|
)
|
|
parser.add_argument("--num_envs", type=int, default=1, help="Number of environments to run in parallel")
|
|
parser.add_argument("--screen_width", type=int, default=1920)
|
|
parser.add_argument("--screen_height", type=int, default=1080)
|
|
parser.add_argument("--sleep_after_execution", type=float, default=1.0)
|
|
parser.add_argument("--max_steps", type=int, default=15)
|
|
|
|
parser.add_argument("--domain", type=str, default="all")
|
|
parser.add_argument(
|
|
"--test_all_meta_path", type=str, default="evaluation_examples/test_all.json"
|
|
)
|
|
parser.add_argument(
|
|
"--test_config_base_dir", type=str, default="evaluation_examples"
|
|
)
|
|
parser.add_argument("--result_dir", type=str, default="./results")
|
|
|
|
parser.add_argument(
|
|
"--region", type=str, default="us-east-1", help="AWS region for the VM"
|
|
)
|
|
parser.add_argument(
|
|
"--client_password", type=str, default="", help="Client password"
|
|
)
|
|
|
|
# agent config
|
|
parser.add_argument("--max_trajectory_length", type=int, default=8)
|
|
|
|
|
|
# lm config
|
|
parser.add_argument("--model_provider", type=str, default="openai")
|
|
parser.add_argument("--model", type=str, default="gpt-4o")
|
|
parser.add_argument(
|
|
"--model_url",
|
|
type=str,
|
|
default="",
|
|
help="The URL of the main generation model API.",
|
|
)
|
|
parser.add_argument(
|
|
"--model_api_key",
|
|
type=str,
|
|
default="",
|
|
help="The API key of the main generation model.",
|
|
)
|
|
parser.add_argument("--model_temperature", type=float, default=None, help="Temperature to fix the generation model at (e.g. o3 can only be run with 1.0)")
|
|
|
|
# grounding model config
|
|
parser.add_argument("--ground_provider", type=str, required=True, help="The provider for the grounding model")
|
|
parser.add_argument("--ground_url", type=str, required=True, help="The URL of the grounding model")
|
|
parser.add_argument(
|
|
"--ground_api_key",
|
|
type=str,
|
|
default="",
|
|
help="The API key of the grounding model.",
|
|
)
|
|
parser.add_argument(
|
|
"--ground_model", type=str, required=True, help="The model name for the grounding model"
|
|
)
|
|
parser.add_argument(
|
|
"--grounding_width",
|
|
type=int,
|
|
required=True,
|
|
help="Width of screenshot image after processor rescaling",
|
|
)
|
|
parser.add_argument(
|
|
"--grounding_height",
|
|
type=int,
|
|
required=True,
|
|
help="Height of screenshot image after processor rescaling",
|
|
)
|
|
|
|
args = parser.parse_args()
|
|
|
|
return args
|
|
|
|
|
|
def test(args: argparse.Namespace, test_all_meta: dict) -> None:
|
|
global processes
|
|
logger.info("Args: %s", args)
|
|
all_tasks = distribute_tasks(test_all_meta)
|
|
logger.info(f"Total tasks: {len(all_tasks)}")
|
|
|
|
engine_params = {
|
|
"engine_type": args.model_provider,
|
|
"model": args.model,
|
|
"base_url": getattr(args, 'model_url', ''),
|
|
"api_key": getattr(args, 'model_api_key', ''),
|
|
"temperature": getattr(args, 'model_temperature', None),
|
|
}
|
|
engine_params_for_grounding = {
|
|
"engine_type": args.ground_provider,
|
|
"model": args.ground_model,
|
|
"base_url": getattr(args, 'ground_url', ''),
|
|
"api_key": getattr(args, 'ground_api_key', ''),
|
|
"grounding_width": args.grounding_width,
|
|
"grounding_height": args.grounding_height,
|
|
}
|
|
|
|
with Manager() as manager:
|
|
shared_scores = manager.list()
|
|
task_queue = manager.Queue()
|
|
for item in all_tasks:
|
|
task_queue.put(item)
|
|
num_envs = args.num_envs
|
|
processes = []
|
|
for i in range(num_envs):
|
|
p = Process(
|
|
target=run_env_tasks,
|
|
args=(task_queue, args, shared_scores, engine_params, engine_params_for_grounding),
|
|
name=f"EnvProcess-{i+1}"
|
|
)
|
|
p.daemon = True
|
|
p.start()
|
|
processes.append(p)
|
|
logger.info(f"Started process {p.name} with PID {p.pid}")
|
|
try:
|
|
while True:
|
|
alive_count = 0
|
|
for idx, p in enumerate(processes):
|
|
if not p.is_alive():
|
|
logger.warning(f"Process {p.name} died, restarting...")
|
|
new_p = Process(
|
|
target=run_env_tasks,
|
|
args=(task_queue, args, shared_scores, engine_params, engine_params_for_grounding),
|
|
name=f"EnvProcess-Restart-{idx+1}"
|
|
)
|
|
new_p.daemon = True
|
|
new_p.start()
|
|
processes[idx] = new_p
|
|
logger.info(f"Restarted process {new_p.name} with PID {new_p.pid}")
|
|
else:
|
|
alive_count += 1
|
|
if task_queue.empty():
|
|
logger.info("All tasks finished.")
|
|
break
|
|
if alive_count == 0:
|
|
logger.error("All processes died, exiting.")
|
|
break
|
|
time.sleep(5)
|
|
for p in processes:
|
|
p.join()
|
|
except KeyboardInterrupt:
|
|
logger.info("Main process received KeyboardInterrupt. Initiating graceful shutdown...")
|
|
raise
|
|
except Exception as e:
|
|
logger.error(f"Unexpected error while waiting for processes: {e}", exc_info=True)
|
|
for p in processes:
|
|
if p.is_alive():
|
|
try:
|
|
logger.info(f"Terminating process {p.name} due to error...")
|
|
p.terminate()
|
|
except Exception as term_e:
|
|
logger.error(f"Error terminating process {p.name}: {term_e}")
|
|
raise
|
|
scores = list(shared_scores)
|
|
logger.info(f"Average score: {sum(scores) / len(scores) if scores else 0}")
|
|
|
|
|
|
def get_unfinished(
|
|
action_space, use_model, observation_type, result_dir, total_file_json
|
|
):
|
|
target_dir = os.path.join(result_dir, action_space, observation_type, use_model)
|
|
|
|
if not os.path.exists(target_dir):
|
|
return total_file_json
|
|
|
|
finished = {}
|
|
for domain in os.listdir(target_dir):
|
|
finished[domain] = []
|
|
domain_path = os.path.join(target_dir, domain)
|
|
if os.path.isdir(domain_path):
|
|
for example_id in os.listdir(domain_path):
|
|
if example_id == "onboard":
|
|
continue
|
|
example_path = os.path.join(domain_path, example_id)
|
|
if os.path.isdir(example_path):
|
|
if "result.txt" not in os.listdir(example_path):
|
|
# empty all files under example_id
|
|
for file in os.listdir(example_path):
|
|
os.remove(os.path.join(example_path, file))
|
|
else:
|
|
finished[domain].append(example_id)
|
|
|
|
if not finished:
|
|
return total_file_json
|
|
|
|
for domain, examples in finished.items():
|
|
if domain in total_file_json:
|
|
total_file_json[domain] = [
|
|
x for x in total_file_json[domain] if x not in examples
|
|
]
|
|
|
|
return total_file_json
|
|
|
|
|
|
def get_result(action_space, use_model, observation_type, result_dir, total_file_json):
|
|
target_dir = os.path.join(result_dir, action_space, observation_type, use_model)
|
|
if not os.path.exists(target_dir):
|
|
print("New experiment, no result yet.")
|
|
return None
|
|
|
|
all_result = []
|
|
|
|
for domain in os.listdir(target_dir):
|
|
domain_path = os.path.join(target_dir, domain)
|
|
if os.path.isdir(domain_path):
|
|
for example_id in os.listdir(domain_path):
|
|
example_path = os.path.join(domain_path, example_id)
|
|
if os.path.isdir(example_path):
|
|
if "result.txt" in os.listdir(example_path):
|
|
# empty all files under example_id
|
|
try:
|
|
all_result.append(
|
|
float(
|
|
open(
|
|
os.path.join(example_path, "result.txt"), "r"
|
|
).read()
|
|
)
|
|
)
|
|
except:
|
|
all_result.append(0.0)
|
|
|
|
if not all_result:
|
|
print("New experiment, no result yet.")
|
|
return None
|
|
else:
|
|
print("Current Success Rate:", sum(all_result) / len(all_result) * 100, "%")
|
|
return all_result
|
|
|
|
|
|
if __name__ == "__main__":
|
|
signal.signal(signal.SIGINT, signal_handler)
|
|
signal.signal(signal.SIGTERM, signal_handler)
|
|
####### The complete version of the list of examples #######
|
|
os.environ["TOKENIZERS_PARALLELISM"] = "false"
|
|
args = config()
|
|
|
|
# save args to json in result_dir/action_space/observation_type/model/args.json
|
|
path_to_args = os.path.join(
|
|
args.result_dir,
|
|
args.action_space,
|
|
args.observation_type,
|
|
args.model,
|
|
"args.json",
|
|
)
|
|
os.makedirs(os.path.dirname(path_to_args), exist_ok=True)
|
|
with open(path_to_args, "w", encoding="utf-8") as f:
|
|
json.dump(vars(args), f, indent=4)
|
|
|
|
with open(args.test_all_meta_path, "r", encoding="utf-8") as f:
|
|
test_all_meta = json.load(f)
|
|
|
|
if args.domain != "all":
|
|
test_all_meta = {args.domain: test_all_meta[args.domain]}
|
|
|
|
test_file_list = get_unfinished(
|
|
args.action_space,
|
|
args.model,
|
|
args.observation_type,
|
|
args.result_dir,
|
|
test_all_meta,
|
|
)
|
|
left_info = ""
|
|
for domain in test_file_list:
|
|
left_info += f"{domain}: {len(test_file_list[domain])}\n"
|
|
logger.info(f"Left tasks:\n{left_info}")
|
|
|
|
get_result(
|
|
args.action_space,
|
|
args.model,
|
|
args.observation_type,
|
|
args.result_dir,
|
|
test_all_meta,
|
|
)
|
|
test(args, test_file_list)
|