NerDLApproach

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

   

   Definition Classes

   Any

10. val batchSize: IntParam

    

11. def beforeTraining(spark: SparkSession): Unit

    

    Definition Classes

    NerDLApproach → AnnotatorApproach

12. def calculateEmbeddingsDim(sentences: Seq[WordpieceEmbeddingsSentence]): Int

    

13. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    

    Attributes

    protected

    Definition Classes

    HasInputAnnotationCols

14. final def clear(param: Param[_]): NerDLApproach.this.type

    

    Definition Classes

    Params

15. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

16. val configProtoBytes: IntArrayParam

    

17. final def copy(extra: ParamMap): Estimator[NerDLModel]

    

    Definition Classes

    AnnotatorApproach → Estimator → 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. val description: String

    

    Definition Classes

    NerDLApproach → AnnotatorApproach

21. val dropout: FloatParam

    

22. val enableOutputLogs: BooleanParam

    

23. val entities: StringArrayParam

    

    Definition Classes

    NerApproach

24. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

25. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

26. val evaluationLogExtended: BooleanParam

    

27. def explainParam(param: Param[_]): String

    

    Definition Classes

    Params

28. def explainParams(): String

    

    Definition Classes

    Params

29. final def extractParamMap(): ParamMap

    

    Definition Classes

    Params

30. final def extractParamMap(extra: ParamMap): ParamMap

    

    Definition Classes

    Params

31. val features: ArrayBuffer[Feature[_, _, _]]

    

    Definition Classes

    HasFeatures

32. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

33. final def fit(dataset: Dataset[_]): NerDLModel

    

    Definition Classes

    AnnotatorApproach → Estimator

34. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[NerDLModel]

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

35. def fit(dataset: Dataset[_], paramMap: ParamMap): NerDLModel

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

36. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): NerDLModel

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" ) @varargs()

37. def get[T](feature: StructFeature[T]): Option[T]

    

    Attributes

    protected

    Definition Classes

    HasFeatures

38. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    

    Attributes

    protected

    Definition Classes

    HasFeatures

39. def get[T](feature: SetFeature[T]): Option[Set[T]]

    

    Attributes

    protected

    Definition Classes

    HasFeatures

40. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Definition Classes

    Params

42. def getBatchSize: Int

    

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

    

    Definition Classes

    AnyRef → Any

44. def getConfigProtoBytes: Option[Array[Byte]]

    

45. final def getDefault[T](param: Param[T]): Option[T]

    

    Definition Classes

    Params

46. def getDropout: Float

    

47. def getEnableOutputLogs: Boolean

    

48. def getIncludeConfidence: Boolean

    

49. def getInputCols: Array[String]

    
    returns

    input annotations columns currently used

    Definition Classes

    HasInputAnnotationCols

50. def getLogName: String

    

    Definition Classes

    NerDLApproach → Logging

51. def getLr: Float

    

52. def getMaxEpochs: Int

    

    Definition Classes

    NerApproach

53. def getMinEpochs: Int

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    Params

55. final def getOutputCol: String

    

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes

    HasOutputAnnotationCol

56. def getParam(paramName: String): Param[Any]

    

    Definition Classes

    Params

57. def getPo: Float

    

58. def getRandomSeed: Int

    

    Definition Classes

    NerApproach

59. def getTrainValidationProp: Float

    

60. def getUseContrib: Boolean

    

61. val graphFolder: Param[String]

    

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

    

    Definition Classes

    Params

63. def hasParam(paramName: String): Boolean

    

    Definition Classes

    Params

64. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

65. val includeConfidence: BooleanParam

    

66. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

67. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

68. val inputAnnotatorTypes: Array[String]

    

    Annotator reference id.

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

    Definition Classes

    NerDLApproach → HasInputAnnotationCols

69. 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

70. final def isDefined(param: Param[_]): Boolean

    

    Definition Classes

    Params

71. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

72. final def isSet(param: Param[_]): Boolean

    

    Definition Classes

    Params

73. def isTraceEnabled(): Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

74. val labelColumn: Param[String]

    

    Definition Classes

    NerApproach

75. def log(value: ⇒ String, minLevel: Level): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

76. def log: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

77. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

78. def logDebug(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

79. def logError(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

80. def logError(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

81. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

82. def logInfo(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

83. def logName: String

    

    Attributes

    protected

    Definition Classes

    Logging

84. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

85. def logTrace(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

86. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

87. def logWarning(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

88. val logger: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

89. val lr: FloatParam

    

90. val maxEpochs: IntParam

    

    Definition Classes

    NerApproach

91. val minEpochs: IntParam

    

    Definition Classes

    NerApproach

92. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

93. final def notify(): Unit

    

    Definition Classes

    AnyRef

94. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

95. def onTrained(model: NerDLModel, spark: SparkSession): Unit

    

    Definition Classes

    AnnotatorApproach

96. def onWrite(path: String, spark: SparkSession): Unit

    

    Attributes

    protected

    Definition Classes

    ParamsAndFeaturesWritable

97. val outputAnnotatorType: String

    

    Definition Classes

    NerDLApproach → HasOutputAnnotatorType

98. final val outputCol: Param[String]

    

    Attributes

    protected

    Definition Classes

    HasOutputAnnotationCol

99. def outputLog(value: ⇒ String, uuid: String, shouldLog: Boolean): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

100. lazy val params: Array[Param[_]]

     

     Definition Classes

     Params

101. val po: FloatParam

     

102. val randomSeed: IntParam

     

     Definition Classes

     NerApproach

103. def save(path: String): Unit

     

     Definition Classes

     MLWritable

     Annotations

     @Since( "1.6.0" ) @throws( ... )

104. def set[T](feature: StructFeature[T], value: T): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     HasFeatures

105. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     HasFeatures

106. def set[T](feature: SetFeature[T], value: Set[T]): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     HasFeatures

107. def set[T](feature: ArrayFeature[T], value: Array[T]): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     HasFeatures

108. final def set(paramPair: ParamPair[_]): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     Params

109. final def set(param: String, value: Any): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     Params

110. final def set[T](param: Param[T], value: T): NerDLApproach.this.type

     

     Definition Classes

     Params

111. def setBatchSize(batch: Int): NerDLApproach.this.type

     

112. def setConfigProtoBytes(bytes: Array[Int]): NerDLApproach.this.type

     

113. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     HasFeatures

114. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     HasFeatures

115. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     HasFeatures

116. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     HasFeatures

117. final def setDefault(paramPairs: ParamPair[_]*): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     Params

118. final def setDefault[T](param: Param[T], value: T): NerDLApproach.this.type

     

     Attributes

     protected

     Definition Classes

     Params

119. def setDropout(dropout: Float): NerDLApproach.this.type

     

120. def setEnableOutputLogs(enableOutputLogs: Boolean): NerDLApproach.this.type

     

121. def setEntities(tags: Array[String]): NerDLApproach

     

     Definition Classes

     NerApproach

122. def setEvaluationLogExtended(evaluationLogExtended: Boolean): NerDLApproach.this.type

     

123. def setGraphFolder(path: String): NerDLApproach.this.type

     

124. def setIncludeConfidence(value: Boolean): NerDLApproach.this.type

     

125. final def setInputCols(value: String*): NerDLApproach.this.type

     

     Definition Classes

     HasInputAnnotationCols

126. final def setInputCols(value: Array[String]): NerDLApproach.this.type

     

     Overrides required annotators column if different than default

     Overrides required annotators column if different than default

     Definition Classes

     HasInputAnnotationCols

127. def setLabelColumn(column: String): NerDLApproach

     

     Definition Classes

     NerApproach

128. def setLr(lr: Float): NerDLApproach.this.type

     

129. def setMaxEpochs(epochs: Int): NerDLApproach

     

     Definition Classes

     NerApproach

130. def setMinEpochs(epochs: Int): NerDLApproach

     

     Definition Classes

     NerApproach

131. final def setOutputCol(value: String): NerDLApproach.this.type

     

     Overrides annotation column name when transforming

     Overrides annotation column name when transforming

     Definition Classes

     HasOutputAnnotationCol

132. def setPo(po: Float): NerDLApproach.this.type

     

133. def setRandomSeed(seed: Int): NerDLApproach

     

     Definition Classes

     NerApproach

134. def setTestDataset(er: ExternalResource): NerDLApproach.this.type

     

135. def setTestDataset(path: String, readAs: Format = ReadAs.SPARK_DATASET, options: Map[String, String] = Map("format" -> "parquet")): NerDLApproach.this.type

     

136. def setTrainValidationProp(trainValidationProp: Float): NerDLApproach.this.type

     

137. def setUseContrib(value: Boolean): NerDLApproach.this.type

     

138. def setVerbose(verbose: Level): NerDLApproach

     

     Definition Classes

     NerApproach

139. def setVerbose(verbose: Int): NerDLApproach

     

     Definition Classes

     NerApproach

140. final def synchronized[T0](arg0: ⇒ T0): T0

     

     Definition Classes

     AnyRef

141. val testDataset: ExternalResourceParam

     

142. def toString(): String

     

     Definition Classes

     Identifiable → AnyRef → Any

143. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): NerDLModel

     

     Definition Classes

     NerDLApproach → AnnotatorApproach

144. val trainValidationProp: FloatParam

     

145. final def transformSchema(schema: StructType): StructType

     

     requirement for pipeline transformation validation.

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

     Definition Classes

     AnnotatorApproach → PipelineStage

146. def transformSchema(schema: StructType, logging: Boolean): StructType

     

     Attributes

     protected

     Definition Classes

     PipelineStage

     Annotations

     @DeveloperApi()

147. val uid: String

     

     Definition Classes

     NerDLApproach → Identifiable

148. val useContrib: BooleanParam

     

149. 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

     AnnotatorApproach

150. val verbose: IntParam

     

     Definition Classes

     NerApproach

151. val verboseLevel: Verbose.Value

     

     Definition Classes

     NerDLApproach → Logging

152. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

153. final def wait(arg0: Long, arg1: Int): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

154. final def wait(arg0: Long): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

155. def write: MLWriter

     

     Definition Classes

     ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable