Class/Object

com.johnsnowlabs.nlp.annotators.sbd.pragmatic

SentenceDetector

Related Docs: object SentenceDetector | package pragmatic

Permalink

class SentenceDetector extends AnnotatorModel[SentenceDetector] with SentenceDetectorParams

Annotator that detects sentence boundaries using any provided approach

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

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

Instance Constructors

  1. new SentenceDetector()

    Permalink
  2. new SentenceDetector(uid: String)

    Permalink

    uid

    internal constructor requirement for serialization of params

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. 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 _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  10. def afterAnnotate(dataset: DataFrame): DataFrame

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

    Permalink

    Uses the model interface to prepare the context and extract the boundaries

    Uses the model interface to prepare the context and extract the boundaries

    annotations

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    One to many annotation relationship depending on how many sentences there are in the document

    Definition Classes
    SentenceDetectorAnnotatorModel
  12. final def asInstanceOf[T0]: T0

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

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

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

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

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

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  19. val customBounds: StringArrayParam

    Permalink

    characters used to explicitly mark sentence bounds

    characters used to explicitly mark sentence bounds

    Definition Classes
    SentenceDetectorParams
  20. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  21. 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
  22. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    Params
  26. val explodeSentences: BooleanParam

    Permalink

    whether to explode each sentence into a different row, for better parallelization.

    whether to explode each sentence into a different row, for better parallelization. Defaults to false.

    Definition Classes
    SentenceDetectorParams
  27. def extraValidate(structType: StructType): Boolean

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  39. def getCustomBounds: Array[String]

    Permalink

    Custom sentence separator text

    Custom sentence separator text

    Definition Classes
    SentenceDetectorParams
  40. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  41. 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.

    Definition Classes
    SentenceDetectorParams
  42. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  43. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  44. def getMaxLength(value: Int): Int

    Permalink

    Get the maximum allowed length for each sentence

    Get the maximum allowed length for each sentence

    Definition Classes
    SentenceDetectorParams
  45. def getMinLength(value: Int): Int

    Permalink

    Get the minimum allowed length for each sentence

    Get the minimum allowed length for each sentence

    Definition Classes
    SentenceDetectorParams
  46. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  47. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  49. def getSplitLength: Int

    Permalink

    Length at which sentences will be forcibly split

    Length at which sentences will be forcibly split

    Definition Classes
    SentenceDetectorParams
  50. def getUseAbbreviations: Boolean

    Permalink

    Whether to consider abbreviation strategies for better accuracy but slower performance.

    Whether to consider abbreviation strategies for better accuracy but slower performance. Defaults to true.

    Definition Classes
    SentenceDetectorParams
  51. def getUseCustomBoundsOnly: Boolean

    Permalink

    Use only custom bounds without considering those of Pragmatic Segmenter.

    Use only custom bounds without considering those of Pragmatic Segmenter. Defaults to false. Needs customBounds.

    Definition Classes
    SentenceDetectorParams
  52. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  54. def hasParent: Boolean

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

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

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

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

    Permalink

    Input annotator type : DOCUMENT

    Input annotator type : DOCUMENT

    Definition Classes
    SentenceDetectorHasInputAnnotationCols
  59. 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
  60. final def isDefined(param: Param[_]): Boolean

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  65. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  77. val maxLength: IntParam

    Permalink

    Set the maximum allowed length for each sentence

    Set the maximum allowed length for each sentence

    Definition Classes
    SentenceDetectorParams
  78. val minLength: IntParam

    Permalink

    Set the minimum allowed length for each sentence

    Set the minimum allowed length for each sentence

    Definition Classes
    SentenceDetectorParams
  79. lazy val model: PragmaticMethod

    Permalink
  80. def msgHelper(schema: StructType): String

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

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

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

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

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

    Permalink

    Output annotator type : DOCUMENT

    Output annotator type : DOCUMENT

    Definition Classes
    SentenceDetectorHasOutputAnnotatorType
  86. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  88. var parent: Estimator[SentenceDetector]

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  97. def setCustomBounds(value: Array[String]): SentenceDetector.this.type

    Permalink

    Custom sentence separator text

    Custom sentence separator text

    Definition Classes
    SentenceDetectorParams
  98. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): SentenceDetector.this.type

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  104. def setExplodeSentences(value: Boolean): SentenceDetector.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.

    Definition Classes
    SentenceDetectorParams
  105. final def setInputCols(value: String*): SentenceDetector.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  107. def setLazyAnnotator(value: Boolean): SentenceDetector.this.type

    Permalink
    Definition Classes
    CanBeLazy
  108. def setMaxLength(value: Int): SentenceDetector.this.type

    Permalink

    Set the maximum allowed length for each sentence

    Set the maximum allowed length for each sentence

    Definition Classes
    SentenceDetectorParams
  109. def setMinLength(value: Int): SentenceDetector.this.type

    Permalink

    Set the minimum allowed length for each sentence

    Set the minimum allowed length for each sentence

    Definition Classes
    SentenceDetectorParams
  110. final def setOutputCol(value: String): SentenceDetector.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  111. def setParent(parent: Estimator[SentenceDetector]): SentenceDetector

    Permalink
    Definition Classes
    Model
  112. def setSplitLength(value: Int): SentenceDetector.this.type

    Permalink

    Length at which sentences will be forcibly split

    Length at which sentences will be forcibly split

    Definition Classes
    SentenceDetectorParams
  113. def setUseAbbreviations(value: Boolean): SentenceDetector.this.type

    Permalink

    Whether to consider abbreviation strategies for better accuracy but slower performance.

    Whether to consider abbreviation strategies for better accuracy but slower performance. Defaults to true.

    Definition Classes
    SentenceDetectorParams
  114. def setUseCustomBoundsOnly(value: Boolean): SentenceDetector.this.type

    Permalink

    Use only custom bounds without considering those of Pragmatic Segmenter.

    Use only custom bounds without considering those of Pragmatic Segmenter. Defaults to false. Needs customBounds.

    Definition Classes
    SentenceDetectorParams
  115. val splitLength: IntParam

    Permalink

    length at which sentences will be forcibly split.

    length at which sentences will be forcibly split.

    Definition Classes
    SentenceDetectorParams
  116. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  117. def tag(document: String): Array[Sentence]

    Permalink
  118. def toString(): String

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  124. def truncateSentence(sentence: String, maxLength: Int): Array[String]

    Permalink
    Definition Classes
    SentenceDetectorParams
  125. val uid: String

    Permalink

    internal constructor requirement for serialization of params

    internal constructor requirement for serialization of params

    Definition Classes
    SentenceDetector → Identifiable
  126. val useAbbrevations: BooleanParam

    Permalink

    whether to apply abbreviations at sentence detection

    whether to apply abbreviations at sentence detection

    Definition Classes
    SentenceDetectorParams
  127. val useCustomBoundsOnly: BooleanParam

    Permalink

    whether to only utilize custom bounds for sentence detection

    whether to only utilize custom bounds for sentence detection

    Definition Classes
    SentenceDetectorParams
  128. 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
  129. final def wait(): Unit

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from SentenceDetectorParams

Inherited from CanBeLazy

Inherited from RawAnnotator[SentenceDetector]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[SentenceDetector]

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

Annotator types

Required input and expected output annotator types

Members