Data IO (Python Functions)

A TFRecords file represents a sequence of (binary) strings. The format is not random access, so it is suitable for streaming large amounts of data but not suitable if fast sharding or other non-sequential access is desired.

class tf.python_io.TFRecordWriter

A class to write records to a TFRecords file.

This class implements __enter__ and __exit__, and can be used in with blocks like a normal file.


tf.python_io.TFRecordWriter.__init__(path, options=None) {:#TFRecordWriter.init}

Opens file path and creates a TFRecordWriter writing to it.

Args:
  • path: The path to the TFRecords file.
  • options: (optional) A TFRecordOptions object.
Raises:
  • IOError: If path cannot be opened for writing.

tf.python_io.TFRecordWriter.write(record)

Write a string record to the file.

Args:
  • record: str

tf.python_io.TFRecordWriter.close()

Close the file.

Other Methods


tf.python_io.TFRecordWriter.__enter__() {:#TFRecordWriter.enter}

Enter a with block.


tf.python_io.TFRecordWriter.__exit__(unused_type, unused_value, unused_traceback) {:#TFRecordWriter.exit}

Exit a with block, closing the file.


tf.python_io.tf_record_iterator(path, options=None)

An iterator that read the records from a TFRecords file.

Args:
  • path: The path to the TFRecords file.
  • options: (optional) A TFRecordOptions object.
Yields:

Strings.

Raises:
  • IOError: If path cannot be opened for reading.

class tf.python_io.TFRecordCompressionType

The type of compression for the record.


class tf.python_io.TFRecordOptions

Options used for manipulating TFRecord files.


tf.python_io.TFRecordOptions.__init__(compression_type) {:#TFRecordOptions.init}


tf.python_io.TFRecordOptions.get_compression_type_string(cls, options)


TFRecords Format Details

A TFRecords file contains a sequence of strings with CRC hashes. Each record has the format

uint64 length
uint32 masked_crc32_of_length
byte   data[length]
uint32 masked_crc32_of_data

and the records are concatenated together to produce the file. The CRC32s are described here, and the mask of a CRC is

masked_crc = ((crc >> 15) | (crc << 17)) + 0xa282ead8ul