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. val annotatorType: String

   

   Definition Classes

   NerDLApproach → HasAnnotatorType

10. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

11. val batchSize: IntParam

    

12. def beforeTraining(spark: SparkSession): Unit

    

    Definition Classes

    ApproachWithWordEmbeddings → AnnotatorApproach

13. val caseSensitiveEmbeddings: BooleanParam

    

    Definition Classes

    HasEmbeddings

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. def close(): Unit

    

    Definition Classes

    HasEmbeddings → AutoCloseable

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 embeddingsDim: IntParam

    

    Definition Classes

    HasEmbeddings

23. val embeddingsFormat: IntParam

    

    Definition Classes

    ApproachWithWordEmbeddings

24. val embeddingsRef: Param[String]

    

    Definition Classes

    HasEmbeddings

25. val entities: StringArrayParam

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    AnyRef

27. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

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

    

    Definition Classes

    Params

29. def explainParams(): String

    

    Definition Classes

    Params

30. val externalDataset: ExternalResourceParam

    

    Definition Classes

    NerApproach

31. def extraValidate(structType: StructType): Boolean

    

    Attributes

    protected

    Definition Classes

    AnnotatorApproach

32. def extraValidateMsg: String

    

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes

    protected

    Definition Classes

    AnnotatorApproach

33. final def extractParamMap(): ParamMap

    

    Definition Classes

    Params

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

    

    Definition Classes

    Params

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

    

    Definition Classes

    HasFeatures

36. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnnotatorApproach → Estimator

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" ) @varargs()

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Definition Classes

    Params

46. def getCaseSensitiveEmbeddings: Boolean

    

    Definition Classes

    HasEmbeddings

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

    

    Definition Classes

    AnyRef → Any

48. def getClusterEmbeddings: ClusterWordEmbeddings

    

    Definition Classes

    HasEmbeddings

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

    

    Definition Classes

    Params

50. def getEmbeddingsDim: Int

    

    Definition Classes

    HasEmbeddings

51. def getEmbeddingsRef: String

    

    Definition Classes

    HasEmbeddings

52. def getIncludeEmbeddings: Boolean

    

    Definition Classes

    HasEmbeddings

53. final def getInputCols: Array[String]

    
    returns

    input annotations columns currently used

    Definition Classes

    HasInputAnnotationCols

54. def getLogName: String

    

    Definition Classes

    NerDLApproach → Logging

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

    

    Definition Classes

    Params

56. final def getOutputCol: String

    

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes

    HasOutputAnnotationCol

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

    

    Definition Classes

    Params

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

    

    Definition Classes

    Params

59. def hasParam(paramName: String): Boolean

    

    Definition Classes

    Params

60. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

61. val includeEmbeddings: BooleanParam

    

    Definition Classes

    HasEmbeddings

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

    

    Attributes

    protected

    Definition Classes

    Logging

63. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

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

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

    

    Definition Classes

    Params

66. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    Params

68. def isTraceEnabled(): Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

69. val labelColumn: Param[String]

    

    Definition Classes

    NerApproach

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

    

    Attributes

    protected

    Definition Classes

    Logging

71. def log: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

78. def logName: String

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

83. val logger: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

84. val lr: FloatParam

    

85. val maxEpochs: IntParam

    

    Definition Classes

    NerApproach

86. val minEpochs: IntParam

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    AnyRef

88. final def notify(): Unit

    

    Definition Classes

    AnyRef

89. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    ApproachWithWordEmbeddings → AnnotatorApproach

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

    

    Definition Classes

    ParamsAndFeaturesWritable

92. final val outputCol: Param[String]

    

    Attributes

    protected

    Definition Classes

    HasOutputAnnotationCol

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

    

    Definition Classes

    Params

94. val po: FloatParam

    

95. lazy val preloadedEmbeddings: ClusterWordEmbeddings

    

    Attributes

    protected

    Definition Classes

    HasEmbeddings

96. val randomSeed: IntParam

    

    Definition Classes

    NerApproach

97. final def recursiveFit(dataset: Dataset[_], recursivePipeline: PipelineModel): NerDLModel

    

    Definition Classes

    HasRecursiveFit

98. val requiredAnnotatorTypes: 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

99. def save(path: String): Unit

    

    Definition Classes

    MLWritable

    Annotations

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

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Definition Classes

     Params

107. def setBatchSize(batch: Int): NerDLApproach

     

108. def setCaseSensitiveEmbeddings(value: Boolean): NerDLApproach.this.type

     

     Definition Classes

     HasEmbeddings

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Attributes

     protected

     Definition Classes

     Params

115. def setDropout(dropout: Float): NerDLApproach

     

116. def setEmbeddingsDim(value: Int): NerDLApproach.this.type

     

     Definition Classes

     HasEmbeddings

117. def setEmbeddingsRef(value: String): NerDLApproach.this.type

     

     Definition Classes

     HasEmbeddings

118. def setEmbeddingsSource(path: String, nDims: Int, format: String): NerDLApproach

     

     Definition Classes

     ApproachWithWordEmbeddings

119. def setEmbeddingsSource(path: String, nDims: Int, format: Format): NerDLApproach

     

     Definition Classes

     ApproachWithWordEmbeddings

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

     

     Definition Classes

     NerApproach

121. def setExternalDataset(path: String, readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): NerDLApproach.this.type

     

     Definition Classes

     NerApproach

122. def setExternalDataset(path: ExternalResource): NerDLApproach

     

     Definition Classes

     NerApproach

123. def setIncludeEmbeddings(value: Boolean): NerDLApproach.this.type

     

     Definition Classes

     HasEmbeddings

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

     

     Definition Classes

     HasInputAnnotationCols

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

126. def setLabelColumn(column: String): NerDLApproach

     

     Definition Classes

     NerApproach

127. def setLr(lr: Float): NerDLApproach

     

128. def setMaxEpochs(epochs: Int): NerDLApproach

     

     Definition Classes

     NerApproach

129. def setMinEpochs(epochs: Int): NerDLApproach

     

     Definition Classes

     NerApproach

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

     

     Overrides annotation column name when transforming

     Overrides annotation column name when transforming

     Definition Classes

     HasOutputAnnotationCol

131. def setPo(po: Float): NerDLApproach

     

132. def setRandomSeed(seed: Int): NerDLApproach

     

     Definition Classes

     NerApproach

133. def setTestDataset(er: ExternalResource): NerDLApproach

     

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

     

135. def setValidationDataset(er: ExternalResource): NerDLApproach

     

136. def setValidationDataset(path: String, readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): NerDLApproach.this.type

     

137. def setVerbose(verbose: Level): NerDLApproach

     

     Definition Classes

     NerApproach

138. def setVerbose(verbose: Int): NerDLApproach

     

     Definition Classes

     NerApproach

139. val sourceEmbeddingsPath: Param[String]

     

     Definition Classes

     ApproachWithWordEmbeddings

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

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

     

     Attributes

     protected

     Definition Classes

     PipelineStage

     Annotations

     @DeveloperApi()

146. val uid: String

     

     Definition Classes

     NerDLApproach → Identifiable

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

     HasInputAnnotationCols

148. val validationDataset: ExternalResourceParam

     

149. val verbose: IntParam

     

     Definition Classes

     NerApproach

150. val verboseLevel: Verbose.Value

     

     Definition Classes

     NerDLApproach → Logging

151. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

154. def write: MLWriter

     

     Definition Classes

     ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable