<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/sparsity/keras/pruning_schedule.py#L22-L131) |

Specifies when to prune layer and the sparsity(%) at each training step.

PruningSchedule controls pruning during training by notifying at each step
whether the layer's weights should be pruned or not, and the sparsity(%) at
which they should be pruned.

It can be invoked as a `callable` by providing the training `step` Tensor. It
returns a tuple of bool and float tensors.

      should_prune, sparsity = pruning_schedule(step)

You can inherit this class to write your own custom pruning schedule.

## Methods

### `from_config`

[View source](https://github.com/tensorflow/model-optimization/blob/v0.8.1/tensorflow_model_optimization/python/core/sparsity/keras/pruning_schedule.py#L121-L131)

    @classmethod
    from_config(
        config
    )

Instantiates a `PruningSchedule` from its config.

<br />

<br />

<br />

| Args ||
|---|---|
| `config` | Output of `get_config()`. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A `PruningSchedule` instance. ||

<br />

### `get_config`

[View source](https://github.com/tensorflow/model-optimization/blob/v0.8.1/tensorflow_model_optimization/python/core/sparsity/keras/pruning_schedule.py#L116-L119)

    @abc.abstractmethod
    get_config()

### `__call__`

[View source](https://github.com/tensorflow/model-optimization/blob/v0.8.1/tensorflow_model_optimization/python/core/sparsity/keras/pruning_schedule.py#L101-L114)

    @abc.abstractmethod
    __call__(
        step
    )

Returns the sparsity(%) to be applied.

If the returned sparsity(%) is 0, pruning is ignored for the step.

<br />

<br />

<br />

| Args ||
|---|---|
| `step` | Current step in graph execution. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| Sparsity (%) that should be applied to the weights for the step. ||

<br />