Package org.apache.spark.ml

Class UnaryTransformer<IN,OUT,T extends UnaryTransformer<IN,OUT,T>>

Object
org.apache.spark.ml.PipelineStage
org.apache.spark.ml.Transformer
org.apache.spark.ml.UnaryTransformer<IN,OUT,T>
All Implemented Interfaces:
Serializable, org.apache.spark.internal.Logging, Params, HasInputCol, HasOutputCol, Identifiable
Direct Known Subclasses:
DCT, ElementwiseProduct, NGram, Normalizer, PolynomialExpansion, RegexTokenizer, Tokenizer
public abstract class UnaryTransformer<IN,OUT,T extends UnaryTransformer<IN,OUT,T>> extends Transformer implements HasInputCol, HasOutputCol, org.apache.spark.internal.Logging
Abstract class for transformers that take one input column, apply transformation, and output the result as a new column.
See Also:

  • Constructor Details

    • UnaryTransformer

      public UnaryTransformer(scala.reflect.api.TypeTags.TypeTag<IN> evidence$1, scala.reflect.api.TypeTags.TypeTag<OUT> evidence$2)

  • Method Details

    • copy

      public T copy(ParamMap extra)
      Description copied from interface: Params
      Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().
      Specified by:
      copy in interface Params
      Specified by:
      copy in class Transformer
      Parameters:
      extra - (undocumented)
      Returns:
      (undocumented)

    • inputCol

      public final Param<String> inputCol()
      Description copied from interface: HasInputCol
      Param for input column name.
      Specified by:
      inputCol in interface HasInputCol
      Returns:
      (undocumented)

    • outputCol

      public final Param<String> outputCol()
      Description copied from interface: HasOutputCol
      Param for output column name.
      Specified by:
      outputCol in interface HasOutputCol
      Returns:
      (undocumented)

    • setInputCol

      public T setInputCol(String value)

    • setOutputCol

      public T setOutputCol(String value)

    • transform

      public Dataset<Row> transform(Dataset<?> dataset)
      Description copied from class: Transformer
      Transforms the input dataset.
      Specified by:
      transform in class Transformer
      Parameters:
      dataset - (undocumented)
      Returns:
      (undocumented)

    • transformSchema

      public StructType transformSchema(StructType schema)
      Description copied from class: PipelineStage
      Check transform validity and derive the output schema from the input schema.

      We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

      Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

      Specified by:
      transformSchema in class PipelineStage
      Parameters:
      schema - (undocumented)
      Returns:
      (undocumented)