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

   

   Attributes

   protected

   Definition Classes

   AnnotatorApproach

10. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

11. val batchSize: IntParam

    

12. def beforeTraining(spark: SparkSession): Unit

    

    Definition Classes

    NerDLApproach → AnnotatorApproach

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

    

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

    

    Attributes

    protected

    Definition Classes

    HasInputAnnotationCols

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

    

    Definition Classes

    Params

16. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

17. val configProtoBytes: IntArrayParam

    

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

    

    Definition Classes

    AnnotatorApproach → Estimator → PipelineStage → Params

19. def copyValues[T <: Params](to: T, extra: ParamMap): T

    

    Attributes

    protected

    Definition Classes

    Params

20. final def defaultCopy[T <: Params](extra: ParamMap): T

    

    Attributes

    protected

    Definition Classes

    Params

21. val description: String

    

    Definition Classes

    NerDLApproach → AnnotatorApproach

22. val dropout: FloatParam

    

23. val enableOutputLogs: BooleanParam

    

24. val entities: StringArrayParam

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    AnyRef

26. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

27. val evaluationLogExtended: BooleanParam

    

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

    

    Definition Classes

    Params

29. def explainParams(): String

    

    Definition Classes

    Params

30. final def extractParamMap(): ParamMap

    

    Definition Classes

    Params

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

    

    Definition Classes

    Params

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

    

    Definition Classes

    HasFeatures

33. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnnotatorApproach → Estimator

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" ) @varargs()

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Definition Classes

    Params

43. def getBatchSize: Int

    

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

    

    Definition Classes

    AnyRef → Any

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

    

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

    

    Definition Classes

    Params

47. def getDropout: Float

    

48. def getEnableOutputLogs: Boolean

    

49. def getIncludeConfidence: Boolean

    

50. def getInputCols: Array[String]

    
    returns

    input annotations columns currently used

    Definition Classes

    HasInputAnnotationCols

51. def getLazyAnnotator: Boolean

    

    Definition Classes

    CanBeLazy

52. def getLogName: String

    

    Definition Classes

    NerDLApproach → Logging

53. def getLr: Float

    

54. def getMaxEpochs: Int

    

    Definition Classes

    NerApproach

55. def getMinEpochs: Int

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    Params

57. final def getOutputCol: String

    

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes

    HasOutputAnnotationCol

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

    

    Definition Classes

    Params

59. def getPo: Float

    

60. def getRandomSeed: Int

    

    Definition Classes

    NerApproach

61. def getUseContrib: Boolean

    

62. def getValidationSplit: Float

    

63. def getVerbose: Int

    

    Definition Classes

    NerApproach

64. val graphFolder: Param[String]

    

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

    

    Definition Classes

    Params

66. def hasParam(paramName: String): Boolean

    

    Definition Classes

    Params

67. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

68. val includeConfidence: BooleanParam

    

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

    

    Attributes

    protected

    Definition Classes

    Logging

70. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

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

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

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

    

    Definition Classes

    Params

74. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    Params

76. def isTraceEnabled(): Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

77. val labelColumn: Param[String]

    

    Definition Classes

    NerApproach

78. val lazyAnnotator: BooleanParam

    

    Definition Classes

    CanBeLazy

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

    

    Attributes

    protected

    Definition Classes

    Logging

80. def log: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

87. def logName: String

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

92. val logger: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

93. val lr: FloatParam

    

94. val maxEpochs: IntParam

    

    Definition Classes

    NerApproach

95. val minEpochs: IntParam

    

    Definition Classes

    NerApproach

96. def msgHelper(schema: StructType): String

    

    Attributes

    protected

    Definition Classes

    HasInputAnnotationCols

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

    

    Definition Classes

    AnyRef

98. final def notify(): Unit

    

    Definition Classes

    AnyRef

99. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

     

     Definition Classes

     AnnotatorApproach

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

     

     Attributes

     protected

     Definition Classes

     ParamsAndFeaturesWritable

102. val outputAnnotatorType: String

     

     Definition Classes

     NerDLApproach → HasOutputAnnotatorType

103. final val outputCol: Param[String]

     

     Attributes

     protected

     Definition Classes

     HasOutputAnnotationCol

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

     

     Attributes

     protected

     Definition Classes

     Logging

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

     

     Definition Classes

     Params

106. val po: FloatParam

     

107. val randomSeed: IntParam

     

     Definition Classes

     NerApproach

108. def save(path: String): Unit

     

     Definition Classes

     MLWritable

     Annotations

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

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Definition Classes

     Params

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

     

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

     

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

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

     

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

     

     Definition Classes

     NerApproach

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

     

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

     

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

     

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

     

     Definition Classes

     HasInputAnnotationCols

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

132. def setLabelColumn(column: String): NerDLApproach

     

     Definition Classes

     NerApproach

133. def setLazyAnnotator(value: Boolean): NerDLApproach.this.type

     

     Definition Classes

     CanBeLazy

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

     

135. def setMaxEpochs(epochs: Int): NerDLApproach

     

     Definition Classes

     NerApproach

136. def setMinEpochs(epochs: Int): NerDLApproach

     

     Definition Classes

     NerApproach

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

     

     Overrides annotation column name when transforming

     Overrides annotation column name when transforming

     Definition Classes

     HasOutputAnnotationCol

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

     

139. def setRandomSeed(seed: Int): NerDLApproach

     

     Definition Classes

     NerApproach

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

     

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

     

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

     

143. def setValidationSplit(validationSplit: Float): NerDLApproach.this.type

     

144. def setVerbose(verbose: Level): NerDLApproach

     

     Definition Classes

     NerApproach

145. def setVerbose(verbose: Int): NerDLApproach

     

     Definition Classes

     NerApproach

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

     

     Definition Classes

     AnyRef

147. val testDataset: ExternalResourceParam

     

148. def toString(): String

     

     Definition Classes

     Identifiable → AnyRef → Any

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

     

     Definition Classes

     NerDLApproach → AnnotatorApproach

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

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

     

     Attributes

     protected

     Definition Classes

     PipelineStage

     Annotations

     @DeveloperApi()

152. val uid: String

     

     Definition Classes

     NerDLApproach → Identifiable

153. val useContrib: BooleanParam

     

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

155. val validationSplit: FloatParam

     

156. val verbose: IntParam

     

     Definition Classes

     NerApproach

157. val verboseLevel: Level

     

     Definition Classes

     NerDLApproach → Logging

158. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

161. def write: MLWriter

     

     Definition Classes

     ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable