Ok, the catchy title is just to get people thinking creatively about this post. I did not build a streamlit app for interactive documentation… But I want to share a scenario where streamlit is proving useful as a supplement to Python package documentation.
As a maintainer of an open-source repository, kneed, users frequently ask me questions about which parameters they should use to identify the knee-point in their data. To answer these questions, I need to:
- request their data (if they didn’t provide it)
- plot their data with the desired knee-point
- email it back to them with an explanation of the parameters
With streamlit and streamlit share, I built an interactive app that allows users to input their data and explore the parameter space in real-time. Of course, I included links to the app in kneed’s README and documentation, so users should be directed to the app before emailing me directly.
How many other repos could benefit from a streamlit implementation like this? I imagine most would, but word2vec and doc2vec come to mind. The difficult step for some projects is: creating a visual that generates a mental connection for the user between the parameter and the outcome.
I’m curious to hear people’s thoughts about efforts in making documentation more interactive. This is a new concept to me, but one I’d like to read more about.