tfx_bsl.public.tfxio.RecordBatchesOptions

Options for TFXIO's RecordBatches.

tfx_bsl.public.tfxio.RecordBatchesOptions(
    batch_size: int,
    drop_final_batch: bool = False,
    num_epochs: Optional[int] = None,
    shuffle: bool = True,
    shuffle_buffer_size: int = 10000,
    shuffle_seed: Optional[int] = None
)

Args
`batch_size`	An int representing the number of records to combine in a single batch.
`drop_final_batch`	If `True`, and the batch size does not evenly divide the input dataset size, the final smaller batch will be dropped. Defaults to `False`.
`num_epochs`	Integer specifying the number of times to read through the dataset. If None, cycles through the dataset forever. Defaults to `None`.
`shuffle`	A boolean, indicates whether the input should be shuffled. Defaults to `True`.
`shuffle_buffer_size`	Buffer size of the items to shuffle. The size is the number of items (i.e. records for a record based TFXIO) to hold. Only data read into the buffer will be shuffled (there is no shuffling across buffers). A large capacity ensures better shuffling but would increase memory usage and startup time.
`shuffle_seed`	Randomization seed to use for shuffling.

Attributes
`batch_size`	A `namedtuple` alias for field number 0
`drop_final_batch`	A `namedtuple` alias for field number 1
`num_epochs`	A `namedtuple` alias for field number 2
`shuffle`	A `namedtuple` alias for field number 3
`shuffle_buffer_size`	A `namedtuple` alias for field number 4
`shuffle_seed`	A `namedtuple` alias for field number 5

tfx_bsl.public.tfxio.RecordBatchesOptions

Args

Attributes