Skip to content

Commit fed2448

Browse files
add streamlit requirement, update readme
1 parent d3a52d9 commit fed2448

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,48 @@ image to select a step and observe the action taken by the agent.
226226

227227
**⚠️ 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.
228228

229+
### AgentLab Server and AgentLab Controller
230+
231+
The AgentLab Server and Controller are two components that work together to control and debug an agent deployed in an environment.
232+
233+
#### Prerequisites
234+
235+
First, set a `.env` file at the root of the repo with the following content:
236+
237+
```bash
238+
# LLM Creds (Azure as an example)
239+
AZURE_OPENAI_ENDPOINT=<YOUR_AZURE_OPENAI_ENDPOINT>
240+
AZURE_OPENAI_API_KEY=<YOUR_AZURE_OPENAI_API_KEY>
241+
AZURE_OPENAI_API_VERSION=<YOUR_AZURE_OPENAI_API_KEY>
242+
243+
# ServiceNow dev instance creds
244+
SNOW_INSTANCE_URL=https://<your_servicenow_dev_instance>.service-now.com/
245+
SNOW_INSTANCE_UNAME="admin"
246+
SNOW_INSTANCE_PWD=<password>
247+
248+
# MiniWob
249+
MINIWOB_URL="file:///path/to/BrowserGym/miniwob-plusplus/miniwob/html/miniwob/"
250+
```
251+
252+
#### Launch the server
253+
254+
The AgentLab Server is responsible for hosting and enabling interaction with the environment. It is a lightweight FastAPI server that handles the BrowserGym environment and provides a REST API for the controller.
255+
256+
To launch the server, open a terminal and run (you will need to keep this terminal open for the next step):
257+
258+
```bash
259+
agentlab-server
260+
```
261+
262+
#### Launch the controller
263+
264+
The AgentLab Controller is a streamlit app responsible for controlling the agent and how it interacts with the environment hosted on the server.
265+
266+
To launch the controller, open a new terminal and run:
267+
268+
```bash
269+
agentlab-controller
270+
```
229271

230272
## 🏆 Leaderboard
231273

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,4 @@ ray[default]
2727
python-slugify
2828
pillow
2929
gymnasium>=0.27
30+
streamlit

0 commit comments

Comments
 (0)