tff.program.ReleaseManager

An interface for releasing values from a federated program.

A tff.program.ReleaseManager is used to release values from platform storage to customer storage in a federated program.

Methods

release

View source

Releases value from a federated program.

An implementation of this interface should be specific about the types of value and key for this method and should document how the key will be used. This allows a federated program to understand how to create a key for the value before it is released. For example, a tff.program.ReleaseManager that releases metrics keyed by a strictly increasing integer might specify a value type of Mapping[str, Any] and a key type of int.

Args
value A materialized value, a value reference, or a structure of materialized values and value references representing the value to release. The exact structure of value is left up to the implementation of tff.program.ReleaseManager.
type_signature The tff.Type of value.
key An optional value used to reference the released value, the exact type and structure of key and how key is used is left up to the implementation of tff.program.ReleaseManager.