# tfrs.experimental.optimizers.CompositeOptimizer

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/recommenders/blob/v0.7.7/tensorflow_recommenders/experimental/optimizers/composite_optimizer.py#L25-L130) |

An optimizer that composes multiple individual optimizers.

    tfrs.experimental.optimizers.CompositeOptimizer(
        optimizers_and_vars: Sequence[Tuple[tf.keras.optimizers.legacy.Optimizer, Callable[[], Sequence[
            tf.Variable]]]],
        name: str = 'CompositeOptimizer'
    ) -> None

It allows different optimizers to be applied to different subsets of the
model's variables. For example, it makes it possible to apply one
optimizer to the model's embeddings (sparse variables) and another
optimizer to the rest of its variables.

To specify which optimizer should apply to each variable, pass a list of
pairs of (optimizer instance, function returning a list of variables the
optimizer should apply to).

#### For example:

      optimizer = CompositeOptimizer([
          (tf.keras.optimizers.legacy.SGD(),
              lambda: model.sparse_trainable_variables),
          (tf.keras.optimizers.legacy.Adam(),
              lambda: model.dense_trainable_variables),
      ])

<br />

<br />

<br />

| ## Args ||
|---|---|
| `optimizers_and_vars` | List of tuples of (optimizer instance, function returning variables that the optimizer should apply to). |
| `name` | The optimizer name. |

<br />

<br />

<br />

<br />

| ## 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`. <br /> If set, clips gradients to a maximum norm. Check [`tf.clip_by_global_norm`](https://www.tensorflow.org/api_docs/python/tf/clip_by_global_norm) for more details. |
| `iterations` | See base class. |
| `optimizers` | Returns the optimizers in composite optimizer (in the original order). |
| `weights` | Returns the optimizer's variables. |

<br />

## 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`.

<br />

<br />

<br />

| 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`. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A slot variable. ||

<br />

### `add_weight`

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

### `apply_gradients`

[View source](https://github.com/tensorflow/recommenders/blob/v0.7.7/tensorflow_recommenders/experimental/optimizers/composite_optimizer.py#L68-L96)

    apply_gradients(
        grads_and_vars: Sequence[Tuple[Tensor, Tensor]],
        name: Optional[str] = None,
        experimental_aggregate_gradients: bool = True
    ) -> None

See base class.

### `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.

<br />

<br />

<br />

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

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| An optimizer instance. ||

<br />

### `get_config`

[View source](https://github.com/tensorflow/recommenders/blob/v0.7.7/tensorflow_recommenders/experimental/optimizers/composite_optimizer.py#L98-L100)

    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.

<br />

<br />

<br />

| Returns ||
|---|---|
| Python dictionary. ||

<br />

### `get_gradients`

    get_gradients(
        loss, params
    )

Returns gradients of `loss` with respect to `params`.

Should be used only in legacy v1 graph mode.

<br />

<br />

<br />

| Args ||
|---|---|
| `loss` | Loss tensor. |
| `params` | List of variables. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| List of gradient tensors. ||

<br />

<br />

<br />

<br />

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

<br />

### `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

<br />

<br />

<br />

| Returns ||
|---|---|
| Weights values as a list of numpy arrays. ||

<br />

### `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`](https://www.tensorflow.org/api_docs/python/tf/GradientTape) and calls
`apply_gradients()`. If you want to process the gradient before applying
then call [`tf.GradientTape`](https://www.tensorflow.org/api_docs/python/tf/GradientTape) and `apply_gradients()` explicitly instead
of using this function.

<br />

<br />

<br />

| 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`](https://www.tensorflow.org/api_docs/python/tf/GradientTape). If `loss` is provided as a `Tensor`, the tape that computed the `loss` must be provided. |

<br />

<br />

<br />

<br />

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

<br />

<br />

<br />

<br />

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

<br />

### `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>

<br />

<br />

<br />

| Args ||
|---|---|
| `weights` | weight values as a list of numpy arrays. |

<br />

### `variables`

[View source](https://github.com/tensorflow/recommenders/blob/v0.7.7/tensorflow_recommenders/experimental/optimizers/composite_optimizer.py#L114-L117)

    variables()

Returns the optimizer's variables.