Skip to content

python_io.md

Latest commit

 

History

History
117 lines (52 loc) · 2.11 KB

python_io.md

File metadata and controls

117 lines (52 loc) · 2.11 KB

Data IO (Python functions)

[TOC]

Python functions for directly manipulating TFRecord-formatted files.

See the @{$python/python_io} guide.

class tf.python_io.TFRecordWriter {#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.__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.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.close() {#TFRecordWriter.close}

Close the file.

tf.python_io.TFRecordWriter.write(record) {#TFRecordWriter.write}

Write a string record to the file.

Args:
  • record: str

tf.python_io.tf_record_iterator(path, options=None) {#tf_record_iterator}

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 {#TFRecordCompressionType}

The type of compression for the record.

class tf.python_io.TFRecordOptions {#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) {#TFRecordOptions.get_compression_type_string}