object RENerChunksFilter extends RENerChunksFilter with ParamsAndFeaturesReadable[RENerChunksFilter]

Linear Supertypes
ParamsAndFeaturesReadable[RENerChunksFilter], DefaultParamsReadable[RENerChunksFilter], MLReadable[RENerChunksFilter], RENerChunksFilter, CheckLicense, HasSimpleAnnotate[RENerChunksFilter], AnnotatorModel[RENerChunksFilter], CanBeLazy, RawAnnotator[RENerChunksFilter], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[RENerChunksFilter], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RENerChunksFilter
  2. ParamsAndFeaturesReadable
  3. DefaultParamsReadable
  4. MLReadable
  5. RENerChunksFilter
  6. CheckLicense
  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

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
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def addReader(reader: (RENerChunksFilter, String, SparkSession) ⇒ Unit): Unit
    Definition Classes
    ParamsAndFeaturesReadable
  11. def afterAnnotate(dataset: DataFrame): DataFrame
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  12. def annotate(annotations: Seq[Annotation]): Seq[Annotation]
    Definition Classes
    RENerChunksFilter → HasSimpleAnnotate
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. def checkValidEnvironment(spark: Option[SparkSession], scopes: Seq[String]): Unit
    Definition Classes
    CheckLicense
  17. def checkValidScope(scope: String): Unit
    Definition Classes
    CheckLicense
  18. def checkValidScopeAndEnvironment(scope: String, spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  19. def checkValidScopesAndEnvironment(scopes: Seq[String], spark: Option[SparkSession], checkLp: Boolean): Unit
    Definition Classes
    CheckLicense
  20. final def clear(param: Param[_]): RENerChunksFilter.this.type
    Definition Classes
    Params
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. def copy(extra: ParamMap): RENerChunksFilter
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  23. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  25. def dfAnnotate: UserDefinedFunction
    Definition Classes
    HasSimpleAnnotate
  26. val directionSensitive: BooleanParam

    If it is true, only relations in the form of "ENTITY1-ENTITY2" will be considered, If it is false, both "ENTITY1-ENTITY2" and "ENTITY2-ENTITY1" relations will be considered,

    If it is true, only relations in the form of "ENTITY1-ENTITY2" will be considered, If it is false, both "ENTITY1-ENTITY2" and "ENTITY2-ENTITY1" relations will be considered,

    Definition Classes
    RENerChunksFilter
  27. var docLevelRelations: BooleanParam

    Whether to include relations between entities from different sentences (Default: False).

    Whether to include relations between entities from different sentences (Default: False).

    Definition Classes
    RENerChunksFilter
  28. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  30. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  31. def explainParams(): String
    Definition Classes
    Params
  32. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  33. def extraValidateMsg: String
    Attributes
    protected
    Definition Classes
    RawAnnotator
  34. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  35. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  36. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  37. val filterByTokenDistance: IntParam

    filtering criterion based on number of token between entities.

    filtering criterion based on number of token between entities. Model only finds relations that have fewer than the specified number of tokens between them.

    Definition Classes
    RENerChunksFilter
  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  42. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  43. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  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 getDirectionSensitive: Boolean

    Gets the directionSensitive

    Gets the directionSensitive

    Definition Classes
    RENerChunksFilter
  47. def getDocLevelRelations: Boolean

    Include relations between entities from different sentences (Default: False)

    Include relations between entities from different sentences (Default: False)

    Definition Classes
    RENerChunksFilter
  48. def getInputCols: Array[String]
    Definition Classes
    HasInputAnnotationCols
  49. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  50. def getMaxSyntacticDistance: Float

    Maximal syntactic distance, as threshold (Default: 0)

    Maximal syntactic distance, as threshold (Default: 0)

    Definition Classes
    RENerChunksFilter
  51. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  52. final def getOutputCol: String
    Definition Classes
    HasOutputAnnotationCol
  53. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  54. def getRelationPairs: Array[String]

    List of dash-separated pairs of named entities ("ENTITY1-ENTITY2", e.g.

    List of dash-separated pairs of named entities ("ENTITY1-ENTITY2", e.g. "Biomarker-RelativeDay"), which will be processed

    Definition Classes
    RENerChunksFilter
  55. def getRelationPairsCaseSensitive: Boolean

    Gets the case sensitivity of relation pairs

    Gets the case sensitivity of relation pairs

    Definition Classes
    RENerChunksFilter
  56. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  57. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  58. def hasParent: Boolean
    Definition Classes
    Model
  59. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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[AnnotatorType]

    Input annotator type : CHUNK, DEPENDENCY

    Input annotator type : CHUNK, DEPENDENCY

    Definition Classes
    RENerChunksFilter → HasInputAnnotationCols
  63. final val inputCols: StringArrayParam
    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 load(path: String): RENerChunksFilter
    Definition Classes
    MLReadable
    Annotations
    @Since( "1.6.0" )
  70. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  71. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  78. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. var maxSyntacticDistance: IntParam

    Maximum syntactic distance between a pair of named entities to consider them as a relation.

    Maximum syntactic distance between a pair of named entities to consider them as a relation.

    Increase this value if you want to consider relations between entities that are far away, but be careful as it may add false positives (Default: 0).

    Definition Classes
    RENerChunksFilter
  83. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  84. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  85. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  87. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  88. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  89. val outputAnnotatorType: String

    Output annotator type : CHUNK

    Output annotator type : CHUNK

    Definition Classes
    RENerChunksFilter → HasOutputAnnotatorType
  90. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  91. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  92. var parent: Estimator[RENerChunksFilter]
    Definition Classes
    Model
  93. def processAnnotations(annotations: Seq[Annotation]): Seq[Annotation]
    Definition Classes
    RENerChunksFilter
  94. def read: MLReader[RENerChunksFilter]
    Definition Classes
    ParamsAndFeaturesReadable → DefaultParamsReadable → MLReadable
  95. var relationPairs: Param[String]

    List of dash-separated pairs of named entities ("ENTITY1-ENTITY2", e.g.

    List of dash-separated pairs of named entities ("ENTITY1-ENTITY2", e.g. "Biomarker-RelativeDay"), which will be processed. If not set, all relations between the entities will be considered.

    Definition Classes
    RENerChunksFilter
  96. var relationPairsCaseSensitive: BooleanParam

    Determines whether relation pairs are case sensitive

    Determines whether relation pairs are case sensitive

    Definition Classes
    RENerChunksFilter
  97. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  98. def set[T](feature: StructFeature[T], value: T): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. def set[T](feature: SetFeature[T], value: Set[T]): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  101. def set[T](feature: ArrayFeature[T], value: Array[T]): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  102. final def set(paramPair: ParamPair[_]): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    Params
  103. final def set(param: String, value: Any): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    Params
  104. final def set[T](param: Param[T], value: T): RENerChunksFilter.this.type
    Definition Classes
    Params
  105. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  107. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  108. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  109. final def setDefault(paramPairs: ParamPair[_]*): RENerChunksFilter.this.type
    Attributes
    protected
    Definition Classes
    Params
  110. final def setDefault[T](param: Param[T], value: T): RENerChunksFilter.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  111. def setDirectionSensitive(value: Boolean): RENerChunksFilter.this.type

    If it is true, only relations in the form of "ENTITY1-ENTITY2" will be considered, If it is false, both "ENTITY1-ENTITY2" and "ENTITY2-ENTITY1" relations will be considered,

    If it is true, only relations in the form of "ENTITY1-ENTITY2" will be considered, If it is false, both "ENTITY1-ENTITY2" and "ENTITY2-ENTITY1" relations will be considered,

    Definition Classes
    RENerChunksFilter
  112. def setDocLevelRelations(docLevelRelations: Boolean): RENerChunksFilter.this.type

    Include relations between entities from different sentences (Default: False).

    Include relations between entities from different sentences (Default: False). If it set to True, then then the sentence ids of all entities is set to 0, i.e. the sentences are merged together. The original sentence ids are preserved in the metadata as 'orig_sentence'. The dependency annotations are not affected. Mind that the model which is used to extract relations may not be able to process texts that exceed a given length. It is generally a bad idea to search for relations between entities spanning more than 100 words unless using a model which is specifically trained on such data.

    Definition Classes
    RENerChunksFilter
  113. def setFilterByTokenDistance(value: Int): RENerChunksFilter.this.type

    filtering criterion based on number of token between entities.

    filtering criterion based on number of token between entities. Model only finds relations that have fewer than the specified number of tokens between them

    Definition Classes
    RENerChunksFilter
  114. final def setInputCols(value: String*): RENerChunksFilter.this.type
    Definition Classes
    HasInputAnnotationCols
  115. def setInputCols(value: Array[String]): RENerChunksFilter.this.type
    Definition Classes
    HasInputAnnotationCols
  116. def setLazyAnnotator(value: Boolean): RENerChunksFilter.this.type
    Definition Classes
    CanBeLazy
  117. def setMaxSyntacticDistance(maxSyntacticDistance: Int): RENerChunksFilter.this.type

    Maximal syntactic distance, as threshold (Default: 0).

    Maximal syntactic distance, as threshold (Default: 0). This constraint may not work well if setDocLevelRelations is set to True, because dependency parsers are poor at detecting syntactic relations across multiple sentences.

    Definition Classes
    RENerChunksFilter
  118. final def setOutputCol(value: String): RENerChunksFilter.this.type
    Definition Classes
    HasOutputAnnotationCol
  119. def setParent(parent: Estimator[RENerChunksFilter]): RENerChunksFilter
    Definition Classes
    Model
  120. def setRelationPairs(relationPairs: Array[String]): RENerChunksFilter.this.type

    List of dash-separated pairs of named entities ("ENTITY1-ENTITY2", e.g.

    List of dash-separated pairs of named entities ("ENTITY1-ENTITY2", e.g. "Biomarker-RelativeDay"), which will be processed

    Definition Classes
    RENerChunksFilter
  121. def setRelationPairsCaseSensitive(value: Boolean): RENerChunksFilter.this.type

    Sets the case sensitivity of relation pairs

    Sets the case sensitivity of relation pairs

    Definition Classes
    RENerChunksFilter
  122. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  123. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  124. final def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    AnnotatorModel → Transformer
  125. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  126. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  127. final def transformSchema(schema: StructType): StructType
    Definition Classes
    RawAnnotator → PipelineStage
  128. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  129. val uid: String
    Definition Classes
    RENerChunksFilter → Identifiable
  130. def validate(schema: StructType): Boolean
    Attributes
    protected
    Definition Classes
    RawAnnotator
  131. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  134. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
    Definition Classes
    RawAnnotator
  135. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from ParamsAndFeaturesReadable[RENerChunksFilter]

Inherited from DefaultParamsReadable[RENerChunksFilter]

Inherited from MLReadable[RENerChunksFilter]

Inherited from RENerChunksFilter

Inherited from CheckLicense

Inherited from HasSimpleAnnotate[RENerChunksFilter]

Inherited from AnnotatorModel[RENerChunksFilter]

Inherited from CanBeLazy

Inherited from RawAnnotator[RENerChunksFilter]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[RENerChunksFilter]

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

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters