Class/Object

org.apache.spark.ml.feature

NGram

Related Docs: object NGram | package feature

Permalink

class NGram extends UnaryTransformer[Seq[String], Seq[String], NGram] with DefaultParamsWritable

A feature transformer that converts the input array of strings into an array of n-grams. Null values in the input array are ignored. It returns an array of n-grams where each n-gram is represented by a space-separated string of words.

When the input is empty, an empty array is returned. When the input array length is less than n (number of elements per n-gram), no n-grams are returned.

Annotations
@Since( "1.5.0" )
Source
NGram.scala
Linear Supertypes
DefaultParamsWritable, MLWritable, UnaryTransformer[Seq[String], Seq[String], NGram], HasOutputCol, HasInputCol, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. NGram
  2. DefaultParamsWritable
  3. MLWritable
  4. UnaryTransformer
  5. HasOutputCol
  6. HasInputCol
  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 NGram()

    Permalink
    Annotations
    @Since( "1.5.0" )
  2. new NGram(uid: String)

    Permalink
    Annotations
    @Since( "1.5.0" )

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. final def clear(param: Param[_]): NGram.this.type

    Permalink

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  7. def clone(): AnyRef

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

    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
    UnaryTransformerTransformerPipelineStageParams
  9. 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
  10. def createTransformFunc: (Seq[String]) ⇒ Seq[String]

    Permalink

    Creates the transform function using the given param map.

    Creates the transform function using the given param map. The input param map already takes account of the embedded param map. So the param values should be determined solely by the input param map.

    Attributes
    protected
    Definition Classes
    NGramUnaryTransformer
  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. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. 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
  22. final def getInputCol: String

    Permalink

    Definition Classes
    HasInputCol
  23. def getN: Int

    Permalink

    Annotations
    @Since( "1.5.0" )
  24. 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
  25. final def getOutputCol: String

    Permalink

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

    Permalink

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  27. 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
  28. 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
  29. def hashCode(): Int

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

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

    Permalink

    Param for input column name.

    Param for input column name.

    Definition Classes
    HasInputCol
  32. 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
  33. final def isInstanceOf[T0]: Boolean

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

    Permalink

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  35. def isTraceEnabled(): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  48. val n: IntParam

    Permalink

    Minimum n-gram length, greater than or equal to 1.

    Minimum n-gram length, greater than or equal to 1. Default: 2, bigram features

    Annotations
    @Since( "1.5.0" )
  49. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink

    Param for output column name.

    Param for output column name.

    Definition Classes
    HasOutputCol
  53. def outputDataType: DataType

    Permalink

    Returns the data type of the output column.

    Returns the data type of the output column.

    Attributes
    protected
    Definition Classes
    NGramUnaryTransformer
  54. 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.

    Definition Classes
    Params
    Note

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

  55. 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( ... )
  56. final def set(paramPair: ParamPair[_]): NGram.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  57. final def set(param: String, value: Any): NGram.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
  58. final def set[T](param: Param[T], value: T): NGram.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  59. final def setDefault(paramPairs: ParamPair[_]*): NGram.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
  60. final def setDefault[T](param: Param[T], value: T): NGram.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
  61. def setInputCol(value: String): NGram

    Permalink

    Definition Classes
    UnaryTransformer
  62. def setN(value: Int): NGram.this.type

    Permalink

    Annotations
    @Since( "1.5.0" )
  63. def setOutputCol(value: String): NGram

    Permalink

    Definition Classes
    UnaryTransformer
  64. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink

    Transforms the input dataset.

    Transforms the input dataset.

    Definition Classes
    UnaryTransformerTransformer
  67. 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" )
  68. 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()
  69. def transformSchema(schema: StructType): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    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.

    Definition Classes
    UnaryTransformerPipelineStage
  70. 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()
  71. 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
    NGramIdentifiable
    Annotations
    @Since( "1.5.0" )
  72. def validateInputType(inputType: DataType): Unit

    Permalink

    Validates the input type.

    Validates the input type. Throw an exception if it is invalid.

    Attributes
    protected
    Definition Classes
    NGramUnaryTransformer
  73. final def wait(): Unit

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

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

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

    Permalink

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    DefaultParamsWritableMLWritable

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from UnaryTransformer[Seq[String], Seq[String], NGram]

Inherited from HasOutputCol

Inherited from HasInputCol

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