Packages

class E5VEmbeddings extends AnnotatorModel[E5VEmbeddings] with HasBatchedAnnotateImage[E5VEmbeddings] with HasImageFeatureProperties with WriteOpenvinoModel with HasGeneratorProperties with HasEngine

E5VEmbeddings provides universal multimodal embeddings using the E5-V model, which is fine-tuned from lmms-lab/llama3-llava-next-8b.

E5-V bridges the modality gap between different input types (text, image) and demonstrates strong performance in multimodal embeddings, even without fine-tuning. It also supports a single-modality training approach, where the model is trained exclusively on text pairs, often yielding better performance than multimodal training.

For more details, see the Hugging Face model card: https://huggingface.co/royokong/e5-v

Overview

E5-V can embed both text and images into a shared space, enabling cross-modal retrieval and similarity tasks. The model is designed for universal embeddings and is suitable for scenarios where you want to compare or retrieve across modalities.

Example

Image + Text Embedding

{{ { import org.apache.spark.sql.functions.lit import com.johnsnowlabs.nlp.base.ImageAssembler import com.johnsnowlabs.nlp.embeddings.E5VEmbeddings import org.apache.spark.ml.Pipeline

val imageDF = spark.read.format("image").option("dropInvalid", value = true).load(imageFolder) val imagePrompt = "<|start_header_id|>user<|end_header_id|>\n\n<image>\\nSummary above image in one word: <|eot_id|><|start_header_id|>assistant<|end_header_id|>\n\n \n" val testDF = imageDF.withColumn("text", lit(imagePrompt))

val imageAssembler = new ImageAssembler().setInputCol("image").setOutputCol("image_assembler") val e5vEmbeddings = E5VEmbeddings.pretrained() .setInputCols("image_assembler") .setOutputCol("e5v")

val pipeline = new Pipeline().setStages(Array(imageAssembler, e5vEmbeddings)) val result = pipeline.fit(testDF).transform(testDF) result.select("e5v.embeddings").show(truncate = false) }}

Text-Only Embedding

{{ { import org.apache.spark.sql.SparkSession import org.apache.spark.sql.functions.lit import com.johnsnowlabs.nlp.util.EmbeddingsDataFrameUtils.{emptyImageRow, imageSchema} import com.johnsnowlabs.nlp.embeddings.E5VEmbeddings

val spark: SparkSession = ... val textPrompt = "<|start_header_id|>user<|end_header_id|>\n\n<sent>\\nSummary above sentence in one word: <|eot_id|><|start_header_id|>assistant<|end_header_id|>\n\n \n" val textDesc = "A cat sitting in a box." val nullImageDF = spark.createDataFrame(spark.sparkContext.parallelize(Seq(emptyImageRow)), imageSchema) val textDF = nullImageDF.withColumn("text", lit(textPrompt.replace("<sent>", textDesc)))

val e5vEmbeddings = E5VEmbeddings.pretrained() .setInputCols("image") .setOutputCol("e5v") val result = e5vEmbeddings.transform(textDF) result.select("e5v.embeddings").show(truncate = false) }}

References

  • Hugging Face model card: https://huggingface.co/royokong/e5-v
  • Paper: https://arxiv.org/abs/2407.12580
  • Code: https://github.com/kongds/E5-V
See also

CLIPForZeroShotClassification for Zero Shot Image Classifier

Annotators Main Page for a list of transformer based classifiers

Linear Supertypes
HasEngine, HasGeneratorProperties, WriteOpenvinoModel, HasImageFeatureProperties, HasBatchedAnnotateImage[E5VEmbeddings], AnnotatorModel[E5VEmbeddings], CanBeLazy, RawAnnotator[E5VEmbeddings], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[E5VEmbeddings], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. E5VEmbeddings
  2. HasEngine
  3. HasGeneratorProperties
  4. WriteOpenvinoModel
  5. HasImageFeatureProperties
  6. HasBatchedAnnotateImage
  7. AnnotatorModel
  8. CanBeLazy
  9. RawAnnotator
  10. HasOutputAnnotationCol
  11. HasInputAnnotationCols
  12. HasOutputAnnotatorType
  13. ParamsAndFeaturesWritable
  14. HasFeatures
  15. DefaultParamsWritable
  16. MLWritable
  17. Model
  18. Transformer
  19. PipelineStage
  20. Logging
  21. Params
  22. Serializable
  23. Serializable
  24. Identifiable
  25. AnyRef
  26. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new E5VEmbeddings()

    Annotator reference id.

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

  2. new E5VEmbeddings(uid: String)

Type Members

  1. 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
  2. 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. val addedTokens: MapFeature[String, Int]

    Additional tokens to be added to the vocabulary

  11. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def batchAnnotate(batchedAnnotations: Seq[Array[AnnotationImage]]): 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 in batches that correspond to inputAnnotationCols generated by previous annotators if any

    returns

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

    Definition Classes
    E5VEmbeddings → HasBatchedAnnotateImage
  14. def batchProcess(rows: Iterator[_]): Iterator[Row]
    Definition Classes
    HasBatchedAnnotateImage
  15. val batchSize: IntParam

    Size of every batch (Default depends on model).

    Size of every batch (Default depends on model).

    Definition Classes
    HasBatchedAnnotateImage
  16. val beamSize: IntParam

    Beam size for the beam search algorithm (Default: 4)

    Beam size for the beam search algorithm (Default: 4)

    Definition Classes
    HasGeneratorProperties
  17. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  18. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  19. final def clear(param: Param[_]): E5VEmbeddings.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def copy(extra: ParamMap): E5VEmbeddings

    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. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. val doNormalize: BooleanParam

    Whether or not to normalize the input with mean and standard deviation

    Whether or not to normalize the input with mean and standard deviation

    Definition Classes
    HasImageFeatureProperties
  25. val doResize: BooleanParam

    Whether to resize the input to a certain size

    Whether to resize the input to a certain size

    Definition Classes
    HasImageFeatureProperties
  26. val doSample: BooleanParam

    Whether or not to use sampling, use greedy decoding otherwise (Default: false)

    Whether or not to use sampling, use greedy decoding otherwise (Default: false)

    Definition Classes
    HasGeneratorProperties
  27. 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
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  30. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  31. def explainParams(): String
    Definition Classes
    Params
  32. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  33. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  34. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  35. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  36. val featureExtractorType: Param[String]

    Name of model's architecture for feature extraction

    Name of model's architecture for feature extraction

    Definition Classes
    HasImageFeatureProperties
  37. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. val generationConfig: StructFeature[GenerationConfig]
  40. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  42. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  43. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  44. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  45. def getBatchSize: Int

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotateImage
  46. def getBeamSize: Int

    Definition Classes
    HasGeneratorProperties
  47. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  48. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  49. def getDoNormalize: Boolean

    Definition Classes
    HasImageFeatureProperties
  50. def getDoResize: Boolean

    Definition Classes
    HasImageFeatureProperties
  51. def getDoSample: Boolean

    Definition Classes
    HasGeneratorProperties
  52. def getEngine: String

    Definition Classes
    HasEngine
  53. def getFeatureExtractorType: String

    Definition Classes
    HasImageFeatureProperties
  54. def getGenerationConfig: GenerationConfig
  55. def getIgnoreTokenIds: Array[Int]

  56. def getImageGridPinpoints: Map[Int, Array[Int]]

  57. def getImageMean: Array[Double]

    Definition Classes
    HasImageFeatureProperties
  58. def getImageStd: Array[Double]

    Definition Classes
    HasImageFeatureProperties
  59. def getImageToken: Int

  60. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  61. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  62. def getMaxOutputLength: Int

    Definition Classes
    HasGeneratorProperties
  63. def getMinOutputLength: Int

    Definition Classes
    HasGeneratorProperties
  64. def getModelIfNotSet: E5V

  65. def getNReturnSequences: Int

    Definition Classes
    HasGeneratorProperties
  66. def getNoRepeatNgramSize: Int

    Definition Classes
    HasGeneratorProperties
  67. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  68. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  69. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  70. def getPatchSize: Int

  71. def getRandomSeed: Option[Long]

    Definition Classes
    HasGeneratorProperties
  72. def getRepetitionPenalty: Double

    Definition Classes
    HasGeneratorProperties
  73. def getResample: Int

    Definition Classes
    HasImageFeatureProperties
  74. def getSize: Int

    Definition Classes
    HasImageFeatureProperties
  75. def getStopTokenIds: Array[Int]

    Definition Classes
    E5VEmbeddings → HasGeneratorProperties
  76. def getTask: Option[String]

    Definition Classes
    HasGeneratorProperties
  77. def getTemperature: Double

    Definition Classes
    HasGeneratorProperties
  78. def getTopK: Int

    Definition Classes
    HasGeneratorProperties
  79. def getTopP: Double

    Definition Classes
    HasGeneratorProperties
  80. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  81. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  82. def hasParent: Boolean
    Definition Classes
    Model
  83. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  84. var ignoreTokenIds: IntArrayParam

    A list of token ids which are ignored in the decoder's output (Default: Array())

  85. val imageGridPinpoints: MapFeature[Int, Array[Int]]

    Pinpoints for image grid, used to extract image features from the grid

  86. val imageMean: DoubleArrayParam

    The sequence of means for each channel, to be used when normalizing images

    The sequence of means for each channel, to be used when normalizing images

    Definition Classes
    HasImageFeatureProperties
  87. val imageStd: DoubleArrayParam

    The sequence of standard deviations for each channel, to be used when normalizing images

    The sequence of standard deviations for each channel, to be used when normalizing images

    Definition Classes
    HasImageFeatureProperties
  88. val imageToken: IntParam
  89. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  90. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. val inputAnnotatorTypes: Array[AnnotatorType]

    Annotator reference id.

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

    Definition Classes
    E5VEmbeddings → HasInputAnnotationCols
  92. 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
  93. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  94. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  95. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  96. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  97. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  98. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  99. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  100. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  101. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  102. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  103. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  104. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  105. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  106. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  107. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  108. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  109. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  110. val maxInputLength: IntParam

    max length of the input sequence (Default: 0)

    max length of the input sequence (Default: 0)

    Definition Classes
    HasGeneratorProperties
  111. val maxOutputLength: IntParam

    Maximum length of the sequence to be generated (Default: 20)

    Maximum length of the sequence to be generated (Default: 20)

    Definition Classes
    HasGeneratorProperties
  112. val merges: MapFeature[(String, String), Int]

    Holding merges.txt coming from RoBERTa model

  113. val minOutputLength: IntParam

    Minimum length of the sequence to be generated (Default: 0)

    Minimum length of the sequence to be generated (Default: 0)

    Definition Classes
    HasGeneratorProperties
  114. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  115. val nReturnSequences: IntParam

    The number of sequences to return from the beam search.

    The number of sequences to return from the beam search.

    Definition Classes
    HasGeneratorProperties
  116. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  117. val noRepeatNgramSize: IntParam

    If set to int > 0, all ngrams of that size can only occur once (Default: 0)

    If set to int > 0, all ngrams of that size can only occur once (Default: 0)

    Definition Classes
    HasGeneratorProperties
  118. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  119. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  120. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    E5VEmbeddings → ParamsAndFeaturesWritable
  121. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  122. val outputAnnotatorType: AnnotatorType
    Definition Classes
    E5VEmbeddings → HasOutputAnnotatorType
  123. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  124. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  125. var parent: Estimator[E5VEmbeddings]
    Definition Classes
    Model
  126. val patchSize: IntParam

    Patch size for image embeddings

  127. val randomSeed: Option[Long]

    Optional Random seed for the model.

    Optional Random seed for the model. Needs to be of type Int.

    Definition Classes
    HasGeneratorProperties
  128. val repetitionPenalty: DoubleParam

    The parameter for repetition penalty (Default: 1.0).

    The parameter for repetition penalty (Default: 1.0). 1.0 means no penalty. See this paper for more details.

    Definition Classes
    HasGeneratorProperties
  129. val resample: IntParam

    An optional resampling filter.

    An optional resampling filter. This can be one of PIL.Image.NEAREST, PIL.Image.BOX, PIL.Image.BILINEAR, PIL.Image.HAMMING, PIL.Image.BICUBIC or PIL.Image.LANCZOS. Only has an effect if do_resize is set to True

    Definition Classes
    HasImageFeatureProperties
  130. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  131. def set[T](feature: StructFeature[T], value: T): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  132. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  133. def set[T](feature: SetFeature[T], value: Set[T]): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  134. def set[T](feature: ArrayFeature[T], value: Array[T]): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  135. final def set(paramPair: ParamPair[_]): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    Params
  136. final def set(param: String, value: Any): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    Params
  137. final def set[T](param: Param[T], value: T): E5VEmbeddings.this.type
    Definition Classes
    Params
  138. def setAddedTokens(value: Map[String, Int]): E5VEmbeddings.this.type

  139. def setBatchSize(size: Int): E5VEmbeddings.this.type

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotateImage
  140. def setBeamSize(beamNum: Int): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  141. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  142. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  143. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  144. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  145. final def setDefault(paramPairs: ParamPair[_]*): E5VEmbeddings.this.type
    Attributes
    protected
    Definition Classes
    Params
  146. final def setDefault[T](param: Param[T], value: T): E5VEmbeddings.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  147. def setDoNormalize(value: Boolean): E5VEmbeddings.this.type

    Definition Classes
    HasImageFeatureProperties
  148. def setDoResize(value: Boolean): E5VEmbeddings.this.type

    Definition Classes
    HasImageFeatureProperties
  149. def setDoSample(value: Boolean): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  150. def setFeatureExtractorType(value: String): E5VEmbeddings.this.type

    Definition Classes
    HasImageFeatureProperties
  151. def setGenerationConfig(value: GenerationConfig): E5VEmbeddings.this.type
  152. def setIgnoreTokenIds(tokenIds: Array[Int]): E5VEmbeddings.this.type

  153. def setImageGridPinpoints(value: Map[Int, Array[Int]]): E5VEmbeddings.this.type

  154. def setImageMean(value: Array[Double]): E5VEmbeddings.this.type

    Definition Classes
    HasImageFeatureProperties
  155. def setImageStd(value: Array[Double]): E5VEmbeddings.this.type

    Definition Classes
    HasImageFeatureProperties
  156. def setImageToken(value: Int): E5VEmbeddings.this.type

  157. final def setInputCols(value: String*): E5VEmbeddings.this.type
    Definition Classes
    HasInputAnnotationCols
  158. def setInputCols(value: Array[String]): E5VEmbeddings.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  159. def setLazyAnnotator(value: Boolean): E5VEmbeddings.this.type
    Definition Classes
    CanBeLazy
  160. def setMaxInputLength(value: Int): E5VEmbeddings.this.type
    Definition Classes
    HasGeneratorProperties
  161. def setMaxOutputLength(value: Int): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  162. def setMerges(value: Map[(String, String), Int]): E5VEmbeddings.this.type

  163. def setMinOutputLength(value: Int): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  164. def setModelIfNotSet(spark: SparkSession, preprocessor: Preprocessor, onnxWrappers: Option[DecoderWrappers], openvinoWrapper: Option[E5VWrappers]): E5VEmbeddings.this.type

  165. def setNReturnSequences(beamNum: Int): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  166. def setNoRepeatNgramSize(value: Int): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  167. final def setOutputCol(value: String): E5VEmbeddings.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  168. def setParent(parent: Estimator[E5VEmbeddings]): E5VEmbeddings
    Definition Classes
    Model
  169. def setPatchSize(value: Int): E5VEmbeddings.this.type

  170. def setRandomSeed(value: Int): E5VEmbeddings.this.type

  171. def setRandomSeed(value: Long): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  172. def setRepetitionPenalty(value: Double): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  173. def setResample(value: Int): E5VEmbeddings.this.type

    Definition Classes
    HasImageFeatureProperties
  174. def setSize(value: Int): E5VEmbeddings.this.type

    Definition Classes
    HasImageFeatureProperties
  175. def setStopTokenIds(value: Array[Int]): E5VEmbeddings.this.type

    Definition Classes
    E5VEmbeddings → HasGeneratorProperties
  176. def setTask(value: String): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  177. def setTemperature(value: Double): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  178. def setTopK(value: Int): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  179. def setTopP(value: Double): E5VEmbeddings.this.type

    Definition Classes
    HasGeneratorProperties
  180. def setVocabulary(value: Map[String, Int]): E5VEmbeddings.this.type

  181. val size: IntParam

    Resize the input to the given size.

    Resize the input to the given size. If a tuple is provided, it should be (width, height). If only an integer is provided, then the input will be resized to (size, size). Only has an effect if do_resize is set to True.

    Definition Classes
    HasImageFeatureProperties
  182. val stopTokenIds: IntArrayParam

    Stop tokens to terminate the generation

    Stop tokens to terminate the generation

    Definition Classes
    E5VEmbeddings → HasGeneratorProperties
  183. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  184. val task: Param[String]

    Set transformer task, e.g.

    Set transformer task, e.g. "summarize:" (Default: "").

    Definition Classes
    HasGeneratorProperties
  185. val temperature: DoubleParam

    The value used to module the next token probabilities (Default: 1.0)

    The value used to module the next token probabilities (Default: 1.0)

    Definition Classes
    HasGeneratorProperties
  186. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  187. val topK: IntParam

    The number of highest probability vocabulary tokens to keep for top-k-filtering (Default: 50)

    The number of highest probability vocabulary tokens to keep for top-k-filtering (Default: 50)

    Definition Classes
    HasGeneratorProperties
  188. val topP: DoubleParam

    If set to float < 1.0, only the most probable tokens with probabilities that add up to topP or higher are kept for generation (Default: 1.0)

    If set to float < 1.0, only the most probable tokens with probabilities that add up to topP or higher are kept for generation (Default: 1.0)

    Definition Classes
    HasGeneratorProperties
  189. 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
  190. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  191. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  192. 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
  193. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  194. val uid: String
    Definition Classes
    E5VEmbeddings → Identifiable
  195. 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
  196. val vocabulary: MapFeature[String, Int]

    Vocabulary used to encode the words to ids with bpeTokenizer.encode

  197. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  198. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  199. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  200. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  201. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  202. def writeOpenvinoModel(path: String, spark: SparkSession, openvinoWrapper: OpenvinoWrapper, suffix: String, fileName: String): Unit
    Definition Classes
    WriteOpenvinoModel
  203. def writeOpenvinoModels(path: String, spark: SparkSession, ovWrappersWithNames: Seq[(OpenvinoWrapper, String)], suffix: String): Unit
    Definition Classes
    WriteOpenvinoModel

Inherited from HasEngine

Inherited from HasGeneratorProperties

Inherited from WriteOpenvinoModel

Inherited from HasImageFeatureProperties

Inherited from HasBatchedAnnotateImage[E5VEmbeddings]

Inherited from AnnotatorModel[E5VEmbeddings]

Inherited from CanBeLazy

Inherited from RawAnnotator[E5VEmbeddings]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[E5VEmbeddings]

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