A programming framework for agentic AI
Improve language (#4650)
gagbb776c53e6f95
diff --git a/python/packages/autogen-core/docs/src/images/example-company.jpg b/python/packages/autogen-core/docs/src/images/example-company.jpgnew file mode 100644index 000000000..ade3d7f86--- /dev/null+++ b/python/packages/autogen-core/docs/src/images/example-company.jpg@@ -0,0 +1,3 @@+version https://git-lfs.github.com/spec/v1+oid sha256:f487409436d338efe69d2e6aab69d7ac786321e215136b2d18736031bf5028ae+size 112131diff --git a/python/packages/autogen-core/docs/src/images/example-literature.jpg b/python/packages/autogen-core/docs/src/images/example-literature.jpgnew file mode 100644index 000000000..fc718ef7e--- /dev/null+++ b/python/packages/autogen-core/docs/src/images/example-literature.jpg@@ -0,0 +1,3 @@+version https://git-lfs.github.com/spec/v1+oid sha256:a450a2917e21ee9d643e4c6bf7fee62fadd2e654772492ce821ac467ac6ad195+size 31965diff --git a/python/packages/autogen-core/docs/src/images/example-travel.jpeg b/python/packages/autogen-core/docs/src/images/example-travel.jpegnew file mode 100644index 000000000..70f20a917--- /dev/null+++ b/python/packages/autogen-core/docs/src/images/example-travel.jpeg@@ -0,0 +1,3 @@+version https://git-lfs.github.com/spec/v1+oid sha256:33c5749af8ebeb72d6020a147baebb3b801a14502d1c2d299dbe892d9ac5d8e0+size 10894diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/index.md b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/index.mdindex 6ee1557f9..2879e9fcb 100644--- a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/index.md+++ b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/index.md@@ -12,7 +12,7 @@ A list of examples to help you get started with AgentChat.:::::{grid} 2 2 2 3::::{grid-item-card} Travel Planning-:img-top: ../../../images/code.svg+:img-top: ../../../images/example-travel.jpeg:img-alt: travel planning example:link: ./travel-planning.html@@ -22,7 +22,7 @@ Generating a travel plan using multiple agents.::::::::{grid-item-card} Company Research-:img-top: ../../../images/code.svg+:img-top: ../../../images/example-company.jpg:img-alt: company research example:link: ./company-research.html@@ -32,7 +32,7 @@ Generating a company research report using multiple agents with tools.::::::::{grid-item-card} Literature Review-:img-top: ../../../images/code.svg+:img-top: ../../../images/example-literature.jpg:img-alt: literature review example:link: ./literature-review.htmldiff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/custom-agents.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/custom-agents.ipynbindex 35e145c14..a3282aaf1 100644--- a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/custom-agents.ipynb+++ b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/custom-agents.ipynb@@ -26,7 +26,7 @@"cell_type": "markdown","metadata": {},"source": [- "## CounterDownAgent\n",+ "## CountDownAgent\n","\n","In this example, we create a simple agent that counts down from a given number to zero,\n","and produces a stream of messages with the current count."diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/selector-group-chat.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/selector-group-chat.ipynbindex c51b2c7a8..74110d180 100644--- a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/selector-group-chat.ipynb+++ b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/selector-group-chat.ipynb@@ -11,25 +11,21 @@"cell_type": "markdown","metadata": {},"source": [- "{py:class}`~autogen_agentchat.teams.SelectorGroupChat` implements a team where participants take turns broadcasting messages to all other participants,\n",- "with the next speaker selected by a generative model (e.g., an LLM) based on the shared context. \n",- "This enables dynamic and context-aware multi-agent collaboration.\n",+ "{py:class}`~autogen_agentchat.teams.SelectorGroupChat` implements a team where participants take turns broadcasting messages to all other members. A generative model (e.g., an LLM) selects the next speaker based on the shared context, enabling dynamic, context-aware collaboration.\n",+ "\n",+ "Key features include:\n","\n",- "{py:class}`~autogen_agentchat.teams.SelectorGroupChat` provides several key features:\n","- Model-based speaker selection\n","- Configurable participant roles and descriptions\n",- "- Optional prevention of consecutive turns by the same speaker\n",+ "- Prevention of consecutive turns by the same speaker (optional)\n","- Customizable selection prompting\n","- Customizable selection function to override the default model-based selection\n","\n","```{note}\n",- "{py:class}`~autogen_agentchat.teams.SelectorGroupChat` is a high-level API.\n",- "If you need more control and customization that is not supported by this API,\n",- "you can take a look at the [Group Chat Pattern](../../core-user-guide/design-patterns/group-chat.ipynb)\n",- "in the Core API documentation and implement your own group chat logic.\n",+ "{py:class}`~autogen_agentchat.teams.SelectorGroupChat` is a high-level API. For more control and customization, refer to the [Group Chat Pattern](../../core-user-guide/design-patterns/group-chat.ipynb) in the Core API documentation to implement your own group chat logic.\n","```\n","\n",- "## How does it work?\n",+ "## How Does it Work?\n","\n","{py:class}`~autogen_agentchat.teams.SelectorGroupChat` is a group chat similar to {py:class}`~autogen_agentchat.teams.RoundRobinGroupChat`,\n","but with a model-based next speaker selection mechanism.\n",@@ -51,7 +47,7 @@"cell_type": "markdown","metadata": {},"source": [- "## Web Search and Analysis Example"+ "## Example: Web Search/Analysis"]},{diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/termination.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/termination.ipynbindex 8646ed38a..a115df68b 100644--- a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/termination.ipynb+++ b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/termination.ipynb@@ -30,7 +30,7 @@"cell_type": "markdown","metadata": {},"source": [- "# AutoGen provides several built-in termination conditions: \n",+ "Built-In Termination Conditions: \n","1. {py:class}`~autogen_agentchat.conditions.MaxMessageTermination`: Stops after a specified number of messages have been produced, including both agent and task messages.\n","2. {py:class}`~autogen_agentchat.conditions.TextMentionTermination`: Stops when specific text or string is mentioned in a message (e.g., \"TERMINATE\").\n","3. {py:class}`~autogen_agentchat.conditions.TokenUsageTermination`: Stops when a certain number of prompt or completion tokens are used. This requires the agents to report token usage in their messages.\n",