Class

com.johnsnowlabs.nlp.annotators.sentence_detector_dl

SentenceDetectorDLApproach

Related Doc: package sentence_detector_dl

Permalink

class SentenceDetectorDLApproach extends AnnotatorApproach[SentenceDetectorDLModel]

Trains an annotator that detects sentence boundaries using a deep learning approach.

For pretrained models see SentenceDetectorDLModel.

Currently, only the CNN model is supported for training, but in the future the architecture of the model can be set with setModelArchitecture.

The default model "cnn" is based on the paper Deep-EOS: General-Purpose Neural Networks for Sentence Boundary Detection (2020, Stefan Schweter, Sajawel Ahmed) using a CNN architecture. We also modified the original implementation a little bit to cover broken sentences and some impossible end of line chars.

Each extracted sentence can be returned in an Array or exploded to separate rows, if explodeSentences is set to true.

For extended examples of usage, see the SentenceDetectorDLSpec.

Example

The training process needs data, where each data point is a sentence.

In this example the train.txt file has the form of

...
Slightly more moderate language would make our present situation – namely the lack of progress – a little easier.
His political successors now have great responsibilities to history and to the heritage of values bequeathed to them by Nelson Mandela.
...

where each line is one sentence. Training can then be started like so:

import com.johnsnowlabs.nlp.base.DocumentAssembler
import com.johnsnowlabs.nlp.annotators.sentence_detector_dl.SentenceDetectorDLApproach
import org.apache.spark.ml.Pipeline

val trainingData = spark.read.text("train.txt").toDF("text")

val documentAssembler = new DocumentAssembler()
  .setInputCol("text")
  .setOutputCol("document")

val sentenceDetector = new SentenceDetectorDLApproach()
  .setInputCols(Array("document"))
  .setOutputCol("sentences")
  .setEpochsNumber(100)

val pipeline = new Pipeline().setStages(Array(documentAssembler, sentenceDetector))

val model = pipeline.fit(trainingData)
See also

SentenceDetector for non deep learning extraction

SentenceDetectorDLModel for pretrained models

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

    Permalink
  2. new SentenceDetectorDLApproach(uid: String)

    Permalink

    uid

    required uid for storing annotator to disk

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]): SentenceDetectorDLModel

    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[_]): SentenceDetectorDLApproach.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def copy(extra: ParamMap): Estimator[SentenceDetectorDLModel]

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  14. val description: String

    Permalink

    Trains TensorFlow model for multi-class text classification

    Trains TensorFlow model for multi-class text classification

    Definition Classes
    SentenceDetectorDLApproachAnnotatorApproach
  15. val epochsNumber: IntParam

    Permalink

    Maximum number of epochs to train (Default: 5)

  16. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    Params
  20. def explodeSentences: BooleanParam

    Permalink

    A flag indicating whether to split sentences into different Dataset rows.

    A flag indicating whether to split sentences into different Dataset rows. Useful for higher parallelism in fat rows (Default: false)

  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[_]): SentenceDetectorDLModel

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

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

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

    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 getEpochsNumber: Int

    Permalink

    Maximum number of epochs to train (Default: 5)

  32. def getExplodeSentences: Boolean

    Permalink

    Whether to split sentences into different Dataset rows.

    Whether to split sentences into different Dataset rows. Useful for higher parallelism in fat rows. Defaults to false.

  33. def getGraphFilename: String

    Permalink
  34. def getImpossiblePenultimates: Array[String]

    Permalink

    Get impossible penultimates

  35. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  36. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  37. def getModel: String

    Permalink

    Get model architecture

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

    Permalink
    Definition Classes
    Params
  39. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  40. def getOutputLogsPath: String

    Permalink

    Get output logs path

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

    Permalink
    Definition Classes
    Params
  42. def getValidationSplit: Float

    Permalink

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  46. val impossiblePenultimates: StringArrayParam

    Permalink

    Impossible penultimates, which should not be split on Default:

    Impossible penultimates, which should not be split on Default:

    Array(
      "Bros", "No", "al", "vs", "etc", "Fig", "Dr", "Prof", "PhD", "MD", "Co", "Corp", "Inc",
      "bros", "VS", "Vs", "ETC", "fig", "dr", "prof", "PHD", "phd", "md", "co", "corp", "inc",
      "Jan", "Feb", "Mar", "Apr", "Jul", "Aug", "Sep", "Sept", "Oct", "Nov", "Dec",
      "St", "st",
      "AM", "PM", "am", "pm",
      "e.g", "f.e", "i.e"
    )
  47. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

    Permalink

    Input annotator type : DOCUMENT

    Input annotator type : DOCUMENT

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

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  56. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. var modelArchitecture: Param[String]

    Permalink

    Model architecture (Default: "cnn")

  69. def msgHelper(schema: StructType): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
  73. def onTrained(model: SentenceDetectorDLModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  74. val outputAnnotatorType: String

    Permalink

    Output annotator type : DOCUMENT

    Output annotator type : DOCUMENT

    Definition Classes
    SentenceDetectorDLApproachHasOutputAnnotatorType
  75. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  76. val outputLogsPath: Param[String]

    Permalink

    Path to folder to output logs (Default: "") If no path is specified, no logs are generated

  77. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  78. def save(path: String): Unit

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  84. def setEpochsNumber(epochs: Int): SentenceDetectorDLApproach.this.type

    Permalink

    Maximum number of epochs to train (Default: 5)

  85. def setExplodeSentences(value: Boolean): SentenceDetectorDLApproach.this.type

    Permalink

    Whether to split sentences into different Dataset rows.

    Whether to split sentences into different Dataset rows. Useful for higher parallelism in fat rows. Defaults to false.

  86. def setGraphFile(graphFilename: String): SentenceDetectorDLApproach.this.type

    Permalink
  87. def setImpossiblePenultimates(impossiblePenultimates: Array[String]): SentenceDetectorDLApproach.this.type

    Permalink

    Set impossible penultimates

  88. final def setInputCols(value: String*): SentenceDetectorDLApproach.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  90. def setLazyAnnotator(value: Boolean): SentenceDetectorDLApproach.this.type

    Permalink
    Definition Classes
    CanBeLazy
  91. def setModel(modelArchitecture: String): SentenceDetectorDLApproach.this.type

    Permalink

    Set architecture

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  93. def setOutputLogsPath(outputLogsPath: String): SentenceDetectorDLApproach.this.type

    Permalink

    Set the output log path

  94. def setValidationSplit(validationSplit: Float): SentenceDetectorDLApproach.this.type

    Permalink

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  95. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink
  98. 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
  99. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink

    required uid for storing annotator to disk

    required uid for storing annotator to disk

    Definition Classes
    SentenceDetectorDLApproach → Identifiable
  101. 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
  102. val validationSplit: FloatParam

    Permalink

    Choose the proportion of training dataset to be validated against the model on each Epoch (Default: 0.0f).

    Choose the proportion of training dataset to be validated against the model on each Epoch (Default: 0.0f). The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  103. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  106. 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[SentenceDetectorDLModel]

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

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

Parameter getters