Module: tff.learning.templates
Stay organized with collections
Save and categorize content based on your preferences.
Libraries of specialized processes used for building learning algorithms.
Classes
class ClientResult
: A structure containing the result of ClientWorkProcess.next
computation.
class ClientWorkProcess
: A stateful process capturing work at clients during learning.
class DistributionProcess
: A stateful process that distributes values.
class FinalizerProcess
: A stateful process for finalization of a round of training.
class LearningAlgorithmState
: A structure representing the state of a learning process.
class LearningProcess
: A stateful process for learning tasks that produces metrics.
class LearningProcessOutput
: A structure containing the output of a LearningProcess.next
computation.
Functions
build_apply_optimizer_finalizer(...)
: Builds finalizer that applies a step of an optimizer.
build_broadcast_process(...)
: Builds DistributionProcess
directly broadcasting values.
build_functional_model_delta_client_work(...)
: Creates a ClientWorkProcess
for federated averaging.
build_model_delta_client_work(...)
: Creates a ClientWorkProcess
for federated averaging.
compose_learning_process(...)
: Composes specialized measured processes into a learning process.
reject_non_finite_update(...)
: Rejects the update if any non-finite value is in the update.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-20 UTC.
[null,null,["Last updated 2024-09-20 UTC."],[],[],null,["# Module: tff.learning.templates\n\n\u003cbr /\u003e\n\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/federated/blob/v0.87.0 Version 2.0, January 2004 Licensed under the Apache License, Version 2.0 (the) |\n\nLibraries of specialized processes used for building learning algorithms.\n\nClasses\n-------\n\n[`class ClientResult`](../../tff/learning/templates/ClientResult): A structure containing the result of [`ClientWorkProcess.next`](../../tff/templates/IterativeProcess#next) computation.\n\n[`class ClientWorkProcess`](../../tff/learning/templates/ClientWorkProcess): A stateful process capturing work at clients during learning.\n\n[`class DistributionProcess`](../../tff/learning/templates/DistributionProcess): A stateful process that distributes values.\n\n[`class FinalizerProcess`](../../tff/learning/templates/FinalizerProcess): A stateful process for finalization of a round of training.\n\n[`class LearningAlgorithmState`](../../tff/learning/templates/LearningAlgorithmState): A structure representing the state of a learning process.\n\n[`class LearningProcess`](../../tff/learning/templates/LearningProcess): A stateful process for learning tasks that produces metrics.\n\n[`class LearningProcessOutput`](../../tff/learning/templates/LearningProcessOutput): A structure containing the output of a [`LearningProcess.next`](../../tff/learning/templates/LearningProcess#next) computation.\n\nFunctions\n---------\n\n[`build_apply_optimizer_finalizer(...)`](../../tff/learning/templates/build_apply_optimizer_finalizer): Builds finalizer that applies a step of an optimizer.\n\n[`build_broadcast_process(...)`](../../tff/learning/templates/build_broadcast_process): Builds `DistributionProcess` directly broadcasting values.\n\n[`build_functional_model_delta_client_work(...)`](../../tff/learning/templates/build_functional_model_delta_client_work): Creates a `ClientWorkProcess` for federated averaging.\n\n[`build_model_delta_client_work(...)`](../../tff/learning/templates/build_model_delta_client_work): Creates a `ClientWorkProcess` for federated averaging.\n\n[`compose_learning_process(...)`](../../tff/learning/templates/compose_learning_process): Composes specialized measured processes into a learning process.\n\n[`reject_non_finite_update(...)`](../../tff/learning/templates/reject_non_finite_update): Rejects the update if any non-finite value is in the update."]]