IPyPlot is a small python package offering fast and efficient plotting of images inside Python Notebooks cells. It's using IPython with HTML for faster, richer and more interactive way of displaying big numbers of images.
Displaying big numbers of images with Python in Notebooks always was a big pain for me as I always used
matplotlib for that task and never have I even considered if it can be done faster, easier or more efficiently.
Especially in one of my recent projects I had to work with a vast number of document images in a very interactive way which led me to forever rerunning notebook cells and waiting for countless seconds for
matplotlib to do it's thing..
My frustration grew up to the point were I couldn't stand it anymore and started to look for other options..
Best solution I found involved using
IPython package in connection with simple HTML. Using that approach I built this simple python package called IPyPlot which finally helped me cure my frustration and saved a lot of my time.
- Easy, fast and efficient plotting of images in python within notebooks
Plotting functions (see examples section to learn more):
plot_images- simply plots all the images in a grid-like layout
plot_class_representations- similar to
plot_imagesbut displays only the first image for each label/class (based on provided labels collection)
plot_class_tabs- plots images in a grid-like manner in a separate tab for each label/class based on provided labels
Supported image formats:
Sequence of local storage URLs, e.g.
Sequence of remote URLs, e.g.
Sequence of images as
Supported sequence types:
- Sequence of local storage URLs, e.g.
custom_textsparam to display additional texts like confidence score or some other information for each image
force_b64flag to force conversion of images from URLs to base64 format
- click on image to enlarge
control number of displayed images and their width through
- "show html" button which reveals the HTML code used to generate plots
- option to set specific order of labels/tabs, filter them or ignore some of the labels
Supported notebook platforms:
- Google Colab
- Azure Notebooks
- Kaggle Notebooks
IPyPlot can be installed through PyPI:
pip install ipyplot
or directly from this repo using
pip install git+https://github.com/karolzak/ipyplot
IPyPlot offers 3 main functions which can be used for displaying images in notebooks:
To start working with
IPyPlot you need to simply import it like this:
and use any of the available plotting functions shown below (notice execution times).
images - should be a sequence of either
string(local or remote image file URLs),
numpy.ndarrayobjects representing images
labels - should be a sequence of
Display a collection of images
images = [ "docs/example1-tabs.jpg", "docs/example2-images.jpg", "docs/example3-classes.jpg", ] ipyplot.plot_images(images, max_images=30, img_width=150)
Display class representations (first image for each unique label)
images = [ "docs/example1-tabs.jpg", "docs/example2-images.jpg", "docs/example3-classes.jpg", ] labels = ['label1', 'label2', 'label3'] ipyplot.plot_class_representations(images, labels, img_width=150)
Display images in separate, interactive tabs for each unique class
images = [ "docs/example1-tabs.jpg", "docs/example2-images.jpg", "docs/example3-classes.jpg", ] labels = ['class1', 'class2', 'class3'] ipyplot.plot_class_tabs(images, labels, max_images_per_tab=10, img_width=150)
To learn more about what you can do with IPyPlot go to gear-images-examples.ipynb notebook for more complex examples.