Merge pull request #348 from DAGWorks-Inc/docs/simplify-concept-pages

`docs` Created a `Cookbook` section
DAGWorks-Inc · Aug 30, 2024 · 32faa7b · 32faa7b
2 parents b7cb3f7 + 7dc7d6f
commit 32faa7b
Show file tree

Hide file tree

Showing 47 changed files with 3,979 additions and 179 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,7 +17,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
-    "myst_parser",
+    "myst_nb",
     "sphinx_sitemap",
     "sphinx_toolbox.collapse",
 ]
@@ -47,6 +47,7 @@
     },
 }
 
+nb_execution_mode = "off"
 
 exclude_patterns = ["README-internal.md"]
 

diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -1,5 +1,5 @@
 =========================
-Developing / Contributing
+Contributing
 =========================
 
 .. _examples:

diff --git a/docs/examples/agents.rst b/docs/examples/agents.rst
diff --git a/docs/examples/agents/_agent_patterns/agent_supervisor.png b/docs/examples/agents/_agent_patterns/agent_supervisor.png
diff --git a/docs/examples/agents/_agent_patterns/hierarchical_agent_teams.png b/docs/examples/agents/_agent_patterns/hierarchical_agent_teams.png
diff --git a/docs/examples/agents/_agent_patterns/multi_agent_collaboration.png b/docs/examples/agents/_agent_patterns/multi_agent_collaboration.png
diff --git a/docs/examples/agents/_agent_patterns/multi_modal_agent.png b/docs/examples/agents/_agent_patterns/multi_modal_agent.png
diff --git a/docs/examples/agents/_divide-and-conquer.png b/docs/examples/agents/_divide-and-conquer.png
diff --git a/docs/examples/agents/agent-patterns.md b/docs/examples/agents/agent-patterns.md
@@ -0,0 +1,31 @@
+# Agent patterns
+
+We have the bones of a few applications that can be used to create agents. These are not fully fleshed out, but they
+can be used as a starting point for creating your own agents.
+
+We have the following templates:
+
+## Multimodal agent
+
+[Code template](https://github.com/DAGWorks-Inc/burr/tree/main/examples/templates/multi_modal_agent)
+
+![](./_agent_patterns/multi_modal_agent.png)
+
+## Multi-agent collaboration
+
+[Code template](https://github.com/DAGWorks-Inc/burr/tree/main/examples/templates/multi_agent_collaboration)
+
+![](./_agent_patterns/multi_agent_collaboration.png)
+
+## Supervisor agent
+
+[Code template](https://github.com/DAGWorks-Inc/burr/tree/main/examples/templates/agent_supervisor)
+
+![](./_agent_patterns/agent_supervisor.png)
+
+
+## Hierarchical teams
+
+[Code template](https://github.com/DAGWorks-Inc/burr/tree/main/examples/templates/hierarchical_agent_teams)
+
+![](./_agent_patterns/hierarchical_agent_teams.png)
diff --git a/docs/examples/agents/divide-and-conquer.md b/docs/examples/agents/divide-and-conquer.md
@@ -0,0 +1,26 @@
+# Divide and Conquer
+
+A single agent can usually operate effectively using a handful of tools within a single domain, but even using powerful models like `gpt-4`, it can be less effective at using many tools.
+
+One way to approach complicated tasks is through a "divide-and-conquer" approach: create a "specialized agent" for each task or domain and route tasks to the correct "expert". This means that each agent can become a sequence of LLM calls that chooses how to use a specific "tool".
+
+The examples we link to below are inspired by the paper [AutoGen: Enabling Next-Gen LLM Applications via Multi-Agent Conversation by Wu, et. al.](https://arxiv.org/abs/2308.08155).
+They can be found in [this part of our repository](https://github.com/DAGWorks-Inc/burr/tree/main/examples/multi-agent-collaboration).
+
+![](./_divide-and-conquer.png)
+
+We provide two implementations of this idea: with [Hamilton](https://github.com/DAGWorks-Inc/burr/tree/main/examples/multi-agent-collaboration/hamilton) and with [LangChain LCEL](https://github.com/DAGWorks-Inc/burr/tree/main/examples/multi-agent-collaboration/lcel). From Burr's standpoint, both look similar and you're free to use your preferred framework within an `action`.
+
+## With Hamilton
+
+<a target="_blank" href="https://colab.research.google.com/github/dagworks-inc/burr/blob/main/examples/multi-agent-collaboration/hamilton/notebook.ipynb">
+    <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
+</a>
+
+
+
+## With LangChain Expression Language (LCEL)
+
+<a target="_blank" href="https://colab.research.google.com/github/dagworks-inc/burr/blob/main/examples/multi-agent-collaboration/lcel/notebook.ipynb">
+    <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
+</a>
diff --git a/docs/examples/agents/index.rst b/docs/examples/agents/index.rst
@@ -0,0 +1,11 @@
+==========
+🤖 Agents
+==========
+
+Burr allows you to create agents that can interact with each other via State.
+
+.. toctree::
+    :maxdepth: 2
+
+    divide-and-conquer
+    agent-patterns
diff --git a/docs/examples/chatbot.rst b/docs/examples/chatbot.rst