-
Notifications
You must be signed in to change notification settings - Fork 289
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
45 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,7 @@ | ||
# Using W&B and Streamlit | ||
# Streamlit | ||
|
||
## Description | ||
Use Streamlit with W&B for quick, interactive apps. | ||
We have two example use cases here in this repo: | ||
|
||
Example repo to show off the different possibilties when utilizing both W&B and Streamlit. In this repo we hit two scenarios in terms of interaction with W&B and Streamlit. | ||
|
||
1. Embed an IFrame of the WANDB dashboard within the Streamlit application. This is shown in the application when selecting the `Embed IFrame` option. In this variant we allow users to select a project and run. We then display both the project dashboard and run dashboard from WANDB | ||
|
||
2. Use WANDB traiditionally to log artifacts that can be pulled from an experiment to visualize traditionally. This is shown in the application when selecting the `Use WANDB Logging` option. In this variant we provide a minimal example of an WANDB experiment that can be run to the users account upon click. When said experiment is finished, it should load in a logged HTML page saved in WANDB to the file directory of the Streamlit project to then be displayed by Stteamlit. | ||
|
||
## Install | ||
|
||
``` | ||
pip install -r requirements.txt | ||
``` | ||
|
||
Generate a `.env` file in the root of the project with variables: | ||
|
||
``` | ||
WANDB_API_KEY=<WANDB_API_KEY> | ||
WANDB_ENTITY=<WANDB_ENTITY_NAME> | ||
``` | ||
|
||
## Usage | ||
|
||
To run streamlit on localhost use command: `streamlit run wandb_streamlit_app.py` | ||
|
||
## Examples | ||
|
||
### WANDB Project Dashboard | ||
|
||
<img src="./static/gifs/embed_wandb_project_dash.gif"/> | ||
|
||
### WANDB Run Dashboard | ||
|
||
<img src="./static/gifs/embed_wandb_run_dash.gif"/> | ||
|
||
### WANDB HTML Artifact rendered via Streamlit | ||
|
||
<img src="./static/gifs/use_wandb_logging.gif"/> | ||
1. **Quickstart**: Embed an iframe of W&B in a Streamlit app | ||
2. **Annotation**: Interactively annotate LLM data |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Using W&B and Streamlit | ||
|
||
## Description | ||
|
||
Example repo to show off the different possibilties when utilizing both W&B and Streamlit. In this repo we hit two scenarios in terms of interaction with W&B and Streamlit. | ||
|
||
1. Embed an IFrame of the WANDB dashboard within the Streamlit application. This is shown in the application when selecting the `Embed IFrame` option. In this variant we allow users to select a project and run. We then display both the project dashboard and run dashboard from WANDB | ||
|
||
2. Use WANDB traiditionally to log artifacts that can be pulled from an experiment to visualize traditionally. This is shown in the application when selecting the `Use WANDB Logging` option. In this variant we provide a minimal example of an WANDB experiment that can be run to the users account upon click. When said experiment is finished, it should load in a logged HTML page saved in WANDB to the file directory of the Streamlit project to then be displayed by Stteamlit. | ||
|
||
## Install | ||
|
||
``` | ||
pip install -r requirements.txt | ||
``` | ||
|
||
Generate a `.env` file in the root of the project with variables: | ||
|
||
``` | ||
WANDB_API_KEY=<WANDB_API_KEY> | ||
WANDB_ENTITY=<WANDB_ENTITY_NAME> | ||
``` | ||
|
||
## Usage | ||
|
||
To run streamlit on localhost use command: `streamlit run wandb_streamlit_app.py` | ||
|
||
## Examples | ||
|
||
### WANDB Project Dashboard | ||
|
||
<img src="./static/gifs/embed_wandb_project_dash.gif"/> | ||
|
||
### WANDB Run Dashboard | ||
|
||
<img src="./static/gifs/embed_wandb_run_dash.gif"/> | ||
|
||
### WANDB HTML Artifact rendered via Streamlit | ||
|
||
<img src="./static/gifs/use_wandb_logging.gif"/> |
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.