class VowpalWabbitGeneric extends Estimator[VowpalWabbitGenericModel] with VowpalWabbitBaseLearner with HasInputCol with SynapseMLLogging
This Estimator supports driving VW using VW-style examples (e.g. 0 |a b c)
- Alphabetic
- By Inheritance
- VowpalWabbitGeneric
- SynapseMLLogging
- HasInputCol
- VowpalWabbitBaseLearner
- VowpalWabbitBase
- ComplexParamsWritable
- MLWritable
- Wrappable
- DotnetWrappable
- RWrappable
- PythonWrappable
- BaseWrappable
- Estimator
- PipelineStage
- Logging
- Params
- Serializable
- Serializable
- Identifiable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
implicit
class
SpecificParamAppender 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
appendExtraParams(sb: ParamsStringBuilder): ParamsStringBuilder
Override to add parameters specific to subclass.
Override to add parameters specific to subclass.
- Attributes
- protected
- Definition Classes
- VowpalWabbitBase
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
buildCommandLineArguments(vwArgs: String, contextArgs: ⇒ String = ""): String
- Attributes
- protected
- Definition Classes
- VowpalWabbitBase
-
lazy val
classNameHelper: String
- Attributes
- protected
- Definition Classes
- BaseWrappable
-
final
def
clear(param: Param[_]): VowpalWabbitGeneric.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): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitGeneric → 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
-
final
def
defaultCopy[T <: Params](extra: ParamMap): T
- Attributes
- protected
- Definition Classes
- Params
-
def
dotnetAdditionalMethods: String
- Definition Classes
- DotnetWrappable
-
def
dotnetClass(): String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
lazy val
dotnetClassName: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
lazy val
dotnetClassNameString: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
lazy val
dotnetClassWrapperName: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
lazy val
dotnetCopyrightLines: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
def
dotnetExtraEstimatorImports: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
def
dotnetExtraMethods: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
lazy val
dotnetInternalWrapper: Boolean
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
def
dotnetMLReadWriteMethods: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
lazy val
dotnetNamespace: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
lazy val
dotnetObjectBaseClass: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
def
dotnetParamGetter(p: Param[_]): String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
def
dotnetParamGetters: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
def
dotnetParamSetter(p: Param[_]): String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
def
dotnetParamSetters: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
def
dotnetWrapAsTypeMethod: String
- Attributes
- protected
- Definition Classes
- DotnetWrappable
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
executeWithVowpalWabbit[T](block: (VowpalWabbitNative) ⇒ T): T
wrap the block w/ a VW instance that will be closed when the block is done.
wrap the block w/ a VW instance that will be closed when the block is done.
- Attributes
- protected
- Definition Classes
- VowpalWabbitBase
-
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
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
fit(dataset: Dataset[_]): VowpalWabbitGenericModel
- Definition Classes
- VowpalWabbitGeneric → Estimator
-
def
fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[VowpalWabbitGenericModel]
- Definition Classes
- Estimator
- Annotations
- @Since( "2.0.0" )
-
def
fit(dataset: Dataset[_], paramMap: ParamMap): VowpalWabbitGenericModel
- Definition Classes
- Estimator
- Annotations
- @Since( "2.0.0" )
-
def
fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): VowpalWabbitGenericModel
- Definition Classes
- Estimator
- Annotations
- @Since( "2.0.0" ) @varargs()
-
final
def
get[T](param: Param[T]): Option[T]
- Definition Classes
- Params
-
def
getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float
- Attributes
- protected
- Definition Classes
- VowpalWabbitBaseLearner
-
def
getAsInt(schema: StructType, idx: Int): (Row) ⇒ Int
- Attributes
- protected
- Definition Classes
- VowpalWabbitBaseLearner
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getCommandLineArgs: ParamsStringBuilder
- Attributes
- protected
- Definition Classes
- VowpalWabbitBase
-
final
def
getDefault[T](param: Param[T]): Option[T]
- Definition Classes
- Params
-
def
getHashSeed: Int
- Definition Classes
- VowpalWabbitBase
-
def
getIgnoreNamespaces: String
- Definition Classes
- VowpalWabbitBase
-
def
getInitialModel: Array[Byte]
- Definition Classes
- VowpalWabbitBase
-
def
getInputCol: String
- Definition Classes
- HasInputCol
-
def
getInputColumns: Seq[String]
- Attributes
- protected
- Definition Classes
- VowpalWabbitGeneric → VowpalWabbitBase
-
def
getInteractions: Array[String]
- Definition Classes
- VowpalWabbitBase
-
def
getL1: Double
- Definition Classes
- VowpalWabbitBase
-
def
getL2: Double
- Definition Classes
- VowpalWabbitBase
-
def
getLearningRate: Double
- Definition Classes
- VowpalWabbitBase
-
def
getNumBits: Int
- Definition Classes
- VowpalWabbitBase
-
def
getNumPasses: Int
- Definition Classes
- VowpalWabbitBase
-
def
getNumSyncsPerPass: 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
getParamInfo(p: Param[_]): ParamInfo[_]
- Definition Classes
- BaseWrappable
-
def
getPassThroughArgs: String
- Definition Classes
- VowpalWabbitBase
-
def
getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
- Attributes
- protected
- Definition Classes
- SynapseMLLogging
-
def
getPowerT: Double
- Definition Classes
- VowpalWabbitBase
-
def
getPredictionIdCol: String
- Definition Classes
- VowpalWabbitBaseLearner
-
def
getSplitCol: String
- Definition Classes
- VowpalWabbitBaseLearner
-
def
getSplitColValues: Array[String]
- Definition Classes
- VowpalWabbitBaseLearner
-
def
getUseBarrierExecutionMode: Boolean
- Definition Classes
- VowpalWabbitBase
-
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
inputCol: Param[String]
The name of the input column
The name of the input column
- Definition Classes
- HasInputCol
-
def
interPassSyncSchedule(df: DataFrame): VowpalWabbitSyncSchedule
initialize sync schedule.
initialize sync schedule. this might trigger computation (e.g. number of rows per partition)
- df
the input dataframe used to compute the schedules' steps
- returns
the synchronization schedule
- Attributes
- protected
- Definition Classes
- VowpalWabbitBase
- Note
this is supposed to be executed on the driver
-
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
-
val
learningRate: DoubleParam
- Definition Classes
- VowpalWabbitBase
-
def
log: Logger
- Attributes
- protected
- Definition Classes
- Logging
-
def
logBase(info: Map[String, String], featureName: Option[String]): Unit
- Attributes
- protected
- Definition Classes
- SynapseMLLogging
-
def
logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit
- Attributes
- protected
- Definition Classes
- SynapseMLLogging
-
def
logClass(featureName: String): Unit
- Definition Classes
- SynapseMLLogging
-
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
- SynapseMLLogging
-
def
logFit[T](f: ⇒ T, columns: Int): T
- Definition Classes
- SynapseMLLogging
-
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
logTransform[T](f: ⇒ T, columns: Int): T
- Definition Classes
- SynapseMLLogging
-
def
logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
- Definition Classes
- SynapseMLLogging
-
def
logWarning(msg: ⇒ String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
logWarning(msg: ⇒ String): Unit
- Attributes
- protected
- Definition Classes
- Logging
-
def
makeDotnetFile(conf: CodegenConfig): Unit
- Definition Classes
- DotnetWrappable
-
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
-
val
numSyncsPerPass: IntParam
- Definition Classes
- VowpalWabbitBase
-
lazy val
params: Array[Param[_]]
- Definition Classes
- Params
-
val
passThroughArgs: Param[String]
- Definition Classes
- VowpalWabbitBase
-
val
powerT: DoubleParam
- Definition Classes
- VowpalWabbitBase
-
val
predictionIdCol: Param[String]
- Definition Classes
- VowpalWabbitBaseLearner
-
def
prepareDataSet(dataset: Dataset[_]): DataFrame
- Attributes
- protected
- Definition Classes
- VowpalWabbitBase
-
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
- VowpalWabbitGeneric → 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[_]): VowpalWabbitGeneric.this.type
- Attributes
- protected
- Definition Classes
- Params
-
final
def
set(param: String, value: Any): VowpalWabbitGeneric.this.type
- Attributes
- protected
- Definition Classes
- Params
-
final
def
set[T](param: Param[T], value: T): VowpalWabbitGeneric.this.type
- Definition Classes
- Params
-
final
def
setDefault(paramPairs: ParamPair[_]*): VowpalWabbitGeneric.this.type
- Attributes
- protected
- Definition Classes
- Params
-
final
def
setDefault[T](param: Param[T], value: T): VowpalWabbitGeneric.this.type
- Attributes
- protected
- Definition Classes
- Params
-
def
setHashSeed(value: Int): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setIgnoreNamespaces(value: String): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setInitialModel(value: Array[Byte]): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setInputCol(value: String): VowpalWabbitGeneric.this.type
- Definition Classes
- HasInputCol
-
def
setInteractions(value: Array[String]): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setL1(value: Double): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setL2(value: Double): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setLearningRate(value: Double): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setNumBits(value: Int): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setNumPasses(value: Int): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setNumSyncsPerPass(value: Int): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setPassThroughArgs(value: String): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setPowerT(value: Double): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
def
setPredictionIdCol(value: String): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBaseLearner
-
def
setSplitCol(value: String): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBaseLearner
-
def
setSplitColValues(value: Array[String]): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBaseLearner
-
def
setUseBarrierExecutionMode(value: Boolean): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
-
val
splitCol: Param[String]
- Definition Classes
- VowpalWabbitBaseLearner
-
val
splitColValues: StringArrayParam
- Definition Classes
- VowpalWabbitBaseLearner
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
thisStage: Params
- Attributes
- protected
- Definition Classes
- BaseWrappable
-
def
toString(): String
- Definition Classes
- Identifiable → AnyRef → Any
-
def
train(dataset: Dataset[_]): VowpalWabbitGenericModel
- Attributes
- protected
-
def
trainDistributedExternal[T <: VowpalWabbitBaseModel](df: DataFrame, model: T): T
- Attributes
- protected
- Definition Classes
- VowpalWabbitBaseLearner
-
def
trainFromRows(schema: StructType, inputRows: Iterator[Row], ctx: TrainContext): Unit
- Attributes
- protected
- Definition Classes
- VowpalWabbitGeneric → VowpalWabbitBaseLearner
-
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
- VowpalWabbitBaseLearner
-
def
trainInternalDistributed(df: DataFrame, vwArgs: ParamsStringBuilder, numTasks: Int): Seq[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
- VowpalWabbitBaseLearner
-
def
transformSchema(schema: StructType): StructType
- Definition Classes
- VowpalWabbitGeneric → PipelineStage
-
def
transformSchema(schema: StructType, logging: Boolean): StructType
- Attributes
- protected
- Definition Classes
- PipelineStage
- Annotations
- @DeveloperApi()
-
val
uid: String
- Definition Classes
- VowpalWabbitGeneric → SynapseMLLogging → Identifiable
-
val
useBarrierExecutionMode: BooleanParam
- Definition Classes
- VowpalWabbitBase
-
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()
-
def
write: MLWriter
- Definition Classes
- ComplexParamsWritable → MLWritable
Deprecated Value Members
-
def
getArgs: String
- Definition Classes
- VowpalWabbitBase
- Annotations
- @deprecated
- Deprecated
(Since version 0.9.6) Please use 'getPassThroughArgs'.
-
def
setArgs(value: String): VowpalWabbitGeneric.this.type
- Definition Classes
- VowpalWabbitBase
- Annotations
- @deprecated
- Deprecated
(Since version 0.9.6) Please use 'setPassThroughArgs'.