# orbit.actions.JSONPersistedValue

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/models/blob/v2.20.0/orbit/actions/new_best_metric.py#L167-L222) |

Represents a value that is persisted via a file-based backing store.

    orbit.actions.JSONPersistedValue(
        initial_value: Any, filename: str, write_value: bool = True
    )

The value must be JSON-serializable. Each time the value is updated, it will
be written to the backing file. It is only read from the file at
initialization.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `initial_value` | The initial value to use if no backing file exists or was given. This must be a JSON-serializable value (possibly nested combination of lists, dicts, and primitive values). |
| `filename` | The path to use for persistent storage of the value. This may be `None`, in which case the value is not stable across preemptions. |
| `write_value` | If `True`, new values will be written to `filename` on calls to `write()`. If `False`, `filename` is only read once to restore any persisted value, and new values will not be written to it. This can be useful in certain multi-client settings to avoid race conditions or excessive file writes. If `filename` is `None`, this parameter has no effect. |

<br />

## Methods

### `read`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/orbit/actions/new_best_metric.py#L209-L211)

    read()

Returns the value.

### `write`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/orbit/actions/new_best_metric.py#L213-L222)

    write(
        value
    )

Writes the value, updating the backing store if one was provided.