<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/model-optimization/blob/v0.8.1/tensorflow_model_optimization/python/core/clustering/keras/clustering_callbacks.py#L23-L94) |

Helper class to create tensorboard summaries for the clustering progress.

    tfmot.clustering.keras.ClusteringSummaries(
        log_dir='logs', cluster_update_freq='epoch', **kwargs
    )

This class is derived from keras.callbacks.TensorBoard and just adds
functionality to write histograms with batch-wise frequency.

<br />

<br />

<br />

| ## Arguments ||
|---|---|
| `log_dir` | The path to the directory where the log files are saved |
| `cluster_update_freq` | determines the frequency of updates of the clustering histograms. Same behaviour as parameter update_freq of the base class, i.e. it accepts `'batch'`, `'epoch'` or integer. |

<br />

## Methods

### `set_model`

    set_model(
        model
    )

Sets TF-Keras model and writes graph if specified.

### `set_params`

    set_params(
        params
    )