Class/Object

com.johnsnowlabs.nlp.annotators.ner.crf

NerCrfApproach

Related Docs: object NerCrfApproach | package crf

Permalink

class NerCrfApproach extends AnnotatorApproach[NerCrfModel]

Linear Supertypes
AnnotatorApproach[NerCrfModel], DefaultParamsWritable, MLWritable, HasAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[NerCrfModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NerCrfApproach
  2. AnnotatorApproach
  3. DefaultParamsWritable
  4. MLWritable
  5. HasAnnotatorType
  6. HasOutputAnnotationCol
  7. HasInputAnnotationCols
  8. Estimator
  9. PipelineStage
  10. Logging
  11. Params
  12. Serializable
  13. Serializable
  14. Identifiable
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NerCrfApproach()

    Permalink
  2. new NerCrfApproach(uid: String)

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. val annotatorType: String

    Permalink
    Definition Classes
    NerCrfApproachHasAnnotatorType
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val c0: IntParam

    Permalink
  8. final def clear(param: Param[_]): NerCrfApproach.this.type

    Permalink
    Definition Classes
    Params
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def copy(extra: ParamMap): Estimator[NerCrfModel]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  12. val datasetPath: Param[String]

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. val description: String

    Permalink
    Definition Classes
    NerCrfApproachAnnotatorApproach
  15. val dicts: StringArrayParam

    Permalink
  16. val entities: StringArrayParam

    Permalink
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  20. def explainParams(): String

    Permalink
    Definition Classes
    Params
  21. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  22. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def fit(dataset: Dataset[_]): NerCrfModel

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator
  25. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[NerCrfModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  26. def fit(dataset: Dataset[_], paramMap: ParamMap): NerCrfModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  27. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): NerCrfModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  28. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  29. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  30. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  31. final def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  32. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  33. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  34. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  35. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  36. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  37. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  38. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  39. final val inputCols: StringArrayParam

    Permalink

    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
  40. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  41. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  42. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  43. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  44. val l2: DoubleParam

    Permalink
  45. val labelColumn: Param[String]

    Permalink
  46. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  47. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  48. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  49. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  52. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  53. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. val lossEps: DoubleParam

    Permalink
  59. val maxEpochs: IntParam

    Permalink
  60. val minEpochs: IntParam

    Permalink
  61. val minW: DoubleParam

    Permalink
  62. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  63. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  64. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  65. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  66. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  67. val randomSeed: IntParam

    Permalink
  68. val requiredAnnotatorTypes: Array[String]

    Permalink

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

    Definition Classes
    NerCrfApproachHasInputAnnotationCols
  69. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  70. final def set(paramPair: ParamPair[_]): NerCrfApproach.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  71. final def set(param: String, value: Any): NerCrfApproach.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  72. final def set[T](param: Param[T], value: T): NerCrfApproach.this.type

    Permalink
    Definition Classes
    Params
  73. def setC0(c0: Int): NerCrfApproach

    Permalink
  74. def setDatsetPath(path: String): NerCrfApproach

    Permalink
  75. final def setDefault(paramPairs: ParamPair[_]*): NerCrfApproach.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  76. final def setDefault[T](param: Param[T], value: T): NerCrfApproach.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  77. def setDicts(paths: Seq[String]): NerCrfApproach

    Permalink
  78. def setEntities(tags: Array[String]): NerCrfApproach

    Permalink
  79. final def setInputCols(value: String*): NerCrfApproach.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  80. final def setInputCols(value: Array[String]): NerCrfApproach.this.type

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  81. def setL2(l2: Double): NerCrfApproach

    Permalink
  82. def setLabelColumn(column: String): NerCrfApproach

    Permalink
  83. def setLossEps(eps: Double): NerCrfApproach

    Permalink
  84. def setMaxEpochs(epochs: Int): NerCrfApproach

    Permalink
  85. def setMinEpochs(epochs: Int): NerCrfApproach

    Permalink
  86. def setMinW(w: Double): NerCrfApproach

    Permalink
  87. final def setOutputCol(value: String): NerCrfApproach.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  88. def setRandomSeed(seed: Int): NerCrfApproach

    Permalink
  89. def setVerbose(verbose: Level): NerCrfApproach

    Permalink
  90. def setVerbose(verbose: Int): NerCrfApproach

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

    Permalink
    Definition Classes
    AnyRef
  92. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  93. def train(dataset: Dataset[_]): NerCrfModel

    Permalink
    Definition Classes
    NerCrfApproachAnnotatorApproach
  94. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    AnnotatorApproach → PipelineStage
  95. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  96. val uid: String

    Permalink
    Definition Classes
    NerCrfApproach → Identifiable
  97. def validate(schema: StructType): Boolean

    Permalink

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

    Permalink
  99. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  100. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from AnnotatorApproach[NerCrfModel]

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[NerCrfModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped