Skip to content

Commit 8564ee3

Browse files
RussellLuoRussellLuo
committed
Update examples
1 parent a736861 commit 8564ee3

File tree

10 files changed

+77
-43
lines changed

10 files changed

+77
-43
lines changed

‎examples/app-builder/README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# StarShip App Builder
22

33

4-
## Quick Start
4+
## Prerequisites
5+
6+
- Install `coagent` (see [Installation](../../README.md#installation)).
7+
- Start a NATS server (see [Distributed](../../README.md#distributed)).
58

6-
First, follow the instructions in [Prerequisites](../../README.md#prerequisites) and [Installation](../../README.md#installation).
79

8-
Then start the dev agent:
10+
## Quick Start
11+
12+
First, start the dev agent:
913

1014
```bash
1115
export AZURE_MODEL=csg-gpt4

‎examples/autogen/README.md‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,21 @@ References:
88
- [Extend Power of AutoGen with Promptflow][3]
99

1010

11-
## Quick Start
11+
## Prerequisites
1212

13-
First, follow the instructions in [Prerequisites](../../README.md#prerequisites) and [Installation](../../README.md#installation).
13+
- Install `coagent` (see [Installation](../../README.md#installation)).
14+
- Start a NATS server (see [Distributed](../../README.md#distributed)).
15+
- Install `autogen-agentchat` and `autogen-ext`:
1416

15-
Also need to install the following package and extension:
17+
```bash
18+
pip install 'autogen-agentchat==0.4.0.dev6'
19+
pip install 'autogen-ext[openai,azure]==0.4.0.dev6'
20+
```
1621

17-
```bash
18-
pip install 'autogen-agentchat==0.4.0.dev6'
19-
pip install 'autogen-ext[openai,azure]==0.4.0.dev6'
20-
```
2122

22-
Then start a server in one terminal:
23+
## Quick Start
24+
25+
First, start a server in one terminal:
2326

2427
```bash
2528
export AZURE_MODEL=csg-gpt4
@@ -30,7 +33,7 @@ export AZURE_API_KEY=<YOUR API KEY>
3033
python examples/using-autogen/autogen.py
3134
```
3235

33-
Finally, start a client in another terminal.
36+
Then start a client in another terminal.
3437

3538
```bash
3639
python examples/rich_client.py autogen

‎examples/cos/README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# CoS Example
22

33

4-
## Quick Start
4+
## Prerequisites
5+
6+
- Install `coagent` (see [Installation](../../README.md#installation)).
7+
- Start a NATS server (see [Distributed](../../README.md#distributed)).
58

6-
First, follow the instructions in [Prerequisites](../../README.md#prerequisites) and [Installation](../../README.md#installation).
79

10+
## Quick Start
811

912
### Run Node.js Agent
1013

‎examples/discovery/README.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Agent Discovery
22

33

4-
## Quick Start
4+
## Prerequisites
5+
6+
- Install `coagent` (see [Installation](../../README.md#installation)).
7+
- Start a NATS server (see [Distributed](../../README.md#distributed)).
58

6-
First, follow the instructions in [Prerequisites](../../README.md#prerequisites) and [Installation](../../README.md#installation).
79

8-
Then start different servers in separate terminals:
10+
## Quick Start
11+
12+
First, start different servers in separate terminals:
913

1014
```bash
1115
python examples/discovery/server.py team1.dev "Dev Engineer in Team 1."
@@ -23,7 +27,7 @@ python examples/discovery/server.py team2.dev "Dev Engineer in Team 2."
2327
python examples/discovery/server.py team3.qa "QA Engineer in Team 3."
2428
```
2529

26-
Finally, start a client in another terminal.
30+
Then start a client in another terminal.
2731

2832
```bash
2933
python examples/discovery/client.py team1

‎examples/notification/README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
This example demonstrates how to implement a notification center to send and receive notifications.
44

55

6-
## Quick Start
6+
## Prerequisites
7+
8+
- Install `coagent` (see [Installation](../../README.md#installation)).
9+
- Start a NATS server (see [Distributed](../../README.md#distributed)).
710

8-
First, follow the instructions in [Prerequisites](../../README.md#prerequisites) and [Installation](../../README.md#installation).
911

12+
## Quick Start
1013

1114
### Using NATS Runtime
1215

‎examples/opencsg/README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# Agentic OpenCSG Demo
22

33

4-
## Quick Start
4+
## Prerequisites
5+
6+
- Install `coagent` (see [Installation](../../README.md#installation)).
7+
- Start a NATS server (see [Distributed](../../README.md#distributed)).
58

6-
First, follow the instructions in [Prerequisites](../../README.md#prerequisites) and [Installation](../../README.md#installation).
9+
10+
## Quick Start
711

812
### Run the Triage agent
913

‎examples/patterns/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Coagent implementations of the Anthropic agent Patterns:
22

33
- [Chaining](chaining.py)
44
- [Parallelization](parallelization.py)
5+
- [Triaging](triaging.py)
56

67
References:
78
- [Building effective agents][1]

‎examples/ping-pong/README.md‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33

44
## Quick Start
55

6-
First, follow the instructions in [Prerequisites](../../README.md#prerequisites) and [Installation](../../README.md#installation).
6+
### Using NATS Runtime
77

8+
Prerequisites:
89

9-
### Using NATS Runtime
10+
- Install `coagent` (see [Installation](../../README.md#installation)).
11+
- Start a NATS server (see [Distributed](../../README.md#distributed)).
1012

1113
Start a server in one terminal:
1214

@@ -23,13 +25,15 @@ coagent server -H type:Ping
2325

2426
### Using HTTP Runtime
2527

26-
Install the following packages:
28+
Prerequisites:
2729

28-
```bash
29-
pip install hypercorn
30-
pip install starlette
31-
pip install sse-starlette
32-
```
30+
- Install the following packages:
31+
32+
```bash
33+
pip install hypercorn
34+
pip install starlette
35+
pip install sse-starlette
36+
```
3337

3438
Start the HTTP runtime server:
3539

‎examples/stream-ping-pong/README.md‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ This example demonstrates how to handle streaming messages. The server sends a s
55

66
## Quick Start
77

8-
First, follow the instructions in [Prerequisites](../../README.md#prerequisites) and [Installation](../../README.md#installation).
8+
### Using NATS Runtime
99

10+
Prerequisites:
1011

11-
### Using NATS Runtime
12+
- Install `coagent` (see [Installation](../../README.md#installation)).
13+
- Start a NATS server (see [Distributed](../../README.md#distributed)).
1214

1315
Start a server in one terminal:
1416

@@ -25,13 +27,15 @@ coagent stream_server -H type:Ping --chat
2527

2628
### Using HTTP Runtime
2729

28-
Install the following packages:
30+
Prerequisites:
2931

30-
```bash
31-
pip install hypercorn
32-
pip install starlette
33-
pip install sse-starlette
34-
```
32+
- Install the following packages:
33+
34+
```bash
35+
pip install hypercorn
36+
pip install starlette
37+
pip install sse-starlette
38+
```
3539

3640
Start the HTTP runtime server:
3741

‎examples/translator/README.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Translator
22

33

4-
## Quick Start
4+
## Prerequisites
5+
6+
- Install `coagent` (see [Installation](../../README.md#installation)).
7+
- Start a NATS server (see [Distributed](../../README.md#distributed)).
58

6-
First, follow the instructions in [Prerequisites](../../README.md#prerequisites) and [Installation](../../README.md#installation).
79

8-
Then start a server in one terminal:
10+
## Quick Start
11+
12+
First, start a server in one terminal:
913

1014
```bash
1115
export AZURE_MODEL=csg-gpt4
@@ -16,13 +20,13 @@ export AZURE_API_KEY=<YOUR API KEY>
1620
python examples/translator/translator.py
1721
```
1822

19-
Finally, communicate with the agent using the `coagent` CLI:
23+
Then communicate with the agent using the `coagent` CLI:
2024

2125
```bash
2226
coagent translator -H type:ChatHistory -d '{"messages":[{"role":"user","content":"你好"}]}' --chat
2327
```
2428

25-
or start a more-friendly rich client in another terminal.
29+
Or start a more-friendly rich client in another terminal:
2630

2731
```bash
2832
python examples/rich_client.py translator

0 commit comments

Comments
 (0)