Packages

t

com.johnsnowlabs.nlp.annotators.sbd

SentenceDetectorParams

trait SentenceDetectorParams extends Params

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
Params, Serializable, Identifiable, AnyRef, Any
Known Subclasses
SentenceDetector
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. SentenceDetectorParams
  2. Params
  3. Serializable
  4. Identifiable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract val uid: String
    Definition Classes
    Identifiable

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def clear(param: Param[_]): SentenceDetectorParams.this.type
    Definition Classes
    Params
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  9. val customBounds: StringArrayParam

    Characters used to explicitly mark sentence bounds (Default: None)

  10. val customBoundsStrategy: Param[String]

    How to return matched custom bounds (Default: none).

    How to return matched custom bounds (Default: none). Will have no effect if no custom bounds are used. Possible values are:

    • "none" - Will not return the matched bound
    • "prepend" - Prepends a sentence break to the match
    • "append" - Appends a sentence break to the match
  11. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  12. val detectLists: BooleanParam

    Whether take lists into consideration at sentence detection (Default: true)

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  16. def explainParams(): String
    Definition Classes
    Params
  17. val explodeSentences: BooleanParam

    Whether to explode each sentence into a different row, for better parallelization (Default: false)

  18. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  19. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  20. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. def getCustomBounds: Array[String]

    Custom sentence separator text

  23. def getCustomBoundsStrategy: String

    Gets how to return matched custom bounds (Default: none).

  24. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  25. def getDetectLists: Boolean

    Whether to take lists into consideration at sentence detection.

    Whether to take lists into consideration at sentence detection. Defaults to true.

  26. def getExplodeSentences: Boolean

    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.

  27. def getMaxLength(value: Int): Int

    Get the maximum allowed length for each sentence

  28. def getMinLength(value: Int): Int

    Get the minimum allowed length for each sentence

  29. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  30. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  31. def getSplitLength: Int

    Length at which sentences will be forcibly split

  32. def getUseAbbreviations: Boolean

    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.

  33. def getUseCustomBoundsOnly: Boolean

    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.

  34. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  35. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  36. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  37. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  40. val maxLength: IntParam

    Set the maximum allowed length for each sentence (Ignored if not set)

  41. val minLength: IntParam

    Set the minimum allowed length for each sentence (Default: 0)

  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  45. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  46. final def set(paramPair: ParamPair[_]): SentenceDetectorParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  47. final def set(param: String, value: Any): SentenceDetectorParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  48. final def set[T](param: Param[T], value: T): SentenceDetectorParams.this.type
    Definition Classes
    Params
  49. def setCustomBounds(value: Array[String]): SentenceDetectorParams.this.type

    Custom sentence separator text

  50. def setCustomBoundsStrategy(value: String): SentenceDetectorParams.this.type

    Sets how to return matched custom bounds (Default: none).

    Sets how to return matched custom bounds (Default: none). Will have no effect if no custom bounds are used. Possible values are:

    • "none" - Will not return the matched bound
    • "prepend" - Prepends a sentence break to the match
    • "append" - Appends a sentence break to the match
  51. final def setDefault(paramPairs: ParamPair[_]*): SentenceDetectorParams.this.type
    Attributes
    protected
    Definition Classes
    Params
  52. final def setDefault[T](param: Param[T], value: T): SentenceDetectorParams.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  53. def setDetectLists(value: Boolean): SentenceDetectorParams.this.type

    Whether to take lists into consideration at sentence detection.

    Whether to take lists into consideration at sentence detection. Defaults to true.

  54. def setExplodeSentences(value: Boolean): SentenceDetectorParams.this.type

    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.

  55. def setMaxLength(value: Int): SentenceDetectorParams.this.type

    Set the maximum allowed length for each sentence

  56. def setMinLength(value: Int): SentenceDetectorParams.this.type

    Set the minimum allowed length for each sentence

  57. def setSplitLength(value: Int): SentenceDetectorParams.this.type

    Length at which sentences will be forcibly split

  58. def setUseAbbreviations(value: Boolean): SentenceDetectorParams.this.type

    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.

  59. def setUseCustomBoundsOnly(value: Boolean): SentenceDetectorParams.this.type

    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.

  60. val splitLength: IntParam

    Length at which sentences will be forcibly split (Ignored if not set)

  61. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  62. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  63. def truncateSentence(sentence: String, maxLength: Int): Array[String]
  64. val useAbbrevations: BooleanParam

    Whether to apply abbreviations at sentence detection (Default: true)

  65. val useCustomBoundsOnly: BooleanParam

    Whether to only utilize custom bounds for sentence detection (Default: false)

  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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 Params

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped