Skip to content

Commit 3fe2584

Browse files
authored
Update README.md
1 parent 2aa2e94 commit 3fe2584

File tree

1 file changed

+24
-17
lines changed

1 file changed

+24
-17
lines changed

README.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
[🛠️ Setup](#%EF%B8%8F-setup-agentlab)  | 
1616
[🤖 Assistant](#-ui-assistant)  | 
1717
[🚀 Launch Experiments](#-launch-experiments)  | 
18-
[🔍 Analyse Results](#-analyse-results)  | 
18+
[🔍 Analyse Results](#-analyse-results)  | 
19+
[🏆 Leaderboard](#-leaderboard)  | 
1920
[🤖 Build Your Agent](#-implement-a-new-agent)  | 
2021
[↻ Reproducibility](#-reproducibility)
2122

@@ -35,10 +36,10 @@ AgentLab is a framework for developing and evaluating agents on a variety of
3536
AgentLab Features:
3637
* Easy large scale parallel [agent experiments](#-launch-experiments) using [ray](https://www.ray.io/)
3738
* Building blocks for making agents over BrowserGym
38-
* Unified LLM API for OpenRouter, OpenAI, Azure, or self hosted using TGI.
39-
* Prefered way for running benchmarks like WebArena
39+
* Unified LLM API for OpenRouter, OpenAI, Azure, or self-hosted using TGI.
40+
* Preferred way for running benchmarks like WebArena
4041
* Various [reproducibility features](#reproducibility-features)
41-
* Unified LeaderBoard (soon)
42+
* Unified [LeaderBoard](https://huggingface.co/spaces/ServiceNow/browsergym-leaderboard)
4243

4344
## 🎯 Supported Benchmarks
4445

@@ -62,12 +63,12 @@ AgentLab Features:
6263
pip install agentlab
6364
```
6465

65-
If not done already, install playwright:
66+
If not done already, install Playwright:
6667
```bash
6768
playwright install
6869
```
6970

70-
Make sure to prepare the required benchmark according to instructions provided in the [setup
71+
Make sure to prepare the required benchmark according to the instructions provided in the [setup
7172
column](#-supported-benchmarks).
7273

7374
```bash
@@ -177,7 +178,7 @@ experience, consider using benchmarks like WorkArena instead.
177178

178179
### Loading Results
179180

180-
The class [`ExpResult`](https://github.com/ServiceNow/BrowserGym/blob/da26a5849d99d9a3169d7b1fde79f909c55c9ba7/browsergym/experiments/src/browsergym/experiments/loop.py#L595) provides a lazy loader for all the information of a specific experiment. You can use [`yield_all_exp_results`](https://github.com/ServiceNow/BrowserGym/blob/da26a5849d99d9a3169d7b1fde79f909c55c9ba7/browsergym/experiments/src/browsergym/experiments/loop.py#L872) to recursivley find all results in a directory. Finally [`load_result_df`](https://github.com/ServiceNow/AgentLab/blob/be1998c5fad5bda47ba50497ec3899aae03e85ec/src/agentlab/analyze/inspect_results.py#L119C5-L119C19) gathers all the summary information in a single dataframe. See [`inspect_results.ipynb`](src/agentlab/analyze/inspect_results.ipynb) for example usage.
181+
The class [`ExpResult`](https://github.com/ServiceNow/BrowserGym/blob/da26a5849d99d9a3169d7b1fde79f909c55c9ba7/browsergym/experiments/src/browsergym/experiments/loop.py#L595) provides a lazy loader for all the information of a specific experiment. You can use [`yield_all_exp_results`](https://github.com/ServiceNow/BrowserGym/blob/da26a5849d99d9a3169d7b1fde79f909c55c9ba7/browsergym/experiments/src/browsergym/experiments/loop.py#L872) to recursively find all results in a directory. Finally [`load_result_df`](https://github.com/ServiceNow/AgentLab/blob/be1998c5fad5bda47ba50497ec3899aae03e85ec/src/agentlab/analyze/inspect_results.py#L119C5-L119C19) gathers all the summary information in a single dataframe. See [`inspect_results.ipynb`](src/agentlab/analyze/inspect_results.ipynb) for example usage.
181182

182183
```python
183184
from agentlab.analyze import inspect_results
@@ -207,9 +208,15 @@ Once this is selected, you can see the trace of your agent on the given task. Cl
207208
image to select a step and observe the action taken by the agent.
208209

209210

210-
**⚠️ Note**: Gradio is still in developement and unexpected behavior have been frequently noticed. Version 5.5 seems to work properly so far. If you're not sure that the proper information is displaying, refresh the page and select your experiment again.
211+
**⚠️ Note**: Gradio is still developing, and unexpected behavior has been frequently noticed. Version 5.5 seems to work properly so far. If you're not sure that the proper information is displaying, refresh the page and select your experiment again.
211212

212213

214+
## 🏆 Leaderboard
215+
216+
Official unified [leaderboard](https://huggingface.co/spaces/ServiceNow/browsergym-leaderboard) across all benchmarks.
217+
218+
Experiments are on their way for more reference points using GenericAgent. We are also working on code to automatically push a study to the leaderboard.
219+
213220
## 🤖 Implement a new Agent
214221

215222
Get inspiration from the `MostBasicAgent` in
@@ -225,32 +232,32 @@ Several factors can influence reproducibility of results in the context of evalu
225232
dynamic benchmarks.
226233

227234
### Factors affecting reproducibility
228-
* **Software version**: Different version of Playwright or any package in the software stack could
235+
* **Software version**: Different versions of Playwright or any package in the software stack could
229236
influence the behavior of the benchmark or the agent.
230-
* **API based LLMs silently changing**: Even for a fixed version, an LLM may be updated e.g. to
231-
incorporate latest web knowledge.
237+
* **API-based LLMs silently changing**: Even for a fixed version, an LLM may be updated e.g. to
238+
incorporate the latest web knowledge.
232239
* **Live websites**:
233240
* WorkArena: The demo instance is mostly fixed in time to a specific version but ServiceNow
234-
sometime push minor modifications.
241+
sometimes pushes minor modifications.
235242
* AssistantBench and GAIA: These rely on the agent navigating the open web. The experience may
236243
change depending on which country or region, some websites might be in different languages by
237244
default.
238-
* **Stochastic Agents**: Setting temperature of the LLM to 0 can reduce most stochasticity.
239-
* **Non deterministic tasks**: For a fixed seed, the changes should be minimal
245+
* **Stochastic Agents**: Setting the temperature of the LLM to 0 can reduce most stochasticity.
246+
* **Non-deterministic tasks**: For a fixed seed, the changes should be minimal
240247

241248
### Reproducibility Features
242249
* `Study` contains a dict of information about reproducibility, including benchmark version, package
243250
version and commit hash
244251
* The `Study` class allows automatic upload of your results to
245252
[`reproducibility_journal.csv`](reproducibility_journal.csv). This makes it easier to populate a
246253
large amount of reference points. For this feature, you need to `git clone` the repository and install via `pip install -e .`.
247-
* **Reproduced results in the leaderboard**. For agents that are repdocudibile, we encourage users
254+
* **Reproduced results in the leaderboard**. For agents that are reprocudibile, we encourage users
248255
to try to reproduce the results and upload them to the leaderboard. There is a special column
249256
containing information about all reproduced results of an agent on a benchmark.
250257
* **ReproducibilityAgent**: [You can run this agent](src/agentlab/agents/generic_agent/reproducibility_agent.py) on an existing study and it will try to re-run
251-
the same actions on the same task seeds. A vsiual diff of the two prompts will be displayed in the
258+
the same actions on the same task seeds. A visual diff of the two prompts will be displayed in the
252259
AgentInfo HTML tab of AgentXray. You will be able to inspect on some tasks what kind of changes
253-
between to two executions. **Note**: this is a beta feature and will need some adaptation for your
260+
between the two executions. **Note**: this is a beta feature and will need some adaptation for your
254261
own agent.
255262

256263

0 commit comments

Comments
 (0)