VowpalWabbitContextualBanditModel

Instance Constructors

new VowpalWabbitContextualBanditModel(uid: String)

Type Members

implicit class ParamStringBuilder extends AnyRef

Definition Classes
VowpalWabbitBase
class TrainContext extends AnyRef

Definition Classes
VowpalWabbitBase

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
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addExtraArgs(args: StringBuilder): Unit

* Allow subclasses to add further arguments
* Allow subclasses to add further arguments
args
argument builder to append to

Attributes
protected
Definition Classes
VowpalWabbitBase
val additionalFeatures: StringArrayParam

Definition Classes
HasAdditionalFeatures
def additionalPythonMethods(): String

Definition Classes
HasAdditionalPythonMethods
val additionalSharedFeatures: StringArrayParam

Definition Classes
VowpalWabbitContextualBanditBase
val args: Param[String]

Definition Classes
VowpalWabbitBase
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def clear(param: Param[_]): VowpalWabbitContextualBanditModel.this.type

Definition Classes
Params
def clone(): AnyRef

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

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

Attributes
protected
Definition Classes
Params
def createLabelSetter(schema: StructType): (Row, VowpalWabbitExample) ⇒ Unit

Attributes
protected
Definition Classes
VowpalWabbitBase
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
lazy val example: VowpalWabbitExample

Definition Classes
VowpalWabbitBaseModel
val exampleStack: SharedVariable[ExampleStack]
def explainParam(param: Param[_]): String

Definition Classes
Params
def explainParams(): String

Definition Classes
Params
final def extractParamMap(): ParamMap

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

Definition Classes
Params
final val featuresCol: Param[String]

Definition Classes
HasFeaturesCol
def featuresDataType: DataType

Attributes
protected
Definition Classes
PredictionModel
def finalize(): Unit

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

Definition Classes
Params
def getAdditionalColumns(): Seq[String]

Attributes
protected
Definition Classes
VowpalWabbitBase
def getAdditionalFeatures: Array[String]

Definition Classes
HasAdditionalFeatures
def getAdditionalSharedFeatures: Array[String]

Definition Classes
VowpalWabbitContextualBanditBase
def getArgs: String

Definition Classes
VowpalWabbitBase
def getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float

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

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

Definition Classes
Params
final def getFeaturesCol: String

Definition Classes
HasFeaturesCol
def getHashSeed: Int

Definition Classes
VowpalWabbitBase
def getIgnoreNamespaces: String

Definition Classes
VowpalWabbitBase
def getInitialModel: Array[Byte]

Definition Classes
VowpalWabbitBase
def getInteractions: Array[String]

Definition Classes
VowpalWabbitBase
def getL1: Double

Definition Classes
VowpalWabbitBase
def getL2: Double

Definition Classes
VowpalWabbitBase
final def getLabelCol: String

Definition Classes
HasLabelCol
def getLearningRate: Double

Definition Classes
VowpalWabbitBase
def getModel: Array[Byte]

Definition Classes
VowpalWabbitBaseModel
def getNumBits: Int

Definition Classes
VowpalWabbitBase
def getNumPasses: Int

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

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

Definition Classes
Params
def getPerformanceStatistics: DataFrame

Definition Classes
VowpalWabbitBaseModel
def getPowerT: Double

Definition Classes
VowpalWabbitBase
final def getPredictionCol: String

Definition Classes
HasPredictionCol
final def getRawPredictionCol: String

Definition Classes
HasRawPredictionCol
def getReadableModel: String

Definition Classes
VowpalWabbitBaseModel
def getSharedCol: String

Definition Classes
VowpalWabbitContextualBanditBase
def getTestArgs: String

Definition Classes
VowpalWabbitBaseModel
def getUseBarrierExecutionMode: Boolean

Definition Classes
VowpalWabbitBase
def getWeightCol: String

Definition Classes
HasWeightCol
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 hashSeed: IntParam

Definition Classes
VowpalWabbitBase
val ignoreNamespaces: Param[String]

Definition Classes
VowpalWabbitBase
val initialModel: ByteArrayParam

Definition Classes
VowpalWabbitBase
def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

Attributes
protected
Definition Classes
Logging
val interactions: StringArrayParam

Definition Classes
VowpalWabbitBase
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 l1: DoubleParam

Definition Classes
VowpalWabbitBase
val l2: DoubleParam

Definition Classes
VowpalWabbitBase
final val labelCol: Param[String]

Definition Classes
HasLabelCol
val learningRate: DoubleParam

Definition Classes
VowpalWabbitBase
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 model: ByteArrayParam

Definition Classes
VowpalWabbitBaseModel
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numBits: IntParam

Definition Classes
VowpalWabbitBase
def numFeatures: Int

Definition Classes
PredictionModel
Annotations
@Since( "1.6.0" )
val numPasses: IntParam

Definition Classes
VowpalWabbitBase
lazy val params: Array[Param[_]]

Definition Classes
Params
var parent: Estimator[VowpalWabbitContextualBanditModel]

Definition Classes
Model
val performanceStatistics: DataFrameParam

Definition Classes
VowpalWabbitBaseModel
val powerT: DoubleParam

Definition Classes
VowpalWabbitBase
def predict(features: Row): Double

Definition Classes
VowpalWabbitContextualBanditModel → PredictionModel
def predictInternal(featureColIndices: Seq[NamespaceInfo], row: Row): Double

Attributes
protected
Definition Classes
VowpalWabbitBaseModel
final val predictionCol: Param[String]

Definition Classes
HasPredictionCol
final val rawPredictionCol: Param[String]

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

Definition Classes
MLWritable
Annotations
@Since( "1.6.0" ) @throws( ... )
def saveNativeModel(path: String): Unit

Definition Classes
VowpalWabbitBaseModel
final def set(paramPair: ParamPair[_]): VowpalWabbitContextualBanditModel.this.type

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

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

Definition Classes
Params
def setAdditionalFeatures(value: Array[String]): VowpalWabbitContextualBanditModel.this.type

Definition Classes
HasAdditionalFeatures
def setAdditionalSharedFeatures(value: Array[String]): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitContextualBanditBase
def setArgs(value: String): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
final def setDefault(paramPairs: ParamPair[_]*): VowpalWabbitContextualBanditModel.this.type

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

Attributes
protected
Definition Classes
Params
def setFeaturesCol(value: String): VowpalWabbitContextualBanditModel

Definition Classes
PredictionModel
def setHashSeed(value: Int): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setIgnoreNamespaces(value: String): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setInitialModel(value: Array[Byte]): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setInteractions(value: Array[String]): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setL1(value: Double): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setL2(value: Double): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setLearningRate(value: Double): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setModel(v: Array[Byte]): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBaseModel
def setNumBits(value: Int): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setNumPasses(value: Int): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setParent(parent: Estimator[VowpalWabbitContextualBanditModel]): VowpalWabbitContextualBanditModel

Definition Classes
Model
def setPerformanceStatistics(v: DataFrame): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBaseModel
def setPowerT(value: Double): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setPredictionCol(value: String): VowpalWabbitContextualBanditModel

Definition Classes
PredictionModel
def setSharedCol(value: String): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitContextualBanditBase
def setTestArgs(value: String): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBaseModel
def setUseBarrierExecutionMode(value: Boolean): VowpalWabbitContextualBanditModel.this.type

Definition Classes
VowpalWabbitBase
def setWeightCol(value: String): VowpalWabbitContextualBanditModel.this.type

Definition Classes
HasWeightCol
val sharedCol: Param[String]

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

Definition Classes
AnyRef
val testArgs: Param[String]

Definition Classes
VowpalWabbitBaseModel
def toString(): String

Definition Classes
Identifiable → AnyRef → Any
def trainInternal[T <: VowpalWabbitBaseModel](dataset: Dataset[_], model: T): T

Main training loop
Main training loop
dataset
input data.
returns
binary VW model.

Attributes
protected
Definition Classes
VowpalWabbitBase
def trainInternalDistributed(df: DataFrame, vwArgs: StringBuilder, numTasks: Int): Array[TrainingResult]

Setup spanning tree and invoke training.
Setup spanning tree and invoke training.
df
input data.
vwArgs
VW command line arguments.
numTasks
number of target tasks.

Attributes
protected
Definition Classes
VowpalWabbitBase
def trainRow(schema: StructType, inputRows: Iterator[Row], ctx: TrainContext): Unit

Attributes
protected
Definition Classes
VowpalWabbitBase
def transform(dataset: Dataset[_]): DataFrame

Definition Classes
VowpalWabbitContextualBanditModel → PredictionModel → 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()
def transformImpl(dataset: Dataset[_]): DataFrame

Attributes
protected
Definition Classes
PredictionModel
def transformImplInternal(dataset: Dataset[_]): DataFrame

Attributes
protected
Definition Classes
VowpalWabbitBaseModel
def transformSchema(schema: StructType): StructType

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

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

Definition Classes
VowpalWabbitContextualBanditModel → Identifiable
val useBarrierExecutionMode: BooleanParam

Definition Classes
VowpalWabbitBase
def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

Attributes
protected
Definition Classes
PredictorParams
lazy val vw: VowpalWabbitNative

Definition Classes
VowpalWabbitBaseModel
lazy val vwArgs: VowpalWabbitArguments

Definition Classes
VowpalWabbitBaseModel
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( ... )
val weightCol: Param[String]

The name of the weight column
The name of the weight column

Definition Classes
HasWeightCol
def write: MLWriter

Definition Classes
ComplexParamsWritable → MLWritable

Related Docs: object VowpalWabbitContextualBanditModel | package vw

class VowpalWabbitContextualBanditModel extends PredictionModel[Row, VowpalWabbitContextualBanditModel] with VowpalWabbitBaseModel with VowpalWabbitContextualBanditBase with ComplexParamsWritable

Instance Constructors

new VowpalWabbitContextualBanditModel(uid: String)

Type Members

implicit class ParamStringBuilder extends AnyRef

class TrainContext extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

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

final def ==(arg0: Any): Boolean

def addExtraArgs(args: StringBuilder): Unit

val additionalFeatures: StringArrayParam

def additionalPythonMethods(): String

val additionalSharedFeatures: StringArrayParam

val args: Param[String]

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

def copy(extra: ParamMap): VowpalWabbitContextualBanditModel.this.type

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

def createLabelSetter(schema: StructType): (Row, VowpalWabbitExample) ⇒ Unit

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

lazy val example: VowpalWabbitExample

val exampleStack: SharedVariable[ExampleStack]

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

def explainParams(): String

final def extractParamMap(): ParamMap

final def extractParamMap(extra: ParamMap): ParamMap

final val featuresCol: Param[String]

def featuresDataType: DataType

def finalize(): Unit

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

def getAdditionalColumns(): Seq[String]

def getAdditionalFeatures: Array[String]

def getAdditionalSharedFeatures: Array[String]

def getArgs: String

def getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float

final def getClass(): Class[_]

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

final def getFeaturesCol: String

def getHashSeed: Int

def getIgnoreNamespaces: String

def getInitialModel: Array[Byte]

def getInteractions: Array[String]

def getL1: Double

def getL2: Double

final def getLabelCol: String

def getLearningRate: Double

def getModel: Array[Byte]

def getNumBits: Int

def getNumPasses: Int

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

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

def getPerformanceStatistics: DataFrame

def getPowerT: Double

final def getPredictionCol: String

final def getRawPredictionCol: String

def getReadableModel: String

def getSharedCol: String

def getTestArgs: String

def getUseBarrierExecutionMode: Boolean

def getWeightCol: String

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

def hasParam(paramName: String): Boolean

def hasParent: Boolean

def hashCode(): Int

val hashSeed: IntParam

val ignoreNamespaces: Param[String]

val initialModel: ByteArrayParam

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

def initializeLogIfNecessary(isInterpreter: Boolean): Unit

val interactions: StringArrayParam

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

final def isInstanceOf[T0]: Boolean

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