# Module: tff.program

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) 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) |

Libraries for creating federated programs.

## Classes

[`class CSVFileReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/CSVFileReleaseManager): A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) that releases values to a CSV file.

[`class CSVKeyFieldnameNotFoundError`](https://www.tensorflow.org/federated/api_docs/python/tff/program/CSVKeyFieldnameNotFoundError): Raised when a file does not contain the key fieldname.

[`class CSVSaveMode`](https://www.tensorflow.org/federated/api_docs/python/tff/program/CSVSaveMode): An enumeration.

[`class ClientIdDataSource`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ClientIdDataSource): A [`tff.program.FederatedDataSource`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FederatedDataSource) backed by client ids.

[`class ClientIdDataSourceIterator`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ClientIdDataSourceIterator): A [`tff.program.FederatedDataSourceIterator`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FederatedDataSourceIterator) backed by client ids.

[`class DatasetDataSource`](https://www.tensorflow.org/federated/api_docs/python/tff/program/DatasetDataSource): A [`tff.program.FederatedDataSource`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FederatedDataSource) backed by [`tf.data.Dataset`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset)s.

[`class DatasetDataSourceIterator`](https://www.tensorflow.org/federated/api_docs/python/tff/program/DatasetDataSourceIterator): A [`tff.program.FederatedDataSourceIterator`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FederatedDataSourceIterator) backed by [`tf.data.Dataset`](https://www.tensorflow.org/api_docs/python/tf/data/Dataset)s.

[`class DelayedReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/DelayedReleaseManager): A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) that releases values after specified delay.

[`class FederatedContext`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FederatedContext): An abstract interface representing a federated context.

[`class FederatedDataSource`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FederatedDataSource): An abstract interface for representing federated data sources.

[`class FederatedDataSourceIterator`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FederatedDataSourceIterator): An abstract interface for representing federated data source iterators.

[`class FileProgramStateManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FileProgramStateManager): A [`tff.program.ProgramStateManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ProgramStateManager) that is backed by a file system.

[`class FilteringReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FilteringReleaseManager): A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) that filters values before releasing them.

[`class GroupingReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/GroupingReleaseManager): A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) that releases values to other release managers.

[`class LoggingReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/LoggingReleaseManager): A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) that releases values to logs.

[`class MaterializableValueReference`](https://www.tensorflow.org/federated/api_docs/python/tff/program/MaterializableValueReference): An abstract interface representing references to server-placed values.

[`class MemoryReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/MemoryReleaseManager): A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) that releases values to memory.

[`class NativeFederatedContext`](https://www.tensorflow.org/federated/api_docs/python/tff/program/NativeFederatedContext): A [`tff.program.FederatedContext`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FederatedContext) backed by an execution context.

[`class NativeValueReference`](https://www.tensorflow.org/federated/api_docs/python/tff/program/NativeValueReference): A [`tff.program.MaterializableValueReference`](https://www.tensorflow.org/federated/api_docs/python/tff/program/MaterializableValueReference) backed by a task.

[`class NotFilterableError`](https://www.tensorflow.org/federated/api_docs/python/tff/program/NotFilterableError): Raised when the structure cannot be filtered.

[`class PeriodicReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/PeriodicReleaseManager): A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) that releases values at regular intervals.

[`class ProgramStateExistsError`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ProgramStateExistsError): Raised when the program state already exists.

[`class ProgramStateManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ProgramStateManager): An interface for saving and loading program state in a federated program.

[`class ProgramStateNotFoundError`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ProgramStateNotFoundError): Raised when the program state cannot be found.

[`class ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager): An interface for releasing values from a federated program.

[`class SavedModelFileReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/SavedModelFileReleaseManager): A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) that releases values to a file system.

[`class TensorBoardReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/TensorBoardReleaseManager): A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) that releases values to TensorBoard.

## Functions

[`check_in_federated_context(...)`](https://www.tensorflow.org/federated/api_docs/python/tff/program/check_in_federated_context): Checks if the current context is a [`tff.program.FederatedContext`](https://www.tensorflow.org/federated/api_docs/python/tff/program/FederatedContext).

[`contains_only_server_placed_data(...)`](https://www.tensorflow.org/federated/api_docs/python/tff/program/contains_only_server_placed_data): Determines if `type_signature` contains only server-placed data.

[`materialize_value(...)`](https://www.tensorflow.org/federated/api_docs/python/tff/program/materialize_value): Materializes the [`tff.program.MaterializableValueReference`](https://www.tensorflow.org/federated/api_docs/python/tff/program/MaterializableValueReference)s in `value`.

## Type Aliases

[`MaterializableStructure`](https://www.tensorflow.org/federated/api_docs/python/tff/program/MaterializableStructure)

[`MaterializableTypeSignature`](https://www.tensorflow.org/federated/api_docs/python/tff/program/MaterializableTypeSignature)

[`MaterializableValue`](https://www.tensorflow.org/federated/api_docs/python/tff/program/MaterializableValue)

[`MaterializedStructure`](https://www.tensorflow.org/federated/api_docs/python/tff/program/MaterializedStructure)

[`MaterializedValue`](https://www.tensorflow.org/federated/api_docs/python/tff/program/MaterializedValue)

[`ProgramStateValue`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ProgramStateValue)

[`ReleasableValue`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleasableValue)

<br />

<br />

<br />

| ## Other Members ||
|---|---|
| ProgramStateStructure | Instance of `typing.TypeVar` |
| ReleasableStructure | Instance of `typing.TypeVar` |

<br />