Class/Object

com.johnsnowlabs.nlp.embeddings

AlbertEmbeddings

Related Docs: object AlbertEmbeddings | package embeddings

Permalink

class AlbertEmbeddings extends AnnotatorModel[AlbertEmbeddings] with HasBatchedAnnotate[AlbertEmbeddings] with WriteTensorflowModel with WriteSentencePieceModel with HasEmbeddingsProperties with HasStorageRef with HasCaseSensitiveProperties

ALBERT: A LITE BERT FOR SELF-SUPERVISED LEARNING OF LANGUAGE REPRESENTATIONS - Google Research, Toyota Technological Institute at Chicago

These word embeddings represent the outputs generated by the Albert model. All official Albert releases by google in TF-HUB are supported with this Albert Wrapper:

Ported TF-Hub Models:

"albert_base_uncased" | albert_base | 768-embed-dim, 12-layer, 12-heads, 12M parameters

"albert_large_uncased" | albert_large | 1024-embed-dim, 24-layer, 16-heads, 18M parameters

"albert_xlarge_uncased" | albert_xlarge | 2048-embed-dim, 24-layer, 32-heads, 60M parameters

"albert_xxlarge_uncased" | albert_xxlarge | 4096-embed-dim, 12-layer, 64-heads, 235M parameters

This model requires input tokenization with SentencePiece model, which is provided by Spark-NLP (See tokenizers package).

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

val embeddings = AlbertEmbeddings.pretrained()
 .setInputCols("sentence", "token")
 .setOutputCol("embeddings")

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

For extended examples of usage, see the Spark NLP Workshop and the AlbertEmbeddingsTestSpec. Models from the HuggingFace πŸ€— Transformers library are also compatible with Spark NLP πŸš€. The Spark NLP Workshop example shows how to import them https://github.com/JohnSnowLabs/spark-nlp/discussions/5669.

Sources:

ALBERT: A LITE BERT FOR SELF-SUPERVISED LEARNING OF LANGUAGE REPRESENTATIONS

https://github.com/google-research/ALBERT

https://tfhub.dev/s?q=albert

Paper abstract:

Increasing model size when pretraining natural language representations often results in improved performance on downstream tasks. However, at some point further model increases become harder due to GPU/TPU memory limitations and longer training times. To address these problems, we present two parameter reduction techniques to lower memory consumption and increase the training speed of BERT (Devlin et al., 2019). Comprehensive empirical evidence shows that our proposed methods lead to models that scale much better compared to the original BERT. We also use a self-supervised loss that focuses on modeling inter-sentence coherence, and show it consistently helps downstream tasks with multi-sentence inputs. As a result, our best model establishes new state-of-the-art results on the GLUE, RACE, and SQuAD benchmarks while having fewer parameters compared to BERT-large.

Tips: ALBERT uses repeating layers which results in a small memory footprint, however the computational cost remains similar to a BERT-like architecture with the same number of hidden layers as it has to iterate through the same number of (repeating) layers.

Example

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

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

val tokenizer = new Tokenizer()
  .setInputCols("document")
  .setOutputCol("token")

val embeddings = AlbertEmbeddings.pretrained()
  .setInputCols("token", "document")
  .setOutputCol("embeddings")

val embeddingsFinisher = new EmbeddingsFinisher()
  .setInputCols("embeddings")
  .setOutputCols("finished_embeddings")
  .setOutputAsVector(true)
  .setCleanAnnotations(false)

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

val data = Seq("This is a sentence.").toDF("text")
val result = pipeline.fit(data).transform(data)

result.selectExpr("explode(finished_embeddings) as result").show(5, 80)
+--------------------------------------------------------------------------------+
|                                                                          result|
+--------------------------------------------------------------------------------+
|[1.1342473030090332,-1.3855540752410889,0.9818322062492371,-0.784737348556518...|
|[0.847029983997345,-1.047153353691101,-0.1520637571811676,-0.6245765686035156...|
|[-0.009860038757324219,-0.13450059294700623,2.707749128341675,1.2916892766952...|
|[-0.04192575812339783,-0.5764210224151611,-0.3196685314178467,-0.527840495109...|
|[0.15583214163780212,-0.1614152491092682,-0.28423872590065,-0.135491415858268...|
+--------------------------------------------------------------------------------+
See also

Annotators Main Page for a list of transformer based embeddings

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

Instance Constructors

  1. new AlbertEmbeddings()

    Permalink

    Annotator reference id.

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

  2. new AlbertEmbeddings(uid: String)

    Permalink

    uid

    required uid for storing annotator to disk

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink

    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
  2. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

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. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AlbertEmbeddings β†’ AnnotatorModel
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def batchAnnotate(batchedAnnotations: Seq[Array[Annotation]]): Seq[Seq[Annotation]]

    Permalink

    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 in batches 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
    AlbertEmbeddings β†’ HasBatchedAnnotate
  13. def batchProcess(rows: Iterator[_]): Iterator[Row]

    Permalink
    Definition Classes
    HasBatchedAnnotate
  14. val batchSize: IntParam

    Permalink

    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[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  16. val caseSensitive: BooleanParam

    Permalink

    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

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. final def clear(param: Param[_]): AlbertEmbeddings.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. val configProtoBytes: IntArrayParam

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

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

  21. def copy(extra: ParamMap): AlbertEmbeddings

    Permalink

    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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  23. def createDatabaseConnection(database: Name): RocksDBConnection

    Permalink
    Definition Classes
    HasStorageRef
  24. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  25. val dimension: IntParam

    Permalink

    Number of embedding dimensions (Default depends on model)

    Number of embedding dimensions (Default depends on model)

    Definition Classes
    HasEmbeddingsProperties
  26. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef β†’ Any
  28. def explainParam(param: Param[_]): String

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  32. final def extractParamMap(): ParamMap

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def get[T](feature: StructFeature[T]): Option[T]

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

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

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

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

    Permalink
    Definition Classes
    Params
  41. def getBatchSize: Int

    Permalink

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotate
  42. def getCaseSensitive: Boolean

    Permalink

    Definition Classes
    HasCaseSensitiveProperties
  43. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef β†’ Any
  44. def getConfigProtoBytes: Option[Array[Byte]]

    Permalink

  45. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  46. def getDimension: Int

    Permalink

    Definition Classes
    HasEmbeddingsProperties
  47. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  48. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  49. def getMaxSentenceLength: Int

    Permalink

  50. def getModelIfNotSet: TensorflowAlbert

    Permalink
  51. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  52. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  54. def getSignatures: Option[Map[String, String]]

    Permalink

  55. def getStorageRef: String

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

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

    Permalink
    Definition Classes
    Params
  58. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  59. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef β†’ Any
  60. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. val inputAnnotatorTypes: Array[String]

    Permalink

    Input Annotator Types: DOCUMENT, TOKEN

    Input Annotator Types: DOCUMENT, TOKEN

    Definition Classes
    AlbertEmbeddings β†’ HasInputAnnotationCols
  63. 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
  64. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  69. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. def logDebug(msg: β‡’ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def logDebug(msg: β‡’ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  72. def logError(msg: β‡’ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. def logError(msg: β‡’ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. def logInfo(msg: β‡’ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  75. def logInfo(msg: β‡’ String): Unit

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  77. def logTrace(msg: β‡’ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  78. def logTrace(msg: β‡’ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  79. def logWarning(msg: β‡’ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  80. def logWarning(msg: β‡’ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  81. val maxSentenceLength: IntParam

    Permalink

    Max sentence length to process (Default: 128)

  82. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  83. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  86. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
  87. val outputAnnotatorType: AnnotatorType

    Permalink

    Output Annotator Types: WORD_EMBEDDINGS

    Output Annotator Types: WORD_EMBEDDINGS

    Definition Classes
    AlbertEmbeddings β†’ HasOutputAnnotatorType
  88. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  90. var parent: Estimator[AlbertEmbeddings]

    Permalink
    Definition Classes
    Model
  91. def save(path: String): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  99. def setBatchSize(size: Int): AlbertEmbeddings.this.type

    Permalink

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotate
  100. def setCaseSensitive(value: Boolean): AlbertEmbeddings.this.type

    Permalink

    Definition Classes
    HasCaseSensitiveProperties
  101. def setConfigProtoBytes(bytes: Array[Int]): AlbertEmbeddings.this.type

    Permalink

  102. def setDefault[T](feature: StructFeature[T], value: () β‡’ T): AlbertEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. def setDefault[K, V](feature: MapFeature[K, V], value: () β‡’ Map[K, V]): AlbertEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. def setDefault[T](feature: SetFeature[T], value: () β‡’ Set[T]): AlbertEmbeddings.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  105. def setDefault[T](feature: ArrayFeature[T], value: () β‡’ Array[T]): AlbertEmbeddings.this.type

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  108. def setDimension(value: Int): AlbertEmbeddings.this.type

    Permalink

    Definition Classes
    AlbertEmbeddings β†’ HasEmbeddingsProperties
  109. final def setInputCols(value: String*): AlbertEmbeddings.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  111. def setLazyAnnotator(value: Boolean): AlbertEmbeddings.this.type

    Permalink
    Definition Classes
    CanBeLazy
  112. def setMaxSentenceLength(value: Int): AlbertEmbeddings.this.type

    Permalink

  113. def setModelIfNotSet(spark: SparkSession, tensorflowWrapper: TensorflowWrapper, spp: SentencePieceWrapper): AlbertEmbeddings

    Permalink

  114. final def setOutputCol(value: String): AlbertEmbeddings.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  115. def setParent(parent: Estimator[AlbertEmbeddings]): AlbertEmbeddings

    Permalink
    Definition Classes
    Model
  116. def setSignatures(value: Map[String, String]): AlbertEmbeddings.this.type

    Permalink

  117. def setStorageRef(value: String): AlbertEmbeddings.this.type

    Permalink
    Definition Classes
    HasStorageRef
  118. val signatures: MapFeature[String, String]

    Permalink

    It contains TF model signatures for the laded saved model

  119. val storageRef: Param[String]

    Permalink

    Unique identifier for storage (Default: this.uid)

    Unique identifier for storage (Default: this.uid)

    Definition Classes
    HasStorageRef
  120. final def synchronized[T0](arg0: β‡’ T0): T0

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

    Permalink
    Definition Classes
    Identifiable β†’ AnyRef β†’ Any
  122. final def transform(dataset: Dataset[_]): DataFrame

    Permalink

    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
  123. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  124. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  125. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator β†’ PipelineStage
  126. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  127. val uid: String

    Permalink

    required uid for storing annotator to disk

    required uid for storing annotator to disk

    Definition Classes
    AlbertEmbeddings β†’ Identifiable
  128. 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
    RawAnnotator
  129. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit

    Permalink
    Definition Classes
    HasStorageRef
  130. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  134. def wrapEmbeddingsMetadata(col: Column, embeddingsDim: Int, embeddingsRef: Option[String] = None): Column

    Permalink
    Attributes
    protected
    Definition Classes
    HasEmbeddingsProperties
  135. def wrapSentenceEmbeddingsMetadata(col: Column, embeddingsDim: Int, embeddingsRef: Option[String] = None): Column

    Permalink
    Attributes
    protected
    Definition Classes
    HasEmbeddingsProperties
  136. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable β†’ DefaultParamsWritable β†’ MLWritable
  137. def writeSentencePieceModel(path: String, spark: SparkSession, spp: SentencePieceWrapper, suffix: String, filename: String): Unit

    Permalink
    Definition Classes
    WriteSentencePieceModel
  138. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String = "_use"): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel
  139. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel
  140. def writeTensorflowModelV2(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None, savedSignatures: Option[Map[String, String]] = None): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel

Inherited from HasStorageRef

Inherited from HasEmbeddingsProperties

Inherited from WriteSentencePieceModel

Inherited from WriteTensorflowModel

Inherited from CanBeLazy

Inherited from RawAnnotator[AlbertEmbeddings]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[AlbertEmbeddings]

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.

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters