A tff.program.TensorBoardReleaseManager is a utility for releasing values
from a federated program to TensorBoard and is used to release values from
platform storage to customer storage in a federated program.
Values are released as summary data using tf.summary. When the value is
released, if the value is a value reference or a structure containing value
references, each value reference is materialized. The value is then flattened
and released as summary data. The structure of the value is used as the name
of the summary data. Scalar values are released using tf.summary.scalar and
non-scalar values are released using tf.summary.histogram.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-20 UTC."],[],[],null,["# tff.program.TensorBoardReleaseManager\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\nA [`tff.program.ReleaseManager`](../../tff/program/ReleaseManager) that releases values to TensorBoard.\n\nInherits From: [`ReleaseManager`](../../tff/program/ReleaseManager) \n\n tff.program.TensorBoardReleaseManager(\n summary_dir: Union[str, os.PathLike[str]]\n )\n\nA [`tff.program.TensorBoardReleaseManager`](../../tff/program/TensorBoardReleaseManager) is a utility for releasing values\nfrom a federated program to TensorBoard and is used to release values from\nplatform storage to customer storage in a federated program.\n\nValues are released as summary data using [`tf.summary`](https://www.tensorflow.org/api_docs/python/tf/summary). When the value is\nreleased, if the value is a value reference or a structure containing value\nreferences, each value reference is materialized. The value is then flattened\nand released as summary data. The structure of the value is used as the name\nof the summary data. Scalar values are released using [`tf.summary.scalar`](https://www.tensorflow.org/api_docs/python/tf/summary/scalar) and\nnon-scalar values are released using [`tf.summary.histogram`](https://www.tensorflow.org/api_docs/python/tf/summary/histogram).\n| **Warning:** The summary data can only contain booleans, integers, unsigned integers, and floats, releasing any other values will be silently ignored.\n\nSee \u003chttps://www.tensorflow.org/api_docs/python/tf/summary\u003e for more information\nabout summary data and how to visualize summary data using TensorBoard.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|---------------|---------------------------------------------------------------------------------------------------|\n| `summary_dir` | A path on the file system to save release values. If this path does not exist it will be created. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|--------------------------------------|\n| `ValueError` | If `summary_dir` is an empty string. |\n\n\u003cbr /\u003e\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: ../../tff/program#ReleasableStructure,\n key\n ) -\u003e value_reference.MaterializedValue\n\nReleases `value` from a federated program.\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 integer used to reference the released `value`; `key` represents a step in a federated program. |\n\n\u003cbr /\u003e"]]
View source on GitHub