xref: /aosp_15_r20/external/federated-compute/fcp/tensorflow/crc32.py (revision 14675a029014e728ec732f129a32e299b2da0601)
1# Copyright 2022 Google LLC
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#      http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14"""Provides the `crc32` operation.
15
16This wraps the generated op and ensures that necessary shared libraries
17are loaded.
18"""
19
20from typing import Optional
21
22import tensorflow as tf
23
24from fcp.tensorflow import gen_crc32_py
25
26_crc32_so = tf.load_op_library(
27    tf.compat.v1.resource_loader.get_path_to_datafile('./_crc32_op.so'))
28
29
30def crc32(tensor: tf.Tensor, name: Optional[str] = None) -> tf.Operation:
31  """Computes the CRC32 checksum of a Tensor.
32
33  Args:
34    tensor: The input `Tensor`.
35    name: A name for the operation (optional).
36
37  Returns:
38    The created `Operation`.
39  """
40  return gen_crc32_py.crc32(tensor, name=name)
41