class ZeroShotNerModel extends nlp.annotators.ner.ZeroShotNerModel

Linear Supertypes
nlp.annotators.ner.ZeroShotNerModel, CheckLicense, RoBertaForQuestionAnswering, HasEngine, HasCaseSensitiveProperties, WriteOnnxModel, WriteTensorflowModel, HasBatchedAnnotate[RoBertaForQuestionAnswering], AnnotatorModel[RoBertaForQuestionAnswering], CanBeLazy, RawAnnotator[RoBertaForQuestionAnswering], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[RoBertaForQuestionAnswering], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ZeroShotNerModel
  2. ZeroShotNerModel
  3. CheckLicense
  4. RoBertaForQuestionAnswering
  5. HasEngine
  6. HasCaseSensitiveProperties
  7. WriteOnnxModel
  8. WriteTensorflowModel
  9. HasBatchedAnnotate
  10. AnnotatorModel
  11. CanBeLazy
  12. RawAnnotator
  13. HasOutputAnnotationCol
  14. HasInputAnnotationCols
  15. HasOutputAnnotatorType
  16. ParamsAndFeaturesWritable
  17. HasFeatures
  18. DefaultParamsWritable
  19. MLWritable
  20. Model
  21. Transformer
  22. PipelineStage
  23. Logging
  24. Params
  25. Serializable
  26. Serializable
  27. Identifiable
  28. AnyRef
  29. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ZeroShotNerModel()
  2. new ZeroShotNerModel(uid: String)

Type Members

  1. type AnnotationContent = Seq[Row]
    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[Annotation]]): Seq[Seq[Annotation]]
    Definition Classes
    ZeroShotNerModel → ZeroShotNerModel → RoBertaForQuestionAnswering → HasBatchedAnnotate
  13. def batchProcess(rows: Iterator[_]): Iterator[Row]
    Definition Classes
    HasBatchedAnnotate
  14. val batchSize: IntParam
    Definition Classes
    HasBatchedAnnotate
  15. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    ZeroShotNerModel → AnnotatorModel
  16. val caseSensitive: BooleanParam
    Definition Classes
    HasCaseSensitiveProperties
  17. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  18. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  19. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  20. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  21. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  22. final def clear(param: Param[_]): ZeroShotNerModel.this.type
    Definition Classes
    Params
  23. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. val configProtoBytes: IntArrayParam
    Definition Classes
    RoBertaForQuestionAnswering
  25. def copy(extra: ParamMap): RoBertaForQuestionAnswering
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  26. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  27. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  28. val engine: Param[String]
    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. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  34. def extraValidateMsg: String
    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 features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  42. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  43. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getBatchSize: Int
    Definition Classes
    HasBatchedAnnotate
  45. def getCaseSensitive: Boolean
    Definition Classes
    HasCaseSensitiveProperties
  46. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  47. def getConfigProtoBytes: Option[Array[Byte]]
    Definition Classes
    RoBertaForQuestionAnswering
  48. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  49. def getEngine: String
    Definition Classes
    HasEngine
  50. def getEntities: Array[String]

    Get the list of entities which are regonized

    Get the list of entities which are regonized

    Definition Classes
    ZeroShotNerModel
  51. def getEntityDefinitionsStr: Array[String]
    Definition Classes
    ZeroShotNerModel
  52. def getIgnoreEntities: Array[String]

    Get the list of questions to catch the distractor entity

    Get the list of questions to catch the distractor entity

    Definition Classes
    ZeroShotNerModel
  53. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  54. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  55. def getMaxSentenceLength: Int
    Definition Classes
    RoBertaForQuestionAnswering
  56. def getModelIfNotSet: RoBertaClassification
    Definition Classes
    ZeroShotNerModel → RoBertaForQuestionAnswering
  57. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  58. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  59. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  60. def getPredictionThreshold: Float

    Get the minimum entity prediction score

    Get the minimum entity prediction score

    Definition Classes
    ZeroShotNerModel
  61. def getSignatures: Option[Map[String, String]]
    Definition Classes
    RoBertaForQuestionAnswering
  62. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  63. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  64. def hasParent: Boolean
    Definition Classes
    Model
  65. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  66. var ignoreEntities: StringArrayParam

    List of entities to ignore

    List of entities to ignore

    Definition Classes
    ZeroShotNerModel
  67. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  68. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. val inputAnnotatorTypes: Array[String]

    Input Annotator Types: DOCUMENT

    Input Annotator Types: DOCUMENT

    Definition Classes
    ZeroShotNerModel → RoBertaForQuestionAnswering → HasInputAnnotationCols
  70. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  71. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  74. def isTokenInEntity(token: Annotation, entity: Annotation): Boolean
    Definition Classes
    ZeroShotNerModel
  75. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  76. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  77. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  78. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  85. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  87. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def maskEntity(document: Annotation, entity: Annotation): String
    Definition Classes
    ZeroShotNerModel
  90. val maskSymbol: String
    Definition Classes
    ZeroShotNerModel
  91. val maxSentenceLength: IntParam
    Definition Classes
    RoBertaForQuestionAnswering
  92. val merges: MapFeature[(String, String), Int]
    Definition Classes
    RoBertaForQuestionAnswering
  93. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  94. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  95. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  96. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  97. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    RoBertaForQuestionAnswering → ParamsAndFeaturesWritable
  98. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  99. val outputAnnotatorType: AnnotatorType

    Output Annotator Types: NAMED_ENTITY

    Output Annotator Types: NAMED_ENTITY

    Definition Classes
    ZeroShotNerModel → RoBertaForQuestionAnswering → HasOutputAnnotatorType
  100. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  101. def padTokenId: Int
    Definition Classes
    RoBertaForQuestionAnswering
  102. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  103. var parent: Estimator[RoBertaForQuestionAnswering]
    Definition Classes
    Model
  104. var predictionThreshold: FloatParam

    Minimal score of predicted entity

    Minimal score of predicted entity

    Definition Classes
    ZeroShotNerModel
  105. def recognizeMultipleEntities(document: Annotation, nerDefs: Map[String, Array[Annotation]], recognizedEntities: Seq[Annotation] = Seq()): Seq[Annotation]
    Definition Classes
    ZeroShotNerModel
  106. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  107. def sentenceEndTokenId: Int
    Definition Classes
    RoBertaForQuestionAnswering
  108. def sentenceStartTokenId: Int
    Definition Classes
    RoBertaForQuestionAnswering
  109. def set[T](feature: StructFeature[T], value: T): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  110. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  111. def set[T](feature: SetFeature[T], value: Set[T]): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  112. def set[T](feature: ArrayFeature[T], value: Array[T]): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  113. final def set(paramPair: ParamPair[_]): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  114. final def set(param: String, value: Any): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  115. final def set[T](param: Param[T], value: T): ZeroShotNerModel.this.type
    Definition Classes
    Params
  116. def setBatchSize(size: Int): ZeroShotNerModel.this.type
    Definition Classes
    HasBatchedAnnotate
  117. def setCaseSensitive(value: Boolean): ZeroShotNerModel.this.type
    Definition Classes
    RoBertaForQuestionAnswering → HasCaseSensitiveProperties
  118. def setConfigProtoBytes(bytes: Array[Int]): ZeroShotNerModel.this.type
    Definition Classes
    RoBertaForQuestionAnswering
  119. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  120. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  121. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  122. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  123. final def setDefault(paramPairs: ParamPair[_]*): ZeroShotNerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  124. final def setDefault[T](param: Param[T], value: T): ZeroShotNerModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  125. def setEntityDefinitions(definitions: HashMap[String, List[String]]): ZeroShotNerModel.this.type

    Set definitions of named entities

    Set definitions of named entities

    Definition Classes
    ZeroShotNerModel
  126. def setEntityDefinitions(definitions: Map[String, Array[String]]): ZeroShotNerModel.this.type

    Set definitions of named entities

    Set definitions of named entities

    Definition Classes
    ZeroShotNerModel
  127. def setIgnoreEntities(value: Array[String]): ZeroShotNerModel.this.type

    Set the list of questions to catch the distractor entity

    Set the list of questions to catch the distractor entity

    Definition Classes
    ZeroShotNerModel
  128. final def setInputCols(value: String*): ZeroShotNerModel.this.type
    Definition Classes
    HasInputAnnotationCols
  129. def setInputCols(value: Array[String]): ZeroShotNerModel.this.type
    Definition Classes
    HasInputAnnotationCols
  130. def setLazyAnnotator(value: Boolean): ZeroShotNerModel.this.type
    Definition Classes
    CanBeLazy
  131. def setMaxSentenceLength(value: Int): ZeroShotNerModel.this.type
    Definition Classes
    RoBertaForQuestionAnswering
  132. def setMerges(value: Map[(String, String), Int]): ZeroShotNerModel.this.type
    Definition Classes
    RoBertaForQuestionAnswering
  133. def setModelIfNotSet(spark: SparkSession, tensorflowWrapper: Option[TensorflowWrapper], onnxWrapper: Option[OnnxWrapper] = None): nlp.annotators.ner.ZeroShotNerModel
    Definition Classes
    ZeroShotNerModel → RoBertaForQuestionAnswering
  134. final def setOutputCol(value: String): ZeroShotNerModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  135. def setParent(parent: Estimator[RoBertaForQuestionAnswering]): RoBertaForQuestionAnswering
    Definition Classes
    Model
  136. def setPredictionThreshold(value: Float): ZeroShotNerModel.this.type

    Set the minimum entity prediction score

    Set the minimum entity prediction score

    Definition Classes
    ZeroShotNerModel
  137. def setSignatures(value: Map[String, String]): ZeroShotNerModel.this.type
    Definition Classes
    RoBertaForQuestionAnswering
  138. def setVocabulary(value: Map[String, Int]): ZeroShotNerModel.this.type
    Definition Classes
    RoBertaForQuestionAnswering
  139. val signatures: MapFeature[String, String]
    Definition Classes
    RoBertaForQuestionAnswering
  140. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  141. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  142. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  143. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  144. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  145. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  146. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  147. val uid: String
    Definition Classes
    ZeroShotNerModel → ZeroShotNerModel → RoBertaForQuestionAnswering → Identifiable
  148. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  149. val vocabulary: MapFeature[String, Int]
    Definition Classes
    RoBertaForQuestionAnswering
  150. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  151. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  152. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  153. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  154. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  155. def writeOnnxModel(path: String, spark: SparkSession, onnxWrapper: OnnxWrapper, suffix: String, fileName: String): Unit
    Definition Classes
    WriteOnnxModel
  156. def writeOnnxModels(path: String, spark: SparkSession, onnxWrappersWithNames: Seq[(OnnxWrapper, String)], suffix: String): Unit
    Definition Classes
    WriteOnnxModel
  157. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String): Unit
    Definition Classes
    WriteTensorflowModel
  158. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]]): Unit
    Definition Classes
    WriteTensorflowModel
  159. def writeTensorflowModelV2(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]], savedSignatures: Option[Map[String, String]]): Unit
    Definition Classes
    WriteTensorflowModel

Inherited from nlp.annotators.ner.ZeroShotNerModel

Inherited from CheckLicense

Inherited from RoBertaForQuestionAnswering

Inherited from HasEngine

Inherited from HasCaseSensitiveProperties

Inherited from WriteOnnxModel

Inherited from WriteTensorflowModel

Inherited from HasBatchedAnnotate[RoBertaForQuestionAnswering]

Inherited from AnnotatorModel[RoBertaForQuestionAnswering]

Inherited from CanBeLazy

Inherited from RawAnnotator[RoBertaForQuestionAnswering]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[RoBertaForQuestionAnswering]

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.

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters