Doc2Chunk

Instance Constructors

new Doc2Chunk()
new Doc2Chunk(uid: String)

Type Members

type AnnotatorType = String

Definition Classes
HasOutputAnnotatorType

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def $[T](param: Param[T]): T

Attributes
protected
Definition Classes
Params
def $$[T](feature: StructFeature[T]): T

Attributes
protected
Definition Classes
HasFeatures
def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

Attributes
protected
Definition Classes
HasFeatures
def $$[T](feature: SetFeature[T]): Set[T]

Attributes
protected
Definition Classes
HasFeatures
def $$[T](feature: ArrayFeature[T]): Array[T]

Attributes
protected
Definition Classes
HasFeatures
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

Attributes
protected
Definition Classes
HasInputAnnotationCols
val chunkCol: Param[String]
final def clear(param: Param[_]): Doc2Chunk.this.type

Definition Classes
Params
def clone(): AnyRef

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

requirement for annotators copies
requirement for annotators copies

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

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

Attributes
protected
Definition Classes
Params
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

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

Definition Classes
Params
def explainParams(): String

Definition Classes
Params
def extraValidate(structType: StructType): Boolean

Attributes
protected
Definition Classes
Doc2Chunk → RawAnnotator
def extraValidateMsg: AnnotatorType

Override for additional custom schema checks
Override for additional custom schema checks

Attributes
protected
Definition Classes
Doc2Chunk → RawAnnotator
final def extractParamMap(): ParamMap

Definition Classes
Params
final def extractParamMap(extra: ParamMap): ParamMap

Definition Classes
Params
val failOnMissing: BooleanParam
val features: ArrayBuffer[Feature[_, _, _]]

Definition Classes
HasFeatures
def finalize(): Unit

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

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

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

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

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

Definition Classes
Params
def getChunkCol: String
final def getClass(): Class[_]

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

Definition Classes
Params
def getFailOnMissing: Boolean
def getInputCols: Array[String]

returns
input annotations columns currently used

Definition Classes
HasInputAnnotationCols
def getIsArray: Boolean
def getLowerCase: Boolean
final def getOrDefault[T](param: Param[T]): T

Definition Classes
Params
final def getOutputCol: String

Gets annotation column name going to generate
Gets annotation column name going to generate

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

Definition Classes
Params
def getStartCol: String
def getStartColByTokenIndex: Boolean
final def hasDefault[T](param: Param[T]): Boolean

Definition Classes
Params
def hasParam(paramName: String): Boolean

Definition Classes
Params
def hasParent: Boolean

Definition Classes
Model
def hashCode(): Int

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

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

Attributes
protected
Definition Classes
Logging
val inputAnnotatorTypes: Array[String]

Annotator reference id.
Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

Definition Classes
Doc2Chunk → HasInputAnnotationCols
final val inputCols: StringArrayParam

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
val isArray: BooleanParam
final def isDefined(param: Param[_]): Boolean

Definition Classes
Params
final def isInstanceOf[T0]: Boolean

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

Definition Classes
Params
def isTraceEnabled(): Boolean

Attributes
protected
Definition Classes
Logging
def log: Logger

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

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

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

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

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

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

Attributes
protected
Definition Classes
Logging
def logName: String

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

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

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

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

Attributes
protected
Definition Classes
Logging
val lowerCase: BooleanParam
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Attributes
protected
Definition Classes
ParamsAndFeaturesWritable
val outputAnnotatorType: AnnotatorType

Definition Classes
Doc2Chunk → HasOutputAnnotatorType
final val outputCol: Param[String]

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

Definition Classes
Params
var parent: Estimator[Doc2Chunk]

Definition Classes
Model
def save(path: String): Unit

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

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

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

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

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

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

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

Definition Classes
Params
def setChunkCol(value: String): Doc2Chunk.this.type
def setDefault[T](feature: StructFeature[T], value: () ⇒ T): Doc2Chunk.this.type

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

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

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

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

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

Attributes
protected
Definition Classes
Params
def setFailOnMissing(value: Boolean): Doc2Chunk.this.type
final def setInputCols(value: String*): Doc2Chunk.this.type

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

Overrides required annotators column if different than default
Overrides required annotators column if different than default

Definition Classes
HasInputAnnotationCols
def setIsArray(value: Boolean): Doc2Chunk.this.type
def setLowerCase(value: Boolean): Doc2Chunk.this.type
final def setOutputCol(value: String): Doc2Chunk.this.type

Overrides annotation column name when transforming
Overrides annotation column name when transforming

Definition Classes
HasOutputAnnotationCol
def setParent(parent: Estimator[Doc2Chunk]): Doc2Chunk

Definition Classes
Model
def setStartCol(value: String): Doc2Chunk.this.type
def setStartColByTokenIndex(value: Boolean): Doc2Chunk.this.type
val startCol: Param[String]
val startColByTokenIndex: BooleanParam
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
def tokenIndexToCharIndex(text: String, tokenIndex: Int): Int
def transform(dataset: Dataset[_]): DataFrame

Definition Classes
Doc2Chunk → Transformer
def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

Definition Classes
Transformer
Annotations
@Since( "2.0.0" ) @varargs()
final def transformSchema(schema: StructType): StructType

requirement for pipeline transformation validation.
requirement for pipeline transformation validation. It is called on fit()

Definition Classes
RawAnnotator → PipelineStage
def transformSchema(schema: StructType, logging: Boolean): StructType

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

Definition Classes
Doc2Chunk → Identifiable
def validate(schema: StructType): Boolean

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
final def wait(): Unit

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

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

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

Attributes
protected
Definition Classes
RawAnnotator
def write: MLWriter

Definition Classes
ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Related Docs: object Doc2Chunk | package nlp

class Doc2Chunk extends Model[Doc2Chunk] with RawAnnotator[Doc2Chunk]

Instance Constructors

new Doc2Chunk()

new Doc2Chunk(uid: String)

Type Members

type AnnotatorType = String

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def $[T](param: Param[T]): T

def $$[T](feature: StructFeature[T]): T

def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

def $$[T](feature: SetFeature[T]): Set[T]

def $$[T](feature: ArrayFeature[T]): Array[T]

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

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

val chunkCol: Param[String]

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

def clone(): AnyRef

def copy(extra: ParamMap): Doc2Chunk

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

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

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

def explainParams(): String

def extraValidate(structType: StructType): Boolean

def extraValidateMsg: AnnotatorType

final def extractParamMap(): ParamMap

final def extractParamMap(extra: ParamMap): ParamMap

val failOnMissing: BooleanParam

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

def finalize(): Unit

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

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

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

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

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

def getChunkCol: String

final def getClass(): Class[_]

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

def getFailOnMissing: Boolean

def getInputCols: Array[String]

def getIsArray: Boolean

def getLowerCase: Boolean

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

final def getOutputCol: String

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

def getStartCol: String

def getStartColByTokenIndex: Boolean

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

def hasParam(paramName: String): Boolean

def hasParent: Boolean

def hashCode(): Int

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

def initializeLogIfNecessary(isInterpreter: Boolean): Unit

val inputAnnotatorTypes: Array[String]

final val inputCols: StringArrayParam

val isArray: BooleanParam

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

final def isInstanceOf[T0]: Boolean

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

def isTraceEnabled(): Boolean

def log: Logger

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

def logDebug(msg: ⇒ String): Unit

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

def logError(msg: ⇒ String): Unit

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

def logInfo(msg: ⇒ String): Unit

def logName: String

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

def logTrace(msg: ⇒ String): Unit

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

def logWarning(msg: ⇒ String): Unit

val lowerCase: BooleanParam

final def ne(arg0: AnyRef): Boolean