Merge branch 'main' into feat/integrate_camel

Author: WHALEEYE

README.md

@@ -6,6 +6,17 @@
 [![Wechat][wechat-image]][wechat-url]
 [![Twitter][twitter-image]][twitter-url]
 
+<p align="center">
+  <a href="https://crab.camel-ai.org/">Website & Demos</a> |
+  <a href="https://www.camel-ai.org/post/crab">Blog</a> |
+  <a href="https://dandansamax.github.io/posts/crab-paper/">Chinese Blog</a> |
+  <a href="https://www.camel-ai.org/">CAMEL-AI</a>
+</p>
+
+<p align="center">
+  <img src='https://raw.githubusercontent.com/camel-ai/crab/main/assets/CRAB_logo1.png' width=800>
+</p>
+
 ## Overview
 
 CRAB is a framework for building LLM agent benchmark environments in a Python-centric way.
@@ -18,10 +29,10 @@ CRAB is a framework for building LLM agent benchmark environments in a Python-ce
 
 ⚙ ️Easy-to-use Configuration
 * Add a new action by simply adding a `@action` decorator on a Python function.
-* Deine the environment by integrating several actions together.
+* Define the environment by integrating several actions together.
 
 📐 Novel Benchmarking Suite
-* Define tasks and the corresponding evlauators in an intuitive Python-native way.
+* Define tasks and the corresponding evaluators in an intuitive Python-native way.
 * Introduce a novel graph evaluator method providing fine-grained metrics.
 
 ## Installation
@@ -72,4 +83,4 @@ Please cite [our paper](https://arxiv.org/abs/2407.01511) if you use anything re
 [twitter-url]: https://twitter.com/CamelAIOrg
 [twitter-image]: https://img.shields.io/twitter/follow/CamelAIOrg?style=social&color=brightgreen&logo=twitter
 [arxiv-image]: https://img.shields.io/badge/arXiv-2407.01511-b31b1b.svg
-[arxiv-url]: https://arxiv.org/abs/2407.01511
+[arxiv-url]: https://arxiv.org/abs/2407.01511

assets/CRAB_logo1.png

@@ -30,18 +30,34 @@ chmod +x ubuntu_env_init.sh
 
 The VM will reboot after initilization. After rebooting, remember its ip address.
 
+
+## Install ADB
+
+Download and install ADB from its [official website](https://developer.android.com/tools/releases/platform-tools).
+
 ## Install Android Emulator
 
-Download the newest version of [Android Studio](https://developer.android.com/studio). Install it.
+You can use emulators in [Android Studio](https://developer.android.com/studio) to simulate an Android device if you
+don't want to use a physical one.
 
-Open Android studio and use build-in device manager to create a Pixel 8 Pro with system image release "R".
+To create a new virtual device, open Android Studio and use its built-in device manager to create a Pixel 8 Pro with
+system image release "R".
+
+> Note that the benchmark on our side runs on a Google Pixel 8 Pro with system image release "R". However, cases are
+> noticed that Google API Level 30 may not work properly when trying to enable USB debugging mode. If such issues are 
+> encountered, you can try switch to releases of lower API levels (e.g. "Q").
 
 ![](./assets/android_1.png)
 
 ![](./assets/android_2.png)
 
-Then boot it.
+Then you can boot the device. To check if it's all set, run
 
-## Install ADB
+```shell
+adb devices
+```
+
+You should see the device in the list.
 
-Download and install ADB from its [official website](https://developer.android.com/tools/releases/platform-tools)
+> Important: ADB won't work normally if you see an `unauthorized` tag after the device ID. To solve this, enable both
+> the developer mode and USB debugging mode in the device.

crab-benchmark-v0/docs/environment_local_setup.md

@@ -105,7 +105,7 @@ def init_log_dir(self):
             self.task_info_dir.mkdir(exist_ok=True, parents=True)
             self.write_task_info_json(self.task_info_dir / "task_info.json")
 
-            self.time_now = datetime.now().strftime("%Y-%m-%d_%H:%M:%S")
+            self.time_now = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
             self.current_experiment_dir = (
                 self.task_info_dir / f"{self.agent_policy.__class__.__name__}"
                 f"({self.agent_policy.get_backend_model_name()})" / self.time_now