Skip to content
New issue

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

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

Already on GitHub? # to your account

Tweak readme quickstart #111

Merged
merged 1 commit into from
Mar 28, 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
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,26 @@ Install from `pypi`:
pip install "burr[start]"
```

Then run the server:
Then run the UI server:

```bash
burr
```
This will open up a demo -- to chat it requires the `OPENAI_API_KEY` environment variable to be set,
but you can still see how it works if you don't have one.
This will open up Burr's telemetry UI. It comes loaded with some default data so you can click around.
It also has a demo chat application to help demonstrate what the UI captures enabling you too see things changing in
real-time. Hit the "Demos" side bar on the left and select `chatbot`. To chat it requires the `OPENAI_API_KEY`
environment variable to be set, but you can still see how it works if you don't have an API key set.

Next, start coding / running examples:

```bash
git clone https://github.com/dagworks-inc/burr && cd burr/examples/counter
python application.py
```
You'll see the counter example running in the terminal, along with the trace being tracked in the UI.
See if you can find it.

For more details see the [getting started guide](https://burr.dagworks.io/getting_started/simple-example/).

## 🔩 How does Burr work?

Expand Down
12 changes: 9 additions & 3 deletions docs/getting_started/up-next.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ All of the following are pre-populated in the UI under ``projects/``. You can st

burr

In-app chatbot ``demo:chatbot``
------------------------------------
Telemetry UI chatbot demo ``demo:chatbot``
------------------------------------------

You'll need the env variable ``OPENAI_API_KEY`` set to your api key for this to work. If you don't
have one, you'll still be able to run it and explore, you just won't be able to chat.
Expand All @@ -28,12 +28,17 @@ Then:
burr-demo

If you've run ``burr`` and have it open on port 7241, just navigate to `demos/chatbot <http://localhost:7241/demos/chatbot>`_.

Repository Examples
-------------------

For the next examples you'll need the repository cloned:

.. code-block:: bash

git clone https://github.com/dagworks-inc/burr && cd burr

-------------------------------
Simple Counter ``demo:counter``
-------------------------------

Expand All @@ -42,6 +47,7 @@ Simple Counter ``demo:counter``
cd examples/counter
python application.py

-------------------------------------------
Interactive RAG ``demo:conversational-rag``
-------------------------------------------

Expand All @@ -53,7 +59,7 @@ This is a toy interactive RAG example. You'll ask questions in the terminal abou
pip install -r requirements.txt
python application.py

----------------------

Understanding Concepts
----------------------

Expand Down
Loading