Class/Object

com.johnsnowlabs.nlp.annotators.pos.perceptron

PerceptronModel

Related Docs: object PerceptronModel | package perceptron

Permalink

class PerceptronModel extends AnnotatorModel[PerceptronModel] with PerceptronUtils

Part of speech tagger that might use different approaches

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

Instance Constructors

  1. new PerceptronModel()

    Permalink
  2. new PerceptronModel(uid: String)

    Permalink

    uid

    Internal constructor requirement for serialization of params

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

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: SetFeature[T]): Set[T]

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  9. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink

    One to one annotation standing from the Tokens perspective, to give each word a corresponding Tag

    One to one annotation standing from the Tokens perspective, to give each word a corresponding Tag

    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
    PerceptronModelAnnotatorModel
  11. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  12. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  13. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  14. final def clear(param: Param[_]): PerceptronModel.this.type

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

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

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  19. def dfAnnotate: UserDefinedFunction

    Permalink

    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
  20. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  25. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  26. final def extractParamMap(): ParamMap

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  32. def get[T](feature: SetFeature[T]): Option[Set[T]]

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

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

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

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

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

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  38. def getModel: AveragedPerceptron

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

    Permalink
    Definition Classes
    Params
  40. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

    Permalink
    Definition Classes
    Params
  44. def hasParent: Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  48. val inputAnnotatorTypes: Array[AnnotatorType]

    Permalink

    Annotator reference id.

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

    Definition Classes
    PerceptronModelHasInputAnnotationCols
  49. 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
  50. final def isDefined(param: Param[_]): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. val model: StructFeature[AveragedPerceptron]

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  71. val outputAnnotatorType: AnnotatorType

    Permalink
  72. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  74. var parent: Estimator[PerceptronModel]

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  78. def set[T](feature: SetFeature[T], value: Set[T]): PerceptronModel.this.type

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  85. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): PerceptronModel.this.type

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

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

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

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

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  91. def setModel(targetModel: AveragedPerceptron): PerceptronModel.this.type

    Permalink
  92. final def setOutputCol(value: String): PerceptronModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  93. def setParent(parent: Estimator[PerceptronModel]): PerceptronModel

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

    Permalink
    Definition Classes
    AnyRef
  95. def tag(tokenizedSentences: Array[TokenizedSentence]): Array[TaggedSentence]

    Permalink

    Tags a group of sentences into POS tagged sentences The logic here is to create a sentence context, run through every word and evaluate its context Based on how frequent a context appears around a word, such context is given a score which is used to predict Some words are marked as non ambiguous from the beginning

    Tags a group of sentences into POS tagged sentences The logic here is to create a sentence context, run through every word and evaluate its context Based on how frequent a context appears around a word, such context is given a score which is used to predict Some words are marked as non ambiguous from the beginning

    tokenizedSentences

    Sentence in the form of single word tokens

    returns

    A list of sentences which have every word tagged

  96. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  97. final def transform(dataset: Dataset[_]): DataFrame

    Permalink

    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
  98. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  100. 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
  101. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink

    Internal constructor requirement for serialization of params

    Internal constructor requirement for serialization of params

    Definition Classes
    PerceptronModel → Identifiable
  103. 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
    RawAnnotator
  104. final def wait(): Unit

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  108. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from PerceptronUtils

Inherited from RawAnnotator[PerceptronModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[PerceptronModel]

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