Feature Transformation -- StringIndexer (Estimator)

A label indexer that maps a string column of labels to an ML column of label indices. If the input column is numeric, we cast it to string and index the string values. The indices are in [0, numLabels), ordered by label frequencies. So the most frequent label gets index 0. This function is the inverse of ft_index_to_string.

ft_string_indexer(x, input_col = NULL, output_col = NULL,
  handle_invalid = "error", string_order_type = "frequencyDesc",
  dataset = NULL, uid = random_string("string_indexer_"), ...)


ft_string_indexer_model(x, input_col = NULL, output_col = NULL, labels,
  handle_invalid = "error",
  uid = random_string("string_indexer_model_"), ...)



A spark_connection, ml_pipeline, or a tbl_spark.


The name of the input column.


The name of the output column.


(Spark 2.1.0+) Param for how to handle invalid entries. Options are 'skip' (filter out rows with invalid values), 'error' (throw an error), or 'keep' (keep invalid values in a special additional bucket). Default: "error"


(Spark 2.3+)How to order labels of string column. The first label after ordering is assigned an index of 0. Options are "frequencyDesc", "frequencyAsc", "alphabetDesc", and "alphabetAsc". Defaults to "frequencyDesc".


(Optional) A tbl_spark. If provided, eagerly fit the (estimator) feature "transformer" against dataset. See details.


A character string used to uniquely identify the feature transformer.


Optional arguments; currently unused.


A fitted StringIndexer model returned by ft_string_indexer()


Vector of labels, corresponding to indices to be assigned.


The object returned depends on the class of x.

  • spark_connection: When x is a spark_connection, the function returns a ml_transformer, a ml_estimator, or one of their subclasses. The object contains a pointer to a Spark Transformer or Estimator object and can be used to compose Pipeline objects.

  • ml_pipeline: When x is a ml_pipeline, the function returns a ml_pipeline with the transformer or estimator appended to the pipeline.

  • tbl_spark: When x is a tbl_spark, a transformer is constructed then immediately applied to the input tbl_spark, returning a tbl_spark

ml_labels() returns a vector of labels, corresponding to indices to be assigned.


When dataset is provided for an estimator transformer, the function internally calls ml_fit() against dataset. Hence, the methods for spark_connection and ml_pipeline will then return a ml_transformer and a ml_pipeline with a ml_transformer appended, respectively. When x is a tbl_spark, the estimator will be fit against dataset before transforming x.

When dataset is not specified, the constructor returns a ml_estimator, and, in the case where x is a tbl_spark, the estimator fits against x then to obtain a transformer, which is then immediately used to transform x.

See also