Skip to content

A programming framework for agentic AI

Add description of each example for team one (#569)

Eric Zhuf5a13627e2b4
diff --git a/python/packages/team-one/examples/example.py b/python/packages/team-one/examples/example.py
index c905154fc..e94e888b5 100644
--- a/python/packages/team-one/examples/example.py
+++ b/python/packages/team-one/examples/example.py
@@ -1,3 +1,9 @@
+"""This example demonstrates a human user interacting with a coder agent and a executor agent
+to generate and execute code snippets. An ledger orchestrator agent orchestrates the interaction
+between the user, coder, and executor agents.
+At each step, the orchestrator agent decides which user or agent to perform the next action.
+The code snippets are executed inside a docker container."""
+
import asyncio
import logging
diff --git a/python/packages/team-one/examples/example_coder.py b/python/packages/team-one/examples/example_coder.py
index 394493b6c..b62f2b801 100644
--- a/python/packages/team-one/examples/example_coder.py
+++ b/python/packages/team-one/examples/example_coder.py
@@ -1,3 +1,9 @@
+"""This example demonstrates a human user interacting with a coder agent and a executor agent
+to generate and execute code snippets. The user and the agents take turn sequentially
+to write input, generate code snippets and execute them, orchestrated by an
+round-robin orchestrator agent. The code snippets are executed inside a docker container.
+"""
+
import asyncio
import logging
diff --git a/python/packages/team-one/examples/example_file_surfer.py b/python/packages/team-one/examples/example_file_surfer.py
index c49ed30fb..b7a81a9d3 100644
--- a/python/packages/team-one/examples/example_file_surfer.py
+++ b/python/packages/team-one/examples/example_file_surfer.py
@@ -1,3 +1,7 @@
+"""This example demonstrates a human user interacting with a file surfer agent
+to navigate the file system. The human user and the file surfer agent takes turn
+to write input or perform actions, orchestrated by an round-robin orchestrator agent."""
+
import asyncio
import logging
diff --git a/python/packages/team-one/examples/example_reflexagents.py b/python/packages/team-one/examples/example_reflexagents.py
index 90a3db258..b49050fb5 100644
--- a/python/packages/team-one/examples/example_reflexagents.py
+++ b/python/packages/team-one/examples/example_reflexagents.py
@@ -1,3 +1,6 @@
+"""This example demonstrates three mock agents taking turn to reflect recieved message
+by publishing it verbatim. The agents are orchestrated by a round-robin orchestrator agent."""
+
import asyncio
import logging
diff --git a/python/packages/team-one/examples/example_userproxy.py b/python/packages/team-one/examples/example_userproxy.py
index 652f79c8e..84773bcc5 100644
--- a/python/packages/team-one/examples/example_userproxy.py
+++ b/python/packages/team-one/examples/example_userproxy.py
@@ -1,3 +1,9 @@
+"""This example demonstrates a human user interacting with a coder agent
+which uses a model to generate code snippets. The user and the coder agent
+takes turn to write input or generate code snippets, orchestrated by an
+round-robin orchestrator agent.
+The code snippets are not executed in this example."""
+
import asyncio
import logging
diff --git a/python/packages/team-one/examples/example_websurfer.py b/python/packages/team-one/examples/example_websurfer.py
index b8aae8a10..e5778ee74 100644
--- a/python/packages/team-one/examples/example_websurfer.py
+++ b/python/packages/team-one/examples/example_websurfer.py
@@ -1,3 +1,8 @@
+"""This example demonstrates a human user interacting with a web surfer agent
+to navigate the web through an embedded incognito browser.
+The human user and the web surfer agent takes turn to write input or perform actions,
+orchestrated by an round-robin orchestrator agent."""
+
import asyncio
import logging
import os
@@ -20,7 +25,7 @@ async def main() -> None:
runtime = SingleThreadedAgentRuntime()
# Create an appropriate client
- client = create_completion_client_from_env()
+ client = create_completion_client_from_env(model="gpt-4o")
# Register agents.
await runtime.register("WebSurfer", lambda: MultimodalWebSurfer(), lambda: [DefaultSubscription()])