Package org.apache.spark.ml.feature

Class PCA

Object
org.apache.spark.ml.PipelineStage
org.apache.spark.ml.Estimator<PCAModel>
org.apache.spark.ml.feature.PCA
All Implemented Interfaces:
Serializable, org.apache.spark.internal.Logging, PCAParams, Params, HasInputCol, HasOutputCol, DefaultParamsWritable, Identifiable, MLWritable
public class PCA extends Estimator<PCAModel> implements PCAParams, DefaultParamsWritable
PCA trains a model to project vectors to a lower dimensional space of the top PCA!.k principal components.
See Also:

  • Constructor Details

    • PCA

      public PCA(String uid)

    • PCA

      public PCA()

  • Method Details

    • load

      public static PCA load(String path)

    • read

      public static MLReader<T> read()

    • k

      public final IntParam k()
      Description copied from interface: PCAParams
      The number of principal components.
      Specified by:
      k in interface PCAParams
      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)

    • inputCol

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

    • 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
      Returns:
      (undocumented)

    • setInputCol

      public PCA setInputCol(String value)

    • setOutputCol

      public PCA setOutputCol(String value)

    • setK

      public PCA setK(int value)

    • fit

      public PCAModel fit(Dataset<?> dataset)
      Computes a PCAModel that contains the principal components of the input vectors.
      Specified by:
      fit in class Estimator<PCAModel>
      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)

    • copy

      public PCA 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 Estimator<PCAModel>
      Parameters:
      extra - (undocumented)
      Returns:
      (undocumented)