Skip to content

Commit 2a285c9

Browse files
add streamlit requirement, update readme
1 parent 3db9f9e commit 2a285c9

File tree

2 files changed

+44
-1
lines changed

2 files changed

+44
-1
lines changed

README.md

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

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

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

229271
## 🏆 Leaderboard
230272

requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,5 @@ matplotlib
2626
ray[default]
2727
python-slugify
2828
pillow
29-
gymnasium>=0.27
29+
gymnasium>=0.27
30+
streamlit

0 commit comments

Comments
 (0)