Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ on:
permissions:
contents: write
pull-requests: write
issues: write

concurrency: ci-${{ github.ref }}

Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,7 @@ While Apache Burr is attempting something (somewhat) unique, there are a variety
## 🌯 Why the name Burr?

Apache Burr is named after [Aaron Burr](https://en.wikipedia.org/wiki/Aaron_Burr), founding father, third VP of the United States, and murderer/arch-nemesis of [Alexander Hamilton](https://en.wikipedia.org/wiki/Alexander_Hamilton).
What's the connection with Hamilton? This is [DAGWorks](www.dagworks.io)' second open-source library release after the [Apache Hamilton library](https://github.com/apache/hamilton)
We imagine a world in which Burr and Hamilton lived in harmony and saw through their differences to better the union. We originally
built Apache Burr as a _harness_ to handle state between executions of Apache Hamilton DAGs (because DAGs don't have cycles),
What's the connection with (Apache) Hamilton? We imagine a world in which Burr and Hamilton lived in harmony and saw through their differences to better the union. Originally Apache Burr was built as a _harness_ to handle state between executions of Apache Hamilton DAGs (because DAGs don't have cycles),
but realized that it has a wide array of applications and decided to release it more broadly.

# Testimonials
Expand Down
8 changes: 4 additions & 4 deletions burr/tracking/server/backend.py
Original file line number Diff line number Diff line change
Expand Up @@ -257,10 +257,10 @@ def safe_json_load(line: bytes):

def get_uri(project_id: str) -> str:
project_id_map = {
"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",
"demo_counter": "https://github.com/apache/burr/tree/main/examples/hello-world-counter",
"demo_tracing": "https://github.com/apache/burr/tree/main/examples/tracing-and-spans/application.py",
"demo_chatbot": "https://github.com/apache/burr/tree/main/examples/multi-modal-chatbot",
"demo_conversational-rag": "https://github.com/apache/burr/tree/main/examples/conversational-rag",
}
return project_id_map.get(project_id, "")

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/chatbots/gpt-like-chatbot.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"<img src=\"https://github.com/user-attachments/assets/2ab9b499-7ca2-4ae9-af72-ccc775f30b4e\" width=\"100\" align=\"left\" /> + \n",
"<img src=\"https://cdn.mos.cms.futurecdn.net/VgGxJABA8DcfAMpPPwdv6a.jpg\" width=\"200\" align=\"center\"/>\n",
"\n",
"[https://github.com/apache/burr](https://github.com/apache/burr) by DAGWorks Inc. (YCW23 & StartX).\n",
"[https://github.com/apache/burr](https://github.com/apache/burr).\n",
"\n",
"Take🏠:\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion examples/adaptive-crag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ We stop after `ask_assistant` to get the next `query` for `router`.
## Adaptive-CRAG 🧪
![statemachine](statemachine.png)

We have some of the core concepts from the [Burr Docs](https://burr.dagworks.io/concepts/) in a folder and we will add that to a `LanceDB` table for Hybrid Search. You can add as many tables as you want. Each table will be a different route for the `router`.
We have some of the core concepts from the [Burr Docs](https://burr.apache.org/concepts/) in a folder and we will add that to a `LanceDB` table for Hybrid Search. You can add as many tables as you want. Each table will be a different route for the `router`.
2 changes: 1 addition & 1 deletion examples/conversational-rag/graph_db_example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ This will run the following two pipelines:
![ingest fighters](ingest_fighters.png)
![ingest fights](ingest_fights.png)

**Note:** [Hamilton](https://github.com/dagworks-inc/hamilton) also comes with a UI that you can use to visualize the pipeline and
**Note:** [Hamilton](https://github.com/apache/hamilton) also comes with a UI that you can use to visualize the pipeline and
track execution information about it. See hamilton_ingest.py or ingest_notebook.ipynb for more information.

## Ingest data using a notebook:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"source": [
"# Ingestion Notebook\n",
"\n",
"In this notebook we see how to load data into FalkorDB using [Hamilton](https://github.com/dagWorks-Inc/hamilton)."
"In this notebook we see how to load data into FalkorDB using [Hamilton](https://github.com/apache/hamilton)."
]
},
{
Expand Down Expand Up @@ -295,7 +295,7 @@
"metadata": {},
"source": [
"### Note about the Hamilton UI\n",
"Hamilton comes with an [open source UI](https://hamilton.dagworks.io/en/latest/hamilton-ui/) that you can\n",
"Hamilton comes with an [open source UI](https://hamilton.apache.io/en/latest/hamilton-ui/) that you can\n",
"surface information about your Hamilton executions. If you pull the docker containers\n",
"locally and uncomment adding the HamiltonTracker, then you'll see runs logged to it."
]
Expand Down
4 changes: 2 additions & 2 deletions examples/hamilton-integration/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Use the 2-layer approach for a maintainable RAG system [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/dagworks-inc/burr/blob/main/examples/hamilton-integration/notebook.ipynb) [![GitHub badge](https://img.shields.io/badge/github-view_source-2b3137?logo=github)](https://github.com/dagworks-inc/burr/blob/main/examples/hamilton-integration/notebook.ipynb)\n",
"# Use the 2-layer approach for a maintainable RAG system [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/dagworks-inc/burr/blob/main/examples/hamilton-integration/notebook.ipynb) [![GitHub badge](https://img.shields.io/badge/github-view_source-2b3137?logo=github)](https://github.com/apache/burr/blob/main/examples/hamilton-integration/notebook.ipynb)\n",
"\n",
"Ready-made solutions can get you started with GenAI, but building reliable product features with retrieval augmented generation (RAG) and LLM agents inevitably required custom code. This post shares the 2-layer approach to build a maintainable RAG application that will evolve with your needs. To illustrate these ideas, we will show how a typical RAG project might evolve.\n",
"\n",
Expand Down Expand Up @@ -676,7 +676,7 @@
"\n",
"In th next snippets, we refactor actions using Hamilton, a lightweight library to structure data transformations as directed acyclic graphs (DAGs). Hamilton uses the function and parameter names to infer the dependencies between functions and the graph structure.\n",
"\n",
"The next cell reimplements the `ingest_blog` action from `V2`. It uses `%%cell_to_module` from the Hamilton notebook extension to define a DAG in a single cell and view it ([see tutorial](https://github.com/DAGWorks-Inc/hamilton/blob/main/examples/jupyter_notebook_magic/example.ipynb))."
"The next cell reimplements the `ingest_blog` action from `V2`. It uses `%%cell_to_module` from the Hamilton notebook extension to define a DAG in a single cell and view it ([see tutorial](https://github.com/apache/hamilton/blob/main/examples/jupyter_notebook_magic/example.ipynb))."
]
},
{
Expand Down
6 changes: 3 additions & 3 deletions examples/image-telephone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ that talks to itself to do something fun. The game is simple:
2. That caption is then provided to DALL-E, which generates an image based on the caption, which is saved to state.
3. The loop repeats -- and you have encoded the game of telephone!

Specifically, each action here in Burr is delegated to the [Hamilton](https://github.com/dagworks-inc/hamilton) micro-framework to run.
Specifically, each action here in Burr is delegated to the [Hamilton](https://github.com/apache/hamilton) micro-framework to run.
Hamilton is a great replacement for tools like LCEL, because it's built to provide a great SDLC experience, in addition
to being lightweight, extensible and more general
purpose (e.g. it's great for expressing things data processing, ML, and web-request logic). We're using
Expand Down Expand Up @@ -71,5 +71,5 @@ documentation for the Hamilton dataflows that are used: [captioning](https://hub
template by overriding values, or by copying the code and modifying it yourself in 2 minutes - see instructions on the [hub](https://hub.dagworks.io/).

## Hamilton code
For more details on the [Hamilton](https://github.com/dagworks-inc/hamilton) code and
this [streamlit app](https://image-telephone.streamlit.app) see [this example in the Hamilton repo.](https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/LLM_Workflows/image_telephone)
For more details on the [Hamilton](https://github.com/apache/hamilton) code and
this [streamlit app](https://image-telephone.streamlit.app) see [this example in the Hamilton repo.](https://github.com/apache/hamilton/tree/main/examples/LLM_Workflows/image_telephone)
4 changes: 2 additions & 2 deletions examples/ml-training/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

# ML Training

This is a WIP! Please contribute back if you have ideas. You can track the associated issue [here](https://github.com/DAGWorks-Inc/burr/issues/138).
This is a WIP! Please contribute back if you have ideas. You can track the associated issue [here](https://github.com/apache/burr/issues/138).

A machine learning training system can easily be modeled as a state machine.

Expand Down Expand Up @@ -52,7 +52,7 @@ you can use Burr hooks to log metrics, visualize, etc... at each step. This allo

While some models are trained in a single-shot and shipped to production, many require human input.
Burr can be used to express training, then checkpoint/pause the state while a human is evaluating it,
and have their input (e.g. go/no-go) passed in as an [input parameter](https://burr.dagworks.io/concepts/actions/#runtime-inputs).
and have their input (e.g. go/no-go) passed in as an [input parameter](https://burr.apache.org/concepts/actions/#runtime-inputs).

Note that this still requires a scheduling tool (say a task executor that runs until the next human input is needed),
but that task executor does not need to be complicated (all it needs to do is run a job when prompted, and possibly on a chron schedule).
Expand Down
2 changes: 1 addition & 1 deletion examples/multi-agent-collaboration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This example resembles the example from following [cookbook](https://github.com/

There are two implementations:

1. `hamilton/` -- this uses [Hamilton](https://github.com/dagworks-inc/hamilton) inside the defined actions.
1. `hamilton/` -- this uses [Hamilton](https://github.com/apache/hamilton) inside the defined actions.
2. `lcel/` -- this uses LangChain's LCEL inside the defined actions.

# `hamilton/application.py` vs `lcel/application.py`:
Expand Down
2 changes: 1 addition & 1 deletion examples/multi-agent-collaboration/hamilton/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ With Hamilton the prompts can be found in the module [`func_agent.py`](func_agen

The Hamilton code creates the following dataflow:

![dataflow](https://github.com/DAGWorks-Inc/burr/assets/2328071/24822ee5-f05b-4fa4-95e7-daa23969cfff)
![dataflow](https://github.com/apache/burr/assets/2328071/24822ee5-f05b-4fa4-95e7-daa23969cfff)


# Tracing
Expand Down
12 changes: 6 additions & 6 deletions examples/multi-modal-chatbot/burr_demo.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"<img src=\"https://github.com/user-attachments/assets/2ab9b499-7ca2-4ae9-af72-ccc775f30b4e\" width=\"100\" align=\"left\" /> +\n",
"<img src=\"https://cdn.mos.cms.futurecdn.net/VgGxJABA8DcfAMpPPwdv6a.jpg\" width=\"200\" align=\"center\"/>\n",
"\n",
"[https://github.com/dagworks-inc/burr](https://github.com/dagworks-inc/burr) by DAGWorks Inc. (YCW23 & StartX).\n",
"[https://github.com/apache/burr](https://github.com/apache/burr).\n",
"\n",
"Take🏠:\n",
"\n",
Expand Down Expand Up @@ -82,7 +82,7 @@
"metadata": {},
"source": [
"# Solution: Burr\n",
"(Complements our other framework [Hamilton](https://github.com/dagWorks-Inc/hamilton))\n"
"(Complements our other framework [Hamilton](https://github.com/apache/hamilton))\n"
]
},
{
Expand Down Expand Up @@ -1002,7 +1002,7 @@
"\n",
"[Link to video walking through this notebook](https://youtu.be/hqutVJyd3TI).\n",
"\n",
"[https://github.com/dagworks-inc/burr](https://github.com/dagworks-inc/burr)\n",
"[https://github.com/apache/burr](https://github.com/apache/burr)\n",
"<img src=\"burr_qrcode.png\" width=\"125\"/>\n",
"\n",
"[Time Travel blog post & video:](https://blog.dagworks.io/p/travel-back-in-time-with-burr)\n",
Expand All @@ -1013,10 +1013,10 @@
"\n",
"More blogs @ `blog.dagworks.io` e.g. [async & streaming](https://blog.dagworks.io/p/streaming-chatbot-with-burr-fastapi)\n",
"\n",
"More [examples](https://github.com/DAGWorks-Inc/burr/tree/main/examples/):\n",
"More [examples](https://github.com/apache/burr/tree/main/examples/):\n",
"\n",
"- e.g. [test case creation](https://burr.dagworks.io/examples/guardrails/creating_tests/)\n",
"- e.g. [multi-agent collaboration](https://github.com/DAGWorks-Inc/burr/tree/main/examples/multi-agent-collaboration)\n",
"- e.g. [test case creation](https://burr.apache.org/examples/guardrails/creating_tests/)\n",
"- e.g. [multi-agent collaboration](https://github.com/apache/burr/tree/main/examples/multi-agent-collaboration)\n",
"\n",
"Follow on Twitter & LinkedIn:\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion examples/opentelemetry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ We have two modes:
See [notebook.ipynb](./notebook.ipynb) for a simple overview.
See [application.py](./application.py) for the full code

See the [documentation](https://burr.dagworks.io/concepts/additional-visibility/#open-telemetry) for more info
See the [documentation](https://burr.apache.org/concepts/additional-visibility/#open-telemetry) for more info
2 changes: 1 addition & 1 deletion examples/opentelemetry/notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"source": [
"# OpenTelemetry\n",
"\n",
"In this notebook we'll instrument a simple Burr app with [OpenTelemetry](www.opentelemetry.io). See the [docs](https://burr.dagworks.io/concepts/additional-visibility/) for more information."
"In this notebook we'll instrument a simple Burr app with [OpenTelemetry](www.opentelemetry.io). See the [docs](https://burr.apache.org/concepts/additional-visibility/) for more information."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion examples/parallelism/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

# Parallelism

In this example we go over Burr's parallelism capabilities. It is based on the documentation (https://burr.dagworks.io/concepts/parallelism/), demonstrating the `MapStates` capabilities.
In this example we go over Burr's parallelism capabilities. It is based on the documentation (https://burr.apache.org/concepts/parallelism/), demonstrating the `MapStates` capabilities.

See [the notebook](./notebook.ipynb) for the full example. Or <a target="_blank" href="https://colab.research.google.com/github/dagworks-inc/burr/blob/main/examples/parallelism/notebook.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
Expand Down
Loading
Loading