Skip to content

Commit 4e2dc2b

Browse files
ekzhuekzhu
authored
Python: Update lab packages and installation instructions (microsoft#1687)
* update lab packages and installation instructions * fix dep
1 parent ae41027 commit 4e2dc2b

7 files changed

Lines changed: 186 additions & 187 deletions

File tree

‎python/packages/lab/README.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ one of the following categories:
1717

1818
- [**gaia**](./gaia/): Evaluate your agents using the GAIA benchmark for general assistant tasks
1919
- [**tau2**](./tau2/): Evaluate your agents using the TAU2 benchmark for customer support tasks
20-
- [**lightning**](./lightning/): RL training for agents (in development)
20+
- [**lightning**](./lightning/): RL training for agents using Agent Lightning
2121

2222
## Repository Structure
2323

@@ -44,16 +44,14 @@ This structure maintains a single PyPI package `agent-framework-lab` while suppo
4444

4545
## Installation
4646

47-
Install from source:
47+
To install each lab module, use the extras syntax with `pip`:
4848

4949
```bash
50-
git clone https://github.com/microsoft/agent-framework.git
51-
cd agent-framework/python/packages/lab
52-
pip install -e .
50+
pip install "agent-framework-lab[gaia]"
51+
pip install "agent-framework-lab[tau2]"
52+
pip install "agent-framework-lab[lightning]"
5353
```
5454

55-
For details on installing individual modules, see their respective README files listed above.
56-
5755
## Usage
5856

5957
Import and use lab modules from the `agent_framework.lab` namespace.

‎python/packages/lab/gaia/README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,10 @@ It includes built-in benchmarks as well as utilities for running custom evaluati
77
88
## Setup
99

10-
Install from source with GAIA dependencies:
10+
Install the `agent-framework-lab` package with GAIA dependencies:
1111

1212
```bash
13-
git clone https://github.com/microsoft/agent-framework.git
14-
cd agent-framework/python/packages/lab
15-
pip install -e ".[gaia]"
13+
pip install "agent-framework-lab[gaia]"
1614
```
1715

1816
Set up Hugging Face token:

‎python/packages/lab/lightning/README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,10 @@ This package enables you to train and fine-tune agents using advanced RL algorit
88
99
## Installation
1010

11-
Install from source with Lightning dependencies:
11+
Install the `agent-framework-lab` package with Lightning dependencies:
1212

1313
```bash
14-
git clone https://github.com/microsoft/agent-framework.git
15-
cd agent-framework/python/packages/lab
16-
pip install -e ".[lightning]"
14+
pip install "agent-framework-lab[lightning]"
1715
```
1816

1917
### Optional Dependencies

‎python/packages/lab/pyproject.toml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ description = "Experimental modules for Microsoft Agent Framework"
44
authors = [{ name = "Microsoft", email = "[email protected]"}]
55
readme = "README.md"
66
requires-python = ">=3.10"
7-
version = "1.0.0b251001"
7+
version = "1.0.0b251024"
88
license-files = ["LICENSE"]
99
urls.homepage = "https://aka.ms/agent-framework"
1010
urls.source = "https://github.com/microsoft/agent-framework/tree/main/python"
1111
urls.release_notes = "https://github.com/microsoft/agent-framework/releases?q=tag%3Apython-1&expanded=true"
1212
urls.issues = "https://github.com/microsoft/agent-framework/issues"
1313
classifiers = [
1414
"License :: OSI Approved :: MIT License",
15-
"Development Status :: 2 - Pre-Alpha",
15+
"Development Status :: 4 - Beta",
1616
"Intended Audience :: Developers",
1717
"Programming Language :: Python :: 3",
1818
"Programming Language :: Python :: 3.10",
@@ -45,7 +45,6 @@ tau2 = [
4545
"tiktoken>=0.11.0",
4646
"loguru>=0.7.3",
4747
"numpy",
48-
"tau2@ git+https://github.com/sierra-research/tau2-bench@5ba9e3e56db57c5e4114bf7f901291f09b2c5619",
4948
]
5049

5150
# Dependencies for math-related training
@@ -72,6 +71,8 @@ dev = [
7271
"rich",
7372
"tomli",
7473
"tomli-w",
74+
# tau2 from source (not available on PyPI)
75+
"tau2@ git+https://github.com/sierra-research/tau2-bench@5ba9e3e56db57c5e4114bf7f901291f09b2c5619",
7576
]
7677

7778
[project.scripts]

‎python/packages/lab/tau2/README.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,16 @@ _Note: Currently only the airline domain is fully supported._
2323

2424
## Installation
2525

26-
Install from source with TAU2 dependencies:
26+
Install the agent-framework-lab package with TAU2 dependencies:
2727

2828
```bash
29-
git clone https://github.com/microsoft/agent-framework.git
30-
cd agent-framework/python/packages/lab
31-
pip install -e ".[tau2]"
29+
pip install "agent-framework-lab[tau2]"
30+
```
31+
32+
**Important:** You must also install the tau2-bench package from source:
33+
34+
```bash
35+
pip install "tau2 @ git+https://github.com/sierra-research/tau2-bench@5ba9e3e56db57c5e4114bf7f901291f09b2c5619"
3236
```
3337

3438
Download data from [Tau2-Bench](https://github.com/sierra-research/tau2-bench):

‎python/pyproject.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ dependencies = [
2626
"agent-framework-a2a",
2727
"agent-framework-azure-ai",
2828
"agent-framework-copilotstudio",
29+
"agent-framework-lab",
2930
"agent-framework-mem0",
3031
"agent-framework-redis",
3132
"agent-framework-devui",

0 commit comments

Comments
 (0)