diff --git a/docs/examples/simple.rst b/docs/examples/simple.rst index 6ecf9bf9..f97dfbbc 100644 --- a/docs/examples/simple.rst +++ b/docs/examples/simple.rst @@ -2,6 +2,6 @@ Simple examples ==================== -- `cowsay `_ +- `cowsay `_ - `counter `_ -- `corgi adventure `_ +- `[corgi] adventure game `_ diff --git a/examples/conversational-rag/README.md b/examples/conversational-rag/README.md index f117874f..8938d238 100644 --- a/examples/conversational-rag/README.md +++ b/examples/conversational-rag/README.md @@ -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): diff --git a/examples/hello-world-counter/README.md b/examples/hello-world-counter/README.md index 495fd1b6..013c3a0d 100644 --- a/examples/hello-world-counter/README.md +++ b/examples/hello-world-counter/README.md @@ -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) diff --git a/examples/llm-adventure-game/README.md b/examples/llm-adventure-game/README.md index 21ed72cc..33bbb106 100644 --- a/examples/llm-adventure-game/README.md +++ b/examples/llm-adventure-game/README.md @@ -7,4 +7,4 @@ How to run: OPENAI_API_KEY= python application.py ``` -![State Machine](digraph.png) +![State Machine](statemachine.png) diff --git a/examples/multi-agent-collaboration/README.md b/examples/multi-agent-collaboration/README.md index 61fc5017..ce5296e0 100644 --- a/examples/multi-agent-collaboration/README.md +++ b/examples/multi-agent-collaboration/README.md @@ -53,7 +53,7 @@ Application run: or ```bash -python lecl_application.py +python lcel_application.py ``` Application run: ![lcel image](lcel-multi-agent.png) diff --git a/examples/multi-agent-collaboration/lcel-multi-agent.png b/examples/multi-agent-collaboration/lcel-multi-agent.png new file mode 100644 index 00000000..0a869a95 Binary files /dev/null and b/examples/multi-agent-collaboration/lcel-multi-agent.png differ diff --git a/examples/multi-modal-chatbot/README.md b/examples/multi-modal-chatbot/README.md index 5119006c..56116d19 100644 --- a/examples/multi-modal-chatbot/README.md +++ b/examples/multi-modal-chatbot/README.md @@ -17,7 +17,7 @@ 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. @@ -25,21 +25,28 @@ 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).