Packages

class UAEEmbeddings extends AnnotatorModel[UAEEmbeddings] with HasBatchedAnnotate[UAEEmbeddings] with WriteTensorflowModel with WriteOnnxModel with HasEmbeddingsProperties with HasStorageRef with HasCaseSensitiveProperties with HasEngine

Sentence embeddings using Universal AnglE Embedding (UAE).

UAE is a novel angle-optimized text embedding model, designed to improve semantic textual similarity tasks, which are crucial for Large Language Model (LLM) applications. By introducing angle optimization in a complex space, AnglE effectively mitigates saturation of the cosine similarity function.

Pretrained models can be loaded with pretrained of the companion object:

val embeddings = UAEEmbeddings.pretrained()
  .setInputCols("document")
  .setOutputCol("UAE_embeddings")

The default model is "uae_large_v1", if no name is provided.

For available pretrained models please see the Models Hub.

For extended examples of usage, see UAEEmbeddingsTestSpec.

Sources :

AnglE-optimized Text Embeddings

UAE Github Repository

Paper abstract

High-quality text embedding is pivotal in improving semantic textual similarity (STS) tasks, which are crucial components in Large Language Model (LLM) applications. However, a common challenge existing text embedding models face is the problem of vanishing gradients, primarily due to their reliance on the cosine function in the optimization objective, which has saturation zones. To address this issue, this paper proposes a novel angle-optimized text embedding model called AnglE. The core idea of AnglE is to introduce angle optimization in a complex space. This novel approach effectively mitigates the adverse effects of the saturation zone in the cosine function, which can impede gradient and hinder optimization processes. To set up a comprehensive STS evaluation, we experimented on existing short-text STS datasets and a newly collected long-text STS dataset from GitHub Issues. Furthermore, we examine domain-specific STS scenarios with limited labeled data and explore how AnglE works with LLM-annotated data. Extensive experiments were conducted on various tasks including short-text STS, long-text STS, and domain-specific STS tasks. The results show that AnglE outperforms the state-of-the-art (SOTA) STS models that ignore the cosine saturation zone. These findings demonstrate the ability of AnglE to generate high-quality text embeddings and the usefulness of angle optimization in STS.

Example

import spark.implicits._
import com.johnsnowlabs.nlp.base.DocumentAssembler
import com.johnsnowlabs.nlp.annotators.Tokenizer
import com.johnsnowlabs.nlp.embeddings.UAEEmbeddings
import com.johnsnowlabs.nlp.EmbeddingsFinisher
import org.apache.spark.ml.Pipeline

val documentAssembler = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("document")

val embeddings = UAEEmbeddings.pretrained()
  .setInputCols("document")
  .setOutputCol("UAE_embeddings")

val embeddingsFinisher = new EmbeddingsFinisher()
  .setInputCols("UAE_embeddings")
  .setOutputCols("finished_embeddings")
  .setOutputAsVector(true)

val pipeline = new Pipeline().setStages(Array(
  documentAssembler,
  embeddings,
  embeddingsFinisher
))

val data = Seq("hello world", "hello moon").toDF("text")
val result = pipeline.fit(data).transform(data)

result.selectExpr("explode(finished_embeddings) as result").show(5, 80)
+--------------------------------------------------------------------------------+
|                                                                          result|
+--------------------------------------------------------------------------------+
|[0.50387806, 0.5861606, 0.35129607, -0.76046336, -0.32446072, -0.117674336, 0...|
|[0.6660665, 0.961762, 0.24854276, -0.1018044, -0.6569202, 0.027635604, 0.1915...|
+--------------------------------------------------------------------------------+
See also

Annotators Main Page for a list of transformer based embeddings

Linear Supertypes
HasEngine, HasCaseSensitiveProperties, HasStorageRef, HasEmbeddingsProperties, HasProtectedParams, WriteOnnxModel, WriteTensorflowModel, HasBatchedAnnotate[UAEEmbeddings], AnnotatorModel[UAEEmbeddings], CanBeLazy, RawAnnotator[UAEEmbeddings], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[UAEEmbeddings], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. UAEEmbeddings
  2. HasEngine
  3. HasCaseSensitiveProperties
  4. HasStorageRef
  5. HasEmbeddingsProperties
  6. HasProtectedParams
  7. WriteOnnxModel
  8. WriteTensorflowModel
  9. HasBatchedAnnotate
  10. AnnotatorModel
  11. CanBeLazy
  12. RawAnnotator
  13. HasOutputAnnotationCol
  14. HasInputAnnotationCols
  15. HasOutputAnnotatorType
  16. ParamsAndFeaturesWritable
  17. HasFeatures
  18. DefaultParamsWritable
  19. MLWritable
  20. Model
  21. Transformer
  22. PipelineStage
  23. Logging
  24. Params
  25. Serializable
  26. Serializable
  27. Identifiable
  28. AnyRef
  29. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    required uid for storing annotator to disk

Type Members

  1. implicit class ProtectedParam[T] extends Param[T]
    Definition Classes
    HasProtectedParams
  2. type AnnotationContent = Seq[Row]

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  3. 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. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    UAEEmbeddings → AnnotatorModel
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def batchAnnotate(batchedAnnotations: Seq[Array[Annotation]]): Seq[Seq[Annotation]]

    takes a document and annotations and produces new annotations of this annotator's annotation type

    takes a document and annotations and produces new annotations of this annotator's annotation type

    batchedAnnotations

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    any number of annotations processed for every input annotation. Not necessary one to one relationship

    Definition Classes
    UAEEmbeddings → HasBatchedAnnotate
  13. def batchProcess(rows: Iterator[_]): Iterator[Row]
    Definition Classes
    HasBatchedAnnotate
  14. val batchSize: IntParam

    Size of every batch (Default depends on model).

    Size of every batch (Default depends on model).

    Definition Classes
    HasBatchedAnnotate
  15. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  16. val caseSensitive: BooleanParam

    Whether to ignore case in index lookups (Default depends on model)

    Whether to ignore case in index lookups (Default depends on model)

    Definition Classes
    HasCaseSensitiveProperties
  17. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. final def clear(param: Param[_]): UAEEmbeddings.this.type
    Definition Classes
    Params
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. val configProtoBytes: IntArrayParam

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

  21. def copy(extra: ParamMap): UAEEmbeddings

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  22. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. def createDatabaseConnection(database: Name): RocksDBConnection
    Definition Classes
    HasStorageRef
  24. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  25. val dimension: ProtectedParam[Int]

    Number of embedding dimensions (Default depends on model)

    Number of embedding dimensions (Default depends on model)

    Definition Classes
    HasEmbeddingsProperties
  26. val engine: Param[String]

    This param is set internally once via loadSavedModel.

    This param is set internally once via loadSavedModel. That's why there is no setter

    Definition Classes
    HasEngine
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  30. def explainParams(): String
    Definition Classes
    Params
  31. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  32. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  33. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  34. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  35. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  36. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. def getBatchSize: Int

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotate
  43. def getCaseSensitive: Boolean

    Definition Classes
    HasCaseSensitiveProperties
  44. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. def getConfigProtoBytes: Option[Array[Byte]]

  46. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  47. def getDimension: Int

    Definition Classes
    HasEmbeddingsProperties
  48. def getEngine: String

    Definition Classes
    HasEngine
  49. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  50. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  51. def getMaxSentenceLength: Int

  52. def getModelIfNotSet: UAE

  53. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  54. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  55. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  56. def getPoolingStrategy: String
  57. def getSignatures: Option[Map[String, String]]

  58. def getStorageRef: String
    Definition Classes
    HasStorageRef
  59. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  60. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  61. def hasParent: Boolean
    Definition Classes
    Model
  62. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  63. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  64. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. val inputAnnotatorTypes: Array[String]

    Annotator reference id.

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

    Definition Classes
    UAEEmbeddings → HasInputAnnotationCols
  66. final val inputCols: StringArrayParam

    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
  67. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  68. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  69. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  70. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  71. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  72. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  73. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  80. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. val maxSentenceLength: IntParam

    Max sentence length to process (Default: 128)

  85. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  86. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  87. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  88. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  89. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    UAEEmbeddings → ParamsAndFeaturesWritable
  90. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  91. val outputAnnotatorType: AnnotatorType
    Definition Classes
    UAEEmbeddings → HasOutputAnnotatorType
  92. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  93. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  94. var parent: Estimator[UAEEmbeddings]
    Definition Classes
    Model
  95. val poolingStrategy: Param[String]

    Pooling strategy to use for sentence embeddings.

    Pooling strategy to use for sentence embeddings.

    Available pooling strategies for sentence embeddings are:

    • "cls": leading [CLS] token
    • "cls_avg": leading [CLS] token + mean of all other tokens
    • "last": embeddings of the last token in the sequence
    • "avg": mean of all tokens
    • "max": max of all embedding values for the token sequence
    • "all": return all token embeddings
    • "int": An integer number, which represents the index of the token to use as the embedding
  96. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  97. def sentenceEndTokenId: Int

  98. def sentenceStartTokenId: Int
  99. def set[T](param: ProtectedParam[T], value: T): UAEEmbeddings.this.type

    Sets the value for a protected Param.

    Sets the value for a protected Param.

    If the parameter was already set, it will not be set again. Default values do not count as a set value and can be overridden.

    T

    Type of the parameter

    param

    Protected parameter to set

    value

    Value for the parameter

    returns

    This object

    Definition Classes
    HasProtectedParams
  100. def set[T](feature: StructFeature[T], value: T): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  101. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  102. def set[T](feature: SetFeature[T], value: Set[T]): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. def set[T](feature: ArrayFeature[T], value: Array[T]): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. final def set(paramPair: ParamPair[_]): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    Params
  105. final def set(param: String, value: Any): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    Params
  106. final def set[T](param: Param[T], value: T): UAEEmbeddings.this.type
    Definition Classes
    Params
  107. def setBatchSize(size: Int): UAEEmbeddings.this.type

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotate
  108. def setCaseSensitive(value: Boolean): UAEEmbeddings.this.type

    Whether to lowercase tokens or not

    Whether to lowercase tokens or not

    Definition Classes
    UAEEmbeddings → HasCaseSensitiveProperties
  109. def setConfigProtoBytes(bytes: Array[Int]): UAEEmbeddings.this.type

  110. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  111. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  112. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  113. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  114. final def setDefault(paramPairs: ParamPair[_]*): UAEEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    Params
  115. final def setDefault[T](param: Param[T], value: T): UAEEmbeddings.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  116. def setDimension(value: Int): UAEEmbeddings.this.type

    Set Embeddings dimensions for the BERT model Only possible to set this when the first time is saved dimension is not changeable, it comes from BERT config file

    Set Embeddings dimensions for the BERT model Only possible to set this when the first time is saved dimension is not changeable, it comes from BERT config file

    Definition Classes
    UAEEmbeddings → HasEmbeddingsProperties
  117. final def setInputCols(value: String*): UAEEmbeddings.this.type
    Definition Classes
    HasInputAnnotationCols
  118. def setInputCols(value: Array[String]): UAEEmbeddings.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  119. def setLazyAnnotator(value: Boolean): UAEEmbeddings.this.type
    Definition Classes
    CanBeLazy
  120. def setMaxSentenceLength(value: Int): UAEEmbeddings.this.type

  121. def setModelIfNotSet(spark: SparkSession, tensorflowWrapper: Option[TensorflowWrapper], onnxWrapper: Option[OnnxWrapper]): UAEEmbeddings

  122. final def setOutputCol(value: String): UAEEmbeddings.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  123. def setParent(parent: Estimator[UAEEmbeddings]): UAEEmbeddings
    Definition Classes
    Model
  124. def setPoolingStrategy(value: String): UAEEmbeddings.this.type

    Pooling strategy to use for sentence embeddings.

    Pooling strategy to use for sentence embeddings.

    Available pooling strategies for sentence embeddings are:

    • "cls": leading [CLS] token
    • "cls_avg": leading [CLS] token + mean of all other tokens
    • "last": embeddings of the last token in the sequence
    • "avg": mean of all tokens
    • "max": max of all embedding features of the entire token sequence
    • "int": An integer number, which represents the index of the token to use as the embedding
  125. def setSignatures(value: Map[String, String]): UAEEmbeddings.this.type

  126. def setStorageRef(value: String): UAEEmbeddings.this.type
    Definition Classes
    HasStorageRef
  127. def setVocabulary(value: Map[String, Int]): UAEEmbeddings.this.type

  128. val signatures: MapFeature[String, String]

    It contains TF model signatures for the laded saved model

  129. val storageRef: Param[String]

    Unique identifier for storage (Default: this.uid)

    Unique identifier for storage (Default: this.uid)

    Definition Classes
    HasStorageRef
  130. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  131. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  132. def tokenize(sentences: Seq[Annotation]): Seq[WordpieceTokenizedSentence]
  133. final def transform(dataset: Dataset[_]): DataFrame

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    dataset

    Dataset[Row]

    Definition Classes
    AnnotatorModel → Transformer
  134. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  135. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  136. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  137. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  138. val uid: String
    Definition Classes
    UAEEmbeddings → Identifiable
  139. def validate(schema: StructType): Boolean

    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
    RawAnnotator
  140. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit
    Definition Classes
    HasStorageRef
  141. val vocabulary: MapFeature[String, Int]

    Vocabulary used to encode the words to ids with WordPieceEncoder

  142. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  143. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  144. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  145. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  146. def wrapEmbeddingsMetadata(col: Column, embeddingsDim: Int, embeddingsRef: Option[String] = None): Column
    Attributes
    protected
    Definition Classes
    HasEmbeddingsProperties
  147. def wrapSentenceEmbeddingsMetadata(col: Column, embeddingsDim: Int, embeddingsRef: Option[String] = None): Column
    Attributes
    protected
    Definition Classes
    HasEmbeddingsProperties
  148. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  149. def writeOnnxModel(path: String, spark: SparkSession, onnxWrapper: OnnxWrapper, suffix: String, fileName: String): Unit
    Definition Classes
    WriteOnnxModel
  150. def writeOnnxModels(path: String, spark: SparkSession, onnxWrappersWithNames: Seq[(OnnxWrapper, String)], suffix: String, dataFileSuffix: String = "_data"): Unit
    Definition Classes
    WriteOnnxModel
  151. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String = "_use"): Unit
    Definition Classes
    WriteTensorflowModel
  152. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None): Unit
    Definition Classes
    WriteTensorflowModel
  153. def writeTensorflowModelV2(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None, savedSignatures: Option[Map[String, String]] = None): Unit
    Definition Classes
    WriteTensorflowModel

Inherited from HasEngine

Inherited from HasCaseSensitiveProperties

Inherited from HasStorageRef

Inherited from HasEmbeddingsProperties

Inherited from HasProtectedParams

Inherited from WriteOnnxModel

Inherited from WriteTensorflowModel

Inherited from HasBatchedAnnotate[UAEEmbeddings]

Inherited from AnnotatorModel[UAEEmbeddings]

Inherited from CanBeLazy

Inherited from RawAnnotator[UAEEmbeddings]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[UAEEmbeddings]

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 annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Members

Parameter setters

Parameter getters