Trait

com.johnsnowlabs.nlp

RawAnnotator

Related Doc: package nlp

Permalink

trait RawAnnotator[M <: Model[M]] extends Model[M] with ParamsAndFeaturesWritable with HasAnnotatorType with HasInputAnnotationCols with HasOutputAnnotationCol

Created by jose on 25/01/18.

Linear Supertypes
HasOutputAnnotationCol, HasInputAnnotationCols, HasAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[M], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RawAnnotator
  2. HasOutputAnnotationCol
  3. HasInputAnnotationCols
  4. HasAnnotatorType
  5. ParamsAndFeaturesWritable
  6. HasFeatures
  7. DefaultParamsWritable
  8. MLWritable
  9. Model
  10. Transformer
  11. PipelineStage
  12. Logging
  13. Params
  14. Serializable
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasAnnotatorType

Abstract Value Members

  1. abstract val annotatorType: AnnotatorType

    Permalink
    Definition Classes
    HasAnnotatorType
  2. abstract 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
    HasInputAnnotationCols
  3. abstract def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  4. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable

Concrete 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. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. final def clear(param: Param[_]): RawAnnotator.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def copy(extra: ParamMap): M

    Permalink

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  12. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    Params
  18. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
  19. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
  20. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  22. val features: ArrayBuffer[Feature[_, _, _]]

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  25. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  26. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  27. final def get[T](param: Param[T]): Option[T]

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

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

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

    Permalink

    returns

    input annotations columns currently used

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

    Permalink
    Definition Classes
    Params
  32. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

    Permalink
    Definition Classes
    Params
  36. def hasParent: Boolean

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  39. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  40. 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
  41. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  60. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable
  61. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  63. var parent: Estimator[M]

    Permalink
    Definition Classes
    Model
  64. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  65. def set[T](feature: StructFeature[T], value: T): RawAnnotator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  66. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): RawAnnotator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  67. def set[T](feature: ArrayFeature[T], value: Array[T]): RawAnnotator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  68. final def set(paramPair: ParamPair[_]): RawAnnotator.this.type

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

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

    Permalink
    Definition Classes
    Params
  71. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): RawAnnotator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  72. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): RawAnnotator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  73. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): RawAnnotator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  74. final def setDefault(paramPairs: ParamPair[_]*): RawAnnotator.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  76. final def setInputCols(value: String*): RawAnnotator.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  78. final def setOutputCol(value: String): RawAnnotator.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  79. def setParent(parent: Estimator[M]): M

    Permalink
    Definition Classes
    Model
  80. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  82. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  83. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  84. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    RawAnnotator → PipelineStage
  85. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  86. 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
  87. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  90. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
  91. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[M]

Inherited from Transformer

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