diff --git a/README.md b/README.md index e667c20..2578a41 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,44 @@ # DesktopEnv: An Environment towards Human-like Computer Task Mastery -## Setup guide -### x86_64 -todo +## Updates +- 2024-03-01: -### Apple Silicon -Please refer to https://docs.google.com/document/d/1KBdeZwmZs2Vi_Wsnngb3Wf1-RiwMMpXTftwMqP2Ztak/edit#heading=h.uh0x0tkl7fuw +## Install +1. Install VMWare and configure `vmrun` command: +Please refer to [guidance](https://docs.google.com/document/d/1KBdeZwmZs2Vi_Wsnngb3Wf1-RiwMMpXTftwMqP2Ztak/edit#heading=h.uh0x0tkl7fuw) +2. Install the environment package, download the examples and the virtual machine image. +```bash +pip install desktop_env +mkdir -p ~/.desktop_env +wget xxxx +wget xxxx +``` + +## Quick Start +Run the following minimal example to interact with the environment: +```python +import json +from desktop_env.envs.desktop_env import DesktopEnv + +with open("evaluation_examples/examples/gimp/f723c744-e62c-4ae6-98d1-750d3cd7d79d.json", "r", encoding="utf-8") as f: + example = json.load(f) + +env = DesktopEnv( + path_to_vm=r"path_to_vm", + action_space="computer_13", + task_config=example +) +observation = env.reset() + +observation, reward, done, info = env.step({"action_type": "CLICK", "parameters": {"button": "right", "num_clicks": 1}}) +``` + +## Annotation Tool Usage +We provide an annotation tool to help you annotate the examples. + +## Agent Usage +We provide a simple agent to interact with the environment. You can use it as a starting point to build your own agent. ## Road map of infra (Proposed) @@ -33,3 +65,14 @@ Please refer to https://docs.google.com/document/d/1KBdeZwmZs2Vi_Wsnngb3Wf1-RiwM - [ ] Build a website for the project - [ ] Crawl all resources we explored from the internet, and make it easy to access - [ ] Set up ways for community to contribute new examples + +## Citation +If you find this environment useful, please consider citing our work: +``` +@article{DesktopEnv, + title={}, + author={}, + journal={arXiv preprint arXiv:xxxx.xxxx}, + year={2024} +} +``` \ No newline at end of file