tf.io.TFRecordOptions

Options used for manipulating TFRecord files.

tf.io.TFRecordOptions(
    compression_type=None,
    flush_mode=None,
    input_buffer_size=None,
    output_buffer_size=None,
    window_bits=None,
    compression_level=None,
    compression_method=None,
    mem_level=None,
    compression_strategy=None
)

compression_type"GZIP", "ZLIB", or "" (no compression).
flush_modeflush mode or None, Default: Z_NO_FLUSH.
input_buffer_sizeint or None.
output_buffer_sizeint or None.
window_bitsint or None.
compression_level0 to 9, or None.
compression_methodcompression method or None.
mem_level1 to 9, or None.
compression_strategystrategy or None. Default: Z_DEFAULT_STRATEGY.

ValueErrorIf compression_type is invalid.

Methods

get_compression_type_string

View source

@classmethod
get_compression_type_string(
    options
)

Convert various option types to a unified string.

Args
optionsTFRecordOption, TFRecordCompressionType, or string.

Returns
Compression type as string (e.g. 'ZLIB', 'GZIP', or '').

Raises
ValueErrorIf compression_type is invalid.

compression_type_map

{
 0: '',
 1: 'ZLIB',
 2: 'GZIP'
}