eagent-eval 0.0.8

No project description provided

Embodied Agent Interface (EAgent): Benchmarking LLMs for Embodied Decision Making

Manling Li, Shiyu Zhao, Qineng Wang, Kangrui Wang, Yu Zhou, Sanjana Srivastava, Cem Gokmen, Tony Lee, Li Erran Li, Ruohan Zhang, Weiyu Liu, Percy Liang, Li Fei-Fei, Jiayuan Mao, Jiajun Wu

Stanford Vision and Learning Lab, Stanford University

Dataset Highlights

• Standardized goal specifications.
• Standardized modules and interfaces.
• Broad coverage of evaluation and fine-grained metrics.

Overview

We aim to evaluate Large Language Models (LLMs) for embodied decision-making. While many works leverage LLMs for decision-making in embodied environments, a systematic understanding of their performance is still lacking. These models are applied in different domains, for various purposes, and with diverse inputs and outputs. Current evaluations tend to rely on final success rates alone, making it difficult to pinpoint where LLMs fall short and how to leverage them effectively in embodied AI systems.

To address this gap, we propose the Embodied Agent Interface (EAgent), which unifies:

1. A broad set of embodied decision-making tasks involving both state and temporally extended goals.
2. Four commonly used LLM-based modules: goal interpretation, subgoal decomposition, action sequencing, and transition modeling.
3. Fine-grained evaluation metrics, identifying errors such as hallucinations, affordance issues, and planning mistakes.

Our benchmark provides a comprehensive assessment of LLM performance across different subtasks, identifying their strengths and weaknesses in embodied decision-making contexts.

Installation

1. Create and Activate a Conda Environment:

   conda create -n eagent python=3.8 -y 
   conda activate eagent
   

2. Install eagent-eval:

   You can install it from pip:

   pip install eagent-eval
   

   Or, install from source:

   git clone https://github.com/embodied-agent-interface/embodied-agent-interface.git
   cd embodied-agent-interface
   pip install -e .
   

3. (Optional) Install iGibson for behavior evaluation:

   If you need to use behavior_eval, install iGibson. Follow these steps to minimize installation issues:

   • Make sure you are using Python 3.8 and meet the minimum system requirements in the iGibson installation guide.

   • Install CMake using Conda (do not use pip):

     conda install cmake
     

   • Install iGibson: We provide an installation script:

     python -m behavior_eval.utils.install_igibson_utils
     

     Alternatively, install it manually:

     git clone https://github.com/embodied-agent-interface/iGibson.git --recursive
     cd iGibson
     pip install -e .
     

   • Download assets:

     python -m behavior_eval.utils.download_utils
     

   We have successfully tested installation on Linux, Windows 10+, and macOS.

Quick Start

1. Arguments:

   eagent-eval \
     --dataset {virtualhome,behavior} \
     --mode {generate_prompts,evaluate_results} \
     --eval-type {action_sequencing,transition_modeling,goal_interpretation,subgoal_decomposition} \
     --llm-response-path <path_to_responses> \
     --output-dir <output_directory> \
     --num-workers <number_of_workers>
   

   Run the following command for further information:

   eagent-eval --help
   

2. Examples:

• Evaluate Results

  Make sure to download our results first if you don't want to specify <path_to_responses>

  python -m eagent_eval.utils.download_utils
  

  Then, run the commands below:

  eagent-eval --dataset virtualhome --eval-type action_sequencing --mode evaluate_results
  eagent-eval --dataset virtualhome --eval-type transition_modeling --mode evaluate_results
  eagent-eval --dataset virtualhome --eval-type goal_interpretation --mode evaluate_results
  eagent-eval --dataset virtualhome --eval-type subgoal_decomposition --mode evaluate_results
  eagent-eval --dataset behavior --eval-type action_sequencing --mode evaluate_results
  eagent-eval --dataset behavior --eval-type transition_modeling --mode evaluate_results
  eagent-eval --dataset behavior --eval-type goal_interpretation --mode evaluate_results
  eagent-eval --dataset behavior --eval-type subgoal_decomposition --mode evaluate_results
  

• Generate Pormpts

  To generate prompts, you can run:

  eagent-eval --dataset virtualhome --eval-type action_sequencing --mode generate_prompts
  eagent-eval --dataset virtualhome --eval-type transition_modeling --mode generate_prompts
  eagent-eval --dataset virtualhome --eval-type goal_interpretation --mode generate_prompts
  eagent-eval --dataset virtualhome --eval-type subgoal_decomposition --mode generate_prompts
  eagent-eval --dataset behavior --eval-type action_sequencing --mode generate_prompts
  eagent-eval --dataset behavior --eval-type transition_modeling --mode generate_prompts
  eagent-eval --dataset behavior --eval-type goal_interpretation --mode generate_prompts
  eagent-eval --dataset behavior --eval-type subgoal_decomposition --mode generate_prompts
  

Docker

We provide a ready-to-use Docker image for easy installation and usage.

First, pull the Docker image from Docker Hub:

docker pull jameskrw/eagent-eval

Next, run the Docker container interactively:

docker run -it jameskrw/eagent-eval

When inside the container, make sure you remain in the /opt/iGibson directory (do not change to other directories).

To check the available arguments for the eagent-eval CLI, use the following command:

python3 -m eagent_eval.cli --help

You can run:

python3 -m eagent_eval.cli

By default, this will start generating prompts for goal interpretation in Behavior.

The command python3 -m eagent_eval.cli is equivalent to eagent-eval as introduced above, although currently only python3 -m eagent_eval.cli is supported in the docker.