karolzak / Ipyplot

Share:

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.

Features:

• [x] Easy, fast and efficient plotting of images in python within notebooks
• [x] Plotting functions (see examples section to learn more):
  • [x] plot_images - simply plots all the images in a grid-like layout
  • [x] plot_class_representations - similar to plot_images but displays only the first image for each label/class (based on provided labels collection)
  • [x] plot_class_tabs - plots images in a grid-like manner in a separate tab for each label/class based on provided labels
• [x] Supported image formats:
  • [x] Sequence of local storage URLs, e.g. [your/dir/img1.jpg]
  • [x] Sequence of remote URLs, e.g. [http://yourimages.com/img1.jpg]
  • [x] Sequence of PIL.Image objects
  • [x] Sequence of images as numpy.ndarray objects
  • [x] Supported sequence types: list, numpy.ndarray, pandas.Series
• [x] Misc features:
  • [x] custom_texts param to display additional texts like confidence score or some other information for each image
  • [x] force_b64 flag to force conversion of images from URLs to base64 format
  • [x] click on image to enlarge
  • [x] control number of displayed images and their width through max_images and img_width params
  • [x] "show html" button which reveals the HTML code used to generate plots
  • [x] option to set specific order of labels/tabs, filter them or ignore some of the labels
• [x] Supported notebook platforms:
  • [x] Jupyter
  • [x] Google Colab
  • [x] Azure Notebooks
  • [x] Kaggle Notebooks

Getting Started

To start using IPyPlot, see examples below or go to gear-images-examples.ipynb notebook which takes you through most of the scenarios and options possible with IPyPlot.

Installation

IPyPlot can be installed through PyPI:

pip install ipyplot

or directly from this repo using pip:

pip install git+https://github.com/karolzak/ipyplot

Usage examples

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:

import ipyplot

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), PIL.Image objects or numpy.ndarray objects representing images
• labels - should be a sequence of string or int

Display a collection of images

Display class representations (first image for each unique label)

Display images in separate, interactive tabs for each unique class

To learn more about what you can do with IPyPlot go to gear-images-examples.ipynb notebook for more complex examples.