Estimator

Instance Constructors

new Estimator()

Abstract Value Members

abstract def fit(dataset: DataFrame, paramMap: ParamMap): M

Fits a single model to the input data with provided parameter map.
Fits a single model to the input data with provided parameter map.
dataset
input dataset
paramMap
Parameter map. These values override any specified in this Estimator's embedded ParamMap.
returns
fitted model
abstract def transformSchema(schema: StructType, paramMap: ParamMap): StructType

:: DeveloperAPI ::
:: DeveloperAPI ::
Derives the output schema from the input schema and parameters. The schema describes the columns and types of the data.
schema
Input schema to this stage
paramMap
Parameters passed to this stage
returns
Output schema from this stage

Definition Classes
PipelineStage
Annotations
@DeveloperApi()

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def addOutputColumn(schema: StructType, colName: String, dataType: DataType): StructType

Attributes
protected
Definition Classes
Params
final def asInstanceOf[T0]: T0

Definition Classes
Any
def checkInputColumn(schema: StructType, colName: String, dataType: DataType): Unit

Check whether the given schema contains an input column.
Check whether the given schema contains an input column.
colName
Parameter name for the input column.
dataType
SQL DataType of the input column.

Attributes
protected
Definition Classes
Params
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def explainParams(): String

Returns the documentation of all params.
Returns the documentation of all params.

Definition Classes
Params
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fit(dataset: DataFrame, paramMaps: Array[ParamMap]): Seq[M]

Fits multiple models to the input data with multiple sets of parameters.
Fits multiple models to the input data with multiple sets of parameters. The default implementation uses a for loop on each parameter map. Subclasses could overwrite this to optimize multi-model training.
dataset
input dataset
paramMaps
An array of parameter maps. These values override any specified in this Estimator's embedded ParamMap.
returns
fitted models, matching the input parameter maps
def fit(dataset: DataFrame, paramPairs: ParamPair[_]*): M

Fits a single model to the input data with optional parameters.
Fits a single model to the input data with optional parameters.
dataset
input dataset
paramPairs
Optional list of param pairs. These values override any specified in this Estimator's embedded ParamMap.
returns
fitted model

Annotations
@varargs()
def get[T](param: Param[T]): T

Gets the value of a parameter in the embedded param map.
Gets the value of a parameter in the embedded param map.

Attributes
protected
Definition Classes
Params
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Checks whether a param is explicitly set.
Checks whether a param is explicitly set.

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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val paramMap: ParamMap

Internal param map.
Internal param map.

Attributes
protected
Definition Classes
Params
def params: Array[Param[_]]

Returns all params.
Returns all params.

Definition Classes
Params
def set[T](param: Param[T], value: T): Estimator.this.type

Sets a parameter in the embedded param map.
Sets a parameter in the embedded param map.

Attributes
protected
Definition Classes
Params
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transformSchema(schema: StructType, paramMap: ParamMap, logging: Boolean): StructType

Derives the output schema from the input schema and parameters, optionally with logging.
Derives the output schema from the input schema and parameters, optionally with logging.

Attributes
protected
Definition Classes
PipelineStage
def validate(): Unit

Validates parameter values stored internally.
Validates parameter values stored internally. Raise an exception if any parameter value is invalid.

Definition Classes
Params
def validate(paramMap: ParamMap): Unit

Validates parameter values stored internally plus the input parameter map.
Validates parameter values stored internally plus the input parameter map. Raises an exception if any parameter is invalid.

Definition Classes
Params
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( ... )

abstract class Estimator[M <: Model[M]] extends PipelineStage with Params

Instance Constructors

new Estimator()

Abstract Value Members

abstract def fit(dataset: DataFrame, paramMap: ParamMap): M

abstract def transformSchema(schema: StructType, paramMap: ParamMap): StructType

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def addOutputColumn(schema: StructType, colName: String, dataType: DataType): StructType

final def asInstanceOf[T0]: T0

def checkInputColumn(schema: StructType, colName: String, dataType: DataType): Unit

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def explainParams(): String

def finalize(): Unit

def fit(dataset: DataFrame, paramMaps: Array[ParamMap]): Seq[M]

def fit(dataset: DataFrame, paramPairs: ParamPair[_]*): M

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

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val paramMap: ParamMap

def params: Array[Param[_]]

def set[T](param: Param[T], value: T): Estimator.this.type

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

def toString(): String

def transformSchema(schema: StructType, paramMap: ParamMap, logging: Boolean): StructType

def validate(): Unit

def validate(paramMap: ParamMap): Unit

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Params

Inherited from Identifiable

Inherited from PipelineStage

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Members