Class/Object

com.johnsnowlabs.nlp.annotators.parser.dep

DependencyParserApproach

Related Docs: object DependencyParserApproach | package dep

Permalink

class DependencyParserApproach extends AnnotatorApproach[DependencyParserModel]

Unlabeled parser that finds a grammatical relation between two words in a sentence. Its input is a directory with dependency treebank files.

See https://github.com/JohnSnowLabs/spark-nlp/tree/master/src/test/scala/com/johnsnowlabs/nlp/annotators/parser/dep for further reference on how to use this API.

Linear Supertypes
AnnotatorApproach[DependencyParserModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[DependencyParserModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DependencyParserApproach
  2. AnnotatorApproach
  3. CanBeLazy
  4. DefaultParamsWritable
  5. MLWritable
  6. HasOutputAnnotatorType
  7. HasOutputAnnotationCol
  8. HasInputAnnotationCols
  9. Estimator
  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 DependencyParserApproach()

    Permalink
  2. new DependencyParserApproach(uid: String)

    Permalink

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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): DependencyParserModel

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  8. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val conllU: ExternalResourceParam

    Permalink

    Universal Dependencies source files

  12. final def copy(extra: ParamMap): Estimator[DependencyParserModel]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  13. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  15. val dependencyTreeBank: ExternalResourceParam

    Permalink

    Dependency treebank source files

  16. val description: String

    Permalink
  17. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def fit(dataset: Dataset[_]): DependencyParserModel

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator
  25. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[DependencyParserModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  26. def fit(dataset: Dataset[_], paramMap: ParamMap): DependencyParserModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  27. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DependencyParserModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  28. final def get[T](param: Param[T]): Option[T]

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

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

    Permalink
    Definition Classes
    Params
  31. def getFilesContentTreeBank: Seq[Iterator[String]]

    Permalink

    Gets a iterable TreeBank

  32. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  33. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  34. def getNumberOfIterations: Int

    Permalink

    Number of iterations in training, converges to better accuracy

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

    Permalink
    Definition Classes
    Params
  36. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  38. def getTrainingSentences: List[Sentence]

    Permalink

    Gets a list of ConnlU training sentences

  39. def getTrainingSentencesFromConllU(conllUAsArray: Array[String]): List[Sentence]

    Permalink
  40. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  42. def hashCode(): Int

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. val inputAnnotatorTypes: Array[String]

    Permalink

    Input annotation type : DOCUMENT, POS, TOKEN

    Input annotation type : DOCUMENT, POS, TOKEN

    Definition Classes
    DependencyParserApproachHasInputAnnotationCols
  46. 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
  47. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  52. def lineIsComment(line: String): Boolean

    Permalink
  53. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  66. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  69. val numberOfIterations: IntParam

    Permalink

    Number of iterations in training, converges to better accuracy

  70. def onTrained(model: DependencyParserModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  71. val outputAnnotatorType: String

    Permalink

    Output annotation type : DEPENDENCY

    Output annotation type : DEPENDENCY

    Definition Classes
    DependencyParserApproachHasOutputAnnotatorType
  72. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  74. def readCONLL(filesContent: Seq[Iterator[String]]): List[Sentence]

    Permalink
  75. def save(path: String): Unit

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

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

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

    Permalink
    Definition Classes
    Params
  79. def setConllU(path: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map.empty[String, String]): DependencyParserApproach.this.type

    Permalink

    Path to a file in CoNLL-U format

  80. final def setDefault(paramPairs: ParamPair[_]*): DependencyParserApproach.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  82. def setDependencyTreeBank(path: String, readAs: Format = ReadAs.TEXT, options: Map[String, String] = Map.empty[String, String]): DependencyParserApproach.this.type

    Permalink

    Dependency treebank folder with files in http://www.nltk.org/nltk_data/ Penn Treebank format

  83. final def setInputCols(value: String*): DependencyParserApproach.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  85. def setLazyAnnotator(value: Boolean): DependencyParserApproach.this.type

    Permalink
    Definition Classes
    CanBeLazy
  86. def setNumberOfIterations(value: Int): DependencyParserApproach.this.type

    Permalink

    Number of iterations in training, converges to better accuracy

  87. final def setOutputCol(value: String): DependencyParserApproach.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  88. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  90. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DependencyParserModel

    Permalink
  91. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

    Definition Classes
    AnnotatorApproach → PipelineStage
  92. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  93. def transformToSentences(cleanConllUSentence: Array[String]): Sentence

    Permalink
  94. val uid: String

    Permalink
    Definition Classes
    DependencyParserApproach → Identifiable
  95. 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
    AnnotatorApproach
  96. def validateTrainingFiles(): Unit

    Permalink
  97. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[DependencyParserModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

Annotator types

Required input and expected output annotator types

Members

Parameter setters

Parameter getters