Class/Object

com.johnsnowlabs.nlp.annotators.btm

BigTextMatcher

Related Docs: object BigTextMatcher | package btm

Permalink

class BigTextMatcher extends AnnotatorApproach[BigTextMatcherModel] with HasStorage

Linear Supertypes
HasStorage, HasCaseSensitiveProperties, HasExcludableStorage, HasStorageRef, ParamsAndFeaturesWritable, HasFeatures, AnnotatorApproach[BigTextMatcherModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[BigTextMatcherModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BigTextMatcher
  2. HasStorage
  3. HasCaseSensitiveProperties
  4. HasExcludableStorage
  5. HasStorageRef
  6. ParamsAndFeaturesWritable
  7. HasFeatures
  8. AnnotatorApproach
  9. CanBeLazy
  10. DefaultParamsWritable
  11. MLWritable
  12. HasOutputAnnotatorType
  13. HasOutputAnnotationCol
  14. HasInputAnnotationCols
  15. Estimator
  16. PipelineStage
  17. Logging
  18. Params
  19. Serializable
  20. Serializable
  21. Identifiable
  22. AnyRef
  23. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BigTextMatcher()

    Permalink
  2. new BigTextMatcher(uid: String)

    Permalink

Type Members

  1. 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 _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): BigTextMatcherModel

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  12. val caseSensitive: BooleanParam

    Permalink
    Definition Classes
    HasCaseSensitiveProperties
  13. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. final def copy(extra: ParamMap): Estimator[BigTextMatcherModel]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  17. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Definition Classes
    HasStorageRef
  19. def createWriter(database: Name, connection: RocksDBConnection): StorageWriter[_]

    Permalink
    Attributes
    protected
    Definition Classes
    BigTextMatcherHasStorage
  20. val databases: Array[Name]

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  22. val description: String

    Permalink
    Definition Classes
    BigTextMatcherAnnotatorApproach
  23. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. final def fit(dataset: Dataset[_]): BigTextMatcherModel

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator
  32. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[BigTextMatcherModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  33. def fit(dataset: Dataset[_], paramMap: ParamMap): BigTextMatcherModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  34. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): BigTextMatcherModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  35. def get[T](feature: StructFeature[T]): Option[T]

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

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

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

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

    Permalink
    Definition Classes
    Params
  40. def getCaseSensitive: Boolean

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

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

    Permalink
    Definition Classes
    Params
  43. def getIncludeStorage: Boolean

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

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  45. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  46. def getMergeOverlapping: Boolean

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

    Permalink
    Definition Classes
    Params
  48. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  50. def getStoragePath: Option[ExternalResource]

    Permalink
    Definition Classes
    HasStorage
  51. def getStorageRef: String

    Permalink
    Definition Classes
    HasStorageRef
  52. def getTokenizer: TokenizerModel

    Permalink
  53. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  55. def hashCode(): Int

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

    Permalink
    Definition Classes
    HasExcludableStorage
  57. def index(fitDataset: Dataset[_], storageSourcePath: Option[String], readAs: Option[util.io.ReadAs.Value], writers: Map[Name, StorageWriter[_]], readOptions: Option[Map[String, String]]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    BigTextMatcherHasStorage
  58. def indexStorage(fitDataset: Dataset[_], resource: Option[ExternalResource]): Unit

    Permalink
    Definition Classes
    HasStorage
  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[String]

    Permalink

    Annotator reference id.

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

    Definition Classes
    BigTextMatcherHasInputAnnotationCols
  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. val mergeOverlapping: BooleanParam

    Permalink
  81. val missingRefMsg: String

    Permalink
    Attributes
    protected
    Definition Classes
    HasStorage
  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 onTrained(model: BigTextMatcherModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  87. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  88. val outputAnnotatorType: AnnotatorType

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

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

    Permalink
    Definition Classes
    Params
  91. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  92. def set[T](feature: StructFeature[T], value: T): BigTextMatcher.this.type

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  99. def setCaseSensitive(value: Boolean): BigTextMatcher.this.type

    Permalink
    Definition Classes
    HasCaseSensitiveProperties
  100. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): BigTextMatcher.this.type

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  108. final def setInputCols(value: Array[String]): BigTextMatcher.this.type

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  109. def setLazyAnnotator(value: Boolean): BigTextMatcher.this.type

    Permalink
    Definition Classes
    CanBeLazy
  110. def setMergeOverlapping(v: Boolean): BigTextMatcher.this.type

    Permalink
  111. final def setOutputCol(value: String): BigTextMatcher.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  112. def setStoragePath(path: String, readAs: util.io.ReadAs.Value): BigTextMatcher.this.type

    Permalink
    Definition Classes
    HasStorage
  113. def setStoragePath(path: String, readAs: String): BigTextMatcher.this.type

    Permalink
    Definition Classes
    HasStorage
  114. def setStorageRef(value: String): BigTextMatcher.this.type

    Permalink
    Definition Classes
    HasStorageRef
  115. def setTokenizer(tokenizer: TokenizerModel): BigTextMatcher.this.type

    Permalink
  116. val storagePath: ExternalResourceParam

    Permalink
    Definition Classes
    HasStorage
  117. val storageRef: Param[String]

    Permalink
    Definition Classes
    HasStorageRef
  118. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  120. val tokenizer: StructFeature[TokenizerModel]

    Permalink
  121. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): BigTextMatcherModel

    Permalink
    Definition Classes
    BigTextMatcherAnnotatorApproach
  122. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    AnnotatorApproach → PipelineStage
  123. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    BigTextMatcher → Identifiable
  125. 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
    AnnotatorApproach
  126. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasStorage

Inherited from HasExcludableStorage

Inherited from HasStorageRef

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[BigTextMatcherModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped