Help protect the Great Barrier Reef with TensorFlow on Kaggle Join Challenge


Linear classifier model.

Inherits From: Estimator, Estimator

Used in the notebooks

Used in the guide Used in the tutorials

Train a linear model to classify instances into one of multiple possible classes. When number of possible classes is 2, this is binary classification.


categorical_column_a = categorical_column_with_hash_bucket(...)
categorical_column_b = categorical_column_with_hash_bucket(...)

categorical_feature_a_x_categorical_feature_b = crossed_column(...)

# Estimator using the default optimizer.
estimator = tf.estimator.LinearClassifier(

# Or estimator using the FTRL optimizer with regularization.
estimator = tf.estimator.LinearClassifier(

# Or estimator using an optimizer with a learning rate decay.
estimator = tf.estimator.LinearClassifier(
    optimizer=lambda: tf.keras.optimizers.Ftrl(

# Or estimator with warm-starting from a previous checkpoint.
estimator = tf.estimator.LinearClassifier(

# Input builders
def input_fn_train:
  # Returns of (x, y) tuple where y represents label's class
  # index.
def input_fn_eval:
  # Returns of (x, y) tuple where y represents label's class
  # index.
def input_fn_predict:
  # Returns of (x, None) tuple.
metrics = estimator.evaluate(input_fn=input_fn_eval)
predictions = estimator.predict(input_fn=input_fn_predict)

Input of train and evaluate should have following features, otherwise there will be a KeyError:

  • if weight_column is not None, a feature with key=weight_column 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.

Loss is calculated by using softmax cross entropy.

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.
n_classes number of label classes. Default is binary classification. Note that class labels are integers representing the class index (i.e. values from 0 to n_classes-1). For arbitrary label values (e.g. string labels), convert to class indices first.
weight_column A string or a _NumericColumn created by tf.feature_column.numeric_column defining feature column representing weights. It is used to down weight or boost examples during training. It will be multiplied by the loss of the example. If it is a string, it is used as a key to fetch weight tensor from the features. If it is a _NumericColumn, raw tensor is fetched by key weight_column.key, then weight_column.normalizer_fn is applied on it to get weight tensor.
label_vocabulary A list of strings represents possible label values. If given, labels must be string type and have any value in label_vocabulary. If it is not given, that means labels are already encoded as integer or float within [0, 1] for n_classes=2 and encoded as integer values in {0, 1,..., n_classes-1} for n_classes>2 . Also there will be errors if vocabulary is not provided and labels are string.
optimizer An instance of tf.keras.optimizers.* or tf.estimator.experimental.LinearSDCA used to train the model. Can also be a string (one of 'Adagrad', 'Adam', 'Ftrl', 'RMSProp', 'SGD'), or callable. Defaults to FTRL optimizer.
config RunConfig object to configure the runtime settings.
warm_start_from A string filepath to a checkpoint to warm-start from, or a WarmStartSettings object to fully configure warm-