Skip to content

armgit / burr

Public Imported from GitHub
0

Build applications that make decisions (chatbots, agents, simulations, etc...). Monitor, trace, persist, and execute on your own infrastructure.

Fixes links due to examples directory structure changing

Stefan Krawczyk8e618486b8d9
diff --git a/README.md b/README.md
index f19c5b55..6ab4ce4e 100644
--- a/README.md
+++ b/README.md
@@ -57,9 +57,9 @@ Burr includes:
Burr can be used to power a variety of applications, including:
-1. [A simple gpt-like chatbot](examples/gpt)
-2. [A stateful RAG-based chatbot](examples/rag)
-3. [A machine learning pipeline](examples/ml_training)
+1. [A simple gpt-like chatbot](examples/multi-modal-chatbot)
+2. [A stateful RAG-based chatbot](examples/conversational-rag)
+3. [A machine learning pipeline](examples/ml-training)
4. [A simulation](examples/simulation)
And a lot more!
diff --git a/burr/cli/__main__.py b/burr/cli/__main__.py
index 39519a27..a1b5aaa0 100644
--- a/burr/cli/__main__.py
+++ b/burr/cli/__main__.py
@@ -166,7 +166,7 @@ def generate_demo_data():
git_root = _get_git_root()
# We need to add the examples directory to the path so we have all the imports
# The GPT-one relies on a local import
- sys.path.extend([git_root, f"{git_root}/examples/gpt"])
+ sys.path.extend([git_root, f"{git_root}/examples/multi-modal-chatbot"])
from burr.cli.demo_data import generate_all
with cd(git_root):
diff --git a/burr/tracking/server/backend.py b/burr/tracking/server/backend.py
index ab2bdfa8..384bd095 100644
--- a/burr/tracking/server/backend.py
+++ b/burr/tracking/server/backend.py
@@ -60,9 +60,9 @@ class BackendBase(abc.ABC):
def get_uri(project_id: str) -> str:
project_id_map = {
- "demo:counter": "https://github.com/DAGWorks-Inc/burr/tree/main/examples/counter",
- "demo:tracing": "https://github.com/DAGWorks-Inc/burr/tree/main/examples/gpt/application_with_traces.py",
- "demo:chatbot": "https://github.com/DAGWorks-Inc/burr/tree/main/examples/gpt",
+ "demo:counter": "https://github.com/DAGWorks-Inc/burr/tree/main/examples/hello-world-counter",
+ "demo:tracing": "https://github.com/DAGWorks-Inc/burr/tree/main/examples/tracing-and-spans/application.py",
+ "demo:chatbot": "https://github.com/DAGWorks-Inc/burr/tree/main/examples/multi-modal-chatbot",
"demo:conversational-rag": "https://github.com/DAGWorks-Inc/burr/tree/main/examples/conversational-rag",
}
return project_id_map.get(project_id, "")
diff --git a/docs/examples/chatbot.rst b/docs/examples/chatbot.rst
index fa2e1990..3b758f45 100644
--- a/docs/examples/chatbot.rst
+++ b/docs/examples/chatbot.rst
@@ -8,12 +8,12 @@ perfect use case for using Burr.
GPT-like chatbot
----------------
-See `github repository example <https://github.com/DAGWorks-Inc/burr/tree/main/examples/gpt>`_.
+See `github repository example <https://github.com/DAGWorks-Inc/burr/tree/main/examples/multi-modal-chatbot>`_.
Conversational RAG chatbot
--------------------------
-See `github example <https://github.com/DAGWorks-Inc/burr/tree/main/examples/conversational_rag>`_.
+See `github example <https://github.com/DAGWorks-Inc/burr/tree/main/examples/conversational-rag>`_.
Accompanying video walkthrough:
diff --git a/docs/examples/simple.rst b/docs/examples/simple.rst
index d8c40355..6ecf9bf9 100644
--- a/docs/examples/simple.rst
+++ b/docs/examples/simple.rst
@@ -2,6 +2,6 @@
Simple examples
====================
-- `cowsay <https://github.com/DAGWorks-Inc/burr/tree/main/examples/cowsay>`_
-- `counter <https://github.com/DAGWorks-Inc/burr/tree/main/examples/counter>`_
-- `corgi adventure <https://github.com/DAGWorks-Inc/burr/tree/main/examples/corgi_adventure>`_
+- `cowsay <https://github.com/DAGWorks-Inc/burr/tree/main/examples/others-examples/cowsay>`_
+- `counter <https://github.com/DAGWorks-Inc/burr/tree/main/examples/hello-world-counter>`_
+- `corgi adventure <https://github.com/DAGWorks-Inc/burr/tree/main/examples/llm-adventure-game>`_
diff --git a/docs/getting_started/simple-example.rst b/docs/getting_started/simple-example.rst
index ffcdd4c8..f6ae9ba3 100644
--- a/docs/getting_started/simple-example.rst
+++ b/docs/getting_started/simple-example.rst
@@ -12,7 +12,7 @@ explanations in the :ref:`concepts <concepts>` section.
🤔 For an alternative example to get started with, you can also check out
`this video walkthrough <https://www.youtube.com/watch?v=rEZ4oDN0GdU>`_
-using `this notebook <https://github.com/DAGWorks-Inc/burr/blob/main/examples/blog_post/blog.ipynb>`_.
+using `this notebook <https://github.com/DAGWorks-Inc/burr/blob/main/examples/conversational-rag/notebook.ipynb>`_.
------------------
Build a Counter
diff --git a/docs/getting_started/up-next.rst b/docs/getting_started/up-next.rst
index 6140caed..45fbe226 100644
--- a/docs/getting_started/up-next.rst
+++ b/docs/getting_started/up-next.rst
@@ -44,7 +44,7 @@ Simple Counter ``demo:counter``
.. code-block:: bash
- cd examples/counter
+ cd examples/hello-world-counter
python application.py
-------------------------------------------
@@ -55,7 +55,7 @@ This is a toy interactive RAG example. You'll ask questions in the terminal abou
.. code-block:: bash
- cd examples/conversational_rag
+ cd examples/conversational-rag
pip install -r requirements.txt
python application.py
diff --git a/docs/main.rst b/docs/main.rst
index 4ab0094f..82ae8dce 100644
--- a/docs/main.rst
+++ b/docs/main.rst
@@ -6,7 +6,7 @@ Welcome to Burr's documentation.
For a quick overview of Burr, watch `this walkthrough <https://www.loom.com/share/a10f163428b942fea55db1a84b1140d8?sid=1512863b-f533-4a42-a2f3-95b13deb07c9>`_
or read `our blog post <https://blog.dagworks.io/p/burr-develop-stateful-ai-applications?r=2cg5z1&utm_campaign=post&utm_medium=web>`_. The following video is
-a longer demo of building a simple chatbot application with Burr using `this notebook <https://github.com/DAGWorks-Inc/burr/blob/main/examples/blog_post/blog.ipynb>`_:
+a longer demo of building a simple chatbot application with Burr using `this notebook <https://github.com/DAGWorks-Inc/burr/blob/main/examples/conversational-rag/notebook.ipynb>`_:
.. raw:: html