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

Fixes broken images in docs #120

Merged
merged 1 commit into from
Mar 31, 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
4 changes: 2 additions & 2 deletions docs/examples/simple.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
Simple examples
====================

- `cowsay <https://github.com/DAGWorks-Inc/burr/tree/main/examples/others-examples/cowsay>`_
- `cowsay <https://github.com/DAGWorks-Inc/burr/tree/main/examples/other-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>`_
- `[corgi] adventure game <https://github.com/DAGWorks-Inc/burr/tree/main/examples/llm-adventure-game>`_
3 changes: 3 additions & 0 deletions examples/conversational-rag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ python application.py

You'll then have a text terminal where you can interact. Type exit to stop.

# Application That's Defined:
![Application Image](statemachine.png)

# Video Walkthrough via Notebook
Watch the video walkthrough with the notebook (1.5x+ speed recommended):

Expand Down
2 changes: 1 addition & 1 deletion examples/hello-world-counter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ streamlit run streamlit_app.py

This will open a chrome window and print out the URL. The state machine this encapsulates takes the following form:

![State Machine](digraph.png)
![State Machine](statemachine.png)
2 changes: 1 addition & 1 deletion examples/llm-adventure-game/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ How to run:
OPENAI_API_KEY=<your key> python application.py
```

![State Machine](digraph.png)
![State Machine](statemachine.png)
2 changes: 1 addition & 1 deletion examples/multi-agent-collaboration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Application run:

or
```bash
python lecl_application.py
python lcel_application.py
```
Application run:
![lcel image](lcel-multi-agent.png)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 17 additions & 10 deletions examples/multi-modal-chatbot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,36 @@ worry about putting in a DAG. As examples get more complex, we anticipate that H

The state machine this encapsulates takes the following form:

![State Machine](digraph.png)
![State Machine](statemachine.png)

Note that it is currently wired up to handle errors in the state machine, but the actions do not respect that yet. Coming soon.

We have three files:

- [application.py](application.py) -- This contains a mainline to generate the graph portrayal.
- [requirements.txt](requirements.txt) -- Just the requirements. All this needs is Burr/Streamlit/openai
- [streamlit_app.py](streamlit_app.py) -- This contains a simple Streamlit app to interact with the cow
- [application_with_traces.py](application_with_traces.py) -- This showcases how to use the tracing feature.
- [simple_streamlit_app.py](simple_streamlit_app.py) -- This contains a more sophisticated Streamlit app to interact with.
- [streamlit_app.py](streamlit_app.py) -- This contains a simple Streamlit app to interact with that is more
sophisticated than the simple version. It contains a more sophisticated UI that also visualizes the Burr application.
You must have your `OPENAI_API_KEY` set in your environment. You can do this by running.

To run on streamlit, you can launch the app:

```bash
streamlit run streamlit_app.py
streamlit run simple_streamlit_app.py & burr
```

This has the state machihne displayed as well as a quick debugging/demo. You should be using the UI,
however, as it is more powerful and responsive. You can run the simple app with:
This will open up both a streamlit app and a server at the same time. Interact with the app, and see
interactions in the Burr UI.


Alternatively, run the more sophisticated streamlit app:

```bash
streamlit run simple_streamlit_app.py & burr
streamlit run streamlit_app.py
```

This will open up both a streamlit app and a server at the same time.
This streamlit app renders the statemachine as well as exposing the burr application showing you
can build a more sophisticated UI around the Burr application.


## Tracing
To see a tracing example see this [example](../tracing-and-spans).
Loading