official/vision/dataloaders/decoder.py

# Copyright 2023 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""The generic decoder interface."""

import abc


class Decoder(metaclass=abc.ABCMeta):
  """Decodes the raw data into tensors."""

  @abc.abstractmethod
  def decode(self, serialized_example):
    """Decodes the serialized example into tensors.

    Args:
      serialized_example: a serialized string tensor that encodes the data.

    Returns:
      decoded_tensors: a dict of Tensors.
    """
    pass