Class

com.johnsnowlabs.nlp.annotators.sentence_detector_dl

SentenceDetectorDLApproach

Related Doc: package sentence_detector_dl

Permalink

class SentenceDetectorDLApproach extends AnnotatorApproach[SentenceDetectorDLModel]

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

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

  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. final def extractParamMap(): ParamMap

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  30. def getEpochsNumber: Int

    Permalink

    Maximum number of epochs to train

  31. def getGraphFilename: String

    Permalink
  32. def getImpossiblePenultimates: Array[String]

    Permalink

    Get impossible penultimates

  33. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  34. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  35. def getModel: String

    Permalink

    Get model architecture

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

    Permalink
    Definition Classes
    Params
  37. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  38. def getOutputLogsPath: String

    Permalink

    Get output logs path

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

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

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

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

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

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

    Permalink

    Impossible penultimates

  45. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

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

    Permalink

    Input annotator type : SENTENCE_EMBEDDINGS

    Input annotator type : SENTENCE_EMBEDDINGS

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

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  54. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

    Model architecture

  67. def msgHelper(schema: StructType): String

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

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

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

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

    Permalink
    Definition Classes
    AnnotatorApproach
  72. val outputAnnotatorType: String

    Permalink

    Output annotator type : CATEGORY

    Output annotator type : CATEGORY

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

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

    Permalink

    Path to folder to output logs.

    Path to folder to output logs. If no path is specified, no logs are generated

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

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

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

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

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

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

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

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

    Permalink

    Maximum number of epochs to train

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

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

    Permalink

    Set impossible penultimates

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  86. 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
  87. def setLazyAnnotator(value: Boolean): SentenceDetectorDLApproach.this.type

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

    Permalink

    Set architecture

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

    Permalink

    Set the output log path

  91. 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.

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

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

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

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

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

    Permalink
    Definition Classes
    SentenceDetectorDLApproach → Identifiable
  98. 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
  99. val validationSplit: FloatParam

    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.

  100. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  103. 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

anno

getParam

param

setParam

Ungrouped