Skip to content

Commit 8dac072

Browse files
ekzhuekzhu
authored
Update references in docs (#4590)
* Update agent doc * Remove outdated doc * Update references * Update readme * Update readme
1 parent fa550c2 commit 8dac072

File tree

33 files changed

+1875
-1971
lines changed

33 files changed

+1875
-1971
lines changed

‎python/packages/agbench/benchmarks/AssistantBench/Templates/MagenticOne/scenario.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
from autogen_core import AgentId, AgentProxy, TopicId
1212
from autogen_core import SingleThreadedAgentRuntime
13-
from autogen_core.application.logging import EVENT_LOGGER_NAME
13+
from autogen_core.logging import EVENT_LOGGER_NAME
1414
from autogen_core.components.models import (
1515
ChatCompletionClient,
1616
UserMessage,

‎python/packages/agbench/benchmarks/GAIA/Templates/MagenticOne/scenario.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
from autogen_core import AgentId, AgentProxy, TopicId
1212
from autogen_core import SingleThreadedAgentRuntime
13-
from autogen_core.application.logging import EVENT_LOGGER_NAME
13+
from autogen_core import EVENT_LOGGER_NAME
1414
from autogen_core.components.models import (
1515
ChatCompletionClient,
1616
ModelCapabilities,

‎python/packages/agbench/benchmarks/HumanEval/Templates/MagenticOne/scenario.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
from autogen_core import AgentId, AgentProxy, TopicId
55
from autogen_core import SingleThreadedAgentRuntime
6-
from autogen_core.application.logging import EVENT_LOGGER_NAME
6+
from autogen_core import EVENT_LOGGER_NAME
77
from autogen_core import DefaultSubscription, DefaultTopicId
88
from autogen_ext.code_executors.local import LocalCommandLineCodeExecutor
99
from autogen_core.components.models import (

‎python/packages/agbench/benchmarks/WebArena/Templates/MagenticOne/scenario.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
from autogen_core import AgentId, AgentProxy, TopicId
1111
from autogen_core import SingleThreadedAgentRuntime
12-
from autogen_core.application.logging import EVENT_LOGGER_NAME
12+
from autogen_core import EVENT_LOGGER_NAME
1313
from autogen_core import DefaultSubscription, DefaultTopicId
1414
from autogen_ext.code_executors.local import LocalCommandLineCodeExecutor
1515
from autogen_core.components.models import (

‎python/packages/autogen-agentchat/README.md

-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
11
# AutoGen AgentChat
22

33
- [Documentation](https://microsoft.github.io/autogen/dev/user-guide/agentchat-user-guide/index.html)
4-
5-
## Package structure
6-
7-
- `agents` are the building blocks for creating agents and built-in agents.
8-
- `teams` are the building blocks for creating teams of agents and built-in teams, such as group chats.
9-
- `logging` contains logging utilities.

‎python/packages/autogen-core/README.md

-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
11
# AutoGen Core
22

33
- [Documentation](https://microsoft.github.io/autogen/dev/user-guide/core-user-guide/index.html)
4-
5-
## Package layering
6-
7-
- `base` are the the foundational generic interfaces upon which all else is built. This module must not depend on any other module.
8-
- `application` are implementations of core components that are used to compose an application.
9-
- `components` are the building blocks for creating agents.

‎python/packages/autogen-core/docs/drawio/layers.drawio

-28
This file was deleted.

‎python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/agents.ipynb

+5-3
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,10 @@
188188
"The following preset agents are available:\n",
189189
"\n",
190190
"- {py:class}`~autogen_agentchat.agents.CodeExecutorAgent`: An agent that can execute code.\n",
191-
"- {py:class}`~autogen_ext.agents.OpenAIAssistantAgent`: An agent that is backed by an OpenAI Assistant, with ability to use custom tools.\n",
192-
"- {py:class}`~autogen_ext.agents.MultimodalWebSurfer`: A multi-modal agent that can search the web and visit web pages for information."
191+
"- {py:class}`~autogen_ext.agents.openai.OpenAIAssistantAgent`: An agent that is backed by an OpenAI Assistant, with ability to use custom tools.\n",
192+
"- {py:class}`~autogen_ext.agents.web_surfer.MultimodalWebSurfer`: A multi-modal agent that can search the web and visit web pages for information.\n",
193+
"- {py:class}`~autogen_ext.agents.file_surfer.FileSurfer`: An agent that can search and browse local files for information.\n",
194+
"- {py:class}`~autogen_ext.agents.video_surfer.VideoSurfer`: An agent that can watch videos for information."
193195
]
194196
},
195197
{
@@ -248,7 +250,7 @@
248250
"name": "python",
249251
"nbconvert_exporter": "python",
250252
"pygments_lexer": "ipython3",
251-
"version": "3.12.6"
253+
"version": "3.11.5"
252254
}
253255
},
254256
"nbformat": 4,

‎python/packages/autogen-core/docs/src/user-guide/core-user-guide/cookbook/llm-usage-logger.ipynb

+6-25
Original file line numberDiff line numberDiff line change
@@ -8,42 +8,23 @@
88
"\n",
99
"The model clients included in AutoGen emit structured events that can be used to track the usage of the model. This notebook demonstrates how to use the logger to track the usage of the model.\n",
1010
"\n",
11-
"These events are logged to the logger with the name: :py:attr:`autogen_core.application.logging.EVENT_LOGGER_NAME`."
11+
"These events are logged to the logger with the name: :py:attr:`autogen_core.EVENT_LOGGER_NAME`."
1212
]
1313
},
1414
{
1515
"cell_type": "code",
16-
"execution_count": 1,
16+
"execution_count": null,
1717
"metadata": {},
1818
"outputs": [],
1919
"source": [
2020
"import logging\n",
2121
"\n",
22-
"from autogen_core.application.logging.events import LLMCallEvent\n",
22+
"from autogen_core.logging import LLMCallEvent\n",
2323
"\n",
2424
"\n",
2525
"class LLMUsageTracker(logging.Handler):\n",
2626
" def __init__(self) -> None:\n",
27-
" \"\"\"Logging handler that tracks the number of tokens used in the prompt and completion.\n",
28-
"\n",
29-
" Example:\n",
30-
"\n",
31-
" .. code-block:: python\n",
32-
"\n",
33-
" from autogen_core.application.logging import LLMUsageTracker, EVENT_LOGGER_NAME\n",
34-
"\n",
35-
" # Set up the logging configuration to use the custom handler\n",
36-
" logger = logging.getLogger(EVENT_LOGGER_NAME)\n",
37-
" logger.setLevel(logging.INFO)\n",
38-
" llm_usage = LLMUsageTracker()\n",
39-
" logger.handlers = [llm_usage]\n",
40-
"\n",
41-
" # ...\n",
42-
"\n",
43-
" print(llm_usage.prompt_tokens)\n",
44-
" print(llm_usage.completion_tokens)\n",
45-
"\n",
46-
" \"\"\"\n",
27+
" \"\"\"Logging handler that tracks the number of tokens used in the prompt and completion.\"\"\"\n",
4728
" super().__init__()\n",
4829
" self._prompt_tokens = 0\n",
4930
" self._completion_tokens = 0\n",
@@ -89,7 +70,7 @@
8970
"metadata": {},
9071
"outputs": [],
9172
"source": [
92-
"from autogen_core.application.logging import EVENT_LOGGER_NAME\n",
73+
"from autogen_core import EVENT_LOGGER_NAME\n",
9374
"\n",
9475
"# Set up the logging configuration to use the custom handler\n",
9576
"logger = logging.getLogger(EVENT_LOGGER_NAME)\n",
@@ -120,7 +101,7 @@
120101
"name": "python",
121102
"nbconvert_exporter": "python",
122103
"pygments_lexer": "ipython3",
123-
"version": "3.12.5"
104+
"version": "3.11.5"
124105
}
125106
},
126107
"nbformat": 4,

0 commit comments

Comments
 (0)