Visualizing PyTorch tensors with a single line of code.
Project description
Torchshow visualizes your data in one line of code. It is designed to help debugging Computer Vision project.
Torchshow automatically infers the type of a tensor such as RGB images, grayscale images, binary masks, categorical masks (automatically apply color palette), etc. and perform necessary unnormalization if needed.
Supported Type:
- RGB Images
- Grayscale Images
- Binary Mask
- Categorical Mask (Integer Labels)
- Multiple Images
- Videos
- Multiple Videos
- Optical Flows (powered by flow_vis)
What's New in v0.4.2
- You can specify the
figsize
,dpi
, andsubtitle
parameter when calling ts.show(). - Add some missing APIs to
ts.save()
. - Revisit the option to add axes titles with placeholders (for usage check the API reference).
- Add tight_layout option to
ts.show_video
(enabled by default).
See the complete changelogs.
Installation
pip install torchshow
Basic Usage
The usage of TorchShow is extremely simple. Simply import the package and visualize your data in one line:
import torchshow as ts
ts.show(tensor)
If you work on a headless server without display. You can use ts.save(tensor)
command (since version 0.3.2).
import torchshow as ts
ts.save(tensor) # Figure will be saved under ./_torchshow/***.png
ts.save(tensor, './vis/test.jpg') # You can specify the save path.
API References
Please check this page for detailed API references.
Examples
Table of Contents
- Visualizing Image Tensor
- Visualizing Mask Tensors
- Visualizing Batch of Tensors
- Visualizing Channels in Feature Maps
- Visualizing Multiple Tensors with Custom Layout.
- Examine the pixel with rich information.
- Visualizing Tensors as Video Clip
- Display Video Animation in Jupyter Notebook
- Visualizing Optical Flows
- Change Channel Order (RGB/BGR)
- Change Unnormalization Presets
1. Visualizing Image Tensor
Visualizing an image-like tensor is not difficult but could be very cumbersome. You usually need to convert the tensor to numpy array with proper shapes. In many cases images were normalized during dataloader, which means that you have to unnormalize it so it can be displayed correctly.
If you need to frequently verify what your tensors look like, TorchShow is a very helpful tool.
Using Matplotlib | Using TorchShow |
---|---|
The image tensor has been normalized so Matlotlib cannot display it correctly. | TorchShow does the conversion automatically. |
2. Visualizing Mask Tensors
For projects related to Semantic Segmentation or Instance Segmentation, we often need to visualize mask tensors -- either ground truth annotations or model's prediction. This can be easily done using TorchShow.
Using Matplotlib | Using TorchShow |
---|---|
Different instances have same colors. Some categories are missing. | TorchShow automatically apply color palletes during visualization. |
3. Visualizing Batch of Tensors
When the tensor is a batch of images, TorchShow will automatically create grid layout to visualize them. It is also possible to manually control the number of rows and columns.
4. Visualizing Feature Maps
If the input tensor has more than 3 channels, TorchShow will visualize each of the channel similar to batch visualization. This is useful to visualize a feature map.
5. Visualizing Multiple Tensors with Custom Layout.
TorchShow has more flexibility to visualize multiple tensor using a custom layout.
To control the layout, put the tensors in list of list as an 2D array. The following example will create a 2 x 3 grid layout.
ts.show([[tensor1, tensor2, tensor3],
[tensor4, tensor5, tensor6]])
It is worth mentioning that there is no need to fill up all the places in the grid. The following example visualizes 5 tensors in a 2 x 3 grid layout.
ts.show([[tensor1, tensor2],
[tensor3, tensor4, tensor5]])
6. Examine the pixel with richer information.
Since v0.4.1
, TorchShow allows you to get richer information from a pixel you are interested by simply hovering your mouse over that pixel. This is very helpful for some types of tensors such as Categorical Mask and Optical Flows.
Currently, Torchshow displays the following information:
Mode
: Visualization Mode.Shape
: Shape of the tensor.X
,Y
: The pixel location of the mouse cursor.Raw
: The raw tensor value at (X, Y).Disp
: The display value at (X, Y).
Note: if the information is not showing on the status bar, try to resize the window and make it wider.
This feature can be turned off by ts.show_rich_info(False)
.
7. Visualizing Tensors as Video Clip
Tensors can be visualized as video clips, which very helpful if the tensor is a sequence of frames. This can be done using show_video
function.
ts.show_video(video_tensor)
It is also possible to visualize multiple videos in a custom grid layout.
8. Display Video Animation in Jupyter Notebook
TorchShow visualizes video clips as an matplotlib.func_animation
object and may not display in a notebook by default. The following example shows a simple trick to display it.
import torchshow as ts
from IPython.display import HTML
ani = ts.show_video(video_tensor)
HTML(ani.to_jshtml())
9. Visualizing Optical Flows
TorchShow support visualizing optical flow (powered by flow_vis). Below is a demostration using a VSCode debugger remotely attached to a SSH server (with X-server configured). Running in a Jupyter Notebook is also supported.
10. Change Channel Order (RGB/BGR)
By default tensorflow visualize image tensor in the RGB mode, you can switch the setting to BGR in case you are using opencv to load the image.
ts.set_color_mode('bgr')
11. Change Unnormalization Presets
The image tensor may have been preprocessed with a normalization function. If not specified, torchshow will automatically rescale it to 0-1.
To change the preset to imagenet normalization. Use the following code.
ts.show(tensor, unnormalize='imagenet')
To use a customize mean and std value, use the following command.
ts.set_image_mean([0., 0., 0.])
ts.set_image_std([1., 1., 1.])
Note that once this is set, torchshow will use this value for the following visualization. This is useful because usually only a single normalization preset will be used for the entire project.
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
Hashes for torchshow-0.4.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 390b1cbeaff31e5ea516e2d0979c353ace7a364a52b60e48c747c56c8371188c |
|
MD5 | 9cb083a6e8e2048849ad5cc5d6970079 |
|
BLAKE2b-256 | 691611b93628da60fcac859ade30d8509943c6de3fc4b3c9d2f4ce25f6c49353 |