Class

com.johnsnowlabs.nlp.embeddings

ApproachWithWordEmbeddings

Related Doc: package embeddings

Permalink

abstract class ApproachWithWordEmbeddings[A <: ApproachWithWordEmbeddings[A, M], M <: Model[M] with HasWordEmbeddings] extends AnnotatorApproach[M] with AutoCloseable

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
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. AutoCloseable
  3. AnnotatorApproach
  4. DefaultParamsWritable
  5. MLWritable
  6. HasAnnotatorType
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. Estimator
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. 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. final def ==(arg0: Any): Boolean

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

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

    Permalink
  7. final def clear(param: Param[_]): ApproachWithWordEmbeddings.this.type

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  13. def embeddings: Option[WordEmbeddings]

    Permalink
  14. val embeddingsFormat: IntParam

    Permalink
  15. val embeddingsNDims: IntParam

    Permalink
  16. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

    Permalink
    Definition Classes
    Params
  24. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  29. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  30. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  32. final def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

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

    Permalink
    Definition Classes
    Params
  34. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  39. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. 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
  42. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  62. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  64. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  68. final def setDefault(paramPairs: ParamPair[_]*): ApproachWithWordEmbeddings.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  70. def setEmbeddingsSource(path: String, nDims: Int, format: String): A

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

    Permalink
  72. final def setInputCols(value: String*): ApproachWithWordEmbeddings.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  73. 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
  74. final def setOutputCol(value: String): ApproachWithWordEmbeddings.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  75. def setUseNormalizedTokensForEmbeddings(value: Boolean): ApproachWithWordEmbeddings.this.type

    Permalink
  76. val sourceEmbeddingsPath: Param[String]

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  79. 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
  80. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  81. val useNormalizedTokensForEmbeddings: BooleanParam

    Permalink
  82. 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
  83. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

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