t

com.johnsnowlabs.nlp

RawAnnotator

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

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RawAnnotator
  2. HasOutputAnnotationCol
  3. HasInputAnnotationCols
  4. HasOutputAnnotatorType
  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
    Definition Classes
    HasOutputAnnotatorType

Abstract Value Members

  1. abstract val inputAnnotatorTypes: Array[String]

    Annotator reference id.

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

    Definition Classes
    HasInputAnnotationCols
  2. abstract val outputAnnotatorType: AnnotatorType
    Definition Classes
    HasOutputAnnotatorType
  3. abstract def transform(dataset: Dataset[_]): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  4. abstract val uid: String
    Definition Classes
    Identifiable

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  11. final def clear(param: Param[_]): RawAnnotator.this.type
    Definition Classes
    Params
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  13. def copy(extra: ParamMap): M

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  14. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  15. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  19. def explainParams(): String
    Definition Classes
    Params
  20. def extraValidate(structType: StructType): Boolean
    Attributes
    protected
  21. def extraValidateMsg: String

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
  22. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  23. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  24. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  27. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  28. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  29. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  30. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  31. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  33. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  34. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  35. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  36. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  37. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  38. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  39. def hasParent: Boolean
    Definition Classes
    Model
  40. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  42. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. 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
  44. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  47. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  48. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  49. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  56. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  61. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  63. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  64. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  65. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  66. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  67. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  68. var parent: Estimator[M]
    Definition Classes
    Model
  69. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  70. def set[T](feature: StructFeature[T], value: T): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  71. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  72. def set[T](feature: SetFeature[T], value: Set[T]): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  73. def set[T](feature: ArrayFeature[T], value: Array[T]): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  74. final def set(paramPair: ParamPair[_]): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    Params
  75. final def set(param: String, value: Any): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    Params
  76. final def set[T](param: Param[T], value: T): RawAnnotator.this.type
    Definition Classes
    Params
  77. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  78. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  79. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  80. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  81. final def setDefault(paramPairs: ParamPair[_]*): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    Params
  82. final def setDefault[T](param: Param[T], value: T): RawAnnotator.this.type
    Attributes
    protected
    Definition Classes
    Params
  83. final def setInputCols(value: String*): RawAnnotator.this.type
    Definition Classes
    HasInputAnnotationCols
  84. final def setInputCols(value: Array[String]): RawAnnotator.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

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

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  86. def setParent(parent: Estimator[M]): M
    Definition Classes
    Model
  87. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  88. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  89. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  90. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  91. 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
  92. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  93. 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
  94. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  95. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  96. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  97. def wrapColumnMetadata(col: Column): Column
    Attributes
    protected
  98. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

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