Class/Object

com.johnsnowlabs.nlp.annotators.assertion.logreg

AssertionLogRegModel

Related Docs: object AssertionLogRegModel | package logreg

Permalink

class AssertionLogRegModel extends Model[AssertionLogRegModel] with RawAnnotator[AssertionLogRegModel] with Windowing with HasStorageRef with CanBeLazy with Licensed

This is a main class in AssertionLogReg family. It contains all the parameters and main point of interest method transform() which projects the input dataset into DataFrame. Unlike DL Model, this class does not extend AnnotatorModel. Instead it extends the RawAnnotator, that's why the main point of interest is method transform()

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

Instance Constructors

  1. new AssertionLogRegModel()

    Permalink

  2. new AssertionLogRegModel(uid: String)

    Permalink

    uid

    a unique identifier for the instanced AnnotatorModel

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

  2. case class VectorizedChunk(vector: Vector, begin: Int, end: Int, sentenceId: Int, chunkId: Int) extends Product with Serializable

    Permalink
    Attributes
    protected
    Definition Classes
    Windowing

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. lazy val after: Int

    Permalink
    Definition Classes
    AssertionLogRegModel → Windowing

  10. val afterParam: IntParam

    Permalink

  11. def applyWindow(tokenizedSentence: WordpieceEmbeddingsSentence, s: Int, e: Int, embeddingsDim: Int): Array[Double]

    Permalink
    Definition Classes
    Windowing

  12. def applyWindowContext(tokenizedSentence: WordpieceEmbeddingsSentence, s: Int, e: Int, embeddingsDim: Int): (Array[Array[Float]], Array[Array[Float]], Array[Array[Float]])

    Permalink
    Definition Classes
    Windowing

  13. def applyWindowUdf(embeddingsDim: Int): UserDefinedFunction

    Permalink
    Definition Classes
    Windowing

  14. def applyWindowUdfChunk(embeddingsDim: Int): UserDefinedFunction

    Permalink
    Definition Classes
    Windowing

  15. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  16. lazy val before: Int

    Permalink
    Definition Classes
    AssertionLogRegModel → Windowing

  17. val beforeParam: IntParam

    Permalink

  18. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols

  19. final def clear(param: Param[_]): AssertionLogRegModel.this.type

    Permalink
    Definition Classes
    Params

  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. def copy(extra: ParamMap): AssertionLogRegModel

    Permalink

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    AssertionLogRegModel → RawAnnotator → Model → Transformer → PipelineStage → Params

  22. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  23. def createDatabaseConnection(database: Name): RocksDBConnection

    Permalink
    Definition Classes
    HasStorageRef

  24. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  25. val endCol: Param[String]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  27. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  28. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  29. def explainParams(): String

    Permalink
    Definition Classes
    Params

  30. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator

  31. def extraValidateMsg: String

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator

  32. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  33. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  34. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures

  35. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  36. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  37. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  38. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  39. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  40. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  41. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  42. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  43. def getInputCols: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols

  44. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy

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

    Permalink
    Definition Classes
    Params

  46. final def getOutputCol: String

    Permalink
    Definition Classes
    HasOutputAnnotationCol

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

    Permalink
    Definition Classes
    Params

  48. def getStorageRef: String

    Permalink
    Definition Classes
    HasStorageRef

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

    Permalink
    Definition Classes
    Params

  50. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  51. def hasParent: Boolean

    Permalink
    Definition Classes
    Model

  52. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  54. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  55. val inputAnnotatorTypes: Array[String]

    Permalink
    Definition Classes
    AssertionLogRegModel → HasInputAnnotationCols

  56. final val inputCols: StringArrayParam

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols

  57. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  58. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  59. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  60. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  61. def l2norm(xs: Array[Double]): Double

    Permalink
    Definition Classes
    Windowing

  62. var labelMap: MapFeature[Double, String]

    Permalink

  63. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy

  64. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  65. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  66. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  67. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  68. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  69. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  70. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  71. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  72. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  73. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  74. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  75. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  76. var model: StructFeature[LogisticRegressionModel]

    Permalink

  77. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols

  78. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  79. def normalize(vec: Array[Double]): Array[Double]

    Permalink
    Definition Classes
    Windowing

  80. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  81. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  82. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable

  83. val outputAnnotatorType: AnnotatorType

    Permalink
    Definition Classes
    AssertionLogRegModel → HasOutputAnnotatorType

  84. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol

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

    Permalink
    Definition Classes
    Params

  86. var parent: Estimator[AssertionLogRegModel]

    Permalink
    Definition Classes
    Model

  87. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  88. def set[T](feature: StructFeature[T], value: T): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  89. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  90. def set[T](feature: SetFeature[T], value: Set[T]): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  91. def set[T](feature: ArrayFeature[T], value: Array[T]): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  92. final def set(paramPair: ParamPair[_]): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  93. final def set(param: String, value: Any): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  94. final def set[T](param: Param[T], value: T): AssertionLogRegModel.this.type

    Permalink
    Definition Classes
    Params

  95. def setAfter(after: Int): AssertionLogRegModel.this.type

    Permalink

  96. def setBefore(before: Int): AssertionLogRegModel.this.type

    Permalink

  97. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  98. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  99. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  100. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  101. final def setDefault(paramPairs: ParamPair[_]*): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  102. final def setDefault[T](param: Param[T], value: T): AssertionLogRegModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  103. def setEndCol(end: String): AssertionLogRegModel.this.type

    Permalink

  104. final def setInputCols(value: String*): AssertionLogRegModel.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols

  105. final def setInputCols(value: Array[String]): AssertionLogRegModel.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols

  106. def setLabelMap(labelMappings: Map[String, Double]): AssertionLogRegModel.this.type

    Permalink

  107. def setLazyAnnotator(value: Boolean): AssertionLogRegModel.this.type

    Permalink
    Definition Classes
    CanBeLazy

  108. def setModel(m: LogisticRegressionModel): AssertionLogRegModel.this.type

    Permalink

  109. final def setOutputCol(value: String): AssertionLogRegModel.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol

  110. def setParent(parent: Estimator[AssertionLogRegModel]): AssertionLogRegModel

    Permalink
    Definition Classes
    Model

  111. def setStartCol(start: String): AssertionLogRegModel.this.type

    Permalink

  112. def setStorageRef(value: String): AssertionLogRegModel.this.type

    Permalink
    Definition Classes
    HasStorageRef

  113. val startCol: Param[String]

    Permalink

  114. val storageRef: Param[String]

    Permalink
    Definition Classes
    HasStorageRef

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

    Permalink
    Definition Classes
    AnyRef

  116. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  117. def tokenIndexToChunkIndex(doc: Array[TokenPieceEmbeddings], start: Int, end: Int): (Int, Int)

    Permalink
    Definition Classes
    Windowing

  118. final def transform(dataset: Dataset[_]): DataFrame

    Permalink

    This is main point of interest.

    This is main point of interest. It gets the input dataset transformed into the dataframe with predictions and probabilities This method utilises chunk groups, word piece embeddings and conversion to chunk indexes

    dataset

    an input dataset

    returns

    a DataFrame with probabilities of predictions

    Definition Classes
    AssertionLogRegModel → Transformer

  119. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )

  120. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()

  121. final def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    RawAnnotator → PipelineStage

  122. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  123. val uid: String

    Permalink

    a unique identifier for the instanced AnnotatorModel

    a unique identifier for the instanced AnnotatorModel

    Definition Classes
    AssertionLogRegModel → Identifiable

  124. def validate(schema: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator

  125. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit

    Permalink
    Definition Classes
    HasStorageRef

  126. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  127. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  128. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  129. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator

  130. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from Licensed

Inherited from CanBeLazy

Inherited from HasStorageRef

Inherited from Windowing

Inherited from RawAnnotator[AssertionLogRegModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[AssertionLogRegModel]

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

Ungrouped