class PerceptronApproachDistributed extends AnnotatorApproach[PerceptronModel] with PerceptronTrainingUtils

Distributed Averaged Perceptron model to tag words part-of-speech.

Sets a POS tag to each word within a sentence. Its train data (train_pos) is a spark dataset of POS format values with Annotation columns.

See https://github.com/JohnSnowLabs/spark-nlp/blob/master/src/test/scala/com/johnsnowlabs/nlp/annotators/pos/perceptron/DistributedPos.scala for further reference on how to use this APIs.

Linear Supertypes
PerceptronTrainingUtils, PerceptronUtils, AnnotatorApproach[PerceptronModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[PerceptronModel], PipelineStage, Logging, Params, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. PerceptronApproachDistributed
  2. PerceptronTrainingUtils
  3. PerceptronUtils
  4. AnnotatorApproach
  5. CanBeLazy
  6. DefaultParamsWritable
  7. MLWritable
  8. HasOutputAnnotatorType
  9. HasOutputAnnotationCol
  10. HasInputAnnotationCols
  11. Estimator
  12. PipelineStage
  13. Logging
  14. Params
  15. Serializable
  16. Identifiable
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PerceptronApproachDistributed()
  2. new PerceptronApproachDistributed(uid: String)

    uid

    internal uid required to generate writable annotators

Type Members

  1. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType

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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): PerceptronModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  8. def buildTagBook(taggedSentences: Dataset[TaggedSentence], frequencyThreshold: Int = 20, ambiguityThreshold: Double = 0.97): Map[String, String]

    Finds very frequent tags on a word in training, and marks them as non ambiguous based on tune parameters ToDo: Move such parameters to configuration

    Finds very frequent tags on a word in training, and marks them as non ambiguous based on tune parameters ToDo: Move such parameters to configuration

    taggedSentences

    Takes entire tagged sentences to find frequent tags

    frequencyThreshold

    How many times at least a tag on a word to be marked as frequent

    ambiguityThreshold

    How much percentage of total amount of words are covered to be marked as frequent

  9. def buildTagBook(taggedSentences: Array[TaggedSentence], frequencyThreshold: Int, ambiguityThreshold: Double): Map[String, String]

    Finds very frequent tags on a word in training, and marks them as non ambiguous based on tune parameters ToDo: Move such parameters to configuration

    Finds very frequent tags on a word in training, and marks them as non ambiguous based on tune parameters ToDo: Move such parameters to configuration

    taggedSentences

    Takes entire tagged sentences to find frequent tags

    frequencyThreshold

    How many times at least a tag on a word to be marked as frequent

    ambiguityThreshold

    How much percentage of total amount of words are covered to be marked as frequent

    Definition Classes
    PerceptronTrainingUtils
  10. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  11. final def clear(param: Param[_]): PerceptronApproachDistributed.this.type
    Definition Classes
    Params
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  13. final def copy(extra: ParamMap): Estimator[PerceptronModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  14. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  15. val corpus: ExternalResourceParam

    POS tags delimited corpus.

    POS tags delimited corpus. Needs 'delimiter' in options

  16. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  17. val description: String

    Averaged Perceptron model to tag words part-of-speech

    Averaged Perceptron model to tag words part-of-speech

    Definition Classes
    PerceptronApproachDistributed → AnnotatorApproach
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  20. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  21. def explainParams(): String
    Definition Classes
    Params
  22. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  23. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  24. final def fit(dataset: Dataset[_]): PerceptronModel
    Definition Classes
    AnnotatorApproach → Estimator
  25. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[PerceptronModel]
    Definition Classes
    Estimator
    Annotations
    @Since("2.0.0")
  26. def fit(dataset: Dataset[_], paramMap: ParamMap): PerceptronModel
    Definition Classes
    Estimator
    Annotations
    @Since("2.0.0")
  27. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): PerceptronModel
    Definition Classes
    Estimator
    Annotations
    @varargs() @Since("2.0.0")
  28. def generatesTagBook(dataset: Dataset[_]): Array[TaggedSentence]

    Generates TagBook, which holds all the word to tags mapping that are not ambiguous

    Generates TagBook, which holds all the word to tags mapping that are not ambiguous

    Definition Classes
    PerceptronTrainingUtils
  29. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  30. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  32. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  33. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  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 hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  40. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  41. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. val inputAnnotatorTypes: Array[AnnotatorType]

    Input annotator types : TOKEN, DOCUMENT

    Input annotator types : TOKEN, DOCUMENT

    Definition Classes
    PerceptronApproachDistributed → HasInputAnnotationCols
  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. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  49. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  50. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  57. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  62. val nIterations: IntParam

    Number of iterations in training, converges to better accuracy

  63. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  64. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  65. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  66. def onTrained(model: PerceptronModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  67. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  68. val outputAnnotatorType: AnnotatorType

    Output annotator types : POS

    Output annotator types : POS

    Definition Classes
    PerceptronApproachDistributed → HasOutputAnnotatorType
  69. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  70. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  71. val posCol: Param[String]

    column of Array of POS tags that match tokens

  72. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @throws("If the input path already exists but overwrite is not enabled.") @Since("1.6.0")
  73. final def set(paramPair: ParamPair[_]): PerceptronApproachDistributed.this.type
    Attributes
    protected
    Definition Classes
    Params
  74. final def set(param: String, value: Any): PerceptronApproachDistributed.this.type
    Attributes
    protected
    Definition Classes
    Params
  75. final def set[T](param: Param[T], value: T): PerceptronApproachDistributed.this.type
    Definition Classes
    Params
  76. def setCorpus(path: String, delimiter: String, readAs: Format = ReadAs.SPARK, options: Map[String, String] = Map("format" -> "text")): PerceptronApproachDistributed.this.type

    POS tags delimited corpus.

    POS tags delimited corpus. Needs 'delimiter' in options

  77. def setCorpus(value: ExternalResource): PerceptronApproachDistributed.this.type

    POS tags delimited corpus.

    POS tags delimited corpus. Needs 'delimiter' in options

  78. final def setDefault(paramPairs: ParamPair[_]*): PerceptronApproachDistributed.this.type
    Attributes
    protected
    Definition Classes
    Params
  79. final def setDefault[T](param: Param[T], value: T): PerceptronApproachDistributed.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  80. final def setInputCols(value: String*): PerceptronApproachDistributed.this.type
    Definition Classes
    HasInputAnnotationCols
  81. def setInputCols(value: Array[String]): PerceptronApproachDistributed.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  82. def setLazyAnnotator(value: Boolean): PerceptronApproachDistributed.this.type
    Definition Classes
    CanBeLazy
  83. def setNIterations(value: Int): PerceptronApproachDistributed.this.type

    Number of iterations for training.

    Number of iterations for training. May improve accuracy but takes longer. Default 5.

  84. final def setOutputCol(value: String): PerceptronApproachDistributed.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  85. def setPosColumn(value: String): PerceptronApproachDistributed.this.type

    Column containing an array of POS Tags matching every token on the line.

  86. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  87. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  88. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): PerceptronModel

    Trains a model based on a provided CORPUS

    Trains a model based on a provided CORPUS

    returns

    A trained averaged model

    Definition Classes
    PerceptronApproachDistributed → AnnotatorApproach
  89. def trainPerceptron(nIterations: Int, initialModel: TrainingPerceptronLegacy, taggedSentences: Array[TaggedSentence], taggedWordBook: Map[String, String]): AveragedPerceptron

    Iterates for training

    Iterates for training

    Definition Classes
    PerceptronTrainingUtils
  90. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

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

    Definition Classes
    AnnotatorApproach → PipelineStage
  91. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  92. val uid: String
    Definition Classes
    PerceptronApproachDistributed → Identifiable
  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
    Definition Classes
    AnnotatorApproach
  94. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  95. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  96. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  97. def write: MLWriter
    Definition Classes
    DefaultParamsWritable → MLWritable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from PerceptronTrainingUtils

Inherited from PerceptronUtils

Inherited from AnnotatorApproach[PerceptronModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[PerceptronModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of (hyper-)parameter keys this annotator can take. Users can set and get the parameter values through setters and getters, respectively.

Annotator types

Required input and expected output annotator types

Members

Parameter setters