Packages

class DolphinForDocumentParsing extends AnnotatorModel[DolphinForDocumentParsing] with HasBatchedAnnotateImage[DolphinForDocumentParsing] with HasImageFeatureProperties with HasRescaleFactor with WriteOnnxModel with HasEngine

Document image parsing with ByteDance Dolphin.

Dolphin follows an analyze-then-parse design: stage 1 generates the page's layout elements in reading order, then each element is cropped and parsed independently in stage 2, batched by type. Tables come back as HTML, formulas as LaTeX, text as markdown.

The task prompt is the decoder prefix; there is no chat template. Dolphin 1.5 and 1.0 load through the same path. The release is recognised from its stage-1 output, which decides the box geometry and whether formulas and code get their own prompts (1.5 only).

Example

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

val dolphin = DolphinForDocumentParsing.pretrained()
  .setInputCols("image_assembler")
  .setOutputCol("elements")
  .setParsingMode("page")

new Pipeline().setStages(Array(imageAssembler, dolphin))
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DolphinForDocumentParsing
  2. HasEngine
  3. WriteOnnxModel
  4. HasRescaleFactor
  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 DolphinForDocumentParsing()
  2. new DolphinForDocumentParsing(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 adjustBoxEdges: BooleanParam

    Dolphin 1.0 only: its boxes are widened off ink as its reference does.

    Dolphin 1.0 only: its boxes are widened off ink as its reference does. 1.5 boxes are used as generated.

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

    batchProcess zips rows with results, so this must return exactly one Seq per input row and in the same order — a shorter result silently truncates the DataFrame.

    batchProcess zips rows with results, so this must return exactly one Seq per input row and in the same order — a shorter result silently truncates the DataFrame.

    Note AnnotationImage.text is deliberately ignored: Reader2Image defaults its promptTemplate to qwen2vl-chat and would otherwise inject chat markup that Dolphin would happily treat as the task prompt. The task comes from parsingMode.

    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
    DolphinForDocumentParsing → 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. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  17. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. final def clear(param: Param[_]): DolphinForDocumentParsing.this.type
    Definition Classes
    Params
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. def copy(extra: ParamMap): DolphinForDocumentParsing

    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. val customPrompt: Param[String]

  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 doRescale: BooleanParam

    Whether to rescale the image values by rescaleFactor.

    Whether to rescale the image values by rescaleFactor.

    Definition Classes
    HasRescaleFactor
  26. val doResize: BooleanParam

    Whether to resize the input to a certain size

    Whether to resize the input to a certain size

    Definition Classes
    HasImageFeatureProperties
  27. val elementBatchSize: IntParam

    Stage-2 crops decoded per forward pass.

    Stage-2 crops decoded per forward pass. Each row's KV cache grows with maxOutputLength, so memory scales with this value.

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

    Override for additional custom schema checks

    Override for additional custom schema checks

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

    Name of model's architecture for feature extraction

    Name of model's architecture for feature extraction

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

  48. def getBatchSize: Int

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotateImage
  49. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  50. def getCustomPrompt: String

  51. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  52. def getDoNormalize: Boolean

    Definition Classes
    HasImageFeatureProperties
  53. def getDoRescale: Boolean

    Definition Classes
    HasRescaleFactor
  54. def getDoResize: Boolean

    Definition Classes
    HasImageFeatureProperties
  55. def getElementBatchSize: Int

  56. def getEngine: String

    Definition Classes
    HasEngine
  57. def getFeatureExtractorType: String

    Definition Classes
    HasImageFeatureProperties
  58. def getGenerationConfig: GenerationConfig

  59. def getImageMean: Array[Double]

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

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

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  62. def getLayoutMaxOutputLength: Int

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

  65. def getMinElementSize: Int

  66. def getModelIfNotSet: Dolphin
  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 getOutputFormat: String

  70. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  71. def getParsingMode: String

  72. def getRepetitionPenalty: Double

  73. def getResample: Int

    Definition Classes
    HasImageFeatureProperties
  74. def getRescaleFactor: Double

    Definition Classes
    HasRescaleFactor
  75. def getSize: Int

    Definition Classes
    HasImageFeatureProperties
  76. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  77. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  78. def hasParent: Boolean
    Definition Classes
    Model
  79. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  80. 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
  81. 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
  82. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  83. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. 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
    DolphinForDocumentParsing → HasInputAnnotationCols
  85. 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
  86. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  87. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  88. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  89. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  90. val layoutMaxOutputLength: IntParam

  91. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  92. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  93. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  94. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  95. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  96. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  97. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  98. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  99. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  100. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  101. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  102. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  103. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  104. val maxOutputLength: IntParam

    Generation stops at the decoder's 4096-position window, prompt included, whatever the cap.

  105. val merges: MapFeature[(String, String), Int]
    Attributes
    protected[nlp]
  106. val minElementSize: IntParam

    Page mode drops elements whose crop is this small, as upstream does.

  107. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  108. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  109. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  110. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  111. def onWrite(path: String, spark: SparkSession): Unit
  112. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  113. val outputAnnotatorType: AnnotatorType
  114. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  115. val outputFormat: Param[String]

  116. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  117. var parent: Estimator[DolphinForDocumentParsing]
    Definition Classes
    Model
  118. val parsingMode: Param[String]

    What the input image is:

    What the input image is:

    • page (default): a whole page. Stage 1 + stage 2.
    • layout: a whole page; stage 1 only.
    • table / text / formula / code: an already cropped region; stage 2 only. formula and code are Dolphin 1.5 prompts.
  119. val repetitionPenalty: DoubleParam

    1.0 (off) matches Dolphin 1.5's reference pipeline; Dolphin 1.0's used 1.1.

  120. 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
  121. 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
  122. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  123. def set[T](feature: StructFeature[T], value: T): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  124. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  125. def set[T](feature: SetFeature[T], value: Set[T]): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  126. def set[T](feature: ArrayFeature[T], value: Array[T]): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  127. final def set(paramPair: ParamPair[_]): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    Params
  128. final def set(param: String, value: Any): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    Params
  129. final def set[T](param: Param[T], value: T): DolphinForDocumentParsing.this.type
    Definition Classes
    Params
  130. def setAdjustBoxEdges(value: Boolean): DolphinForDocumentParsing.this.type

  131. def setBatchSize(size: Int): DolphinForDocumentParsing.this.type

    Size of every batch.

    Size of every batch.

    Definition Classes
    HasBatchedAnnotateImage
  132. def setCustomPrompt(value: String): DolphinForDocumentParsing.this.type

  133. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  134. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  135. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  136. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  137. final def setDefault(paramPairs: ParamPair[_]*): DolphinForDocumentParsing.this.type
    Attributes
    protected
    Definition Classes
    Params
  138. final def setDefault[T](param: Param[T], value: T): DolphinForDocumentParsing.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  139. def setDoNormalize(value: Boolean): DolphinForDocumentParsing.this.type

    Definition Classes
    HasImageFeatureProperties
  140. def setDoRescale(value: Boolean): DolphinForDocumentParsing.this.type

    Definition Classes
    HasRescaleFactor
  141. def setDoResize(value: Boolean): DolphinForDocumentParsing.this.type

    Definition Classes
    HasImageFeatureProperties
  142. def setElementBatchSize(value: Int): DolphinForDocumentParsing.this.type

  143. def setExtraInputCols(value: Array[String]): DolphinForDocumentParsing.this.type
    Definition Classes
    HasInputAnnotationCols
  144. def setFeatureExtractorType(value: String): DolphinForDocumentParsing.this.type

    Definition Classes
    HasImageFeatureProperties
  145. def setGenerationConfig(value: GenerationConfig): DolphinForDocumentParsing.this.type

  146. def setImageMean(value: Array[Double]): DolphinForDocumentParsing.this.type

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

    Definition Classes
    HasImageFeatureProperties
  148. final def setInputCols(value: String*): DolphinForDocumentParsing.this.type
    Definition Classes
    HasInputAnnotationCols
  149. def setInputCols(value: Array[String]): DolphinForDocumentParsing.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  150. def setLayoutMaxOutputLength(value: Int): DolphinForDocumentParsing.this.type

  151. def setLazyAnnotator(value: Boolean): DolphinForDocumentParsing.this.type
    Definition Classes
    CanBeLazy
  152. def setMaxOutputLength(value: Int): DolphinForDocumentParsing.this.type

  153. def setMerges(value: Map[(String, String), Int]): DolphinForDocumentParsing.this.type

  154. def setMinElementSize(value: Int): DolphinForDocumentParsing.this.type

  155. def setModelIfNotSet(spark: SparkSession, onnxWrappers: Option[EncoderDecoderWrappers], preprocessor: Preprocessor): DolphinForDocumentParsing.this.type
  156. final def setOutputCol(value: String): DolphinForDocumentParsing.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  157. def setOutputFormat(value: String): DolphinForDocumentParsing.this.type

  158. def setParent(parent: Estimator[DolphinForDocumentParsing]): DolphinForDocumentParsing
    Definition Classes
    Model
  159. def setParsingMode(value: String): DolphinForDocumentParsing.this.type

  160. def setRepetitionPenalty(value: Double): DolphinForDocumentParsing.this.type

  161. def setResample(value: Int): DolphinForDocumentParsing.this.type

    Definition Classes
    HasImageFeatureProperties
  162. def setRescaleFactor(value: Double): DolphinForDocumentParsing.this.type

    Definition Classes
    HasRescaleFactor
  163. def setSize(value: Int): DolphinForDocumentParsing.this.type

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

  165. 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
  166. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  167. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  168. 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
  169. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  170. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  171. 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
  172. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  173. val uid: String
    Definition Classes
    DolphinForDocumentParsing → Identifiable
  174. 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
  175. val vocabulary: MapFeature[String, Int]
    Attributes
    protected[nlp]
  176. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  177. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  178. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  179. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  180. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  181. def writeOnnxModel(path: String, spark: SparkSession, onnxWrapper: OnnxWrapper, suffix: String, fileName: String): Unit
    Definition Classes
    WriteOnnxModel
  182. def writeOnnxModels(path: String, spark: SparkSession, onnxWrappersWithNames: Seq[(OnnxWrapper, String)], suffix: String): Unit
    Definition Classes
    WriteOnnxModel

Inherited from HasEngine

Inherited from WriteOnnxModel

Inherited from HasRescaleFactor

Inherited from HasImageFeatureProperties

Inherited from CanBeLazy

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[DolphinForDocumentParsing]

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

getParam

Parameters

setParam

Ungrouped