class_docstr: Options used for manipulating TFRecord files.
class_docstr_tok: ["Options","used","for","manipulating","TFRecord","files","."]
docstr: Creates a `TFRecordOptions` instance.
  
  Options only effect TFRecordWriter when compression_type is not `None`.
  Documentation, details, and defaults can be found in
  [`zlib_compression_options.h`](https://www.tensorflow.org/code/tensorflow/core/lib/io/zlib_compression_options.h)
  and in the [zlib manual](http://www.zlib.net/manual.html).
  Leaving an option as `None` allows C++ to set a reasonable default.
  
  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.
  
  Returns:
    A `TFRecordOptions` object.
  
  Raises:
    ValueError: If compression_type is invalid.
docstr_tok: ["Creates","a","`","TFRecordOptions","`","instance",".","Options","only","effect","TFRecordWriter","when","compression_type","is","not","`","None","`",".","Documentation",",","details",",","and","defaults","can","be","found","in","[","`","zlib_compression_options.h","`","]","(","https",":","\/\/www.tensorflow.org\/code\/tensorflow\/core\/lib\/io\/zlib_compression_options.h",")","and","in","the","[","zlib","manual","]","(","http",":","\/\/www.zlib.net\/manual.html",")",".","Leaving","an","option","as","`","None","`","allows","C++","to","set","a","reasonable","default",".","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",".","Returns",":","A","`","TFRecordOptions","`","object",".","Raises",":","ValueError",":","If","compression_type","is","invalid","."]
code: def __init__(
      self,
      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,
  ):
      # pylint: disable=line-too-long
      """Creates a `TFRecordOptions` instance.
  
      Options only effect TFRecordWriter when compression_type is not `None`.
      Documentation, details, and defaults can be found in
      [`zlib_compression_options.h`](https://www.tensorflow.org/code/tensorflow/core/lib/io/zlib_compression_options.h)
      and in the [zlib manual](http://www.zlib.net/manual.html).
      Leaving an option as `None` allows C++ to set a reasonable default.
  
      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.
  
      Returns:
        A `TFRecordOptions` object.
  
      Raises:
        ValueError: If compression_type is invalid.
      """
      # pylint: enable=line-too-long
      # Check compression_type is valid, but for backwards compatibility don't
      # immediately convert to a string.
      self.get_compression_type_string(compression_type)
      self.compression_type = compression_type
      self.flush_mode = flush_mode
      self.input_buffer_size = input_buffer_size
      self.output_buffer_size = output_buffer_size
      self.window_bits = window_bits
      self.compression_level = compression_level
      self.compression_method = compression_method
      self.mem_level = mem_level
      self.compression_strategy = compression_strategy
  
file_path: tensorflow/tensorflow/python/lib/io/tf_record.py
imports: from tensorflow.python.lib.io import _pywrap_record_io
  from tensorflow.python.util import compat
  from tensorflow.python.util import deprecation
  from tensorflow.python.util.tf_export import tf_export
label_desc: Use image node_id 1 to create a new TFRecordOptions object from inherited base classes: object with example: obj = TFRecordOptions(compression_type, flush_mode, input_buffer_size, output_buffer_size, window_bits, compression_level, compression_method, mem_level, compression_strategy)