Class/Object

com.johnsnowlabs.nlp.annotators.btm

BigTextMatcherModel

Related Docs: object BigTextMatcherModel | package btm

Permalink

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

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

Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. BigTextMatcherModel
  2. HasStorageModel
  3. HasExcludableStorage
  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 BigTextMatcherModel()

    Permalink

    internal constructor for writabale annotator

  2. new BigTextMatcherModel(uid: String)

    Permalink

    uid

    internally renquired UID to make it writable

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink

    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

    Permalink
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink

    Defines annotator phrase matching depending on whether we are using SBD or not

    Defines annotator phrase matching depending on whether we are using SBD or not

    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
    BigTextMatcherModelHasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. val caseSensitive: BooleanParam

    Permalink

    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

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. final def clear(param: Param[_]): BigTextMatcherModel.this.type

    Permalink
    Definition Classes
    Params
  17. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def collapse(rs: List[(Int, Int)], sep: List[(Int, Int)] = Nil): List[(Int, Int)]

    Permalink
    Attributes
    protected
    Annotations
    @tailrec()
  19. def copy(extra: ParamMap): BigTextMatcherModel

    Permalink

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  20. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  21. def createDatabaseConnection(database: Name): RocksDBConnection

    Permalink
    Definition Classes
    HasStorageRef
  22. def createReader(database: Name, connection: RocksDBConnection): StorageReader[_]

    Permalink
    Attributes
    protected
    Definition Classes
    BigTextMatcherModelHasStorageReader
  23. val databases: Array[Name]

    Permalink
    Attributes
    protected
    Definition Classes
    BigTextMatcherModelHasStorageModel
  24. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  25. def deserializeStorage(path: String, spark: SparkSession): Unit

    Permalink
    Definition Classes
    HasStorageModel
  26. def dfAnnotate: UserDefinedFunction

    Permalink

    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
  27. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  29. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  30. def explainParams(): String

    Permalink
    Definition Classes
    Params
  31. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  32. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  33. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  34. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  35. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures
  36. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  42. def getCaseSensitive: Boolean

    Permalink

    Definition Classes
    HasCaseSensitiveProperties
  43. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  44. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  45. def getIncludeStorage: Boolean

    Permalink
    Definition Classes
    HasExcludableStorage
  46. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  47. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  48. def getMergeOverlapping: Boolean

    Permalink

  49. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  50. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  51. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  52. def getReader[A](database: Name): StorageReader[A]

    Permalink
    Attributes
    protected
    Definition Classes
    HasStorageReader
  53. def getStorageRef: String

    Permalink
    Definition Classes
    HasStorageRef
  54. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  55. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  56. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  57. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  58. val includeStorage: BooleanParam

    Permalink
    Definition Classes
    HasExcludableStorage
  59. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. val inputAnnotatorTypes: Array[AnnotatorType]

    Permalink

    Input Annotator Types: DOCUMENT, TOKEN

    Input Annotator Types: DOCUMENT, TOKEN

    Definition Classes
    BigTextMatcherModelHasInputAnnotationCols
  62. final val inputCols: StringArrayParam

    Permalink

    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
  63. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  64. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  65. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  66. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  67. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  68. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  72. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  73. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  74. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  75. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  76. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  77. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  78. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  79. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  80. def merge(rs: List[(Int, Int)]): List[(Int, Int)]

    Permalink
    Attributes
    protected
  81. val mergeOverlapping: BooleanParam

    Permalink

    Whether to merge overlapping matched chunks (Default: false)

  82. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  83. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  84. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  85. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  86. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    HasStorageModelParamsAndFeaturesWritable
  87. val optionalInputAnnotatorTypes: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols
  88. val outputAnnotatorType: AnnotatorType

    Permalink

    Output Annotator Types: CHUNK

    Output Annotator Types: CHUNK

    Definition Classes
    BigTextMatcherModelHasOutputAnnotatorType
  89. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  90. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  91. var parent: Estimator[BigTextMatcherModel]

    Permalink
    Definition Classes
    Model
  92. var readers: Map[Name, StorageReader[_]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasStorageReader
  93. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  94. def saveStorage(path: String, spark: SparkSession, withinStorage: Boolean = false): Unit

    Permalink
    Definition Classes
    HasStorageModel
  95. def serializeStorage(path: String, spark: SparkSession): Unit

    Permalink
    Definition Classes
    HasStorageModel
  96. def set[T](feature: StructFeature[T], value: T): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def set[T](feature: SetFeature[T], value: Set[T]): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def set[T](feature: ArrayFeature[T], value: Array[T]): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. final def set(paramPair: ParamPair[_]): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  101. final def set(param: String, value: Any): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  102. final def set[T](param: Param[T], value: T): BigTextMatcherModel.this.type

    Permalink
    Definition Classes
    Params
  103. def setCaseSensitive(value: Boolean): BigTextMatcherModel.this.type

    Permalink

    Definition Classes
    HasCaseSensitiveProperties
  104. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  105. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  107. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  108. final def setDefault(paramPairs: ParamPair[_]*): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  109. final def setDefault[T](param: Param[T], value: T): BigTextMatcherModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  110. def setIncludeStorage(value: Boolean): BigTextMatcherModel.this.type

    Permalink
    Definition Classes
    HasExcludableStorage
  111. final def setInputCols(value: String*): BigTextMatcherModel.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  112. def setInputCols(value: Array[String]): BigTextMatcherModel.this.type

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  113. def setLazyAnnotator(value: Boolean): BigTextMatcherModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  114. def setMergeOverlapping(v: Boolean): BigTextMatcherModel.this.type

    Permalink

  115. final def setOutputCol(value: String): BigTextMatcherModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  116. def setParent(parent: Estimator[BigTextMatcherModel]): BigTextMatcherModel

    Permalink
    Definition Classes
    Model
  117. def setStorageRef(value: String): BigTextMatcherModel.this.type

    Permalink
    Definition Classes
    HasStorageRef
  118. val storageRef: Param[String]

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef
  120. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  121. final def transform(dataset: Dataset[_]): DataFrame

    Permalink

    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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  123. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  124. final def transformSchema(schema: StructType): StructType

    Permalink

    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

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  126. val uid: String

    Permalink

    internally renquired UID to make it writable

    internally renquired UID to make it writable

    Definition Classes
    BigTextMatcherModel → Identifiable
  127. def validate(schema: StructType): Boolean

    Permalink

    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

    Permalink
    Definition Classes
    HasStorageRef
  129. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  133. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasStorageModel

Inherited from HasExcludableStorage

Inherited from HasStorageReader

Inherited from HasStorageRef

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

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

anno

getParam

param

setParam

Ungrouped