Skip to content

Commit da803d3

Browse files
martinzrrlskzhang1jackgerrits
authored
Improve readability of notebooks (microsoft#2200)
* Improve readability * Update context_handling.py update line breaks according to comment of reviewer * Update agentchat_groupchat_finite_state_machine.ipynb corrected sentence according to comment of reviewer * Update autogen/agentchat/contrib/capabilities/context_handling.py Co-authored-by: Jack Gerrits <[email protected]> --------- Co-authored-by: Shaokun Zhang <[email protected]> Co-authored-by: Jack Gerrits <[email protected]>
1 parent 6750e67 commit da803d3

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

autogen/agentchat/contrib/capabilities/context_handling.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ class TransformChatHistory:
3535
3. Third, it limits the total number of tokens in the chat history
3636
3737
When adding this capability to an agent, the following are modified:
38-
- A hook is added to the hookable method `process_all_messages_before_reply` to transform the received messages for possible truncation.
38+
- A hook is added to the hookable method `process_all_messages_before_reply` to transform the
39+
received messages for possible truncation.
3940
Not modifying the stored message history.
4041
"""
4142

notebook/agentchat_agentoptimizer.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
"source": [
6161
"# MathUserProxy with function_call\n",
6262
"\n",
63-
"This agent is a customozied MathUserProxy inherits from its [partent class](https://github.com/microsoft/autogen/blob/main/autogen/agentchat/contrib/math_user_proxy_agent.py.).\n",
63+
"This agent is a customized MathUserProxy inherits from its [partent class](https://github.com/microsoft/autogen/blob/main/autogen/agentchat/contrib/math_user_proxy_agent.py).\n",
6464
"\n",
6565
"It supports using both function_call and python to solve math problems.\n"
6666
]
@@ -265,7 +265,7 @@
265265
"\n",
266266
"MATAH dataset contains 12,500 challenging competition mathematics problems. Each problem in MATH has a full step-by-step solution which can be used to teach models to generate answer derivations and explanations. \n",
267267
"\n",
268-
"We strctly follow the [train](https://github.com/lifan-yuan/CRAFT/blob/main/tab_and_math/MATH/dataset/train/algebra.jsonl)/[test](https://github.com/lifan-yuan/CRAFT/blob/main/tab_and_math/MATH/dataset/algebra.jsonl) splits of [Craft](https://github.com/lifan-yuan/CRAFT). Please specific your own path to the dataset. Here we sample the first 10 algebra problems as examples. "
268+
"We strictly follow the [train](https://github.com/lifan-yuan/CRAFT/blob/main/tab_and_math/MATH/dataset/train/algebra.jsonl)/[test](https://github.com/lifan-yuan/CRAFT/blob/main/tab_and_math/MATH/dataset/algebra.jsonl) splits of [Craft](https://github.com/lifan-yuan/CRAFT). Please specific your own path to the dataset. Here we sample the first 10 algebra problems as examples. "
269269
]
270270
},
271271
{

notebook/agentchat_groupchat_finite_state_machine.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
"## Motivation\n",
9292
"\n",
9393
"\n",
94-
"The current GroupChat class allows transition to any agent (without or without the decision of LLM), some use case might demand for more control over transition. A graph is a possible way to control the transition paths, where each node represents an agent and each directed edge represent possible transition path. Let's illustrate the current transition paths for a GroupChat with five agents."
94+
"The current GroupChat class allows transitioning to any agent (with or without the decision of the LLM), some use cases might demand for more control over transition. A graph is a possible way to control the transition paths, where each node represents an agent and each directed edge represents possible transition paths. Let's illustrate the current transition paths for a GroupChat with five agents."
9595
]
9696
},
9797
{

notebook/agentchat_surfer.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@
152152
"metadata": {},
153153
"source": [
154154
"### Example 1: Search, summarize\n",
155-
"- Search for information aobut Microsoft AutoGen\n",
155+
"- Search for information about Microsoft AutoGen\n",
156156
"- Summarize the results\n",
157157
"- Visit the Getting Started Docs page"
158158
]

0 commit comments

Comments
 (0)