# tf.contrib.learn.DNNLinearCombinedEstimator

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/dnn_linear_combined.py#L377-L496) |

An estimator for TensorFlow Linear and DNN joined training models.

Inherits From: [`Estimator`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/contrib/learn/Estimator)

    tf.contrib.learn.DNNLinearCombinedEstimator(
        head, model_dir=None, linear_feature_columns=None, linear_optimizer=None,
        _joint_linear_weights=False, dnn_feature_columns=None, dnn_optimizer=None,
        dnn_hidden_units=None, dnn_activation_fn=None, dnn_dropout=None,
        gradient_clip_norm=None, config=None, feature_engineering_fn=None,
        embedding_lr_multipliers=None, fix_global_step_increment_bug=False,
        input_layer_partitioner=None
    )

THIS CLASS IS DEPRECATED. See
[contrib/learn/README.md](https://www.tensorflow.org/code/tensorflow/contrib/learn/README.md)
for general migration instructions.

> [!NOTE]
> **Note:** New users must set `fix_global_step_increment_bug=True` when creating an estimator.

Input of `fit`, `train`, and `evaluate` should have following features,
otherwise there will be a `KeyError`:
if `weight_column_name` is not `None`, a feature with
`key=weight_column_name` whose value is a `Tensor`.
for each `column` in `dnn_feature_columns` + `linear_feature_columns`:

    - if `column` is a `SparseColumn`, a feature with `key=column.name`
      whose `value` is a `SparseTensor`.
    - if `column` is a `WeightedSparseColumn`, two features: the first with
      `key` the id column name, the second with `key` the weight column
      name. Both features' `value` must be a `SparseTensor`.
    - if `column` is a `RealValuedColumn, a feature with `key=column.name`
      whose `value` is a `Tensor`.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `head` | A _Head object. |
| `model_dir` | Directory to save model parameters, graph and etc. This can also be used to load checkpoints from the directory into a estimator to continue training a previously saved model. |
| `linear_feature_columns` | An iterable containing all the feature columns used by linear part of the model. All items in the set should be instances of classes derived from `FeatureColumn`. |
| `linear_optimizer` | An instance of `tf.Optimizer` used to apply gradients to the linear part of the model. If `None`, will use a FTRL optimizer. |
| `_joint_linear_weights` | If True will use a single (possibly partitioned) variable to store all weights for the linear model. More efficient if there are many columns, however requires all columns are sparse and have the 'sum' combiner. |
| `dnn_feature_columns` | An iterable containing all the feature columns used by deep part of the model. All items in the set should be instances of classes derived from `FeatureColumn`. |
| `dnn_optimizer` | An instance of `tf.Optimizer` used to apply gradients to the deep part of the model. If `None`, will use an Adagrad optimizer. |
| `dnn_hidden_units` | List of hidden units per layer. All layers are fully connected. |
| `dnn_activation_fn` | Activation function applied to each layer. If `None`, will use [`tf.nn.relu`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/nn/relu). |
| `dnn_dropout` | When not None, the probability we will drop out a given coordinate. |
| `gradient_clip_norm` | A float \> 0. If provided, gradients are clipped to their global norm with this clipping ratio. See tf.clip_by_global_norm for more details. |
| `config` | RunConfig object to configure the runtime settings. |
| `feature_engineering_fn` | Feature engineering function. Takes features and labels which are the output of `input_fn` and returns features and labels which will be fed into the model. |
| `embedding_lr_multipliers` | Optional. A dictionary from `EmbeddingColumn` to a `float` multiplier. Multiplier will be used to multiply with learning rate for the embedding variables. |
| `fix_global_step_increment_bug` | If `False`, the estimator needs two fit steps to optimize both linear and dnn parts. If `True`, this bug is fixed. New users must set this to `True`, but the default value is `False` for backwards compatibility. |
| `input_layer_partitioner` | Optional. Partitioner for input layer. |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | If both linear_feature_columns and dnn_features_columns are empty at the same time. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `config` | <br /> <br /> |
| `model_dir` | Returns a path in which the eval process will look for checkpoints. |
| `model_fn` | Returns the model_fn which is bound to self.params. |

<br />

## Methods

### `evaluate`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/estimator.py#L580-L621)

    evaluate(
        x=None, y=None, input_fn=None, feed_fn=None, batch_size=None, steps=None,
        metrics=None, name=None, checkpoint_path=None, hooks=None, log_progress=True
    )

See `Evaluable`. (deprecated arguments)

> [!WARNING]
> **Warning:** SOME ARGUMENTS ARE DEPRECATED: `(batch_size, x, y)`. They will be removed after 2016-12-01. Instructions for updating: Estimator is decoupled from Scikit Learn interface by moving into separate class SKCompat. Arguments x, y and batch_size are only available in the SKCompat class, Estimator will only accept input_fn. Example conversion: est = Estimator(...) -\> est = SKCompat(Estimator(...))

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If at least one of `x` or `y` is provided, and at least one of `input_fn` or `feed_fn` is provided. Or if `metrics` is not `None` or `dict`. |

<br />

### `export`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/estimator.py#L695-L754)

    export(
        export_dir, input_fn=export._default_input_fn, input_feature_key=None,
        use_deprecated_input_fn=True, signature_fn=None, prediction_key=None,
        default_batch_size=1, exports_to_keep=None, checkpoint_path=None
    )

Exports inference graph into given dir. (deprecated)

> [!WARNING]
> **Warning:** THIS FUNCTION IS DEPRECATED. It will be removed after 2017-03-25. Instructions for updating: Please use Estimator.export_savedmodel() instead.

<br />

<br />

<br />

| Args ||
|---|---|
| `export_dir` | A string containing a directory to write the exported graph and checkpoints. |
| `input_fn` | If `use_deprecated_input_fn` is true, then a function that given `Tensor` of `Example` strings, parses it into features that are then passed to the model. Otherwise, a function that takes no argument and returns a tuple of (features, labels), where features is a dict of string key to `Tensor` and labels is a `Tensor` that's currently not used (and so can be `None`). |
| `input_feature_key` | Only used if `use_deprecated_input_fn` is false. String key into the features dict returned by `input_fn` that corresponds to a the raw `Example` strings `Tensor` that the exported model will take as input. Can only be `None` if you're using a custom `signature_fn` that does not use the first arg (examples). |
| `use_deprecated_input_fn` | Determines the signature format of `input_fn`. |
| `signature_fn` | Function that returns a default signature and a named signature map, given `Tensor` of `Example` strings, `dict` of `Tensor`s for features and `Tensor` or `dict` of `Tensor`s for predictions. |
| `prediction_key` | The key for a tensor in the `predictions` dict (output from the `model_fn`) to use as the `predictions` input to the `signature_fn`. Optional. If `None`, predictions will pass to `signature_fn` without filtering. |
| `default_batch_size` | Default batch size of the `Example` placeholder. |
| `exports_to_keep` | Number of exports to keep. |
| `checkpoint_path` | the checkpoint path of the model to be exported. If it is `None` (which is default), will use the latest checkpoint in export_dir. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| The string path to the exported directory. NB: this functionality was added ca. 2016/09/25; clients that depend on the return value may need to handle the case where this function returns None because subclasses are not returning a value. ||

<br />

### `export_savedmodel`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/estimator.py#L1317-L1490)

    export_savedmodel(
        export_dir_base, serving_input_fn, default_output_alternative_key=None,
        assets_extra=None, as_text=False, checkpoint_path=None,
        graph_rewrite_specs=(GraphRewriteSpec((tag_constants.SERVING,), ()),),
        strip_default_attrs=False
    )

Exports inference graph as a SavedModel into given dir.

<br />

<br />

<br />

| Args ||
|---|---|
| `export_dir_base` | A string containing a directory to write the exported graph and checkpoints. |
| `serving_input_fn` | A function that takes no argument and returns an `InputFnOps`. |
| `default_output_alternative_key` | the name of the head to serve when none is specified. Not needed for single-headed models. |
| `assets_extra` | A dict specifying how to populate the assets.extra directory within the exported SavedModel. Each key should give the destination path (including the filename) relative to the assets.extra directory. The corresponding value gives the full path of the source file to be copied. For example, the simple case of copying a single file without renaming it is specified as `{'my_asset_file.txt': '/path/to/my_asset_file.txt'}`. |
| `as_text` | whether to write the SavedModel proto in text format. |
| `checkpoint_path` | The checkpoint path to export. If None (the default), the most recent checkpoint found within the model directory is chosen. |
| `graph_rewrite_specs` | an iterable of `GraphRewriteSpec`. Each element will produce a separate MetaGraphDef within the exported SavedModel, tagged and rewritten as specified. Defaults to a single entry using the default serving tag ("serve") and no rewriting. |
| `strip_default_attrs` | Boolean. If `True`, default-valued attributes will be removed from the NodeDefs. For a detailed guide, see [Stripping Default-Valued Attributes](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/python/saved_model/README.md#stripping-default-valued-attributes). |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| The string path to the exported directory. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | if an unrecognized export_type is requested. |

<br />

### `fit`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/estimator.py#L487-L526)

    fit(
        x=None, y=None, input_fn=None, steps=None, batch_size=None, monitors=None,
        max_steps=None
    )

See `Trainable`. (deprecated arguments)

> [!WARNING]
> **Warning:** SOME ARGUMENTS ARE DEPRECATED: `(batch_size, x, y)`. They will be removed after 2016-12-01. Instructions for updating: Estimator is decoupled from Scikit Learn interface by moving into separate class SKCompat. Arguments x, y and batch_size are only available in the SKCompat class, Estimator will only accept input_fn. Example conversion: est = Estimator(...) -\> est = SKCompat(Estimator(...))

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If `x` or `y` are not `None` while `input_fn` is not `None`. |
| `ValueError` | If both `steps` and `max_steps` are not `None`. |

<br />

### `get_params`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/_sklearn.py#L41-L67)

    get_params(
        deep=True
    )

Get parameters for this estimator.

<br />

<br />

<br />

| Args ||
|---|---|
| `deep` | boolean, optional <br /> If `True`, will return the parameters for this estimator and contained subobjects that are estimators. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `params` | mapping of string to any Parameter names mapped to their values. |

<br />

### `get_variable_names`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/estimator.py#L683-L689)

    get_variable_names()

Returns list of all variable names in this model.

<br />

<br />

<br />

| Returns ||
|---|---|
| List of names. ||

<br />

### `get_variable_value`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/estimator.py#L672-L681)

    get_variable_value(
        name
    )

Returns value of the variable given by name.

<br />

<br />

<br />

| Args ||
|---|---|
| `name` | string, name of the tensor. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| Numpy array - value of the tensor. ||

<br />

### `partial_fit`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/estimator.py#L528-L578)

    partial_fit(
        x=None, y=None, input_fn=None, steps=1, batch_size=None, monitors=None
    )

Incremental fit on a batch of samples. (deprecated arguments)

> [!WARNING]
> **Warning:** SOME ARGUMENTS ARE DEPRECATED: `(batch_size, x, y)`. They will be removed after 2016-12-01. Instructions for updating: Estimator is decoupled from Scikit Learn interface by moving into separate class SKCompat. Arguments x, y and batch_size are only available in the SKCompat class, Estimator will only accept input_fn. Example conversion: est = Estimator(...) -\> est = SKCompat(Estimator(...))

This method is expected to be called several times consecutively
on different or the same chunks of the dataset. This either can
implement iterative training or out-of-core/online training.

This is especially useful when the whole dataset is too big to
fit in memory at the same time. Or when model is taking long time
to converge, and you want to split up training into subparts.

<br />

<br />

<br />

| Args ||
|---|---|
| `x` | Matrix of shape \[n_samples, n_features...\]. Can be iterator that returns arrays of features. The training input samples for fitting the model. If set, `input_fn` must be `None`. |
| `y` | Vector or matrix \[n_samples\] or \[n_samples, n_outputs\]. Can be iterator that returns array of labels. The training label values (class labels in classification, real numbers in regression). If set, `input_fn` must be `None`. |
| `input_fn` | Input function. If set, `x`, `y`, and `batch_size` must be `None`. |
| `steps` | Number of steps for which to train model. If `None`, train forever. |
| `batch_size` | minibatch size to use on the input, defaults to first dimension of `x`. Must be `None` if `input_fn` is provided. |
| `monitors` | List of `BaseMonitor` subclass instances. Used for callbacks inside the training loop. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `self`, for chaining. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If at least one of `x` and `y` is provided, and `input_fn` is provided. |

<br />

### `predict`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/estimator.py#L623-L670)

    predict(
        x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=True,
        iterate_batches=False
    )

Returns predictions for given features. (deprecated arguments)

> [!WARNING]
> **Warning:** SOME ARGUMENTS ARE DEPRECATED: `(as_iterable, batch_size, x)`. They will be removed after 2016-12-01. Instructions for updating: Estimator is decoupled from Scikit Learn interface by moving into separate class SKCompat. Arguments x, y and batch_size are only available in the SKCompat class, Estimator will only accept input_fn. Example conversion: est = Estimator(...) -\> est = SKCompat(Estimator(...))

<br />

<br />

<br />

| Args ||
|---|---|
| `x` | Matrix of shape \[n_samples, n_features...\]. Can be iterator that returns arrays of features. The training input samples for fitting the model. If set, `input_fn` must be `None`. |
| `input_fn` | Input function. If set, `x` and 'batch_size' must be `None`. |
| `batch_size` | Override default batch size. If set, 'input_fn' must be 'None'. |
| `outputs` | list of `str`, name of the output to predict. If `None`, returns all. |
| `as_iterable` | If True, return an iterable which keeps yielding predictions for each example until inputs are exhausted. Note: The inputs must terminate if you want the iterable to terminate (e.g. be sure to pass num_epochs=1 if you are using something like read_batch_features). |
| `iterate_batches` | If True, yield the whole batch at once instead of decomposing the batch into individual samples. Only relevant when as_iterable is True. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A numpy array of predicted classes or regression values if the constructor's `model_fn` returns a `Tensor` for `predictions` or a `dict` of numpy arrays if `model_fn` returns a `dict`. Returns an iterable of predictions if as_iterable is True. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If x and input_fn are both provided or both `None`. |

<br />

### `set_params`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/_sklearn.py#L69-L110)

    set_params(
        **params
    )

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects
(such as pipelines). The former have parameters of the form
`<component>__<parameter>` so that it's possible to update each
component of a nested object.

<br />

<br />

<br />

| Args ||
|---|---|
| `**params` | Parameters. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| self ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If params contain invalid names. |

<br />