Class/Object

org.apache.spark.ml.feature

CountVectorizerModel

Related Docs: object CountVectorizerModel | package feature

Permalink

class CountVectorizerModel extends Model[CountVectorizerModel] with CountVectorizerParams with MLWritable

Converts a text document to a sparse vector of token counts.

Annotations
@Since( "1.5.0" )
Source
CountVectorizer.scala
Linear Supertypes
MLWritable, CountVectorizerParams, HasOutputCol, HasInputCol, Model[CountVectorizerModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. CountVectorizerModel
  2. MLWritable
  3. CountVectorizerParams
  4. HasOutputCol
  5. HasInputCol
  6. Model
  7. Transformer
  8. PipelineStage
  9. Logging
  10. Params
  11. Serializable
  12. Serializable
  13. Identifiable
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CountVectorizerModel(vocabulary: Array[String])

    Permalink
    Annotations
    @Since( "1.5.0" )
  2. new CountVectorizerModel(uid: String, vocabulary: Array[String])

    Permalink

    vocabulary

    An Array over terms. Only the terms in the vocabulary will be counted.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink

    An alias for getOrDefault().

    An alias for getOrDefault().

    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val binary: BooleanParam

    Permalink

    Binary toggle to control the output vector values.

    Binary toggle to control the output vector values. If True, all nonzero counts (after minTF filter applied) are set to 1. This is useful for discrete probabilistic models that model binary events rather than integer counts. Default: false

    Definition Classes
    CountVectorizerParams
  7. final def clear(param: Param[_]): CountVectorizerModel.this.type

    Permalink

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def copy(extra: ParamMap): CountVectorizerModel

    Permalink

    Creates a copy of this instance with the same UID and some extra 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().

    Definition Classes
    CountVectorizerModelModelTransformerPipelineStageParams
    Annotations
    @Since( "1.5.0" )
  10. def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    Permalink

    Copies param values from this instance to another instance for params shared by them.

    Copies param values from this instance to another instance for params shared by them.

    This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

    to

    the target instance, which should work with the same set of default Params as this source instance

    extra

    extra params to be copied to the target's paramMap

    returns

    the target instance with param values copied

    Attributes
    protected
    Definition Classes
    Params
  11. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink

    Default implementation of copy with extra params.

    Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

    Attributes
    protected
    Definition Classes
    Params
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def explainParam(param: Param[_]): String

    Permalink

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

    a string that contains the input param name, doc, and optionally its default value and the user-supplied value

    Definition Classes
    Params
  15. def explainParams(): String

    Permalink

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

    Definition Classes
    Params
  16. final def extractParamMap(): ParamMap

    Permalink

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params
  17. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Definition Classes
    Params
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def get[T](param: Param[T]): Option[T]

    Permalink

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes
    Params
  20. def getBinary: Boolean

    Permalink

    Definition Classes
    CountVectorizerParams
  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def getDefault[T](param: Param[T]): Option[T]

    Permalink

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes
    Params
  23. final def getInputCol: String

    Permalink

    Definition Classes
    HasInputCol
  24. def getMinDF: Double

    Permalink

    Definition Classes
    CountVectorizerParams
  25. def getMinTF: Double

    Permalink

    Definition Classes
    CountVectorizerParams
  26. final def getOrDefault[T](param: Param[T]): T

    Permalink

    Gets the value of a param in the embedded param map or its default value.

    Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

    Definition Classes
    Params
  27. final def getOutputCol: String

    Permalink

    Definition Classes
    HasOutputCol
  28. def getParam(paramName: String): Param[Any]

    Permalink

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  29. def getVocabSize: Int

    Permalink

    Definition Classes
    CountVectorizerParams
  30. final def hasDefault[T](param: Param[T]): Boolean

    Permalink

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

    Definition Classes
    Params
  31. def hasParam(paramName: String): Boolean

    Permalink

    Tests whether this instance contains a param with a given name.

    Tests whether this instance contains a param with a given name.

    Definition Classes
    Params
  32. def hasParent: Boolean

    Permalink

    Indicates whether this Model has a corresponding parent.

    Indicates whether this Model has a corresponding parent.

    Definition Classes
    Model
  33. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  34. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  35. final val inputCol: Param[String]

    Permalink

    Param for input column name.

    Param for input column name.

    Definition Classes
    HasInputCol
  36. final def isDefined(param: Param[_]): Boolean

    Permalink

    Checks whether a param is explicitly set or has a default value.

    Checks whether a param is explicitly set or has a default value.

    Definition Classes
    Params
  37. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  38. final def isSet(param: Param[_]): Boolean

    Permalink

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  39. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  40. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  42. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  43. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  44. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  46. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  47. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  48. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  49. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  52. val minDF: DoubleParam

    Permalink

    Specifies the minimum number of different documents a term must appear in to be included in the vocabulary.

    Specifies the minimum number of different documents a term must appear in to be included in the vocabulary. If this is an integer >= 1, this specifies the number of documents the term must appear in; if this is a double in [0,1), then this specifies the fraction of documents.

    Default: 1.0

    Definition Classes
    CountVectorizerParams
  53. val minTF: DoubleParam

    Permalink

    Filter to ignore rare words in a document.

    Filter to ignore rare words in a document. For each document, terms with frequency/count less than the given threshold are ignored. If this is an integer >= 1, then this specifies a count (of times the term must appear in the document); if this is a double in [0,1), then this specifies a fraction (out of the document's token count).

    Note that the parameter is only used in transform of CountVectorizerModel and does not affect fitting.

    Default: 1.0

    Definition Classes
    CountVectorizerParams
  54. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  55. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  56. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  57. final val outputCol: Param[String]

    Permalink

    Param for output column name.

    Param for output column name.

    Definition Classes
    HasOutputCol
  58. lazy val params: Array[Param[_]]

    Permalink

    Returns all params sorted by their names.

    Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

    Note: Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

    Definition Classes
    Params
  59. var parent: Estimator[CountVectorizerModel]

    Permalink

    The parent estimator that produced this model.

    The parent estimator that produced this model. Note: For ensembles' component Models, this value can be null.

    Definition Classes
    Model
  60. def save(path: String): Unit

    Permalink

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  61. final def set(paramPair: ParamPair[_]): CountVectorizerModel.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  62. final def set(param: String, value: Any): CountVectorizerModel.this.type

    Permalink

    Sets a parameter (by name) in the embedded param map.

    Sets a parameter (by name) in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  63. final def set[T](param: Param[T], value: T): CountVectorizerModel.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  64. def setBinary(value: Boolean): CountVectorizerModel.this.type

    Permalink

    Annotations
    @Since( "2.0.0" )
  65. final def setDefault(paramPairs: ParamPair[_]*): CountVectorizerModel.this.type

    Permalink

    Sets default values for a list of params.

    Sets default values for a list of params.

    Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

    paramPairs

    a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

    Attributes
    protected
    Definition Classes
    Params
  66. final def setDefault[T](param: Param[T], value: T): CountVectorizerModel.this.type

    Permalink

    Sets a default value for a param.

    Sets a default value for a param.

    param

    param to set the default value. Make sure that this param is initialized before this method gets called.

    value

    the default value

    Attributes
    protected
    Definition Classes
    Params
  67. def setInputCol(value: String): CountVectorizerModel.this.type

    Permalink

    Annotations
    @Since( "1.5.0" )
  68. def setMinTF(value: Double): CountVectorizerModel.this.type

    Permalink

    Annotations
    @Since( "1.5.0" )
  69. def setOutputCol(value: String): CountVectorizerModel.this.type

    Permalink

    Annotations
    @Since( "1.5.0" )
  70. def setParent(parent: Estimator[CountVectorizerModel]): CountVectorizerModel

    Permalink

    Sets the parent of this model (Java API).

    Sets the parent of this model (Java API).

    Definition Classes
    Model
  71. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  72. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  73. def transform(dataset: Dataset[_]): DataFrame

    Permalink

    Transforms the input dataset.

    Transforms the input dataset.

    Definition Classes
    CountVectorizerModelTransformer
    Annotations
    @Since( "2.0.0" )
  74. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink

    Transforms the dataset with provided parameter map as additional parameters.

    Transforms the dataset with provided parameter map as additional parameters.

    dataset

    input dataset

    paramMap

    additional parameters, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  75. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink

    Transforms the dataset with optional parameters

    Transforms the dataset with optional parameters

    dataset

    input dataset

    firstParamPair

    the first param pair, overwrite embedded params

    otherParamPairs

    other param pairs, overwrite embedded params

    returns

    transformed dataset

    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  76. def transformSchema(schema: StructType): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    Check transform validity and derive the output schema from the input schema.

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

    Definition Classes
    CountVectorizerModelPipelineStage
    Annotations
    @Since( "1.5.0" )
  77. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    Derives the output schema from the input schema and parameters, optionally with logging.

    This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.

    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  78. val uid: String

    Permalink

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes
    CountVectorizerModelIdentifiable
    Annotations
    @Since( "1.5.0" )
  79. def validateAndTransformSchema(schema: StructType): StructType

    Permalink

    Validates and transforms the input schema.

    Validates and transforms the input schema.

    Attributes
    protected
    Definition Classes
    CountVectorizerParams
  80. val vocabSize: IntParam

    Permalink

    Max size of the vocabulary.

    Max size of the vocabulary. CountVectorizer will build a vocabulary that only considers the top vocabSize terms ordered by term frequency across the corpus.

    Default: 218

    Definition Classes
    CountVectorizerParams
  81. val vocabulary: Array[String]

    Permalink

    An Array over terms.

    An Array over terms. Only the terms in the vocabulary will be counted.

    Annotations
    @Since( "1.5.0" )
  82. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. def write: MLWriter

    Permalink

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    CountVectorizerModelMLWritable
    Annotations
    @Since( "1.6.0" )

Deprecated Value Members

  1. def validateParams(): Unit

    Permalink

    Validates parameter values stored internally.

    Validates parameter values stored internally. Raise an exception if any parameter value is invalid.

    This only needs to check for interactions between parameters. Parameter value checks which do not depend on other parameters are handled by Param.validate(). This method does not handle input/output column parameters; those are checked during schema validation.

    Definition Classes
    Params
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Will be removed in 2.1.0. Checks should be merged into transformSchema.

Inherited from MLWritable

Inherited from CountVectorizerParams

Inherited from HasOutputCol

Inherited from HasInputCol

Inherited from Model[CountVectorizerModel]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

Members

Parameter setters

Parameter getters