Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve language #4650

Merged
merged 6 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
gagb marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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.html

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -51,7 +47,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Web Search and Analysis Example"
"## Example: Web Search/Analysis"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading