xref: /aosp_15_r20/external/federated-compute/fcp/demo/federated_computation.py (revision 14675a029014e728ec732f129a32e299b2da0601)

# Copyright 2022 Google LLC
#
# 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 expresus or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""tff.Computation subclass for the demo Federated Computation platform."""

import functools
import re

import tensorflow_federated as tff

COMPUTATION_NAME_REGEX = re.compile(r'\w+(/\w+)*')


class FederatedComputation(tff.Computation):
  """A tff.Computation that should be run in a tff.program.FederatedContext."""

  def __init__(self, comp: tff.Computation, *, name: str):
    """Constructs a new FederatedComputation object.

    Args:
      comp: The MapReduceForm- and DistributeAggregateForm- compatible
        computation that will be run.
      name: A unique name for the computation.
    """
    tff.backends.mapreduce.check_computation_compatible_with_map_reduce_form(
        comp
    )  # pytype: disable=wrong-arg-types
    if not COMPUTATION_NAME_REGEX.fullmatch(name):
      raise ValueError(f'name must match "{COMPUTATION_NAME_REGEX.pattern}".')
    self._comp = comp
    self._name = name

  @functools.cached_property
  def map_reduce_form(self) -> tff.backends.mapreduce.MapReduceForm:
    """The underlying MapReduceForm representation."""
    return tff.backends.mapreduce.get_map_reduce_form_for_computation(  # pytype: disable=wrong-arg-types
        self._comp
    )

  @functools.cached_property
  def distribute_aggregate_form(
      self,
  ) -> tff.backends.mapreduce.DistributeAggregateForm:
    """The underlying DistributeAggregateForm representation."""
    return tff.backends.mapreduce.get_distribute_aggregate_form_for_computation(  # pytype: disable=wrong-arg-types
        self._comp
    )

  @property
  def wrapped_computation(self) -> tff.Computation:
    """The underlying tff.Computation."""
    return self._comp

  @property
  def name(self) -> str:
    """The name of the computation."""
    return self._name

  @property
  def type_signature(self) -> tff.Type:
    return self._comp.type_signature

  def __call__(self, *args, **kwargs) ->...:
    arg = tff.structure.Struct([(None, arg) for arg in args] +
                               list(kwargs.items()))
    return tff.framework.get_context_stack().current.invoke(self, arg)

  def __hash__(self) -> int:
    return hash((self._comp, self._name))