Improve language (#4650)

* Improve language * Update images for examples * reduce size --------- Co-authored-by: Ryan Sweet <[email protected]>
microsoft · Dec 11, 2024 · b776c53 · b776c53
1 parent 7d01bc6
commit b776c53
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 16 deletions.
diff --git a/python/packages/autogen-core/docs/src/images/example-company.jpg b/python/packages/autogen-core/docs/src/images/example-company.jpg
diff --git a/python/packages/autogen-core/docs/src/images/example-literature.jpg b/python/packages/autogen-core/docs/src/images/example-literature.jpg
diff --git a/python/packages/autogen-core/docs/src/images/example-travel.jpeg b/python/packages/autogen-core/docs/src/images/example-travel.jpeg
diff --git a/...ackages/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/index.md b/...ackages/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.html
 

diff --git a/...ckages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/custom-agents.ipynb b/...ckages/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/.../autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/selector-group-chat.ipynb b/.../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/...packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/termination.ipynb b/...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",