Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds quick gif to README to demonstrate what burr does #3

Merged
merged 1 commit into from
Feb 10, 2024
Merged
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
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Burr is a state machine for data/AI projects. You can (and should!) use it for a
is always hard!

You can find the documentation [here](https://studious-spork-n8kznlw.pages.github.io/).

## What can you do with Burr?

Burr can be used for a variety of applications. Burr can build a state machine to orchestrate, express, and track:
Expand All @@ -20,8 +21,10 @@ Using hooks and other integrations you can (a) integrate with any of your favori
(b) build custom actions that delegate to your favorite libraries.

Bur will *not* tell you how to build your models, how to query APIs, or how to manage your data. It will help you tie all these together
in a way that scales with your needs and makes following the logic of your system easy.
in a way that scales with your needs and makes following the logic of your system easy. Burr comes out of the box with a host of integrations
including tooling to build a UI in streamlit and watch your state machine execute.

![Burr at work](./chatbot.gif)

## Why the name Burr?

Expand All @@ -30,6 +33,7 @@ We imagine a world in which Burr and Hamilton lived in harmony and saw through t
built Burr as a _harness_ to handle state between executions of Hamilton DAGs,
but realized that it has a wide array of applications and decided to release it.


# Getting Started

To get started, install from `pypi`, using your favorite package manager:
Expand Down
Binary file added chatbot.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion examples/gpt/streamlit_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ def main():
"...", disabled=st.session_state.get("running", False), key="chat_input"
)
should_rerun = chatbot_step(app_state, prompt)
with st.container(height=800):
with st.container(height=850):
for item in app_state.history:
render_chat_message(item)
with columns[1]:
Expand Down
Loading