Packages

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

JanusForMultiModal can load Janus models for unified multimodal understanding and generation. The model consists of a vision encoder, a text encoder, and a text decoder. Janus decouples visual encoding for enhanced flexibility, leveraging a unified transformer architecture for both understanding and generation tasks.

Janus uses SigLIP-L as the vision encoder, supporting 384 x 384 image inputs. For image generation, it utilizes a tokenizer with a downsample rate of 16. The framework is based on DeepSeek-LLM-1.3b-base, trained on approximately 500B text tokens.

Pretrained models can be loaded with pretrained from the companion object: {{ val visualQA = JanusForMultiModal.pretrained() .setInputCols("image_assembler") .setOutputCol("answer") }} The default model is "janus_1_3b_int4" if no name is provided.

For available pretrained models, please refer to the Models Hub.

Models from the HuggingFace 🤗 Transformers library are also compatible with Spark NLP 🚀. For compatibility details and import instructions, see https://github.com/JohnSnowLabs/spark-nlp/discussions/5669. For extended examples, refer to https://github.com/JohnSnowLabs/spark-nlp/blob/master/src/test/scala/com/johnsnowlabs/nlp/annotators/cv/JanusForMultiModalTest.scala.

Example

{{ import spark.implicits._

import com.johnsnowlabs.nlp.base._

import com.johnsnowlabs.nlp.annotator._

import org.apache.spark.ml.Pipeline

val imageDF: DataFrame = ResourceHelper.spark.read .format("image") .option("dropInvalid", value = true) .load(imageFolder)

val testDF: DataFrame = imageDF.withColumn("text", lit("User: <image_placeholder>Describe image in details Assistant:"))

val imageAssembler: ImageAssembler = new ImageAssembler() .setInputCol("image") .setOutputCol("image_assembler")

val visualQAClassifier = JanusForMultiModal.pretrained() .setInputCols("image_assembler") .setOutputCol("answer")

val pipeline = new Pipeline().setStages(Array( imageAssembler, visualQAClassifier ))

val result = pipeline.fit(testDF).transform(testDF)

result.select("image_assembler.origin", "answer.result").show(false)

origin

result

[file:///content/images/cat_image.jpg]

[The unusual aspect of this picture is the presence of two cats lying on a pink couch.]

}}

See also

CLIPForZeroShotClassification for Zero Shot Image Classification

Annotators Main Page for a list of transformer-based classifiers

Linear Supertypes
HasEngine, HasGeneratorProperties, WriteOpenvinoModel, HasImageFeatureProperties, HasBatchedAnnotateImage[JanusForMultiModal], AnnotatorModel[JanusForMultiModal], CanBeLazy, RawAnnotator[JanusForMultiModal], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[JanusForMultiModal], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. JanusForMultiModal
  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 JanusForMultiModal()

    Annotator reference id.

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

  2. new JanusForMultiModal(uid: String)

    uid

    Required UID for storing the annotator to disk

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
    JanusForMultiModal → 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[_]): JanusForMultiModal.this.type
    Definition Classes
    Params
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def copy(extra: ParamMap): JanusForMultiModal

    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. final val extraInputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  33. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  34. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

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

    Name of model's architecture for feature extraction

    Name of model's architecture for feature extraction

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

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotateImage
  47. def getBeamSize: Int

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

    Definition Classes
    HasImageFeatureProperties
  51. def getDoResize: Boolean

    Definition Classes
    HasImageFeatureProperties
  52. def getDoSample: Boolean

    Definition Classes
    HasGeneratorProperties
  53. def getEngine: String

    Definition Classes
    HasEngine
  54. def getFeatureExtractorType: String

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

  57. def getImageGenerateMode: Boolean

  58. def getImageMean: Array[Double]

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

    Definition Classes
    HasImageFeatureProperties
  60. def getImageToken: Int

  61. def getImageTokenLength: Int

  62. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  63. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  64. def getMaxOutputLength: Int

    Definition Classes
    HasGeneratorProperties
  65. def getMinOutputLength: Int

    Definition Classes
    HasGeneratorProperties
  66. def getModelIfNotSet: Janus

  67. def getNReturnSequences: Int

    Definition Classes
    HasGeneratorProperties
  68. def getNoRepeatNgramSize: Int

    Definition Classes
    HasGeneratorProperties
  69. def getNumOfParallelImages: Int

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

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  72. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  73. def getRandomSeed: Option[Long]

    Definition Classes
    HasGeneratorProperties
  74. def getRepetitionPenalty: Double

    Definition Classes
    HasGeneratorProperties
  75. def getResample: Int

    Definition Classes
    HasImageFeatureProperties
  76. def getSize: Int

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

    Definition Classes
    JanusForMultiModal → HasGeneratorProperties
  78. def getTask: Option[String]

    Definition Classes
    HasGeneratorProperties
  79. def getTemperature: Double

    Definition Classes
    HasGeneratorProperties
  80. def getTopK: Int

    Definition Classes
    HasGeneratorProperties
  81. def getTopP: Double

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

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

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

    max length of the input sequence (Default: 0)

    max length of the input sequence (Default: 0)

    Definition Classes
    HasGeneratorProperties
  114. 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
  115. val merges: MapFeature[(String, String), Int]

    Holding merges.txt coming from RoBERTa model

  116. 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
  117. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  118. 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
  119. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  120. 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
  121. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  122. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  123. val numOfParallelImages: IntParam
  124. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    JanusForMultiModal → ParamsAndFeaturesWritable
  125. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  126. val outputAnnotatorType: AnnotatorType
    Definition Classes
    JanusForMultiModal → HasOutputAnnotatorType
  127. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  128. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  129. var parent: Estimator[JanusForMultiModal]
    Definition Classes
    Model
  130. 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
  131. 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
  132. 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
  133. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  134. def set[T](feature: StructFeature[T], value: T): JanusForMultiModal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  135. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): JanusForMultiModal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  136. def set[T](feature: SetFeature[T], value: Set[T]): JanusForMultiModal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  137. def set[T](feature: ArrayFeature[T], value: Array[T]): JanusForMultiModal.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  138. final def set(paramPair: ParamPair[_]): JanusForMultiModal.this.type
    Attributes
    protected
    Definition Classes
    Params
  139. final def set(param: String, value: Any): JanusForMultiModal.this.type
    Attributes
    protected
    Definition Classes
    Params
  140. final def set[T](param: Param[T], value: T): JanusForMultiModal.this.type
    Definition Classes
    Params
  141. def setAddedTokens(value: Map[String, Int]): JanusForMultiModal.this.type

  142. def setBatchSize(size: Int): JanusForMultiModal.this.type

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotateImage
  143. def setBeamSize(beamNum: Int): JanusForMultiModal.this.type

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

    Definition Classes
    HasImageFeatureProperties
  151. def setDoResize(value: Boolean): JanusForMultiModal.this.type

    Definition Classes
    HasImageFeatureProperties
  152. def setDoSample(value: Boolean): JanusForMultiModal.this.type

    Definition Classes
    HasGeneratorProperties
  153. def setExtraInputCols(value: Array[String]): JanusForMultiModal.this.type
    Definition Classes
    HasInputAnnotationCols
  154. def setFeatureExtractorType(value: String): JanusForMultiModal.this.type

    Definition Classes
    HasImageFeatureProperties
  155. def setGenerationConfig(value: GenerationConfig): JanusForMultiModal.this.type
  156. def setIgnoreTokenIds(tokenIds: Array[Int]): JanusForMultiModal.this.type

  157. def setImageGenerateMode(value: Boolean): JanusForMultiModal.this.type

  158. def setImageMean(value: Array[Double]): JanusForMultiModal.this.type

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

    Definition Classes
    HasImageFeatureProperties
  160. def setImageToken(value: Int): JanusForMultiModal.this.type

  161. def setImageTokenLength(value: Int): JanusForMultiModal.this.type

  162. final def setInputCols(value: String*): JanusForMultiModal.this.type
    Definition Classes
    HasInputAnnotationCols
  163. def setInputCols(value: Array[String]): JanusForMultiModal.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  164. def setLazyAnnotator(value: Boolean): JanusForMultiModal.this.type
    Definition Classes
    CanBeLazy
  165. def setMaxInputLength(value: Int): JanusForMultiModal.this.type
    Definition Classes
    HasGeneratorProperties
  166. def setMaxOutputLength(value: Int): JanusForMultiModal.this.type

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

  168. def setMinOutputLength(value: Int): JanusForMultiModal.this.type

    Definition Classes
    HasGeneratorProperties
  169. def setModelIfNotSet(spark: SparkSession, preprocessor: Preprocessor, onnxWrappers: Option[DecoderWrappers], openvinoWrapper: Option[JanusWrappers]): JanusForMultiModal.this.type

  170. def setNReturnSequences(beamNum: Int): JanusForMultiModal.this.type

    Definition Classes
    HasGeneratorProperties
  171. def setNoRepeatNgramSize(value: Int): JanusForMultiModal.this.type

    Definition Classes
    HasGeneratorProperties
  172. def setNumOfParallelImages(value: Int): JanusForMultiModal.this.type

  173. final def setOutputCol(value: String): JanusForMultiModal.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  174. def setParent(parent: Estimator[JanusForMultiModal]): JanusForMultiModal
    Definition Classes
    Model
  175. def setRandomSeed(value: Long): JanusForMultiModal.this.type

    Definition Classes
    HasGeneratorProperties
  176. def setRepetitionPenalty(value: Double): JanusForMultiModal.this.type

    Definition Classes
    HasGeneratorProperties
  177. def setResample(value: Int): JanusForMultiModal.this.type

    Definition Classes
    HasImageFeatureProperties
  178. def setSize(value: Int): JanusForMultiModal.this.type

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

    Definition Classes
    JanusForMultiModal → HasGeneratorProperties
  180. def setTask(value: String): JanusForMultiModal.this.type

    Definition Classes
    HasGeneratorProperties
  181. def setTemperature(value: Double): JanusForMultiModal.this.type

    Definition Classes
    HasGeneratorProperties
  182. def setTopK(value: Int): JanusForMultiModal.this.type

    Definition Classes
    HasGeneratorProperties
  183. def setTopP(value: Double): JanusForMultiModal.this.type

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

  185. 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
  186. val stopTokenIds: IntArrayParam

    Stop tokens to terminate the generation

    Stop tokens to terminate the generation

    Definition Classes
    JanusForMultiModal → HasGeneratorProperties
  187. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  188. val task: Param[String]

    Set transformer task, e.g.

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

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

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

  201. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  202. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  203. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  204. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  205. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  206. def writeOpenvinoModel(path: String, spark: SparkSession, openvinoWrapper: OpenvinoWrapper, suffix: String, fileName: String): Unit
    Definition Classes
    WriteOpenvinoModel
  207. 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[JanusForMultiModal]

Inherited from AnnotatorModel[JanusForMultiModal]

Inherited from CanBeLazy

Inherited from RawAnnotator[JanusForMultiModal]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[JanusForMultiModal]

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