c
com.microsoft.azure.synapse.ml.vw
VowpalWabbitContextualBandit
Companion object VowpalWabbitContextualBandit
class VowpalWabbitContextualBandit extends Predictor[Row, VowpalWabbitContextualBandit, VowpalWabbitContextualBanditModel] with VowpalWabbitContextualBanditBase with HasParallelismInjected with ComplexParamsWritable with BasicLogging
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- VowpalWabbitContextualBandit
- BasicLogging
- ComplexParamsWritable
- MLWritable
- HasParallelismInjected
- HasParallelism
- VowpalWabbitContextualBanditBase
- VowpalWabbitBase
- HasAdditionalFeatures
- HasWeightCol
- Wrappable
- RWrappable
- PythonWrappable
- BaseWrappable
- Predictor
- PredictorParams
- HasPredictionCol
- HasFeaturesCol
- HasLabelCol
- Estimator
- PipelineStage
- Logging
- Params
- Serializable
- Serializable
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
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
- VowpalWabbitContextualBandit → VowpalWabbitBase
-
val
additionalFeatures: StringArrayParam
- Definition Classes
- HasAdditionalFeatures
-
val
additionalSharedFeatures: StringArrayParam
- Definition Classes
- VowpalWabbitContextualBanditBase
-
val
args: Param[String]
- Definition Classes
- VowpalWabbitBase
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
awaitFutures[T](futures: Array[Future[T]]): Seq[T]
- Attributes
- protected
- Definition Classes
- HasParallelismInjected
- val chosenActionCol: Param[String]
-
lazy val
classNameHelper: String
- Attributes
- protected
- Definition Classes
- BaseWrappable
-
final
def
clear(param: Param[_]): VowpalWabbitContextualBandit.this.type
- Definition Classes
- Params
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
companionModelClassName: String
- Attributes
- protected
- Definition Classes
- BaseWrappable
-
def
copy(extra: ParamMap): VowpalWabbitContextualBandit
- Definition Classes
- VowpalWabbitContextualBandit → Predictor → Estimator → PipelineStage → Params
-
def
copyValues[T <: Params](to: T, extra: ParamMap): T
- Attributes
- protected
- Definition Classes
- Params
-
lazy val
copyrightLines: String
- Attributes
- protected
- Definition Classes
- BaseWrappable
-
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
- val epsilon: DoubleParam
-
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
extractInstances(dataset: Dataset[_], validateInstance: (Instance) ⇒ Unit): RDD[Instance]
- Attributes
- protected
- Definition Classes
- PredictorParams
-
def
extractInstances(dataset: Dataset[_]): RDD[Instance]
- Attributes
- protected
- Definition Classes
- PredictorParams
-
def
extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]
- Attributes
- protected
- Definition Classes
- Predictor
-
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
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[VowpalWabbitContextualBanditModel]
- Definition Classes
- VowpalWabbitContextualBandit → Estimator
-
def
fit(dataset: Dataset[_]): VowpalWabbitContextualBanditModel
- Definition Classes
- Predictor → Estimator
-
def
fit(dataset: Dataset[_], paramMap: ParamMap): VowpalWabbitContextualBanditModel
- Definition Classes
- Estimator
- Annotations
- @Since( "2.0.0" )
-
def
fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): VowpalWabbitContextualBanditModel
- Definition Classes
- Estimator
- Annotations
- @Since( "2.0.0" ) @varargs()
-
final
def
get[T](param: Param[T]): Option[T]
- Definition Classes
- Params
-
def
getAdditionalColumns: Seq[String]
- Attributes
- protected
- Definition Classes
- VowpalWabbitContextualBandit → 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
- def getChosenActionCol: String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
getDefault[T](param: Param[T]): Option[T]
- Definition Classes
- Params
- def getEpsilon: Double
-
def
getExecutionContextProxy: ExecutionContext
- Definition Classes
- HasParallelismInjected
-
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
getNumBits: Int
- Definition Classes
- VowpalWabbitBase
-
def
getNumPasses: Int
- Definition Classes
- VowpalWabbitBase
-
final
def
getOrDefault[T](param: Param[T]): T
- Definition Classes
- Params
-
def
getParallelism: Int
- Definition Classes
- HasParallelism
-
def
getParam(paramName: String): Param[Any]
- Definition Classes
- Params
-
def
getPowerT: Double
- Definition Classes
- VowpalWabbitBase
-
final
def
getPredictionCol: String
- Definition Classes
- HasPredictionCol
- def getProbabilityCol: String
-
def
getSharedCol: String
- Definition Classes
- VowpalWabbitContextualBanditBase
-
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
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
logBase(methodName: String): Unit
- Attributes
- protected
- Definition Classes
- BasicLogging
-
def
logClass(): Unit
- Definition Classes
- BasicLogging
-
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
logErrorBase(methodName: String, e: Exception): Unit
- Attributes
- protected
- Definition Classes
- BasicLogging
-
def
logFit[T](f: ⇒ T): T
- Definition Classes
- BasicLogging
-
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
logPredict[T](f: ⇒ T): T
- Definition Classes
- BasicLogging
-
def
logTrace(msg: ⇒ String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logTrace(msg: ⇒ String): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logTrain[T](f: ⇒ T): T
- Definition Classes
- BasicLogging
-
def
logTransform[T](f: ⇒ T): T
- Definition Classes
- BasicLogging
-
def
logVerb[T](verb: String, f: ⇒ T): T
- Definition Classes
- BasicLogging
-
def
logWarning(msg: ⇒ String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logWarning(msg: ⇒ String): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
makePyFile(conf: CodegenConfig): Unit
- Definition Classes
- PythonWrappable
-
def
makeRFile(conf: CodegenConfig): Unit
- Definition Classes
- RWrappable
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
numBits: IntParam
- Definition Classes
- VowpalWabbitBase
-
val
numPasses: IntParam
- Definition Classes
- VowpalWabbitBase
- def parallelFit(dataset: Dataset[_], paramMaps: ArrayList[ParamMap]): List[VowpalWabbitContextualBanditModel]
-
val
parallelism: IntParam
- Definition Classes
- HasParallelism
-
lazy val
params: Array[Param[_]]
- Definition Classes
- Params
-
val
powerT: DoubleParam
- Definition Classes
- VowpalWabbitBase
-
final
val
predictionCol: Param[String]
- Definition Classes
- HasPredictionCol
- val probabilityCol: Param[String]
-
def
pyAdditionalMethods: String
- Definition Classes
- PythonWrappable
-
lazy val
pyClassDoc: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
lazy val
pyClassName: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyExtraEstimatorImports: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyExtraEstimatorMethods: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
lazy val
pyInheritedClasses: Seq[String]
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyInitFunc(): String
- Definition Classes
- PythonWrappable
-
lazy val
pyInternalWrapper: Boolean
- Attributes
- protected
- Definition Classes
- VowpalWabbitContextualBandit → VowpalWabbitContextualBanditBase → VowpalWabbitBase → PythonWrappable
-
lazy val
pyObjectBaseClass: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamArg[T](p: Param[T]): String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamDefault[T](p: Param[T]): Option[String]
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamGetter(p: Param[_]): String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamSetter(p: Param[_]): String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamsArgs: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamsDefaults: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
lazy val
pyParamsDefinitions: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamsGetters: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pyParamsSetters: String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
pythonClass(): String
- Attributes
- protected
- Definition Classes
- PythonWrappable
-
def
rClass(): String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rDocString: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rExtraBodyLines: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rExtraInitLines: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
lazy val
rFuncName: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
lazy val
rInternalWrapper: Boolean
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rParamArg[T](p: Param[T]): String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rParamsArgs: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
rSetterLines: String
- Attributes
- protected
- Definition Classes
- RWrappable
-
def
save(path: String): Unit
- Definition Classes
- MLWritable
- Annotations
- @Since( "1.6.0" ) @throws( ... )
-
final
def
set(paramPair: ParamPair[_]): VowpalWabbitContextualBandit.this.type
- Attributes
- protected
- Definition Classes
- Params
-
final
def
set(param: String, value: Any): VowpalWabbitContextualBandit.this.type
- Attributes
- protected
- Definition Classes
- Params
-
final
def
set[T](param: Param[T], value: T): VowpalWabbitContextualBandit.this.type
- Definition Classes
- Params
-
def
setAdditionalFeatures(value: Array[String]): VowpalWabbitContextualBandit.this.type
- Definition Classes
- HasAdditionalFeatures
-
def
setAdditionalSharedFeatures(value: Array[String]): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitContextualBanditBase
-
def
setArgs(value: String): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
- def setChosenActionCol(value: String): VowpalWabbitContextualBandit.this.type
-
final
def
setDefault(paramPairs: ParamPair[_]*): VowpalWabbitContextualBandit.this.type
- Attributes
- protected
- Definition Classes
- Params
-
final
def
setDefault[T](param: Param[T], value: T): VowpalWabbitContextualBandit.this.type
- Attributes
- protected
- Definition Classes
- Params
- def setEpsilon(value: Double): VowpalWabbitContextualBandit.this.type
-
def
setFeaturesCol(value: String): VowpalWabbitContextualBandit
- Definition Classes
- Predictor
-
def
setHashSeed(value: Int): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setIgnoreNamespaces(value: String): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setInitialModel(value: Array[Byte]): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setInteractions(value: Array[String]): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setL1(value: Double): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setL2(value: Double): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setLabelCol(value: String): VowpalWabbitContextualBandit
- Definition Classes
- Predictor
-
def
setLearningRate(value: Double): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setNumBits(value: Int): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setNumPasses(value: Int): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
- def setParallelismForParamListFit(value: Int): VowpalWabbitContextualBandit.this.type
-
def
setPowerT(value: Double): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setPredictionCol(value: String): VowpalWabbitContextualBandit
- Definition Classes
- Predictor
- def setProbabilityCol(value: String): VowpalWabbitContextualBandit.this.type
-
def
setSharedCol(value: String): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitContextualBanditBase
-
def
setUseBarrierExecutionMode(value: Boolean): VowpalWabbitContextualBandit.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setWeightCol(value: String): VowpalWabbitContextualBandit.this.type
- Definition Classes
- HasWeightCol
-
val
sharedCol: Param[String]
- Definition Classes
- VowpalWabbitContextualBanditBase
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- Identifiable → AnyRef → Any
-
def
train(dataset: Dataset[_]): VowpalWabbitContextualBanditModel
- Attributes
- protected
- Definition Classes
- VowpalWabbitContextualBandit → Predictor
-
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
- VowpalWabbitContextualBandit → VowpalWabbitBase
-
def
transformSchema(schema: StructType): StructType
- Definition Classes
- VowpalWabbitContextualBandit → Predictor → PipelineStage
-
def
transformSchema(schema: StructType, logging: Boolean): StructType
- Attributes
- protected
- Definition Classes
- PipelineStage
- Annotations
- @DeveloperApi()
-
val
uid: String
- Definition Classes
- VowpalWabbitContextualBandit → BasicLogging → Identifiable
-
val
useBarrierExecutionMode: BooleanParam
- Definition Classes
- VowpalWabbitBase
-
def
validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType
- Attributes
- protected
- Definition Classes
- PredictorParams
-
val
ver: String
- Definition Classes
- BasicLogging
-
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( ... ) @native()
-
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