Add Documentation for AgentChat (#3635)

* update docs on agent chat. * add langchain support * fix formatting issues * Update python/packages/autogen-core/docs/src/agentchat-user-guide/index.md Co-authored-by: gagb <[email protected]> * Update python/packages/autogen-core/docs/src/agentchat-user-guide/index.md Co-authored-by: gagb <[email protected]> * add company reseach and literature review examples with tools * format fixes * format and type fixes * add selector groupchat to agentchat index page * rename quick start as code exec * type fixes * format fix * Remove blank cell from notebooks --------- Co-authored-by: gagb <[email protected]> Co-authored-by: Eric Zhu <[email protected]>
microsoft · Oct 8, 2024 · 4290cfa · 4290cfa
1 parent 02ced7c
commit 4290cfa
Show file tree

Hide file tree

Showing 10 changed files with 1,442 additions and 117 deletions.
diff --git a/python/packages/autogen-core/docs/src/agentchat-user-guide/examples/company-research.ipynb b/python/packages/autogen-core/docs/src/agentchat-user-guide/examples/company-research.ipynb
diff --git a/python/packages/autogen-core/docs/src/agentchat-user-guide/examples/index.md b/python/packages/autogen-core/docs/src/agentchat-user-guide/examples/index.md
@@ -0,0 +1,54 @@
+---
+myst:
+  html_meta:
+    "description lang=en": |
+      Examples built using AgentChat, a high-level api for AutoGen
+---
+
+# Examples
+
+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-alt: travel planning example
+:link: ./travel-planning.html
+
+^^^
+Generating a travel plan using multiple agents.
+
+::::
+
+::::{grid-item-card} Company Research
+:img-top: ../../images/code.svg
+:img-alt: company research example
+:link: ./company-research.html
+
+^^^
+Generating a company research report using multiple agents with tools.
+
+::::
+
+::::{grid-item-card} Literature Review
+:img-top: ../../images/code.svg
+:img-alt: literature review example
+:link: ./literature-review.html
+
+^^^
+Generating a literature review using agents with tools.
+
+::::
+
+:::::
+
+```{toctree}
+:maxdepth: 1
+:hidden:
+
+travel-planning
+company-research
+literature-review
+
+```
diff --git a/python/packages/autogen-core/docs/src/agentchat-user-guide/examples/literature-review.ipynb b/python/packages/autogen-core/docs/src/agentchat-user-guide/examples/literature-review.ipynb
diff --git a/python/packages/autogen-core/docs/src/agentchat-user-guide/examples/travel-planning.ipynb b/python/packages/autogen-core/docs/src/agentchat-user-guide/examples/travel-planning.ipynb
diff --git a/...ntchat-user-guide/guides/quickstart.ipynb → ...at-user-guide/guides/code-execution.ipynb b/...ntchat-user-guide/guides/quickstart.ipynb → ...at-user-guide/guides/code-execution.ipynb
@@ -4,7 +4,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Quick Start\n",
+    "# Code Execution\n",
+    "\n",
+    "\n",
+    "AgentChat offers a `CodeExecutorAgent` agent that can execute code in messages it receives. \n",
     "\n",
     ":::{note}\n",
     "See [here](pkg-info-autogen-agentchat) for installation instructions.\n",