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 entities: StringArrayParam

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    AnyRef

24. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

25. val evaluationLogExtended: BooleanParam

    

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

    

    Definition Classes

    Params

27. def explainParams(): String

    

    Definition Classes

    Params

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[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnnotatorApproach → Estimator

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" ) @varargs()

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Definition Classes

    Params

41. def getBatchSize: Int

    

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

    

    Definition Classes

    AnyRef → Any

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

    

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

    

    Definition Classes

    Params

45. def getDropout: Float

    

46. def getIncludeConfidence: Boolean

    

47. def getInputCols: Array[String]

    
    returns

    input annotations columns currently used

    Definition Classes

    HasInputAnnotationCols

48. def getLogName: String

    

    Definition Classes

    NerDLApproach → Logging

49. def getLr: Float

    

50. def getMaxEpochs: Int

    

    Definition Classes

    NerApproach

51. def getMinEpochs: Int

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    Params

53. final def getOutputCol: String

    

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes

    HasOutputAnnotationCol

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

    

    Definition Classes

    Params

55. def getPo: Float

    

56. def getRandomSeed: Int

    

    Definition Classes

    NerApproach

57. def getTrainValidationProp: Float

    

58. def getUseContrib: Boolean

    

59. val graphFolder: Param[String]

    

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

    

    Definition Classes

    Params

61. def hasParam(paramName: String): Boolean

    

    Definition Classes

    Params

62. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

63. val includeConfidence: BooleanParam

    

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

    

    Attributes

    protected

    Definition Classes

    Logging

65. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

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

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

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

    

    Definition Classes

    Params

69. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    Params

71. def isTraceEnabled(): Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

72. val labelColumn: Param[String]

    

    Definition Classes

    NerApproach

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

    

    Attributes

    protected

    Definition Classes

    Logging

74. def log: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

81. def logName: String

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

86. val logger: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

87. val lr: FloatParam

    

88. val maxEpochs: IntParam

    

    Definition Classes

    NerApproach

89. val minEpochs: IntParam

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    AnyRef

91. final def notify(): Unit

    

    Definition Classes

    AnyRef

92. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    AnnotatorApproach

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

    

    Attributes

    protected

    Definition Classes

    ParamsAndFeaturesWritable

95. val outputAnnotatorType: String

    

    Definition Classes

    NerDLApproach → HasOutputAnnotatorType

96. final val outputCol: Param[String]

    

    Attributes

    protected

    Definition Classes

    HasOutputAnnotationCol

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

    

    Definition Classes

    Params

98. val po: FloatParam

    

99. val randomSeed: IntParam

    

    Definition Classes

    NerApproach

100. def save(path: String): Unit

     

     Definition Classes

     MLWritable

     Annotations

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

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Definition Classes

     Params

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

     

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

     

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

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

     

     Definition Classes

     NerApproach

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

     

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

     

120. def setIncludeConfidence(value: Boolean): NerDLApproach

     

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

     

     Definition Classes

     HasInputAnnotationCols

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

123. def setLabelColumn(column: String): NerDLApproach

     

     Definition Classes

     NerApproach

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

     

125. def setMaxEpochs(epochs: Int): NerDLApproach

     

     Definition Classes

     NerApproach

126. def setMinEpochs(epochs: Int): NerDLApproach

     

     Definition Classes

     NerApproach

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

     

     Overrides annotation column name when transforming

     Overrides annotation column name when transforming

     Definition Classes

     HasOutputAnnotationCol

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

     

129. def setRandomSeed(seed: Int): NerDLApproach

     

     Definition Classes

     NerApproach

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

     

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

     

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

     

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

     

134. def setVerbose(verbose: Level): NerDLApproach

     

     Definition Classes

     NerApproach

135. def setVerbose(verbose: Int): NerDLApproach

     

     Definition Classes

     NerApproach

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

     

     Definition Classes

     AnyRef

137. val testDataset: ExternalResourceParam

     

138. def toString(): String

     

     Definition Classes

     Identifiable → AnyRef → Any

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

     

     Definition Classes

     NerDLApproach → AnnotatorApproach

140. val trainValidationProp: FloatParam

     

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

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

     

     Attributes

     protected

     Definition Classes

     PipelineStage

     Annotations

     @DeveloperApi()

143. val uid: String

     

     Definition Classes

     NerDLApproach → Identifiable

144. val useContrib: BooleanParam

     

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

146. val verbose: IntParam

     

     Definition Classes

     NerApproach

147. val verboseLevel: Verbose.Value

     

     Definition Classes

     NerDLApproach → Logging

148. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

151. def write: MLWriter

     

     Definition Classes

     ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable