grid_display
GridDisplay
¶
Bases: Trace
A Trace to display of grid of images.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
columns |
Sequence[BatchDisplay]
|
A list of BatchDisplay traces to be combined into a grid. Their batch_limit, frequency, save_dir, mode, and ds_id arguments will be ignored in favor of the ones provided to the GridDisplay. |
required |
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 |
None
|
title |
str
|
The title prefix to use if save_dir is specified. |
'grid'
|
mode |
Union[None, str, Iterable[str]]
|
What mode(s) to execute this Trace in. For example, "train", "eval", "test", or "infer". To execute regardless of mode, pass None. To execute in all modes except for a particular one, you can pass an argument like "!infer" or "!train". |
None
|
ds_id |
Union[None, str, Iterable[str]]
|
What dataset id(s) to execute this Trace in. To execute regardless of ds_id, pass None. To execute in all ds_ids except for a particular one, you can pass an argument like "!ds1". |
None
|