class EntityRulerModel extends AnnotatorModel[EntityRulerModel] with HasSimpleAnnotate[EntityRulerModel] with HasStorageModel

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

Linear Supertypes
HasStorageModel, HasStorageOptions, HasStorageReader, HasCaseSensitiveProperties, HasStorageRef, HasSimpleAnnotate[EntityRulerModel], AnnotatorModel[EntityRulerModel], CanBeLazy, RawAnnotator[EntityRulerModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[EntityRulerModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. EntityRulerModel
  2. HasStorageModel
  3. HasStorageOptions
  4. HasStorageReader
  5. HasCaseSensitiveProperties
  6. HasStorageRef
  7. HasSimpleAnnotate
  8. AnnotatorModel
  9. CanBeLazy
  10. RawAnnotator
  11. HasOutputAnnotationCol
  12. HasInputAnnotationCols
  13. HasOutputAnnotatorType
  14. ParamsAndFeaturesWritable
  15. HasFeatures
  16. DefaultParamsWritable
  17. MLWritable
  18. Model
  19. Transformer
  20. PipelineStage
  21. Logging
  22. Params
  23. Serializable
  24. Serializable
  25. Identifiable
  26. AnyRef
  27. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    uid

    internally renquired UID to make it writable

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
    Definition Classes
    EntityRulerModel → 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
    EntityRulerModel → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Definition Classes
    EntityRulerModel → AnnotatorModel
  14. val caseSensitive: BooleanParam

    Whether to ignore case in index lookups (Default depends on model)

    Whether to ignore case in index lookups (Default depends on model)

    Definition Classes
    HasCaseSensitiveProperties
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. final def clear(param: Param[_]): EntityRulerModel.this.type
    Definition Classes
    Params
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. def copy(extra: ParamMap): EntityRulerModel

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  19. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. def createDatabaseConnection(database: Name): RocksDBConnection
    Definition Classes
    HasStorageRef
  21. def createReader(database: Name, connection: RocksDBConnection): StorageReader[_]
    Attributes
    protected
    Definition Classes
    EntityRulerModel → HasStorageReader
  22. val databases: Array[Name]
    Attributes
    protected
    Definition Classes
    EntityRulerModel → HasStorageModel
  23. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. def deserializeStorage(path: String, spark: SparkSession): Unit
    Definition Classes
    EntityRulerModel → HasStorageModel
  25. def dfAnnotate: UserDefinedFunction

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    returns

    udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation

    Definition Classes
    HasSimpleAnnotate
  26. val enableInMemoryStorage: BooleanParam
    Definition Classes
    HasStorageOptions
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): 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 features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  36. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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 getAutomatonModelIfNotSet: Option[AhoCorasickAutomaton]
  43. def getCaseSensitive: Boolean

    Definition Classes
    HasCaseSensitiveProperties
  44. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  46. def getEnableInMemoryStorage: Boolean
    Definition Classes
    HasStorageOptions
  47. def getIncludeStorage: Boolean
    Definition Classes
    HasStorageOptions
  48. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  49. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  50. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  51. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  52. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  53. def getReader[A](database: Name): StorageReader[A]
    Attributes
    protected
    Definition Classes
    HasStorageReader
  54. def getStorageRef: String
    Definition Classes
    HasStorageRef
  55. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  56. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  57. def hasParent: Boolean
    Definition Classes
    Model
  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. val includeStorage: BooleanParam
    Definition Classes
    HasStorageOptions
  60. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  61. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. 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
    EntityRulerModel → HasInputAnnotationCols
  63. 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
  64. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  65. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  66. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  67. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  68. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  69. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  70. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  77. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  82. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  83. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  84. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  85. def onWrite(path: String, spark: SparkSession): Unit
    Definition Classes
    EntityRulerModel → HasStorageModel → ParamsAndFeaturesWritable
  86. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    EntityRulerModel → HasInputAnnotationCols
  87. val outputAnnotatorType: AnnotatorType
    Definition Classes
    EntityRulerModel → HasOutputAnnotatorType
  88. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  89. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  90. var parent: Estimator[EntityRulerModel]
    Definition Classes
    Model
  91. val readers: Map[Name, StorageReader[_]]
    Attributes
    protected
    Definition Classes
    HasStorageReader
    Annotations
    @transient()
  92. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  93. def saveStorage(path: String, spark: SparkSession, withinStorage: Boolean = false): Unit
    Definition Classes
    HasStorageModel
  94. def serializeStorage(path: String, spark: SparkSession): Unit
    Definition Classes
    HasStorageModel
  95. def set[T](feature: StructFeature[T], value: T): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  96. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[T](feature: SetFeature[T], value: Set[T]): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def set[T](feature: ArrayFeature[T], value: Array[T]): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. final def set(paramPair: ParamPair[_]): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  100. final def set(param: String, value: Any): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def set[T](param: Param[T], value: T): EntityRulerModel.this.type
    Definition Classes
    Params
  102. def setAutomatonModelIfNotSet(spark: SparkSession, automaton: Option[AhoCorasickAutomaton]): EntityRulerModel.this.type
  103. def setCaseSensitive(value: Boolean): EntityRulerModel.this.type

    Definition Classes
    HasCaseSensitiveProperties
  104. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  105. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  107. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  108. final def setDefault(paramPairs: ParamPair[_]*): EntityRulerModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  109. final def setDefault[T](param: Param[T], value: T): EntityRulerModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  110. def setEnableInMemoryStorage(value: Boolean): EntityRulerModel.this.type
    Definition Classes
    HasStorageOptions
  111. def setIncludeStorage(value: Boolean): EntityRulerModel.this.type
    Definition Classes
    HasStorageOptions
  112. final def setInputCols(value: String*): EntityRulerModel.this.type
    Definition Classes
    HasInputAnnotationCols
  113. def setInputCols(value: Array[String]): EntityRulerModel.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  114. def setLazyAnnotator(value: Boolean): EntityRulerModel.this.type
    Definition Classes
    CanBeLazy
  115. final def setOutputCol(value: String): EntityRulerModel.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  116. def setParent(parent: Estimator[EntityRulerModel]): EntityRulerModel
    Definition Classes
    Model
  117. def setStorageRef(value: String): EntityRulerModel.this.type
    Definition Classes
    HasStorageRef
  118. val storageRef: Param[String]

    Unique identifier for storage (Default: this.uid)

    Unique identifier for storage (Default: this.uid)

    Definition Classes
    HasStorageRef
  119. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  120. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  121. 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
  122. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  123. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  124. 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
  125. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  126. val uid: String
    Definition Classes
    EntityRulerModel → Identifiable
  127. 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
  128. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit
    Definition Classes
    HasStorageRef
  129. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  132. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  133. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasStorageModel

Inherited from HasStorageOptions

Inherited from HasStorageReader

Inherited from HasCaseSensitiveProperties

Inherited from HasStorageRef

Inherited from HasSimpleAnnotate[EntityRulerModel]

Inherited from AnnotatorModel[EntityRulerModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[EntityRulerModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[EntityRulerModel]

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.

Members

Parameter setters

Parameter getters