Package org.apache.spark.ml.feature

Class CountVectorizer

Object
org.apache.spark.ml.PipelineStage
org.apache.spark.ml.Estimator<CountVectorizerModel>
org.apache.spark.ml.feature.CountVectorizer
All Implemented Interfaces:
Serializable, org.apache.spark.internal.Logging, org.apache.spark.ml.feature.CountVectorizerParams, Params, HasInputCol, HasOutputCol, DefaultParamsWritable, Identifiable, MLWritable
public class CountVectorizer extends Estimator<CountVectorizerModel> implements org.apache.spark.ml.feature.CountVectorizerParams, DefaultParamsWritable
Extracts a vocabulary from document collections and generates a CountVectorizerModel.
See Also:

  • Constructor Details

    • CountVectorizer

      public CountVectorizer(String uid)

    • CountVectorizer

      public CountVectorizer()

  • Method Details

    • load

      public static CountVectorizer load(String path)

    • read

      public static MLReader<T> read()

    • vocabSize

      public IntParam vocabSize()
      Specified by:
      vocabSize in interface org.apache.spark.ml.feature.CountVectorizerParams

    • minDF

      public DoubleParam minDF()
      Specified by:
      minDF in interface org.apache.spark.ml.feature.CountVectorizerParams

    • maxDF

      public DoubleParam maxDF()
      Specified by:
      maxDF in interface org.apache.spark.ml.feature.CountVectorizerParams

    • minTF

      public DoubleParam minTF()
      Specified by:
      minTF in interface org.apache.spark.ml.feature.CountVectorizerParams

    • binary

      public BooleanParam binary()
      Specified by:
      binary in interface org.apache.spark.ml.feature.CountVectorizerParams

    • 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 CountVectorizer setInputCol(String value)

    • setOutputCol

      public CountVectorizer setOutputCol(String value)

    • setVocabSize

      public CountVectorizer setVocabSize(int value)

    • setMinDF

      public CountVectorizer setMinDF(double value)

    • setMaxDF

      public CountVectorizer setMaxDF(double value)

    • setMinTF

      public CountVectorizer setMinTF(double value)

    • setBinary

      public CountVectorizer setBinary(boolean value)

    • fit

      public CountVectorizerModel fit(Dataset<?> dataset)
      Description copied from class: Estimator
      Fits a model to the input data.
      Specified by:
      fit in class Estimator<CountVectorizerModel>
      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 CountVectorizer 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<CountVectorizerModel>
      Parameters:
      extra - (undocumented)
      Returns:
      (undocumented)