# tff.program.PeriodicReleaseManager

<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) |

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

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

    tff.program.PeriodicReleaseManager(
        release_manager: ReleaseManager[ReleasableStructure, Key],
        periodicity: Union[int, datetime.timedelta]
    )

A [`tff.program.PeriodicReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/PeriodicReleaseManager) is a utility for releasing values at
regular intervals and is used to release values from platform storage to
customer storage in a federated program.

The interval can be controlled at construction time by setting the
`periodicity`. The `periodicity` can be a positive integer or
`datetime.timedelta`. A `periodicity` of `3` means that every third value is
released to the `release_manager`, and invoking `release` ten times will
release the third, sixth, and ninth values. A `periodicity` of
`datetime.timedelta(hours=3)` means that three hours after the previously
released value the next value is released to the `release_manager`.

> [!NOTE]
> **Note:** that a `periodicity` of one or a very small `datetime.timedelta` will release every value, making the [`tff.program.PeriodicReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/PeriodicReleaseManager) a noop wrapper around the `release_manager`.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `release_manager` | A [`tff.program.ReleaseManager`](https://www.tensorflow.org/federated/api_docs/python/tff/program/ReleaseManager) used to release values to. |
| `periodicity` | The interval to release values. Must be a positive integer or `datetime.timedelta`. |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | If `periodicity` is not a positive integer or `datetime.timedelta`. |

<br />

## Methods

### `release`

[View source](https://github.com/tensorflow/federated/blob/v0.87.0
Version 2.0, January 2004
Licensed under the Apache License, Version 2.0 (the)

    release(
        value, key
    )

Releases `value` from a federated program.

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | A [`tff.program.ReleasableStructure`](https://www.tensorflow.org/federated/api_docs/python/tff/program#ReleasableStructure) to release. |
| `key` | A value used to reference the released `value`. |

<br />