Class VectorAttributeRewriter

All Implemented Interfaces:
Serializable, org.apache.spark.internal.Logging, Params, Identifiable, MLWritable, scala.Serializable

public class VectorAttributeRewriter extends Transformer implements MLWritable
Utility transformer that rewrites Vector attribute names via prefix replacement. For example, it can rewrite attribute names starting with 'foo_' to start with 'bar_' instead.

param: vectorCol name of the vector column to rewrite. param: prefixesToRewrite the map of string prefixes to their replacement values. Each attribute name defined in vectorCol will be checked against the keys of this map. When a key prefixes a name, the matching prefix will be replaced by the value in the map.

See Also:
  • Constructor Details

    • VectorAttributeRewriter

      public VectorAttributeRewriter(String uid, String vectorCol, scala.collection.immutable.Map<String,String> prefixesToRewrite)
    • VectorAttributeRewriter

      public VectorAttributeRewriter(String vectorCol, scala.collection.immutable.Map<String,String> prefixesToRewrite)
  • Method Details

    • read

      public static MLReader<VectorAttributeRewriter> read()
    • load

      public static VectorAttributeRewriter load(String path)
    • uid

      public String uid()
      Description copied from interface: Identifiable
      An immutable unique ID for the object and its derivatives.
      Specified by:
      uid in interface Identifiable
    • vectorCol

      public String vectorCol()
    • prefixesToRewrite

      public scala.collection.immutable.Map<String,String> prefixesToRewrite()
    • transform

      public Dataset<Row> transform(Dataset<?> dataset)
      Description copied from class: Transformer
      Transforms the input dataset.
      Specified by:
      transform in class Transformer
      dataset - (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
      schema - (undocumented)
    • copy

      public VectorAttributeRewriter 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
      extra - (undocumented)
    • write

      public MLWriter write()
      Description copied from interface: MLWritable
      Returns an MLWriter instance for this ML instance.
      Specified by:
      write in interface MLWritable