NerCrfModel

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 afterAnnotate(dataset: DataFrame): DataFrame

   

   Attributes

   protected

   Definition Classes

   AnnotatorModel

10. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    

    takes a document and annotations and produces new annotations of this annotator's annotation type

    takes a document and annotations and produces new annotations of this annotator's annotation type

    annotations

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    any number of annotations processed for every input annotation. Not necessary one to one relationship

    Definition Classes

    NerCrfModel → AnnotatorModel

11. val annotatorType: AnnotatorType

    

    Definition Classes

    NerCrfModel → HasAnnotatorType

12. final def asInstanceOf[T0]: T0

    

    Definition Classes

    Any

13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    

    Attributes

    protected

    Definition Classes

    AnnotatorModel

14. val caseSensitiveEmbeddings: BooleanParam

    

    Definition Classes

    HasEmbeddings

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

    

    Definition Classes

    Params

16. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

17. def close(): Unit

    

    Definition Classes

    HasEmbeddings → AutoCloseable

18. def copy(extra: ParamMap): NerCrfModel

    

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes

    RawAnnotator → Model → Transformer → 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. def deserializeEmbeddings(path: String, spark: SparkSession): Unit

    

    Definition Classes

    ModelWithWordEmbeddings

22. def dfAnnotate: UserDefinedFunction

    

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    returns

    udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation

    Attributes

    protected

    Definition Classes

    AnnotatorModel

23. val dictionaryFeatures: MapFeature[String, String]

    

24. val embeddingsDim: IntParam

    

    Definition Classes

    HasEmbeddings

25. val embeddingsRef: Param[String]

    

    Definition Classes

    HasEmbeddings

26. val entities: StringArrayParam

    

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

    

    Definition Classes

    AnyRef

28. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

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

    

    Definition Classes

    Params

30. def explainParams(): String

    

    Definition Classes

    Params

31. def extraValidate(structType: StructType): Boolean

    

    Attributes

    protected

    Definition Classes

    RawAnnotator

32. def extraValidateMsg: String

    

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes

    protected

    Definition Classes

    RawAnnotator

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. 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 getCaseSensitiveEmbeddings: Boolean

    

    Definition Classes

    HasEmbeddings

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

    

    Definition Classes

    AnyRef → Any

44. def getClusterEmbeddings: ClusterWordEmbeddings

    

    Definition Classes

    HasEmbeddings

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

    

    Definition Classes

    Params

46. def getEmbeddingsDim: Int

    

    Definition Classes

    HasEmbeddings

47. def getEmbeddingsRef: String

    

    Definition Classes

    HasEmbeddings

48. def getIncludeEmbeddings: Boolean

    

    Definition Classes

    HasEmbeddings

49. final def getInputCols: Array[String]

    
    returns

    input annotations columns currently used

    Definition Classes

    HasInputAnnotationCols

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

    

    Definition Classes

    Params

51. final def getOutputCol: String

    

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes

    HasOutputAnnotationCol

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

    

    Definition Classes

    Params

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

    

    Definition Classes

    Params

54. def hasParam(paramName: String): Boolean

    

    Definition Classes

    Params

55. def hasParent: Boolean

    

    Definition Classes

    Model

56. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

57. val includeEmbeddings: BooleanParam

    

    Definition Classes

    HasEmbeddings

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

    

    Attributes

    protected

    Definition Classes

    Logging

59. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

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

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

    

    Definition Classes

    Params

62. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

    

    Definition Classes

    Params

64. def isTraceEnabled(): Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

65. def log: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

72. def logName: String

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

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

    

    Attributes

    protected

    Definition Classes

    Logging

77. val model: StructFeature[LinearChainCrfModel]

    

78. def moveFolderFiles(folderSrc: String, folderDst: String): Unit

    

    Definition Classes

    ModelWithWordEmbeddings

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

    

    Definition Classes

    AnyRef

80. final def notify(): Unit

    

    Definition Classes

    AnyRef

81. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

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

    

    Definition Classes

    ModelWithWordEmbeddings → ParamsAndFeaturesWritable

83. final val outputCol: Param[String]

    

    Attributes

    protected

    Definition Classes

    HasOutputAnnotationCol

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

    

    Definition Classes

    Params

85. var parent: Estimator[NerCrfModel]

    

    Definition Classes

    Model

86. lazy val preloadedEmbeddings: ClusterWordEmbeddings

    

    Attributes

    protected

    Definition Classes

    HasEmbeddings

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

    NerCrfModel → HasInputAnnotationCols

88. def save(path: String): Unit

    

    Definition Classes

    MLWritable

    Annotations

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

89. def serializeEmbeddings(path: String, spark: SparkSession): Unit

    

    Definition Classes

    ModelWithWordEmbeddings

90. def set[T](feature: StructFeature[T], value: T): NerCrfModel.this.type

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

94. final def set(paramPair: ParamPair[_]): NerCrfModel.this.type

    

    Attributes

    protected

    Definition Classes

    Params

95. final def set(param: String, value: Any): NerCrfModel.this.type

    

    Attributes

    protected

    Definition Classes

    Params

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

    

    Definition Classes

    Params

97. def setCaseSensitiveEmbeddings(value: Boolean): NerCrfModel.this.type

    

    Definition Classes

    HasEmbeddings

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

    

    Attributes

    protected

    Definition Classes

    HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

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

     

     Attributes

     protected

     Definition Classes

     HasFeatures

102. final def setDefault(paramPairs: ParamPair[_]*): NerCrfModel.this.type

     

     Attributes

     protected

     Definition Classes

     Params

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

     

     Attributes

     protected

     Definition Classes

     Params

104. def setDictionaryFeatures(dictFeatures: DictionaryFeatures): NerCrfModel.this.type

     

105. def setEmbeddingsDim(value: Int): NerCrfModel.this.type

     

     Definition Classes

     HasEmbeddings

106. def setEmbeddingsRef(value: String): NerCrfModel.this.type

     

     Definition Classes

     HasEmbeddings

107. def setEntities(toExtract: Array[String]): NerCrfModel

     

108. def setIncludeEmbeddings(value: Boolean): NerCrfModel.this.type

     

     Definition Classes

     HasEmbeddings

109. final def setInputCols(value: String*): NerCrfModel.this.type

     

     Definition Classes

     HasInputAnnotationCols

110. final def setInputCols(value: Array[String]): NerCrfModel.this.type

     

     Overrides required annotators column if different than default

     Overrides required annotators column if different than default

     Definition Classes

     HasInputAnnotationCols

111. def setModel(crf: LinearChainCrfModel): NerCrfModel

     

112. final def setOutputCol(value: String): NerCrfModel.this.type

     

     Overrides annotation column name when transforming

     Overrides annotation column name when transforming

     Definition Classes

     HasOutputAnnotationCol

113. def setParent(parent: Estimator[NerCrfModel]): NerCrfModel

     

     Definition Classes

     Model

114. def shrink(minW: Float): NerCrfModel

     

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

     

     Definition Classes

     AnyRef

116. def tag(sentences: Seq[PosTaggedSentence]): Seq[NerTaggedSentence]

     

     Predicts Named Entities in input sentences

     Predicts Named Entities in input sentences

     sentences

     POS tagged sentences.

     returns

     sentences with recognized Named Entities

117. def toString(): String

     

     Definition Classes

     Identifiable → AnyRef → Any

118. final def transform(dataset: Dataset[_]): DataFrame

     

     Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

     Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

     dataset

     Dataset[Row]

     Definition Classes

     AnnotatorModel → Transformer

119. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

     

     Definition Classes

     Transformer

     Annotations

     @Since( "2.0.0" )

120. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

     

     Definition Classes

     Transformer

     Annotations

     @Since( "2.0.0" ) @varargs()

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

     

     requirement for pipeline transformation validation.

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

     Definition Classes

     RawAnnotator → PipelineStage

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

     

     Attributes

     protected

     Definition Classes

     PipelineStage

     Annotations

     @DeveloperApi()

123. val uid: String

     

     Definition Classes

     NerCrfModel → Identifiable

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

125. final def wait(): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

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

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

128. def wrapColumnMetadata(col: Column): Column

     

     Attributes

     protected

     Definition Classes

     RawAnnotator

129. def write: MLWriter

     

     Definition Classes

     ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable