Packages

class CLIPForZeroShotClassification extends AnnotatorModel[CLIPForZeroShotClassification] with HasBatchedAnnotateImage[CLIPForZeroShotClassification] with HasImageFeatureProperties with WriteTensorflowModel with WriteOnnxModel with WriteOpenvinoModel with HasEngine with HasRescaleFactor

Zero Shot Image Classifier based on CLIP.

CLIP (Contrastive Language-Image Pre-Training) is a neural network that was trained on image and text pairs. It has the ability to predict images without training on any hard-coded labels. This makes it very flexible, as labels can be provided during inference. This is similar to the zero-shot capabilities of the GPT-2 and 3 models.

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

val imageClassifier = CLIPForZeroShotClassification.pretrained()
  .setInputCols("image_assembler")
  .setOutputCol("label")

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

For available pretrained models please see the Models Hub.

Models from the HuggingFace 🤗 Transformers library are also compatible with Spark NLP 🚀. To see which models are compatible and how to import them see https://github.com/JohnSnowLabs/spark-nlp/discussions/5669 and to see more extended examples, see CLIPForZeroShotClassificationTestSpec.

Example

import com.johnsnowlabs.nlp.ImageAssembler
import com.johnsnowlabs.nlp.annotator._
import org.apache.spark.ml.Pipeline

val imageDF = ResourceHelper.spark.read
  .format("image")
  .option("dropInvalid", value = true)
  .load("src/test/resources/image/")

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

val candidateLabels = Array(
  "a photo of a bird",
  "a photo of a cat",
  "a photo of a dog",
  "a photo of a hen",
  "a photo of a hippo",
  "a photo of a room",
  "a photo of a tractor",
  "a photo of an ostrich",
  "a photo of an ox")

val imageClassifier = CLIPForZeroShotClassification
  .pretrained()
  .setInputCols("image_assembler")
  .setOutputCol("label")
  .setCandidateLabels(candidateLabels)

val pipeline =
  new Pipeline().setStages(Array(imageAssembler, imageClassifier)).fit(imageDF).transform(imageDF)

pipeline
  .selectExpr("reverse(split(image.origin, '/'))[0] as image_name", "label.result")
  .show(truncate = false)
+-----------------+-----------------------+
|image_name       |result                 |
+-----------------+-----------------------+
|palace.JPEG      |[a photo of a room]    |
|egyptian_cat.jpeg|[a photo of a cat]     |
|hippopotamus.JPEG|[a photo of a hippo]   |
|hen.JPEG         |[a photo of a hen]     |
|ostrich.JPEG     |[a photo of an ostrich]|
|junco.JPEG       |[a photo of a bird]    |
|bluetick.jpg     |[a photo of a dog]     |
|chihuahua.jpg    |[a photo of a dog]     |
|tractor.JPEG     |[a photo of a tractor] |
|ox.JPEG          |[a photo of an ox]     |
+-----------------+-----------------------+
Linear Supertypes
HasRescaleFactor, HasEngine, WriteOpenvinoModel, WriteOnnxModel, WriteTensorflowModel, HasImageFeatureProperties, HasBatchedAnnotateImage[CLIPForZeroShotClassification], AnnotatorModel[CLIPForZeroShotClassification], CanBeLazy, RawAnnotator[CLIPForZeroShotClassification], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[CLIPForZeroShotClassification], Transformer, PipelineStage, Logging, Params, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. CLIPForZeroShotClassification
  2. HasRescaleFactor
  3. HasEngine
  4. WriteOpenvinoModel
  5. WriteOnnxModel
  6. WriteTensorflowModel
  7. HasImageFeatureProperties
  8. HasBatchedAnnotateImage
  9. AnnotatorModel
  10. CanBeLazy
  11. RawAnnotator
  12. HasOutputAnnotationCol
  13. HasInputAnnotationCols
  14. HasOutputAnnotatorType
  15. ParamsAndFeaturesWritable
  16. HasFeatures
  17. DefaultParamsWritable
  18. MLWritable
  19. Model
  20. Transformer
  21. PipelineStage
  22. Logging
  23. Params
  24. Serializable
  25. Identifiable
  26. AnyRef
  27. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CLIPForZeroShotClassification()

    Annotator reference id.

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

  2. new CLIPForZeroShotClassification(uid: String)

    uid

    required uid for storing 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. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. 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 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
    CLIPForZeroShotClassification → HasBatchedAnnotateImage
  13. def batchProcess(rows: Iterator[_]): Iterator[Row]
    Definition Classes
    HasBatchedAnnotateImage
  14. val batchSize: IntParam

    Size of every batch (Default depends on model).

    Size of every batch (Default depends on model).

    Definition Classes
    HasBatchedAnnotateImage
  15. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  16. val candidateLabels: StringArrayParam

    Candidate labels for classification, you can set candidateLabels dynamically during the runtime

  17. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. final def clear(param: Param[_]): CLIPForZeroShotClassification.this.type
    Definition Classes
    Params
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  20. def copy(extra: ParamMap): CLIPForZeroShotClassification

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  21. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  22. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  23. 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
  24. val doRescale: BooleanParam

    Whether to rescale the image values by rescaleFactor.

    Whether to rescale the image values by rescaleFactor.

    Definition Classes
    HasRescaleFactor
  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 engine: Param[String]

    This param is set internally once via loadSavedModel.

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

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

    Override for additional custom schema checks

    Override for additional custom schema checks

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

    Name of model's architecture for feature extraction

    Name of model's architecture for feature extraction

    Definition Classes
    HasImageFeatureProperties
  36. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  37. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  42. def getBatchSize: Int

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotateImage
  43. def getCandidateLabels: Array[String]

  44. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  45. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  46. def getDoNormalize: Boolean

    Definition Classes
    HasImageFeatureProperties
  47. def getDoRescale: Boolean

    Definition Classes
    HasRescaleFactor
  48. def getDoResize: Boolean

    Definition Classes
    HasImageFeatureProperties
  49. def getEngine: String

    Definition Classes
    HasEngine
  50. def getFeatureExtractorType: String

    Definition Classes
    HasImageFeatureProperties
  51. def getImageMean: Array[Double]

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

    Definition Classes
    HasImageFeatureProperties
  53. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  54. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  55. def getMerges: Map[(String, String), Int]

    Attributes
    protected[nlp]
  56. def getModelIfNotSet: CLIP

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

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  59. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  60. def getResample: Int

    Definition Classes
    HasImageFeatureProperties
  61. def getRescaleFactor: Double

    Definition Classes
    HasRescaleFactor
  62. def getSize: Int

    Definition Classes
    HasImageFeatureProperties
  63. def getVocabulary: Map[String, Int]

    Attributes
    protected[nlp]
  64. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  65. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  66. def hasParent: Boolean
    Definition Classes
    Model
  67. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  68. 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
  69. 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
  70. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  71. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator type : IMAGE

    Input annotator type : IMAGE

    Definition Classes
    CLIPForZeroShotClassification → HasInputAnnotationCols
  73. 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
  74. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  75. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  76. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  77. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  78. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  79. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  80. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  87. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  91. val merges: MapFeature[(String, String), Int]

    Holding merges.txt for BPE Tokenization

    Holding merges.txt for BPE Tokenization

    Attributes
    protected[nlp]
  92. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  93. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  94. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  95. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  96. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    CLIPForZeroShotClassification → ParamsAndFeaturesWritable
  97. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  98. val outputAnnotatorType: AnnotatorType

    Output annotator type : CATEGORY

    Output annotator type : CATEGORY

    Definition Classes
    CLIPForZeroShotClassification → HasOutputAnnotatorType
  99. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  100. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  101. var parent: Estimator[CLIPForZeroShotClassification]
    Definition Classes
    Model
  102. 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
  103. val rescaleFactor: DoubleParam

    Factor to scale the image values (Default: 1 / 255.0).

    Factor to scale the image values (Default: 1 / 255.0).

    Definition Classes
    HasRescaleFactor
  104. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @throws("If the input path already exists but overwrite is not enabled.") @Since("1.6.0")
  105. def set[T](feature: StructFeature[T], value: T): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  107. def set[T](feature: SetFeature[T], value: Set[T]): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  108. def set[T](feature: ArrayFeature[T], value: Array[T]): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  109. final def set(paramPair: ParamPair[_]): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    Params
  110. final def set(param: String, value: Any): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    Params
  111. final def set[T](param: Param[T], value: T): CLIPForZeroShotClassification.this.type
    Definition Classes
    Params
  112. def setBatchSize(size: Int): CLIPForZeroShotClassification.this.type

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotateImage
  113. def setCandidateLabels(value: Array[String]): CLIPForZeroShotClassification.this.type

  114. def setDefault[T](feature: StructFeature[T], value: () => T): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  115. def setDefault[K, V](feature: MapFeature[K, V], value: () => Map[K, V]): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  116. def setDefault[T](feature: SetFeature[T], value: () => Set[T]): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  117. def setDefault[T](feature: ArrayFeature[T], value: () => Array[T]): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  118. final def setDefault(paramPairs: ParamPair[_]*): CLIPForZeroShotClassification.this.type
    Attributes
    protected
    Definition Classes
    Params
  119. final def setDefault[T](param: Param[T], value: T): CLIPForZeroShotClassification.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  120. def setDoNormalize(value: Boolean): CLIPForZeroShotClassification.this.type

    Definition Classes
    HasImageFeatureProperties
  121. def setDoRescale(value: Boolean): CLIPForZeroShotClassification.this.type

    Definition Classes
    HasRescaleFactor
  122. def setDoResize(value: Boolean): CLIPForZeroShotClassification.this.type

    Definition Classes
    HasImageFeatureProperties
  123. def setFeatureExtractorType(value: String): CLIPForZeroShotClassification.this.type

    Definition Classes
    HasImageFeatureProperties
  124. def setImageMean(value: Array[Double]): CLIPForZeroShotClassification.this.type

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

    Definition Classes
    HasImageFeatureProperties
  126. final def setInputCols(value: String*): CLIPForZeroShotClassification.this.type
    Definition Classes
    HasInputAnnotationCols
  127. def setInputCols(value: Array[String]): CLIPForZeroShotClassification.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  128. def setLazyAnnotator(value: Boolean): CLIPForZeroShotClassification.this.type
    Definition Classes
    CanBeLazy
  129. def setMerges(value: Map[(String, String), Int]): CLIPForZeroShotClassification.this.type

    Attributes
    protected[nlp]
  130. def setModelIfNotSet(spark: SparkSession, tensorflow: Option[TensorflowWrapper], onnx: Option[OnnxWrapper], openvinoWrapper: Option[OpenvinoWrapper], preprocessor: Preprocessor): CLIPForZeroShotClassification.this.type

  131. final def setOutputCol(value: String): CLIPForZeroShotClassification.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  132. def setParent(parent: Estimator[CLIPForZeroShotClassification]): CLIPForZeroShotClassification
    Definition Classes
    Model
  133. def setResample(value: Int): CLIPForZeroShotClassification.this.type

    Definition Classes
    HasImageFeatureProperties
  134. def setRescaleFactor(value: Double): CLIPForZeroShotClassification.this.type

    Definition Classes
    HasRescaleFactor
  135. def setSize(value: Int): CLIPForZeroShotClassification.this.type

    Definition Classes
    HasImageFeatureProperties
  136. def setVocabulary(value: Map[String, Int]): CLIPForZeroShotClassification.this.type

    Attributes
    protected[nlp]
  137. 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
  138. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  139. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  140. 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
  141. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since("2.0.0")
  142. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @varargs() @Since("2.0.0")
  143. 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
  144. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  145. val uid: String
    Definition Classes
    CLIPForZeroShotClassification → Identifiable
  146. 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
  147. val vocabulary: MapFeature[String, Int]

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

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

    Attributes
    protected[nlp]
  148. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  149. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  150. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  151. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  152. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  153. def writeOnnxModel(path: String, spark: SparkSession, onnxWrapper: OnnxWrapper, suffix: String, fileName: String): Unit
    Definition Classes
    WriteOnnxModel
  154. def writeOnnxModels(path: String, spark: SparkSession, onnxWrappersWithNames: Seq[(OnnxWrapper, String)], suffix: String): Unit
    Definition Classes
    WriteOnnxModel
  155. def writeOpenvinoModel(path: String, spark: SparkSession, openvinoWrapper: OpenvinoWrapper, suffix: String, fileName: String): Unit
    Definition Classes
    WriteOpenvinoModel
  156. def writeOpenvinoModels(path: String, spark: SparkSession, ovWrappersWithNames: Seq[(OpenvinoWrapper, String)], suffix: String): Unit
    Definition Classes
    WriteOpenvinoModel
  157. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String = "_use"): Unit
    Definition Classes
    WriteTensorflowModel
  158. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None): Unit
    Definition Classes
    WriteTensorflowModel
  159. def writeTensorflowModelV2(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None, savedSignatures: Option[Map[String, String]] = None): Unit
    Definition Classes
    WriteTensorflowModel

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from HasRescaleFactor

Inherited from HasEngine

Inherited from WriteOpenvinoModel

Inherited from WriteOnnxModel

Inherited from WriteTensorflowModel

Inherited from HasImageFeatureProperties

Inherited from HasBatchedAnnotateImage[CLIPForZeroShotClassification]

Inherited from AnnotatorModel[CLIPForZeroShotClassification]

Inherited from CanBeLazy

Inherited from RawAnnotator[CLIPForZeroShotClassification]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[CLIPForZeroShotClassification]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

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