# tf.io.TFRecordOptions

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.13.1/tensorflow/python/lib/io/tf_record.py#L35-L145) |

Options used for manipulating TFRecord files.

#### View aliases


**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.io.TFRecordOptions`](https://www.tensorflow.org/api_docs/python/tf/io/TFRecordOptions), [`tf.compat.v1.python_io.TFRecordOptions`](https://www.tensorflow.org/api_docs/python/tf/io/TFRecordOptions)

<br />

    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
    )

<br />

<br />

<br />

| ## Args ||
|---|---|
| `compression_type` | `"GZIP"`, `"ZLIB"`, or `""` (no compression). |
| `flush_mode` | flush mode or `None`, Default: Z_NO_FLUSH. |
| `input_buffer_size` | int or `None`. |
| `output_buffer_size` | int or `None`. |
| `window_bits` | int or `None`. |
| `compression_level` | 0 to 9, or `None`. |
| `compression_method` | compression method or `None`. |
| `mem_level` | 1 to 9, or `None`. |
| `compression_strategy` | strategy or `None`. Default: Z_DEFAULT_STRATEGY. |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | If compression_type is invalid. |

<br />

## Methods

### `get_compression_type_string`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.13.1/tensorflow/python/lib/io/tf_record.py#L97-L121)

    @classmethod
    get_compression_type_string(
        options
    )

Convert various option types to a unified string.

<br />

<br />

<br />

| Args ||
|---|---|
| `options` | `TFRecordOption`, `TFRecordCompressionType`, or string. |

<br />

<br />

<br />

<br />

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

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If compression_type is invalid. |

<br />

<br />

<br />

<br />

| ## Class Variables ||
|---|---|
| compression_type_map | <br /> { 0: '', 1: 'ZLIB', 2: 'GZIP' } <br /> |

<br />