batch_display

BatchDisplay

Bases: Trace

A Trace to display a batch of images.

Parameters:

Name	Type	Description	Default
image	Optional[str]	Key corresponding to a batch of images to be displayed.	None
text	Optional[str]	Key corresponding to text to be printed in the center of the figure.	None
masks	Union[None, str, Tuple[str, Sequence[str]]]	Key corresponding to masks to be displayed over an image. May be accompanied by a sequence of mask labels (1 per channel) if desired: (, [, , ...])	None
bboxes	Optional[str]	Key corresponding to bounding boxes to be displayed over the image.	None
keypoints	Union[None, str, Tuple[str, Sequence[str]]]	Key corresponding to keypoints to be displayed over the image. May be accompanied by a sequence of keypoint labels (1 per keypoint) if desired: (, [, , ...])	None
mask_threshold	Optional[float]	If provided, any masks will be binarized based on the given threshold value (1 if > t, else 0).	None
color_map	Union[str, Tuple[str, str]]	How to color 1-channel images. Options from: https://plotly.com/python/builtin-colorscales/. If 2 strings are provided, the first will be used to color grey-scale images and the second will be used to color continuous (non-thresholded) masks. If a single string is provided it will be used for both image and masks.	('gray', 'turbo')
title	Optional[str]	The title of the generated figure. If None it defaults to any image/text/mask/bbox/keypoint key which was provided (in that order).	None
batch_limit	Optional[int]	A limit on the number of batch elements to display.	None
frequency	Union[None, int, str]	'batch', 'epoch', integer, or strings like '10s', '15e'. When using 'batch', writes the losses and metrics to TensorBoard after each batch. The same applies for 'epoch'. If using an integer, let's say 1000, the callback will write the metrics and losses to TensorBoard every 1000 samples. You can also use strings like '8s' to indicate every 8 steps or '5e' to indicate every 5 epochs. You can use None to default to matching the log printing frequency.	None
save_dir	Optional[str]	A directory into which to save images rather than displaying them. The file names will be formatted as