Class

com.johnsnowlabs.nlp.annotators.re

RelationExtractionApproach

Related Doc: package re

Permalink

class RelationExtractionApproach extends GenericClassifierApproach

Linear Supertypes
GenericClassifierApproach, Licensed, AnnotatorApproach[GenericClassifierModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[GenericClassifierModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RelationExtractionApproach
  2. GenericClassifierApproach
  3. Licensed
  4. AnnotatorApproach
  5. CanBeLazy
  6. DefaultParamsWritable
  7. MLWritable
  8. HasOutputAnnotatorType
  9. HasOutputAnnotationCol
  10. HasInputAnnotationCols
  11. Estimator
  12. PipelineStage
  13. Logging
  14. Params
  15. Serializable
  16. Serializable
  17. Identifiable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RelationExtractionApproach()

    Permalink
  2. new RelationExtractionApproach(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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): GenericClassifierModel

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

    Permalink
    Definition Classes
    Any
  7. val batchSize: IntParam

    Permalink

    Batch size

    Batch size

    Definition Classes
    GenericClassifierApproach
  8. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    GenericClassifierApproach → AnnotatorApproach
  9. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

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

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

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

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

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

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

    Permalink

    Trains TensorFlow model for multi-class text classification

    Trains TensorFlow model for multi-class text classification

    Definition Classes
    RelationExtractionApproachGenericClassifierApproach → AnnotatorApproach
  16. val dropout: FloatParam

    Permalink

    Dropout coefficient

    Dropout coefficient

    Definition Classes
    GenericClassifierApproach
  17. val epochsN: IntParam

    Permalink

    Maximum number of epochs to train

    Maximum number of epochs to train

    Definition Classes
    GenericClassifierApproach
  18. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  24. val featureScaling: Param[String]

    Permalink

    Feature scaling method.

    Feature scaling method. Possible values are 'zscore', 'minmax' or empty (no scaling)

    Definition Classes
    GenericClassifierApproach
  25. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  30. val fixImbalance: BooleanParam

    Permalink

    Fix the imbalance in the training set by replicating examples of under represented categories

    Fix the imbalance in the training set by replicating examples of under represented categories

    Definition Classes
    GenericClassifierApproach
  31. val fromEntityBeginCol: Param[String]

    Permalink

    From entity start position

  32. val fromEntityEndCol: Param[String]

    Permalink

    From entity end position

  33. val fromEntityLabelCol: Param[String]

    Permalink

    To entity label

  34. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  35. def getBatchSize: Int

    Permalink

    Batch size

    Batch size

    Definition Classes
    GenericClassifierApproach
  36. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  38. def getDropout: Float

    Permalink

    Dropout coefficient

    Dropout coefficient

    Definition Classes
    GenericClassifierApproach
  39. def getFeatureScaling: String

    Permalink

    Get feature scaling method

    Get feature scaling method

    Definition Classes
    GenericClassifierApproach
  40. def getFixImbalance: Boolean

    Permalink

    Fix imbalance in training set

    Fix imbalance in training set

    Definition Classes
    GenericClassifierApproach
  41. def getFromEntityBeginCol: String

    Permalink

    Get from entity begging

  42. def getFromEntityEndCol: String

    Permalink

    Get from entity end

  43. def getFromEntityLabelCol: String

    Permalink

    Get from entity label

  44. def getInputCols: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols
  45. def getLabelColumn: String

    Permalink

    Column with label per each document

    Column with label per each document

    Definition Classes
    GenericClassifierApproach
  46. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  47. def getLearningRate: Float

    Permalink

    Learning Rate

    Learning Rate

    Definition Classes
    GenericClassifierApproach
  48. def getMaxEpochs: Int

    Permalink

    Maximum number of epochs to train

    Maximum number of epochs to train

    Definition Classes
    GenericClassifierApproach
  49. def getModelFile: String

    Permalink

    Model file name

    Model file name

    Definition Classes
    GenericClassifierApproach
  50. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  51. final def getOutputCol: String

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  52. def getOutputLogsPath: String

    Permalink

    Get output logs path

    Get output logs path

    Definition Classes
    GenericClassifierApproach
  53. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  54. def getToEntityBeginCol: String

    Permalink

    Get to entity begging

  55. def getToEntityEndCol: String

    Permalink

    Get to entity end

  56. def getToEntityLabelCol: String

    Permalink

    Get to entity label

  57. def getValidationSplit: Float

    Permalink

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

    Definition Classes
    GenericClassifierApproach
  58. final def hasDefault[T](param: Param[T]): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  61. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

    Permalink

    Input annotator type : SENTENCE_EMBEDDINGS

    Input annotator type : SENTENCE_EMBEDDINGS

    Definition Classes
    RelationExtractionApproachGenericClassifierApproach → HasInputAnnotationCols
  64. final val inputCols: StringArrayParam

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  65. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. val labelColumn: Param[String]

    Permalink

    Column with label per each document

    Column with label per each document

    Definition Classes
    GenericClassifierApproach
  70. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  71. val learningRate: FloatParam

    Permalink

    Learning Rate

    Learning Rate

    Definition Classes
    GenericClassifierApproach
  72. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  84. val modelFile: Param[String]

    Permalink

    Location of file of the model used for classification

    Location of file of the model used for classification

    Definition Classes
    GenericClassifierApproach
  85. def msgHelper(schema: StructType): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
  89. def onTrained(model: GenericClassifierModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  90. val outputAnnotatorType: String

    Permalink

    Output annotator type : CATEGORY

    Output annotator type : CATEGORY

    Definition Classes
    GenericClassifierApproach → HasOutputAnnotatorType
  91. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  92. val outputLogsPath: Param[String]

    Permalink

    Path to folder to output logs.

    Path to folder to output logs. If no path is specified, no logs are generated

    Definition Classes
    GenericClassifierApproach
  93. lazy val params: Array[Param[_]]

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

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  95. final def set(paramPair: ParamPair[_]): RelationExtractionApproach.this.type

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

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

    Permalink
    Definition Classes
    Params
  98. def setBatchSize(batch: Int): RelationExtractionApproach.this.type

    Permalink

    Batch size

    Batch size

    Definition Classes
    GenericClassifierApproach
  99. final def setDefault(paramPairs: ParamPair[_]*): RelationExtractionApproach.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  101. def setDropout(dropout: Float): RelationExtractionApproach.this.type

    Permalink

    Dropout coefficient

    Dropout coefficient

    Definition Classes
    GenericClassifierApproach
  102. def setEpochsNumber(epochs: Int): RelationExtractionApproach.this.type

    Permalink

    Maximum number of epochs to train

    Maximum number of epochs to train

    Definition Classes
    GenericClassifierApproach
  103. def setFeatureScaling(featureScaling: String): RelationExtractionApproach.this.type

    Permalink

    Set the feature scaling method.

    Set the feature scaling method. Possible values are 'zscore', 'minmax' or empty (no scaling)

    Definition Classes
    GenericClassifierApproach
  104. def setFixImbalance(fix: Boolean): RelationExtractionApproach.this.type

    Permalink

    Fix imbalance of training set

    Fix imbalance of training set

    Definition Classes
    GenericClassifierApproach
  105. def setFromEntity(beginCol: String, endCol: String, labelCol: String): RelationExtractionApproach.this.type

    Permalink

    Set from entity

  106. final def setInputCols(value: String*): RelationExtractionApproach.this.type

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  108. def setLabelColumn(column: String): RelationExtractionApproach.this.type

    Permalink

    Column with label per each document

    Column with label per each document

    Definition Classes
    GenericClassifierApproach
  109. def setLazyAnnotator(value: Boolean): RelationExtractionApproach.this.type

    Permalink
    Definition Classes
    CanBeLazy
  110. def setModelFile(modelFile: String): RelationExtractionApproach.this.type

    Permalink

    Set the model file name

    Set the model file name

    Definition Classes
    GenericClassifierApproach
  111. final def setOutputCol(value: String): RelationExtractionApproach.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  112. def setOutputLogsPath(outputLogsPath: String): RelationExtractionApproach.this.type

    Permalink

    Set the output log path

    Set the output log path

    Definition Classes
    GenericClassifierApproach
  113. def setToEntity(beginCol: String, endCol: String, labelCol: String): RelationExtractionApproach.this.type

    Permalink

    Set to entity

  114. def setValidationSplit(validationSplit: Float): RelationExtractionApproach.this.type

    Permalink

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

    Definition Classes
    GenericClassifierApproach
  115. def setlearningRate(lr: Float): RelationExtractionApproach.this.type

    Permalink

    Learning Rate

    Learning Rate

    Definition Classes
    GenericClassifierApproach
  116. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  117. val toEntityBeginCol: Param[String]

    Permalink

    To entity start position

  118. val toEntityEndCol: Param[String]

    Permalink

    To entity end position

  119. val toEntityLabelCol: Param[String]

    Permalink

    To entity label

  120. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  121. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): RelationExtractionModel

    Permalink
    Definition Classes
    RelationExtractionApproachGenericClassifierApproach → AnnotatorApproach
  122. final def transformSchema(schema: StructType): StructType

    Permalink
    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
    RelationExtractionApproachGenericClassifierApproach → Identifiable
  125. def validate(schema: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  126. val validationSplit: FloatParam

    Permalink

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

    Definition Classes
    GenericClassifierApproach
  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
    DefaultParamsWritable → MLWritable

Inherited from GenericClassifierApproach

Inherited from Licensed

Inherited from AnnotatorApproach[GenericClassifierModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[GenericClassifierModel]

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