Packages

c

com.johnsnowlabs.nlp

FeaturesAssembler

class FeaturesAssembler extends Transformer with DefaultParamsWritable with HasOutputAnnotatorType with HasOutputAnnotationCol with HasStorageRef with Licensed

The FeaturesAssembler is used to collect features from different columns. It can collect features from single value columns (anything which can be cast to a float, if casts fails then the value is set to 0), array columns or SparkNLP annotations (if the annotation is an embedding, it takes the embedding, otherwise tries to cast the result field). The output of the transformer is a FEATURE_VECTOR annotation (the numeric vector is in the embeddings field).

Linear Supertypes
Licensed, HasStorageRef, ParamsAndFeaturesWritable, HasFeatures, HasOutputAnnotationCol, HasOutputAnnotatorType, DefaultParamsWritable, MLWritable, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. FeaturesAssembler
  2. Licensed
  3. HasStorageRef
  4. ParamsAndFeaturesWritable
  5. HasFeatures
  6. HasOutputAnnotationCol
  7. HasOutputAnnotatorType
  8. DefaultParamsWritable
  9. MLWritable
  10. Transformer
  11. PipelineStage
  12. Logging
  13. Params
  14. Serializable
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FeaturesAssembler()
  2. new FeaturesAssembler(uid: String)

    uid

    a unique identifier for the instantiated AnnotatorModel

Type Members

  1. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. final def clear(param: Param[_]): FeaturesAssembler.this.type
    Definition Classes
    Params
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def copy(extra: ParamMap): Transformer
    Definition Classes
    FeaturesAssembler → Transformer → PipelineStage → Params
  13. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  14. def createDatabaseConnection(database: Name): RocksDBConnection
    Definition Classes
    HasStorageRef
  15. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  19. def explainParams(): String
    Definition Classes
    Params
  20. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  21. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  22. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  25. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  26. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  27. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  28. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  31. def getInputCols: Array[String]

    Input columns containing features

  32. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  33. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  34. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  35. def getStorageRef: String
    Definition Classes
    HasStorageRef
  36. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  37. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  38. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  39. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  40. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. val inputCols: StringArrayParam

    Input columns containing features

  42. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  45. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  46. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  47. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  54. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  59. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  60. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  61. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  62. val outputAnnotatorType: AnnotatorType

    Output annotator type: FEATURE_VECTOR

    Output annotator type: FEATURE_VECTOR

    Definition Classes
    FeaturesAssembler → HasOutputAnnotatorType
  63. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  64. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  65. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  66. def set[T](feature: StructFeature[T], value: T): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  67. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  68. def set[T](feature: SetFeature[T], value: Set[T]): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  69. def set[T](feature: ArrayFeature[T], value: Array[T]): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  70. final def set(paramPair: ParamPair[_]): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  71. final def set(param: String, value: Any): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  72. final def set[T](param: Param[T], value: T): FeaturesAssembler.this.type
    Definition Classes
    Params
  73. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  74. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  75. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  76. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  77. final def setDefault(paramPairs: ParamPair[_]*): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  78. final def setDefault[T](param: Param[T], value: T): FeaturesAssembler.this.type
    Attributes
    protected
    Definition Classes
    Params
  79. def setInputCols(value: Array[String]): FeaturesAssembler.this.type

    Input columns containing features

  80. final def setOutputCol(value: String): FeaturesAssembler.this.type
    Definition Classes
    HasOutputAnnotationCol
  81. def setStorageRef(value: String): FeaturesAssembler.this.type
    Definition Classes
    HasStorageRef
  82. val storageRef: Param[String]
    Definition Classes
    HasStorageRef
  83. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  84. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  85. def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    FeaturesAssembler → Transformer
  86. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  87. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  88. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    FeaturesAssembler → PipelineStage
  89. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  90. val uid: String
    Definition Classes
    FeaturesAssembler → Identifiable
  91. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit
    Definition Classes
    HasStorageRef
  92. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  93. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  95. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from Licensed

Inherited from HasStorageRef

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from HasOutputAnnotationCol

Inherited from HasOutputAnnotatorType

Inherited from DefaultParamsWritable

Inherited from MLWritable

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

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters