Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xavierpuigf authored Nov 6, 2024
1 parent e13f82a commit e57bc4b
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,30 @@

This is the official repository for the PARTNR benchmark. It includes instructions for downloading and running the PARTNR benchmark in the Habitat simulator and implements Large Language Model (LLM) based planners as baselines.

[Project Website](https://aihabitat.org/partnr/) | [Paper](https://arxiv.org/pdf/2411.00081)

<img src="docs/cover_fig.png" width="100%"/>

## Overview

This codebase contains abstractions for enabling agents to follow free form natural language instructions in the Habitat simulator. The main abstractions are - **Agent**, **Planner**, **Tool**, and **Skill**. The agent has access to a set of tools which can allow it to perceive the state of the environment, or interact with the environment using low level skills. This repository also contains the codebase for generating PARTNR datasets using LLMs.

## Citing PARTNR

If you use our codebase or dataset in your research, please cite the [PARTNR](https://arxiv.org/pdf/2411.00081) paper:

```
@misc{chang2024partnrbenchmarkplanningreasoning,
title={PARTNR: A Benchmark for Planning and Reasoning in Embodied Multi-agent Tasks},
author={Matthew Chang and Gunjan Chhablani and Alexander Clegg and Mikael Dallaire Cote and Ruta Desai and Michal Hlavac and Vladimir Karashchuk and Jacob Krantz and Roozbeh Mottaghi and Priyam Parashar and Siddharth Patki and Ishita Prasad and Xavier Puig and Akshara Rai and Ram Ramrakhya and Daniel Tran and Joanne Truong and John M. Turner and Eric Undersander and Tsung-Yen Yang},
year={2024},
eprint={2411.00081},
archivePrefix={arXiv},
primaryClass={cs.RO},
url={https://arxiv.org/abs/2411.00081},
}
```

## Code Organization

Below are the details of various important directories and classes.
Expand Down Expand Up @@ -175,6 +193,8 @@ See detailed doc [here](./habitat_llm/finetuning/README.md)

For additional details about adding new agents, tools and custom actions see [here](./docs/extending.md)



## License

partnr-planner is MIT licensed. See the [LICENSE](LICENSE) for details.

0 comments on commit e57bc4b

Please sign in to comment.