Class/Object

com.johnsnowlabs.nlp.annotators.pos.perceptron

PerceptronModel

Related Docs: object PerceptronModel | package perceptron

Permalink

class PerceptronModel extends AnnotatorModel[PerceptronModel]

Part of speech tagger that might use different approaches

Linear Supertypes
AnnotatorModel[PerceptronModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasAnnotatorType, DefaultParamsWritable, MLWritable, Model[PerceptronModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PerceptronModel
  2. AnnotatorModel
  3. HasOutputAnnotationCol
  4. HasInputAnnotationCols
  5. HasAnnotatorType
  6. DefaultParamsWritable
  7. MLWritable
  8. Model
  9. Transformer
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. 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
    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. 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
  6. val annotatorType: AnnotatorType

    Permalink
    Definition Classes
    PerceptronModelHasAnnotatorType
  7. final def asInstanceOf[T0]: T0

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

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

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

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def get[T](param: Param[T]): Option[T]

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

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

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

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  24. def getModel: AveragedPerceptron

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

    Permalink
    Definition Classes
    Params
  26. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

    Permalink
    Definition Classes
    Params
  30. def hasParent: Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. val model: AnnotatorParam[AveragedPerceptron, SerializedPerceptronModel]

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

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

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

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

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

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

    Permalink
    Definition Classes
    Model
  57. val requiredAnnotatorTypes: 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
  58. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  62. final def setDefault(paramPairs: ParamPair[_]*): PerceptronModel.this.type

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

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  65. 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
  66. def setModel(targetModel: AveragedPerceptron): PerceptronModel.this.type

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

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

    Permalink
    Definition Classes
    AnyRef
  70. 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

  71. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  72. 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
  73. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

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

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    AnnotatorModel → PipelineStage
  76. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink

    Internal constructor requirement for serialization of params

    Internal constructor requirement for serialization of params

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

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasAnnotatorType

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