tff.program.ReleaseManager
Stay organized with collections
Save and categorize content based on your preferences.
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
release(
value, key
)
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, ReleasableValue]
and a key
type of int
.
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,["# tff.program.ReleaseManager\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\nAn interface for releasing values from a federated program.\n\nA [`tff.program.ReleaseManager`](../../tff/program/ReleaseManager) is used to release values from platform storage\nto customer storage in a federated program.\n\nMethods\n-------\n\n### `release`\n\n[View source](https://github.com/tensorflow/federated/blob/v0.87.0\nVersion 2.0, January 2004\nLicensed under the Apache License, Version 2.0 (the) \n\n release(\n value, key\n )\n\nReleases `value` from a federated program.\n\nAn implementation of this interface should be specific about the types of\n`value` and `key` for this method and should document how the `key` will be\nused. This allows a federated program to understand how to create a `key`\nfor the `value` before it is released. For example, a\n[`tff.program.ReleaseManager`](../../tff/program/ReleaseManager) that releases metrics keyed by a strictly\nincreasing integer might specify a `value` type of\n`Mapping[str, ReleasableValue]` and a `key` type of `int`.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ||\n|---------|------------------------------------------------------------------------------------------|\n| `value` | A [`tff.program.ReleasableStructure`](../../tff/program#ReleasableStructure) to release. |\n| `key` | A value used to reference the released `value`. |\n\n\u003cbr /\u003e"]]