tfp.optimizer.VariationalSGD

An optimizer module for constant stochastic gradient descent.

tfp.optimizer.VariationalSGD(
    batch_size,
    total_num_examples,
    max_learning_rate=1.0,
    preconditioner_decay_rate=0.95,
    burnin=25,
    burnin_max_learning_rate=1e-06,
    use_single_learning_rate=False,
    name=None
)

This implements an optimizer module for the constant stochastic gradient descent algorithm [(Mandt et al., 2017)][1]. The optimization variable is regarded as an approximate sample from the posterior .

Note: If a prior is included in the loss, it should be scaled by 1/num_pseudo_batches, where num_pseudo_batches is the number of minibatches in the data. I.e., it should be divided by the num_pseudo_batches term described below.

Args
batch_size	Scalar int-like Tensor. The number of examples in a minibatch in the data set. Note: Assumes the loss is taken as the mean over a minibatch. Otherwise if the sum was taken set this to 1.
total_num_examples	Scalar int-like Tensor. The total number of examples in the data set.
max_learning_rate	Scalar float-like Tensor. A maximum allowable effective coordinate-wise learning rate. The algorithm scales down any effective learning rate (i.e. after preconditioning) that is larger than this. (Default: 1)
preconditioner_decay_rate	Scalar float-like Tensor. The exponential decay rate of the rescaling of the preconditioner (RMSprop). (This is "alpha" in Mandt et al. (2017)). Should be smaller than but nearly 1 to approximate sampling from the posterior. (Default: 0.95)
burnin	Scalar int-like Tensor. The number of iterations to collect gradient statistics to update the preconditioner before starting to draw noisy samples. (Default: 25)
burnin_max_learning_rate	Scalar float-like Tensor. Maximum learning rate to use during the burnin period. (Default: 1e-8)
use_single_learning_rate	Boolean Indicates whether one single learning rate is used or coordinate_wise learning rates are used. (Default: False)
name	Python str describing ops managed by this function. (Default: "VariationalSGD")

Raises
InvalidArgumentError	If preconditioner_decay_rate is a Tensor not in (0,1].

References

[1]: Stephan Mandt, Matthew D. Hoffman, and David M. Blei. Stochastic Gradient Descent as Approximate Bayesian Inference. arXiv preprint arXiv:1704.04289, 2017. https://arxiv.org/abs/1704.04289

Attributes
clipnorm	float or None. If set, clips gradients to a maximum norm.
clipvalue	float or None. If set, clips gradients to a maximum value.
global_clipnorm	float or None. If set, clips gradients to a maximum norm. Check tf.clip_by_global_norm for more details.
iterations	Variable. The number of training steps this Optimizer has run.
weights	Returns variables of this Optimizer based on the order created.

Methods

add_slot

add_slot(
    var, slot_name, initializer='zeros', shape=None
)

Add a new slot variable for var.

A slot variable is an additional variable associated with var to train. It is allocated and managed by optimizers, e.g. Adam.

Args
var	a Variable object.
slot_name	name of the slot variable.
initializer	initializer of the slot variable
shape	(Optional) shape of the slot variable. If not set, it will default to the shape of var.

Returns
A slot variable.

add_weight

add_weight(
    name,
    shape,
    dtype=None,
    initializer='zeros',
    trainable=None,
    synchronization=tf.VariableSynchronization.AUTO,
    aggregation=tf.VariableAggregation.NONE
)

apply_gradients

apply_gradients(
    grads_and_vars, name=None, experimental_aggregate_gradients=True
)

Apply gradients to variables.

This is the second part of minimize(). It returns an Operation that applies gradients.

The method sums gradients from all replicas in the presence of tf.distribute.Strategy by default. You can aggregate gradients yourself by passing experimental_aggregate_gradients=False.

Example:

grads = tape.gradient(loss, vars)
grads = tf.distribute.get_replica_context().all_reduce('sum', grads)
# Processing aggregated gradients.
optimizer.apply_gradients(zip(grads, vars),
    experimental_aggregate_gradients=False)

Args
grads_and_vars	List of (gradient, variable) pairs.
name	Optional name for the returned operation. When None, uses the name passed to the Optimizer constructor. Defaults to None.
experimental_aggregate_gradients	Whether to sum gradients from different replicas in the presence of tf.distribute.Strategy. If False, it's user responsibility to aggregate the gradients. Default to True.

Returns
An Operation that applies the specified gradients. The iterations will be automatically increased by 1.

Raises
TypeError	If grads_and_vars is malformed.
ValueError	If none of the variables have gradients.
RuntimeError	If called in a cross-replica context.

from_config

@classmethod
from_config(
    config, custom_objects=None
)

Creates an optimizer from its config.

This method is the reverse of get_config, capable of instantiating the same optimizer from the config dictionary.

Args
config	A Python dictionary, typically the output of get_config.
custom_objects	A Python dictionary mapping names to additional Python objects used to create this optimizer, such as a function used for a hyperparameter.

Returns
An optimizer instance.

get_config

View source

get_config()

Returns the config of the optimizer.

An optimizer config is a Python dictionary (serializable) containing the configuration of an optimizer. The same optimizer can be reinstantiated later (without any saved state) from this configuration.

Returns
Python dictionary.

get_gradients

get_gradients(
    loss, params
)

Returns gradients of loss with respect to params.

Should be used only in legacy v1 graph mode.

Args
loss	Loss tensor.
params	List of variables.

Returns
List of gradient tensors.

Raises
ValueError	In case any gradient cannot be computed (e.g. if gradient function not implemented).

get_slot

get_slot(
    var, slot_name
)

get_slot_names

get_slot_names()

A list of names for this optimizer's slots.

get_updates

get_updates(
    loss, params
)

get_weights

get_weights()

Returns the current weights of the optimizer.

The weights of an optimizer are its state (ie, variables). This function returns the weight values associated with this optimizer as a list of Numpy arrays. The first value is always the iterations count of the optimizer, followed by the optimizer's state variables in the order they were created. The returned list can in turn be used to load state into similarly parameterized optimizers.

For example, the RMSprop optimizer for this simple model returns a list of three values-- the iteration count, followed by the root-mean-square value of the kernel and bias of the single Dense layer:

opt = tf.keras.optimizers.legacy.RMSprop()
m = tf.keras.models.Sequential([tf.keras.layers.Dense(10)])
m.compile(opt, loss='mse')
data = np.arange(100).reshape(5, 20)
labels = np.zeros(5)
results = m.fit(data, labels)  # Training.
len(opt.get_weights())
3

Returns
Weights values as a list of numpy arrays.

minimize

minimize(
    loss, var_list, grad_loss=None, name=None, tape=None
)

Minimize loss by updating var_list.

This method simply computes gradient using tf.GradientTape and calls apply_gradients(). If you want to process the gradient before applying then call tf.GradientTape and apply_gradients() explicitly instead of using this function.

Args
loss	Tensor or callable. If a callable, loss should take no arguments and return the value to minimize. If a Tensor, the tape argument must be passed.
var_list	list or tuple of Variable objects to update to minimize loss, or a callable returning the list or tuple of Variable objects. Use callable when the variable list would otherwise be incomplete before minimize since the variables are created at the first time loss is called.
grad_loss	(Optional). A Tensor holding the gradient computed for loss.
name	(Optional) str. Name for the returned operation.
tape	(Optional) tf.GradientTape. If loss is provided as a Tensor, the tape that computed the loss must be provided.

Returns
An Operation that updates the variables in var_list. The iterations will be automatically increased by 1.

Raises
ValueError	If some of the variables are not Variable objects.

set_weights

set_weights(
    weights
)

Set the weights of the optimizer.

The weights of an optimizer are its state (ie, variables). This function takes the weight values associated with this optimizer as a list of Numpy arrays. The first value is always the iterations count of the optimizer, followed by the optimizer's state variables in the order they are created. The passed values are used to set the new state of the optimizer.

For example, the RMSprop optimizer for this simple model takes a list of three values-- the iteration count, followed by the root-mean-square value of the kernel and bias of the single Dense layer:

opt = tf.keras.optimizers.legacy.RMSprop()
m = tf.keras.models.Sequential([tf.keras.layers.Dense(10)])
m.compile(opt, loss='mse')
data = np.arange(100).reshape(5, 20)
labels = np.zeros(5)
results = m.fit(data, labels)  # Training.
new_weights = [np.array(10), np.ones([20, 10]), np.zeros([10])]
opt.set_weights(new_weights)
opt.iterations
<tf.Variable 'RMSprop/iter:0' shape=() dtype=int64, numpy=10>

Args
weights	weight values as a list of numpy arrays.

variables

variables()

Returns variables of this Optimizer based on the order created.