Class

com.johnsnowlabs.nlp.embeddings

ApproachWithWordEmbeddings

Related Doc: package embeddings

Permalink

abstract class ApproachWithWordEmbeddings[A <: ApproachWithWordEmbeddings[A, M], M <: Model[M] with ModelWithWordEmbeddings] extends AnnotatorApproach[M] with HasEmbeddings

Base class for annotators that uses Word Embeddings. This implementation is based on RocksDB so it has a compact RAM usage

1. User configures Word Embeddings by method 'setWordEmbeddingsSource'. 2. During training Word Embeddings are indexed as RockDB index file. 3. Than this index file is spread across the cluster. 4. Every model 'ModelWithWordEmbeddings' uses local RocksDB as Word Embeddings lookup.

Linear Supertypes
HasEmbeddings, ParamsAndFeaturesWritable, HasFeatures, AutoCloseable, AnnotatorApproach[M], DefaultParamsWritable, MLWritable, HasAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[M], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApproachWithWordEmbeddings
  2. HasEmbeddings
  3. ParamsAndFeaturesWritable
  4. HasFeatures
  5. AutoCloseable
  6. AnnotatorApproach
  7. DefaultParamsWritable
  8. MLWritable
  9. HasAnnotatorType
  10. HasOutputAnnotationCol
  11. HasInputAnnotationCols
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ApproachWithWordEmbeddings()

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasAnnotatorType

Abstract Value Members

  1. abstract val annotatorType: AnnotatorType

    Permalink
    Definition Classes
    HasAnnotatorType
  2. abstract val description: String

    Permalink
    Definition Classes
    AnnotatorApproach
  3. abstract val requiredAnnotatorTypes: Array[String]

    Permalink

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

    Definition Classes
    HasInputAnnotationCols
  4. abstract def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel] = None): M

    Permalink
    Definition Classes
    AnnotatorApproach
  5. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable

Concrete 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
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  10. def beforeTraining(spark: SparkSession): Unit

    Permalink
  11. val caseSensitiveEmbeddings: BooleanParam

    Permalink
    Definition Classes
    HasEmbeddings
  12. final def clear(param: Param[_]): ApproachWithWordEmbeddings.this.type

    Permalink
    Definition Classes
    Params
  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def close(): Unit

    Permalink
    Definition Classes
    HasEmbeddings → AutoCloseable
  15. final def copy(extra: ParamMap): Estimator[M]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  16. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  18. val embeddingsDim: IntParam

    Permalink
    Definition Classes
    HasEmbeddings
  19. val embeddingsFormat: IntParam

    Permalink
  20. val embeddingsRef: Param[String]

    Permalink
    Definition Classes
    HasEmbeddings
  21. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    Params
  24. def explainParams(): String

    Permalink
    Definition Classes
    Params
  25. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  26. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  27. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  29. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures
  30. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. final def fit(dataset: Dataset[_]): M

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator
  32. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[M]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  33. def fit(dataset: Dataset[_], paramMap: ParamMap): M

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  34. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): M

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  35. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  40. def getCaseSensitiveEmbeddings: Boolean

    Permalink
    Definition Classes
    HasEmbeddings
  41. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  42. def getClusterEmbeddings: ClusterWordEmbeddings

    Permalink
    Definition Classes
    HasEmbeddings
  43. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  44. def getEmbeddingsDim: Int

    Permalink
    Definition Classes
    HasEmbeddings
  45. def getEmbeddingsRef: String

    Permalink
    Definition Classes
    HasEmbeddings
  46. def getIncludeEmbeddings: Boolean

    Permalink
    Definition Classes
    HasEmbeddings
  47. final def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  48. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  49. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  50. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  51. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  53. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  54. val includeEmbeddings: BooleanParam

    Permalink
    Definition Classes
    HasEmbeddings
  55. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. final val inputCols: StringArrayParam

    Permalink

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  58. final def isDefined(param: Param[_]): Boolean

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

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

    Permalink
    Definition Classes
    Params
  61. def isTraceEnabled(): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  77. def onTrained(model: M, spark: SparkSession): Unit

    Permalink
  78. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable
  79. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  80. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  81. lazy val preloadedEmbeddings: ClusterWordEmbeddings

    Permalink
    Attributes
    protected
    Definition Classes
    HasEmbeddings
  82. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  83. def set[T](feature: StructFeature[T], value: T): ApproachWithWordEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  84. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ApproachWithWordEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  85. def set[T](feature: SetFeature[T], value: Set[T]): ApproachWithWordEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  86. def set[T](feature: ArrayFeature[T], value: Array[T]): ApproachWithWordEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  87. final def set(paramPair: ParamPair[_]): ApproachWithWordEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  88. final def set(param: String, value: Any): ApproachWithWordEmbeddings.this.type

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

    Permalink
    Definition Classes
    Params
  90. def setCaseSensitiveEmbeddings(value: Boolean): ApproachWithWordEmbeddings.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  91. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ApproachWithWordEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ApproachWithWordEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ApproachWithWordEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  94. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ApproachWithWordEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  95. final def setDefault(paramPairs: ParamPair[_]*): ApproachWithWordEmbeddings.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  97. def setEmbeddingsDim(value: Int): ApproachWithWordEmbeddings.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  98. def setEmbeddingsRef(value: String): ApproachWithWordEmbeddings.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  99. def setEmbeddingsSource(path: String, nDims: Int, format: String): A

    Permalink
  100. def setEmbeddingsSource(path: String, nDims: Int, format: Format): A

    Permalink
  101. def setIncludeEmbeddings(value: Boolean): ApproachWithWordEmbeddings.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  102. final def setInputCols(value: String*): ApproachWithWordEmbeddings.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  103. final def setInputCols(value: Array[String]): ApproachWithWordEmbeddings.this.type

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  104. final def setOutputCol(value: String): ApproachWithWordEmbeddings.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  105. val sourceEmbeddingsPath: Param[String]

    Permalink
  106. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  108. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    AnnotatorApproach → PipelineStage
  109. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  110. def validate(schema: StructType): Boolean

    Permalink

    takes a Dataset and checks to see if all the required annotation types are present.

    takes a Dataset and checks to see if all the required annotation types are present.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  111. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasEmbeddings

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from AutoCloseable

Inherited from AnnotatorApproach[M]

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[M]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped