From 8aa56414b21df3f443ea1fb92220cddcf4881dca Mon Sep 17 00:00:00 2001 From: Den-Dre <47823556+Den-Dre@users.noreply.github.com> Date: Tue, 19 Aug 2025 22:41:35 +0200 Subject: [PATCH 1/3] Update agents.ipynb Fix typo --- .../src/user-guide/agentchat-user-guide/tutorial/agents.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/docs/src/user-guide/agentchat-user-guide/tutorial/agents.ipynb b/python/docs/src/user-guide/agentchat-user-guide/tutorial/agents.ipynb index efd530e1b80a..4e1264cb6eb0 100644 --- a/python/docs/src/user-guide/agentchat-user-guide/tutorial/agents.ipynb +++ b/python/docs/src/user-guide/agentchat-user-guide/tutorial/agents.ipynb @@ -698,7 +698,7 @@ "\n", "The following preset agents are available:\n", "\n", - "- {py:class}`~autogen_agentchat.agents.UserProxyAgent`: An agent that takes user input returns it as responses.\n", + "- {py:class}`~autogen_agentchat.agents.UserProxyAgent`: An agent that takes user input and returns it as responses.\n", "- {py:class}`~autogen_agentchat.agents.CodeExecutorAgent`: An agent that can execute code.\n", "- {py:class}`~autogen_ext.agents.openai.OpenAIAssistantAgent`: An agent that is backed by an OpenAI Assistant, with ability to use custom tools.\n", "- {py:class}`~autogen_ext.agents.web_surfer.MultimodalWebSurfer`: A multi-modal agent that can search the web and visit web pages for information.\n", From db70d68b386ffb5c675ff7a819ff792a54b5c8aa Mon Sep 17 00:00:00 2001 From: Lachlan Greenland <59797179+lach-g@users.noreply.github.com> Date: Wed, 20 Aug 2025 14:43:11 +0800 Subject: [PATCH 2/3] Fix docs dotnet core typo (#6950) --- docs/dotnet/core/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/dotnet/core/index.md b/docs/dotnet/core/index.md index 664ab30e50c7..c7bfbb8b9791 100644 --- a/docs/dotnet/core/index.md +++ b/docs/dotnet/core/index.md @@ -81,7 +81,7 @@ You can run the backend on its own: dotnet run --project Microsoft.AutoGen.AgentHost ``` -or you can run iclude it inside your own application: +or you can include it inside your own application: ```csharp using Microsoft.AutoGen.RuntimeGateway; From 004f9b4353650dec92303710d6a43e7399daae6f Mon Sep 17 00:00:00 2001 From: Andreas Hinderyckx Date: Fri, 22 Aug 2025 14:33:37 +0200 Subject: [PATCH 3/3] Fix typos in AgentChat and Core docs --- .../agentchat-user-guide/selector-group-chat.ipynb | 6 +++--- .../components/command-line-code-executors.ipynb | 2 +- .../core-user-guide/components/model-clients.ipynb | 3 +-- .../core-concepts/agent-identity-and-lifecycle.md | 6 +++--- .../core-user-guide/core-concepts/topic-and-subscription.md | 4 ++-- .../core-user-guide/design-patterns/mixture-of-agents.ipynb | 2 +- .../core-user-guide/framework/agent-and-agent-runtime.ipynb | 4 ++-- python/docs/src/user-guide/core-user-guide/quickstart.ipynb | 2 +- 8 files changed, 14 insertions(+), 15 deletions(-) diff --git a/python/docs/src/user-guide/agentchat-user-guide/selector-group-chat.ipynb b/python/docs/src/user-guide/agentchat-user-guide/selector-group-chat.ipynb index 64ce93a93aa4..2a251b9afcef 100644 --- a/python/docs/src/user-guide/agentchat-user-guide/selector-group-chat.ipynb +++ b/python/docs/src/user-guide/agentchat-user-guide/selector-group-chat.ipynb @@ -224,7 +224,7 @@ "\n", "Let's use two termination conditions:\n", "{py:class}`~autogen_agentchat.conditions.TextMentionTermination` to end the conversation when the Planning Agent sends \"TERMINATE\",\n", - "and {py:class}`~autogen_agentchat.conditions.MaxMessageTermination` to limit the conversation to 25 messages to avoid infinite loop." + "and {py:class}`~autogen_agentchat.conditions.MaxMessageTermination` to limit the conversation to 25 messages to avoid entering an infinite loop." ] }, { @@ -550,7 +550,7 @@ "Each participant agent only makes one step (executing tools, generating a response, etc.)\n", "on each turn. \n", "If you want an {py:class}`~autogen_agentchat.agents.AssistantAgent` to repeat\n", - "until it stop returning a {py:class}`~autogen_agentchat.messages.ToolCallSummaryMessage`\n", + "until it stops by returning a {py:class}`~autogen_agentchat.messages.ToolCallSummaryMessage`\n", "when it has finished running all the tools it needs to run, you can do so by\n", "checking the last message and returning the agent if it is a\n", "{py:class}`~autogen_agentchat.messages.ToolCallSummaryMessage`.\n", @@ -689,7 +689,7 @@ " if web_search_agent.name in previous_set_of_agents and data_analyst_agent.name in previous_set_of_agents:\n", " return [planning_agent.name]\n", "\n", - " # if no-conditions are met then return all the agents\n", + " # if no conditions are met then return all the agents\n", " return [planning_agent.name, web_search_agent.name, data_analyst_agent.name]\n", "\n", "\n", diff --git a/python/docs/src/user-guide/core-user-guide/components/command-line-code-executors.ipynb b/python/docs/src/user-guide/core-user-guide/components/command-line-code-executors.ipynb index efac7daa3acd..b7f34276a462 100644 --- a/python/docs/src/user-guide/core-user-guide/components/command-line-code-executors.ipynb +++ b/python/docs/src/user-guide/core-user-guide/components/command-line-code-executors.ipynb @@ -31,7 +31,7 @@ "\n", "### Inspecting the container\n", "\n", - "If you wish to keep the container around after AutoGen is finished using it for whatever reason (e.g. to inspect the container), \n", + "If you wish to keep the container around after AutoGen is finished using it for whatever reason (e.g., to inspect the container), \n", "then you can set the `auto_remove` parameter to `False` when creating the executor. \n", "`stop_container` can also be set to `False` to prevent the container from being stopped at the end of the execution.\n", "\n", diff --git a/python/docs/src/user-guide/core-user-guide/components/model-clients.ipynb b/python/docs/src/user-guide/core-user-guide/components/model-clients.ipynb index 2dc10abb1c53..94b4d2769635 100644 --- a/python/docs/src/user-guide/core-user-guide/components/model-clients.ipynb +++ b/python/docs/src/user-guide/core-user-guide/components/model-clients.ipynb @@ -180,8 +180,7 @@ "## Structured Output\n", "\n", "Structured output can be enabled by setting the `response_format` field in\n", - "{py:class}`~autogen_ext.models.openai.OpenAIChatCompletionClient` and {py:class}`~autogen_ext.models.openai.AzureOpenAIChatCompletionClient` to\n", - "as a [Pydantic BaseModel](https://docs.pydantic.dev/latest/concepts/models/) class.\n", + "{py:class}`~autogen_ext.models.openai.OpenAIChatCompletionClient` and {py:class}`~autogen_ext.models.openai.AzureOpenAIChatCompletionClient` to a [Pydantic BaseModel](https://docs.pydantic.dev/latest/concepts/models/) class.\n", "\n", "```{note}\n", "Structured output is only available for models that support it. It also\n", diff --git a/python/docs/src/user-guide/core-user-guide/core-concepts/agent-identity-and-lifecycle.md b/python/docs/src/user-guide/core-user-guide/core-concepts/agent-identity-and-lifecycle.md index 0dae41e78bd8..67e3e252c71c 100644 --- a/python/docs/src/user-guide/core-user-guide/core-concepts/agent-identity-and-lifecycle.md +++ b/python/docs/src/user-guide/core-user-guide/core-concepts/agent-identity-and-lifecycle.md @@ -3,7 +3,7 @@ The agent runtime manages agents' identities and lifecycles. -Application does not create agents directly, rather, +An application does not create agents directly, rather, it registers an agent type with a factory function for agent instances. In this section, we explain how agents are identified @@ -11,8 +11,8 @@ and created by the runtime. ## Agent ID -Agent ID uniquely identifies an agent instance within -an agent runtime -- including distributed runtime. +An Agent ID uniquely identifies an agent instance within +an agent runtime -- including in a distributed runtime. It is the "address" of the agent instance for receiving messages. It has two components: agent type and agent key. diff --git a/python/docs/src/user-guide/core-user-guide/core-concepts/topic-and-subscription.md b/python/docs/src/user-guide/core-user-guide/core-concepts/topic-and-subscription.md index faac3ab8da0d..0b52e61747de 100644 --- a/python/docs/src/user-guide/core-user-guide/core-concepts/topic-and-subscription.md +++ b/python/docs/src/user-guide/core-user-guide/core-concepts/topic-and-subscription.md @@ -35,7 +35,7 @@ when publishing messages about new issues. Topic source is the unique identifier for a topic within a topic type. It is typically defined by application data. For example, the GitHub agent may use `"github.com/{repo_name}/issues/{issue_number}"` -as the topic source to uniquely identifies the topic. +as the topic source to uniquely identify the topic. Topic source allows the publisher to limit the scope of messages and create silos. @@ -71,7 +71,7 @@ exact topic sources and agent keys. The mechanism is simple: any topic matching the type-based subscription's topic type will be mapped to an agent ID with the subscription's agent type and the agent key assigned to the value of the topic source. -For Python API, use {py:class}`~autogen_core.components.TypeSubscription`. +For the Python API, use {py:class}`~autogen_core.components.TypeSubscription`. ```{note} Type-Based Subscription = Topic Type --> Agent Type diff --git a/python/docs/src/user-guide/core-user-guide/design-patterns/mixture-of-agents.ipynb b/python/docs/src/user-guide/core-user-guide/design-patterns/mixture-of-agents.ipynb index c7430773261d..ea30b88c7a1a 100644 --- a/python/docs/src/user-guide/core-user-guide/design-patterns/mixture-of-agents.ipynb +++ b/python/docs/src/user-guide/core-user-guide/design-patterns/mixture-of-agents.ipynb @@ -18,7 +18,7 @@ "following the [original implementation](https://github.com/togethercomputer/moa) of multi-layer mixture of agents.\n", "\n", "Here is a high-level procedure overview of the pattern:\n", - "1. The orchestrator agent takes input a user task and first dispatches it to the worker agents in the first layer.\n", + "1. The orchestrator agent takes as input a user task and first dispatches it to the worker agents in the first layer.\n", "2. The worker agents in the first layer process the task and return the results to the orchestrator agent.\n", "3. The orchestrator agent then synthesizes the results from the first layer and dispatches an updated task with the previous results to the worker agents in the second layer.\n", "4. The process continues until the final layer is reached.\n", diff --git a/python/docs/src/user-guide/core-user-guide/framework/agent-and-agent-runtime.ipynb b/python/docs/src/user-guide/core-user-guide/framework/agent-and-agent-runtime.ipynb index 7f18ac2bce3e..bf80adf4cf24 100644 --- a/python/docs/src/user-guide/core-user-guide/framework/agent-and-agent-runtime.ipynb +++ b/python/docs/src/user-guide/core-user-guide/framework/agent-and-agent-runtime.ipynb @@ -28,7 +28,7 @@ "It has a unique identifier of the type {py:class}`~autogen_core.AgentId`,\n", "a metadata dictionary of the type {py:class}`~autogen_core.AgentMetadata`.\n", "\n", - "In most cases, you can subclass your agents from higher level class {py:class}`~autogen_core.RoutedAgent` which enables you to route messages to corresponding message handler specified with {py:meth}`~autogen_core.message_handler` decorator and proper type hint for the `message` variable.\n", + "In most cases, you can subclass your agents from a higher level class {py:class}`~autogen_core.RoutedAgent`, which enables you to route messages to corresponding message handler specified with the {py:meth}`~autogen_core.message_handler` decorator and proper type hints for the `message` variable.\n", "An agent runtime is the execution environment for agents in AutoGen.\n", "\n", "Similar to the runtime environment of a programming language,\n", @@ -282,7 +282,7 @@ "For batch scenarios such as running benchmarks for evaluating agents,\n", "you may want to wait for the background task to stop automatically when\n", "there are no unprocessed messages and no agent is handling messages --\n", - "the batch may considered complete.\n", + "the batch may be considered complete.\n", "You can achieve this by using the {py:meth}`~autogen_core.SingleThreadedAgentRuntime.stop_when_idle` method:" ] }, diff --git a/python/docs/src/user-guide/core-user-guide/quickstart.ipynb b/python/docs/src/user-guide/core-user-guide/quickstart.ipynb index 6ee673e1beba..310ac1c38d9c 100644 --- a/python/docs/src/user-guide/core-user-guide/quickstart.ipynb +++ b/python/docs/src/user-guide/core-user-guide/quickstart.ipynb @@ -82,7 +82,7 @@ "a local embedded agent runtime implementation.\n", "\n", "```{note}\n", - "If you are using VSCode or other Editor remember to import asyncio and wrap the code with async def main() -> None: and run the code with asyncio.run(main()) function.\n", + "If you are using VSCode or another editor, remember to import asyncio and wrap the code with async def main() -> None: and run the code with asyncio.run(main()) function.\n", "```" ] },