WordEmbeddingsModel

Instance Constructors

new WordEmbeddingsModel()

Annotator reference id.
Annotator reference id. Used to identify elements in metadata or to refer to this annotator type
new WordEmbeddingsModel(uid: String)

Type Members

type AnnotationContent = Seq[Row]

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

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

Attributes
protected
Definition Classes
WordEmbeddingsModel → AnnotatorModel
def annotate(annotations: Seq[Annotation]): Seq[Annotation]

takes a document and annotations and produces new annotations of this annotator's annotation type
takes a document and annotations and produces new annotations of this annotator's annotation type
annotations
Annotations that correspond to inputAnnotationCols generated by previous annotators if any
returns
any number of annotations processed for every input annotation. Not necessary one to one relationship

Definition Classes
WordEmbeddingsModel → AnnotatorModel
final def asInstanceOf[T0]: T0

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

Attributes
protected
Definition Classes
AnnotatorModel
val caseSensitive: BooleanParam

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

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

Definition Classes
Params
def clone(): AnyRef

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

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

Attributes
protected
Definition Classes
Params
def createDatabaseConnection(database: Name): RocksDBConnection

Definition Classes
HasStorageRef
def createReader(database: Name, connection: RocksDBConnection): WordEmbeddingsReader

Attributes
protected
Definition Classes
WordEmbeddingsModel → HasStorageReader
val databases: Array[Name]

Definition Classes
WordEmbeddingsModel → HasStorageModel
final def defaultCopy[T <: Params](extra: ParamMap): T

Attributes
protected
Definition Classes
Params
def deserializeStorage(path: String, spark: SparkSession): Unit

Definition Classes
HasStorageModel
def dfAnnotate: UserDefinedFunction

Attributes
protected
Definition Classes
AnnotatorModel
val dimension: IntParam

Definition Classes
HasEmbeddingsProperties
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
RawAnnotator
def extraValidateMsg: String

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

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

Definition Classes
Params
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 getCaseSensitive: Boolean

Definition Classes
HasCaseSensitiveProperties
final def getClass(): Class[_]

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

Definition Classes
Params
def getDimension: Int

Definition Classes
HasEmbeddingsProperties
def getIncludeStorage: Boolean

Definition Classes
HasExcludableStorage
def getInputCols: Array[String]

Definition Classes
HasInputAnnotationCols
def getLazyAnnotator: Boolean

Definition Classes
CanBeLazy
final def getOrDefault[T](param: Param[T]): T

Definition Classes
Params
final def getOutputCol: String

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

Definition Classes
Params
def getReader[A](database: Name): StorageReader[A]

Attributes
protected
Definition Classes
HasStorageReader
def getStorageRef: String

Definition Classes
HasStorageRef
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
val includeStorage: BooleanParam

Definition Classes
HasExcludableStorage
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]

Input annotator type : DOCUMENT, TOKEN
Input annotator type : DOCUMENT, TOKEN

Definition Classes
WordEmbeddingsModel → HasInputAnnotationCols
final val inputCols: StringArrayParam

Attributes
protected
Definition Classes
HasInputAnnotationCols
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
val lazyAnnotator: BooleanParam

Definition Classes
CanBeLazy
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
def msgHelper(schema: StructType): String

Attributes
protected
Definition Classes
HasInputAnnotationCols
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
HasStorageModel → ParamsAndFeaturesWritable
val outputAnnotatorType: AnnotatorType

Output annotator type : WORD_EMBEDDINGS
Output annotator type : WORD_EMBEDDINGS

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

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

Definition Classes
Params
var parent: Estimator[WordEmbeddingsModel]

Definition Classes
Model
val readCacheSize: IntParam

cache size for items retrieved from storage.
cache size for items retrieved from storage. Increase for performance but higher memory consumption
var readers: Map[Name, StorageReader[_]]

Attributes
protected
Definition Classes
HasStorageReader
def save(path: String): Unit

Definition Classes
MLWritable
Annotations
@Since( "1.6.0" ) @throws( ... )
def saveStorage(path: String, spark: SparkSession, withinStorage: Boolean): Unit

Definition Classes
HasStorageModel
def serializeStorage(path: String, spark: SparkSession): Unit

Definition Classes
HasStorageModel
def set[T](feature: StructFeature[T], value: T): WordEmbeddingsModel.this.type

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

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

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

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

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

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

Definition Classes
Params
def setCaseSensitive(value: Boolean): WordEmbeddingsModel.this.type

Definition Classes
HasCaseSensitiveProperties
def setDefault[T](feature: StructFeature[T], value: () ⇒ T): WordEmbeddingsModel.this.type

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

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

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

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

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

Attributes
protected
Definition Classes
Params
def setDimension(value: Int): WordEmbeddingsModel.this.type

Definition Classes
HasEmbeddingsProperties
def setIncludeStorage(value: Boolean): WordEmbeddingsModel.this.type

Definition Classes
HasExcludableStorage
final def setInputCols(value: String*): WordEmbeddingsModel.this.type

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

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

Definition Classes
CanBeLazy
final def setOutputCol(value: String): WordEmbeddingsModel.this.type

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

Definition Classes
Model
def setReadCacheSize(value: Int): WordEmbeddingsModel.this.type

Set cache size for items retrieved from storage.
Set cache size for items retrieved from storage. Increase for performance but higher memory consumption
def setStorageRef(value: String): WordEmbeddingsModel.this.type

Definition Classes
HasStorageRef
val storageRef: Param[String]

Definition Classes
HasStorageRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
final def transform(dataset: Dataset[_]): DataFrame

Definition Classes
AnnotatorModel → 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

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

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

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

Attributes
protected
Definition Classes
RawAnnotator
def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit

Definition Classes
HasStorageRef
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 wrapEmbeddingsMetadata(col: Column, embeddingsDim: Int, embeddingsRef: Option[String]): Column

Attributes
protected
Definition Classes
HasEmbeddingsProperties
def wrapSentenceEmbeddingsMetadata(col: Column, embeddingsDim: Int, embeddingsRef: Option[String]): Column

Attributes
protected
Definition Classes
HasEmbeddingsProperties
def write: MLWriter

Definition Classes
ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Related Docs: object WordEmbeddingsModel | package embeddings

class WordEmbeddingsModel extends AnnotatorModel[WordEmbeddingsModel] with HasEmbeddingsProperties with HasStorageModel with ParamsAndFeaturesWritable

Instance Constructors

new WordEmbeddingsModel()

new WordEmbeddingsModel(uid: String)

Type Members

type AnnotationContent = Seq[Row]

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

def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

def afterAnnotate(dataset: DataFrame): DataFrame

def annotate(annotations: Seq[Annotation]): Seq[Annotation]

final def asInstanceOf[T0]: T0

def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

val caseSensitive: BooleanParam

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

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

def clone(): AnyRef

def copy(extra: ParamMap): WordEmbeddingsModel

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

def createDatabaseConnection(database: Name): RocksDBConnection

def createReader(database: Name, connection: RocksDBConnection): WordEmbeddingsReader

val databases: Array[Name]

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

def deserializeStorage(path: String, spark: SparkSession): Unit

def dfAnnotate: UserDefinedFunction

val dimension: IntParam

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: String

final def extractParamMap(): ParamMap

final def extractParamMap(extra: ParamMap): ParamMap

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 getCaseSensitive: Boolean

final def getClass(): Class[_]

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

def getDimension: Int

def getIncludeStorage: Boolean

def getInputCols: Array[String]

def getLazyAnnotator: Boolean

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

final def getOutputCol: String

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

def getReader[A](database: Name): StorageReader[A]

def getStorageRef: String

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

def hasParam(paramName: String): Boolean

def hasParent: Boolean

def hashCode(): Int

val includeStorage: BooleanParam

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

def initializeLogIfNecessary(isInterpreter: Boolean): Unit

val inputAnnotatorTypes: Array[String]

final val inputCols: StringArrayParam

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

final def isInstanceOf[T0]: Boolean

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

def isTraceEnabled(): Boolean

val lazyAnnotator: BooleanParam

def log: Logger

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

def logDebug(msg: ⇒ String): Unit