Module: tff.program

Libraries for creating federated programs.

Classes

class AwaitableValueReference: A tff.program.MaterializableValueReference backed by a coroutine function.

class CSVFileReleaseManager: A tff.program.ReleaseManager that releases values to a CSV file.

class CSVKeyFieldnameNotFoundError: Raised when a file does not contain the key fieldname.

class CSVSaveMode: An enumeration.

class ClientIdDataSource: A tff.program.FederatedDataSource backed by client ids.

class ClientIdDataSourceIterator: A tff.program.FederatedDataSourceIterator backed by client ids.

class DatasetDataSource: A tff.program.FederatedDataSource backed by tf.data.Datasets.

class DatasetDataSourceIterator: A tff.program.FederatedDataSourceIterator backed by tf.data.Datasets.

class DelayedReleaseManager: A tff.program.ReleaseManager that releases values after specified delay.

class FederatedContext: An abstract interface representing a federated context.

class FederatedDataSource: An abstract interface for representing federated data sources.

class FederatedDataSourceIterator: An abstract interface for representing federated data source iterators.

class FileProgramStateManager: A tff.program.ProgramStateManager that is backed by a file system.

class FilteringReleaseManager: A tff.program.ReleaseManager that filters values before releasing them.

class GroupingReleaseManager: A tff.program.ReleaseManager that releases values to other release managers.

class LoggingReleaseManager: A tff.program.ReleaseManager that releases values to logs.

class MaterializableValueReference: An abstract interface representing references to server-placed values.

class MemoryReleaseManager: A tff.program.ReleaseManager that releases values to memory.

class NativeFederatedContext: A tff.program.FederatedContext backed by an execution context.

class NotFilterableError: Raised when the structure cannot be filtered.

class PeriodicReleaseManager: A tff.program.ReleaseManager that releases values at regular intervals.

class ProgramStateExistsError: Raised when the program state already exists.

class ProgramStateManager: An interface for saving and loading program state in a federated program.

class ProgramStateNotFoundError: Raised when the program state cannot be found.

class ReleaseManager: An interface for releasing values from a federated program.

class SavedModelFileReleaseManager: A tff.program.ReleaseManager that releases values to a file system.

class TensorBoardReleaseManager: A tff.program.ReleaseManager that releases values to TensorBoard.

Functions

check_in_federated_context(...): Checks if the current context is a tff.program.FederatedContext.

contains_only_server_placed_data(...): Determines if type_signature contains only server-placed data.

materialize_value(...): Materializes the tff.program.MaterializableValueReferences in value.

Type Aliases

MaterializableStructure

MaterializableTypeSignature

MaterializableValue

MaterializedStructure

MaterializedValue

ProgramStateValue

ReleasableValue

ProgramStateStructure Instance of typing.TypeVar
ReleasableStructure Instance of typing.TypeVar