Packages

class RegexMatcherModel extends AnnotatorModel[RegexMatcherModel] with HasSimpleAnnotate[RegexMatcherModel]

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

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

Instance Constructors

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

    uid

    internal element required for storing annotator to disk

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

    one-to-many annotation that returns matches as annotations

    one-to-many annotation that returns matches as annotations

    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
    RegexMatcherModel → HasSimpleAnnotate
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  15. final def clear(param: Param[_]): RegexMatcherModel.this.type
    Definition Classes
    Params
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. def copy(extra: ParamMap): RegexMatcherModel

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  19. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  20. 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
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  24. def explainParams(): String
    Definition Classes
    Params
  25. val externalRules: ArrayFeature[(String, String)]

    rules

  26. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  27. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  28. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  29. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  30. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  31. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  33. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  34. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  35. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  36. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  39. def getExternalRules: Array[(String, String)]

    Rules represented as Array of Tuples

  40. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  41. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  42. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  43. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  44. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  45. def getStrategy: String

    Can be any of MATCH_FIRST|MATCH_ALL|MATCH_COMPLETE

  46. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  47. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  48. def hasParent: Boolean
    Definition Classes
    Model
  49. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  50. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  51. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator type: DOCUMENT

    Input annotator type: DOCUMENT

    Definition Classes
    RegexMatcherModel → HasInputAnnotationCols
  53. 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
  54. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  57. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  58. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  59. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  60. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  67. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  69. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  72. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  73. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  75. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  76. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  77. val outputAnnotatorType: AnnotatorType

    Input annotator type: CHUNK

    Input annotator type: CHUNK

    Definition Classes
    RegexMatcherModel → HasOutputAnnotatorType
  78. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  79. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  80. var parent: Estimator[RegexMatcherModel]
    Definition Classes
    Model
  81. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  82. def set[T](feature: StructFeature[T], value: T): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  83. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  84. def set[T](feature: SetFeature[T], value: Set[T]): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  85. def set[T](feature: ArrayFeature[T], value: Array[T]): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  86. final def set(paramPair: ParamPair[_]): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  87. final def set(param: String, value: Any): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  88. final def set[T](param: Param[T], value: T): RegexMatcherModel.this.type
    Definition Classes
    Params
  89. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  90. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  91. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  92. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  93. final def setDefault(paramPairs: ParamPair[_]*): RegexMatcherModel.this.type
    Attributes
    protected
    Definition Classes
    Params
  94. final def setDefault[T](param: Param[T], value: T): RegexMatcherModel.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  95. def setExternalRules(value: Array[(String, String)]): RegexMatcherModel.this.type

    Path to file containing a set of regex,key pair.

    Path to file containing a set of regex,key pair. readAs can be LINE_BY_LINE or SPARK_DATASET. options contain option passed to spark reader if readAs is SPARK_DATASET.

  96. final def setInputCols(value: String*): RegexMatcherModel.this.type
    Definition Classes
    HasInputAnnotationCols
  97. def setInputCols(value: Array[String]): RegexMatcherModel.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  98. def setLazyAnnotator(value: Boolean): RegexMatcherModel.this.type
    Definition Classes
    CanBeLazy
  99. final def setOutputCol(value: String): RegexMatcherModel.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  100. def setParent(parent: Estimator[RegexMatcherModel]): RegexMatcherModel
    Definition Classes
    Model
  101. def setStrategy(value: String): RegexMatcherModel.this.type

    Can be any of MATCH_FIRST|MATCH_ALL|MATCH_COMPLETE

  102. val strategy: Param[String]

    MATCH_ALL|MATCH_FIRST|MATCH_COMPLETE

  103. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  104. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  105. 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
  106. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  107. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  108. 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
  109. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  110. val uid: String
    Definition Classes
    RegexMatcherModel → Identifiable
  111. 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
  112. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  113. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  114. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  115. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  116. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasSimpleAnnotate[RegexMatcherModel]

Inherited from AnnotatorModel[RegexMatcherModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[RegexMatcherModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[RegexMatcherModel]

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

getParams

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