Packages

t

com.johnsnowlabs.nlp

IAnnotation

trait IAnnotation extends AnyRef

IAnnotation trait is used to abstract the annotator's output for each NLP tasks available in Spark NLP.

Currently Spark NLP supports three types of outputs:

LightPipeline models in Java/Scala returns an IAnnotation collection. All of these outputs are structs with the required data types to represent Text, Image and Audio.

If one wants to access the data as Annotation, AnnotationImage or AnnotationAudio, one just needs casting to the desired output.

Example

import com.johnsnowlabs.nlp.annotators.cv.ViTForImageClassification
import org.apache.spark.ml.Pipeline
import com.johnsnowlabs.nlp.annotators.Tokenizer
import com.johnsnowlabs.nlp.annotators.sbd.pragmatic.SentenceDetector
import com.johnsnowlabs.nlp.ImageAssembler
import com.johnsnowlabs.nlp.LightPipeline
import com.johnsnowlabs.util.PipelineModels

val imageDf = spark.read
 .format("image")
 .option("dropInvalid", value = true)
 .load("./images")

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

val imageClassifier = ViTForImageClassification
.pretrained()
.setInputCols("image_assembler")
.setOutputCol("class")

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

val vitModel = pipeline.fit(imageDf)
val lightPipeline = new LightPipeline(vitModel)
val predictions = lightPipeline.fullAnnotate("./images/hen.JPEG")

val result = predictions.flatMap(prediction => prediction._2.map {
    case annotationText: Annotation =>
      annotationText
    case annotationImage: AnnotationImage =>
      annotationImage
})
Linear Supertypes
AnyRef, Any
Known Subclasses
Annotation, AnnotationAudio, AnnotationImage, JavaAnnotation
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IAnnotation
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def annotatorType: String

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped