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

   

   Definition Classes

   AnyRef → Any

5. val annotatorType: String

   

   Definition Classes

   NerDLApproach → HasAnnotatorType

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. val batchSize: IntParam

   

8. def beforeTraining(spark: SparkSession): Unit

   

   Definition Classes

   ApproachWithWordEmbeddings → AnnotatorApproach

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

   

   Definition Classes

   Params

10. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

11. def close(): Unit

    

    Definition Classes

    ApproachWithWordEmbeddings → AutoCloseable

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

    

    Definition Classes

    AnnotatorApproach → Estimator → PipelineStage → Params

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

    

    Attributes

    protected

    Definition Classes

    Params

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

    

    Attributes

    protected

    Definition Classes

    Params

15. val description: String

    

    Definition Classes

    NerDLApproach → AnnotatorApproach

16. val dropout: FloatParam

    

17. def embeddings: Option[WordEmbeddings]

    

    Definition Classes

    ApproachWithWordEmbeddings

18. val embeddingsFormat: IntParam

    

    Definition Classes

    ApproachWithWordEmbeddings

19. val embeddingsNDims: IntParam

    

    Definition Classes

    ApproachWithWordEmbeddings

20. val entities: StringArrayParam

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    AnyRef

22. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

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

    

    Definition Classes

    Params

24. def explainParams(): String

    

    Definition Classes

    Params

25. val externalDataset: ExternalResourceParam

    

    Definition Classes

    NerApproach

26. final def extractParamMap(): ParamMap

    

    Definition Classes

    Params

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

    

    Definition Classes

    Params

28. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnnotatorApproach → Estimator

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" )

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

    

    Definition Classes

    Estimator

    Annotations

    @Since( "2.0.0" ) @varargs()

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

    

    Definition Classes

    Params

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

    

    Definition Classes

    AnyRef → Any

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

    

    Definition Classes

    Params

36. final def getInputCols: Array[String]

    
    returns

    input annotations columns currently used

    Definition Classes

    HasInputAnnotationCols

37. def getLogName: String

    

    Definition Classes

    NerDLApproach → Logging

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

    

    Definition Classes

    Params

39. final def getOutputCol: String

    

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes

    HasOutputAnnotationCol

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

    

    Definition Classes

    Params

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

    

    Definition Classes

    Params

42. def hasParam(paramName: String): Boolean

    

    Definition Classes

    Params

43. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

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

    

    Attributes

    protected

    Definition Classes

    Logging

45. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

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

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

    

    Definition Classes

    Params

48. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    Params

50. def isTraceEnabled(): Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

51. val labelColumn: Param[String]

    

    Definition Classes

    NerApproach

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

    

    Attributes

    protected

    Definition Classes

    Logging

53. def log: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

60. def logName: String

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

65. val logger: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

66. val lr: FloatParam

    

67. val maxEpochs: IntParam

    

    Definition Classes

    NerApproach

68. val minEpochs: IntParam

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    AnyRef

70. final def notify(): Unit

    

    Definition Classes

    AnyRef

71. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    ApproachWithWordEmbeddings → AnnotatorApproach

73. final val outputCol: Param[String]

    

    Attributes

    protected

    Definition Classes

    HasOutputAnnotationCol

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

    

    Definition Classes

    Params

75. val po: FloatParam

    

76. val randomSeed: IntParam

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    HasRecursiveFit

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

79. def save(path: String): Unit

    

    Definition Classes

    MLWritable

    Annotations

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

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

    

    Attributes

    protected

    Definition Classes

    Params

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

    

    Attributes

    protected

    Definition Classes

    Params

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

    

    Definition Classes

    Params

83. def setBatchSize(batch: Int): NerDLApproach

    

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

    

    Attributes

    protected

    Definition Classes

    Params

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

    

    Attributes

    protected

    Definition Classes

    Params

86. def setDropout(dropout: Float): NerDLApproach

    

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

    

    Definition Classes

    ApproachWithWordEmbeddings

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

    

    Definition Classes

    ApproachWithWordEmbeddings

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

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    NerApproach

91. def setExternalDataset(path: ExternalResource): NerDLApproach

    

    Definition Classes

    NerApproach

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

    

    Definition Classes

    HasInputAnnotationCols

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

94. def setLabelColumn(column: String): NerDLApproach

    

    Definition Classes

    NerApproach

95. def setLr(lr: Float): NerDLApproach

    

96. def setMaxEpochs(epochs: Int): NerDLApproach

    

    Definition Classes

    NerApproach

97. def setMinEpochs(epochs: Int): NerDLApproach

    

    Definition Classes

    NerApproach

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

    

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes

    HasOutputAnnotationCol

99. def setPo(po: Float): NerDLApproach

    

100. def setRandomSeed(seed: Int): NerDLApproach

     

     Definition Classes

     NerApproach

101. def setTestDataset(er: ExternalResource): NerDLApproach

     

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

     

103. def setValidationDataset(er: ExternalResource): NerDLApproach

     

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

     

105. def setVerbose(verbose: Level): NerDLApproach

     

     Definition Classes

     NerApproach

106. def setVerbose(verbose: Int): NerDLApproach

     

     Definition Classes

     NerApproach

107. val sourceEmbeddingsPath: Param[String]

     

     Definition Classes

     ApproachWithWordEmbeddings

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

     

     Definition Classes

     AnyRef

109. val testDataset: ExternalResourceParam

     

110. def toString(): String

     

     Definition Classes

     Identifiable → AnyRef → Any

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

     

     Definition Classes

     NerDLApproach → AnnotatorApproach

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

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

     

     Attributes

     protected

     Definition Classes

     PipelineStage

     Annotations

     @DeveloperApi()

114. val uid: String

     

     Definition Classes

     NerDLApproach → Identifiable

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

116. val validationDataset: ExternalResourceParam

     

117. val verbose: IntParam

     

     Definition Classes

     NerApproach

118. val verboseLevel: Verbose.Value

     

     Definition Classes

     NerDLApproach → Logging

119. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

122. def write: MLWriter

     

     Definition Classes

     DefaultParamsWritable → MLWritable