Packages

class EntityRulerInternalModel extends AnnotatorModel[EntityRulerInternalModel] with HasSimpleAnnotate[EntityRulerInternalModel] with HasStorageModel with CheckLicense

Instantiated model of the EntityRulerApproach. For usage and examples see the documentation of the main class.

Linear Supertypes
CheckLicense, HasStorageModel, HasStorageOptions, HasStorageReader, HasCaseSensitiveProperties, HasStorageRef, HasSimpleAnnotate[EntityRulerInternalModel], AnnotatorModel[EntityRulerInternalModel], CanBeLazy, RawAnnotator[EntityRulerInternalModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[EntityRulerInternalModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EntityRulerInternalModel
  2. CheckLicense
  3. HasStorageModel
  4. HasStorageOptions
  5. HasStorageReader
  6. HasCaseSensitiveProperties
  7. HasStorageRef
  8. HasSimpleAnnotate
  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. Serializable
  26. Identifiable
  27. AnyRef
  28. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    internally renquired UID to make it writable

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
    Definition Classes
    EntityRulerInternalModel → AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): 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

    annotations

    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
    EntityRulerInternalModel → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    EntityRulerInternalModel → AnnotatorModel
  14. val caseSensitive: BooleanParam
    Definition Classes
    HasCaseSensitiveProperties
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String], metadata: Option[Map[String, Value]]): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  18. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean, metadata: Option[Map[String, Value]]): Unit
    Definition Classes
    CheckLicense
  19. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean, metadata: Option[Map[String, Value]]): Unit
    Definition Classes
    CheckLicense
  20. final def clear(param: Param[_]): EntityRulerInternalModel.this.type
    Definition Classes
    Params
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. def copy(extra: ParamMap): EntityRulerInternalModel
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  23. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. def createDatabaseConnection(database: Name): RocksDBConnection
    Definition Classes
    HasStorageRef
  25. def createReader(database: Name, connection: RocksDBConnection): StorageReader[_]
    Attributes
    protected
    Definition Classes
    EntityRulerInternalModel → HasStorageReader
  26. val databases: Array[Name]
    Attributes
    protected
    Definition Classes
    EntityRulerInternalModel → HasStorageModel
  27. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  28. def deserializeStorage(path: String, spark: SparkSession): Unit
    Definition Classes
    EntityRulerInternalModel → HasStorageModel
  29. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  30. val enableInMemoryStorage: BooleanParam
    Definition Classes
    HasStorageOptions
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  33. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  34. def explainParams(): String
    Definition Classes
    Params
  35. final val extraInputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  36. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  37. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  38. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  39. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  40. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  41. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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 getAutomatonModelIfNotSet: Option[AhoCorasickAutomatonInternal]
  48. def getCaseSensitive: Boolean
    Definition Classes
    HasCaseSensitiveProperties
  49. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  50. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  51. def getEnableInMemoryStorage: Boolean
    Definition Classes
    HasStorageOptions
  52. def getIncludeStorage: Boolean
    Definition Classes
    HasStorageOptions
  53. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  54. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  55. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  56. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  57. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  58. def getReader[A](database: Name): StorageReader[A]
    Attributes
    protected
    Definition Classes
    HasStorageReader
  59. def getStorageRef: String
    Definition Classes
    HasStorageRef
  60. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  61. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  62. def hasParent: Boolean
    Definition Classes
    Model
  63. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  64. val includeStorage: BooleanParam
    Definition Classes
    HasStorageOptions
  65. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  66. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. val inputAnnotatorTypes: Array[String]

    Annotator reference id.

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

    Definition Classes
    EntityRulerInternalModel → HasInputAnnotationCols
  68. final val inputCols: StringArrayParam
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  69. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  70. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  71. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  72. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  73. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  74. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  75. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  82. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  87. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  88. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  89. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  90. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    EntityRulerInternalModel → HasStorageModel → ParamsAndFeaturesWritable
  91. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    EntityRulerInternalModel → HasInputAnnotationCols
  92. val outputAnnotatorType: AnnotatorType
    Definition Classes
    EntityRulerInternalModel → HasOutputAnnotatorType
  93. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  94. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  95. var parent: Estimator[EntityRulerInternalModel]
    Definition Classes
    Model
  96. val readers: Map[Name, StorageReader[_]]
    Attributes
    protected
    Definition Classes
    HasStorageReader
    Annotations
    @transient()
  97. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  98. def saveStorage(path: String, spark: SparkSession, withinStorage: Boolean): Unit
    Definition Classes
    HasStorageModel
  99. def serializeStorage(path: String, spark: SparkSession): Unit
    Definition Classes
    HasStorageModel
  100. def set[T](feature: StructFeature[T], value: T): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  101. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  102. def set[T](feature: SetFeature[T], value: Set[T]): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  103. def set[T](feature: ArrayFeature[T], value: Array[T]): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  104. final def set(paramPair: ParamPair[_]): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  105. final def set(param: String, value: Any): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  106. final def set[T](param: Param[T], value: T): EntityRulerInternalModel.this.type
    Definition Classes
    Params
  107. def setAutomatonModelIfNotSet(spark: SparkSession, automaton: Option[AhoCorasickAutomatonInternal]): EntityRulerInternalModel.this.type
  108. def setCaseSensitive(value: Boolean): EntityRulerInternalModel.this.type
    Definition Classes
    HasCaseSensitiveProperties
  109. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  110. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  111. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  112. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  113. final def setDefault(paramPairs: ParamPair[_]*): EntityRulerInternalModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  114. final def setDefault[T](param: Param[T], value: T): EntityRulerInternalModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  115. def setEnableInMemoryStorage(value: Boolean): EntityRulerInternalModel.this.type
    Definition Classes
    HasStorageOptions
  116. def setExtraInputCols(value: Array[String]): EntityRulerInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  117. def setIncludeStorage(value: Boolean): EntityRulerInternalModel.this.type
    Definition Classes
    HasStorageOptions
  118. final def setInputCols(value: String*): EntityRulerInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  119. def setInputCols(value: Array[String]): EntityRulerInternalModel.this.type
    Definition Classes
    HasInputAnnotationCols
  120. def setLazyAnnotator(value: Boolean): EntityRulerInternalModel.this.type
    Definition Classes
    CanBeLazy
  121. final def setOutputCol(value: String): EntityRulerInternalModel.this.type
    Definition Classes
    HasOutputAnnotationCol
  122. def setParent(parent: Estimator[EntityRulerInternalModel]): EntityRulerInternalModel
    Definition Classes
    Model
  123. def setStorageRef(value: String): EntityRulerInternalModel.this.type
    Definition Classes
    HasStorageRef
  124. val storageRef: Param[String]
    Definition Classes
    HasStorageRef
  125. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  126. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  127. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  128. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  129. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  130. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  131. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  132. val uid: String
    Definition Classes
    EntityRulerInternalModel → Identifiable
  133. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  134. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit
    Definition Classes
    HasStorageRef
  135. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  136. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  138. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  139. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from CheckLicense

Inherited from HasStorageModel

Inherited from HasStorageOptions

Inherited from HasStorageReader

Inherited from HasCaseSensitiveProperties

Inherited from HasStorageRef

Inherited from HasSimpleAnnotate[EntityRulerInternalModel]

Inherited from AnnotatorModel[EntityRulerInternalModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[EntityRulerInternalModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[EntityRulerInternalModel]

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

Members