- class docarray.document.mixins.plot.PlotMixin#
Provide helper functions for
Documentto plot and visualize itself.
Print non-empty fields and nested structure of this Document object.
- Return type
- plot_matches_sprites(top_k=10, channel_axis=- 1, inv_normalize=False, skip_empty=False, canvas_size=1920, min_size=100, output=None)#
Generate a sprite image for the query and its matching images in this Document object.
An image sprite is a collection of images put into a single image. Query image is on the left followed by matching images. The Document object should contain matches.
int) – the number of top matching documents to show in the sprite.
int) – the axis id of the color channel,
-1indicates the color channel info at the last axis
bool) – skip matches which has no .uri or .tensor.
int) – the width of the canvas
int) – the minimum size of the image
str]) – Optional path to store the visualization. If not given, show in UI