Streamlit component that allows you to do plot audio embeddings as a plotly figure with source audio playback on hover or click.
Project description
streamlit-audio-plot
Streamlit component that allows you to plot audio embeddings as a plotly figure with source audio playback on hover or click. Supports Python 3.8+
Installation instructions
pip install streamlit-audio-plot
Usage instructions
import streamlit as st
from audio_plot import audio_plot, Events
# minimal example
audio_plot(
embeddings = [[0.1, 0.2], [0.3, 0.4]],
urls = [
"https://www.learningcontainer.com/wp-content/uploads/2020/02/Kalimba.mp3#t=0.0,3.0",
"https://www.learningcontainer.com/wp-content/uploads/2020/02/Kalimba.mp3#t=60.0,63.0",
]
)
# e.g. metadata is a pd.DataFrame
audio_plot(
embeddings=metadata[["valence", "arousal"]],
urls=metadata["urls"],
labels=[f"{artist}: {title}" for artist, title in zip(metadata["artist"], metadata["title"])],
event=Events.CLICK, # or Events.HOVER
height=800,
volume=0.4, # between 0. and 1.
hidePlayer=true,
)
See the docstring for full specifications of parameters.
The JS audio playback requires that the user first interacts with the webpage (e.g. by clicking on the page). Otherwise, React with throw a runtime error that will replace the plot. This should be streamlined in the future to not require page reload.
Development instructions
Backend
python3.x -m venv venv # 3.8+
source venv/bin/activate # your shell
pip install -e .
streamlit run audio_plot/__init__.py
Frontend (requires nvm or node.js)
cd audio_plot/frontend
nvm use # nvm install if not present
npm install
npm run start
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for streamlit-audio-plot-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41dc31d7ec0fcbe76f82c5b5a69de9808e70c16cb3e3b2f85c137c34003aa401 |
|
MD5 | 86ecfe8a5551b6134e22149694e381e7 |
|
BLAKE2b-256 | 7a30be27032b4b4b710fafdee3447b04336445887f164e9c9de97c96b051c0d2 |
Close
Hashes for streamlit_audio_plot-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e47bd894184dcb831b11f09f46d0bb8da2eef4e8fd50abedefbc6b55203b6da9 |
|
MD5 | 233c2d868f84a23e9b2f31eb8f70ad70 |
|
BLAKE2b-256 | e1f7564c82f032b7bd3a063a189e21eca3da40e8ae4354dad56b82f4999745f0 |