View source on GitHub

A Estimator for TensorFlow DNN models with user specified _Head.

Inherits From: Estimator

THIS CLASS IS DEPRECATED. See contrib/learn/ for general migration instructions.


sparse_feature_a = sparse_column_with_hash_bucket(...)
sparse_feature_b = sparse_column_with_hash_bucket(...)

sparse_feature_a_emb = embedding_column(sparse_id_column=sparse_feature_a,
sparse_feature_b_emb = embedding_column(sparse_id_column=sparse_feature_b,
To create a DNNEstimator for binary classification, where
estimator = DNNEstimator(
    feature_columns=[sparse_feature_a_emb, sparse_feature_b_emb],
    hidden_units=[1024, 512, 256])

If your label is keyed with "y" in your labels dict, and weights are keyed
with "w" in features dict, and you want to enable centered bias,
head = tf.contrib.learn.multi_class_head(
estimator = DNNEstimator(
    feature_columns=[sparse_feature_a_emb, sparse_feature_b_emb],
    hidden_units=[1024, 512, 256])

# Input builders
def input_fn_train: # returns x, y (where y represents label's class index).

def input_fn_eval: # returns x, y (where y represents label's class index).
estimator.predict(x=x) # returns predicted labels (i.e. label's class index).

Input of fit 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 feature_columns:
    • if column is a SparseColumn, a feature with 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 whose value is a Tensor.

head Head instance.
hidden_units List of hidden units per layer. All layers are fully connected. Ex. [64, 32] means first layer has 64 nodes and second one has 32.
feature_columns An iterable containing all the feature columns used by the model. All items in the set should be instances of classes derived from FeatureColumn.
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.
optimizer An instance of tf.Optimizer used to train the model. If None, will use an Adagrad optimizer.
activation_fn Activation function applied to each layer. If None, will use tf.nn.relu. Note that a string containing the unqualified name of the op may also be provided, e.g., "relu", "tanh", or "sigmoid".
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.
input_layer_min_slice_size Optional. The min slice size of input layer partitions. If not provided, will use the default of 64M.


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.



View source

See Evaluable. (deprecated arguments)

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.


View source

Exports inference graph into given dir. (deprecated)

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 Tensors for features and Tensor or dict of Tensors 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.

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.


View source

Exports inference graph as a SavedModel into given dir.

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.

The string path to the exported directory.

ValueError if an unrecognized export_type is requested.


View source

See Trainable. (deprecated arguments)

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


View source

Get parameters for this estimator.

deep boolean, optional

If True, will return the parameters for this estimator and contained subobjects that are estimators.

params mapping of string to any Parameter names mapped to their values.


View source

Returns list of all variable names in this model.

List of names.


View source

Returns value of the variable given by name.

name string, name of the tensor.

Numpy array - value of the tensor.


View source

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

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.

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.

self, for chaining.

ValueError If at least one of x and y is provided, and input_fn is provided.


View source

Returns predictions for given features. (deprecated arguments)

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.

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.

ValueError If x and input_fn are both provided or both None.


View source

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.

**params Parameters.


ValueError If params contain invalid names.