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)

Linear Supertypes
SynapseMLLogging, HasInputCol, VowpalWabbitBaseLearner, VowpalWabbitBase, ComplexParamsWritable, MLWritable, Wrappable, RWrappable, PythonWrappable, BaseWrappable, Estimator[VowpalWabbitGenericModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VowpalWabbitGeneric
  2. SynapseMLLogging
  3. HasInputCol
  4. VowpalWabbitBaseLearner
  5. VowpalWabbitBase
  6. ComplexParamsWritable
  7. MLWritable
  8. Wrappable
  9. RWrappable
  10. PythonWrappable
  11. BaseWrappable
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new VowpalWabbitGeneric()
  2. new VowpalWabbitGeneric(uid: String)

Type Members

  1. implicit class SpecificParamAppender extends AnyRef
    Definition Classes
    VowpalWabbitBase

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def appendExtraParams(sb: ParamsStringBuilder): ParamsStringBuilder

    Override to add parameters specific to subclass.

    Override to add parameters specific to subclass.

    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def buildCommandLineArguments(vwArgs: String, contextArgs: ⇒ String = ""): String
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  8. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  9. final def clear(param: Param[_]): VowpalWabbitGeneric.this.type
    Definition Classes
    Params
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  12. def copy(extra: ParamMap): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitGeneric → Estimator → PipelineStage → Params
  13. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  14. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  15. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. 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
  19. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  20. def explainParams(): String
    Definition Classes
    Params
  21. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  22. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def fit(dataset: Dataset[_]): VowpalWabbitGenericModel
    Definition Classes
    VowpalWabbitGeneric → Estimator
  25. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[VowpalWabbitGenericModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  26. def fit(dataset: Dataset[_], paramMap: ParamMap): VowpalWabbitGenericModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  27. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): VowpalWabbitGenericModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  28. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. def getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseLearner
  30. def getAsInt(schema: StructType, idx: Int): (Row) ⇒ Int
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseLearner
  31. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. def getCommandLineArgs: ParamsStringBuilder
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  33. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  34. def getHashSeed: Int
    Definition Classes
    VowpalWabbitBase
  35. def getIgnoreNamespaces: String
    Definition Classes
    VowpalWabbitBase
  36. def getInitialModel: Array[Byte]
    Definition Classes
    VowpalWabbitBase
  37. def getInputCol: String

    Definition Classes
    HasInputCol
  38. def getInputColumns: Seq[String]
    Attributes
    protected
    Definition Classes
    VowpalWabbitGeneric → VowpalWabbitBase
  39. def getInteractions: Array[String]
    Definition Classes
    VowpalWabbitBase
  40. def getL1: Double
    Definition Classes
    VowpalWabbitBase
  41. def getL2: Double
    Definition Classes
    VowpalWabbitBase
  42. def getLearningRate: Double
    Definition Classes
    VowpalWabbitBase
  43. def getNumBits: Int
    Definition Classes
    VowpalWabbitBase
  44. def getNumPasses: Int
    Definition Classes
    VowpalWabbitBase
  45. def getNumSyncsPerPass: Int
    Definition Classes
    VowpalWabbitBase
  46. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  47. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  48. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  49. def getPassThroughArgs: String
    Definition Classes
    VowpalWabbitBase
  50. def getPayload(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], exception: Option[Exception]): Map[String, String]
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  51. def getPowerT: Double
    Definition Classes
    VowpalWabbitBase
  52. def getPredictionIdCol: String
    Definition Classes
    VowpalWabbitBaseLearner
  53. def getSplitCol: String
    Definition Classes
    VowpalWabbitBaseLearner
  54. def getSplitColValues: Array[String]
    Definition Classes
    VowpalWabbitBaseLearner
  55. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    VowpalWabbitBase
  56. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  57. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. val hashSeed: IntParam
    Definition Classes
    VowpalWabbitBase
  60. val ignoreNamespaces: Param[String]
    Definition Classes
    VowpalWabbitBase
  61. val initialModel: ByteArrayParam
    Definition Classes
    VowpalWabbitBase
  62. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  63. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. val inputCol: Param[String]

    The name of the input column

    The name of the input column

    Definition Classes
    HasInputCol
  65. 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

  66. val interactions: StringArrayParam
    Definition Classes
    VowpalWabbitBase
  67. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  68. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  69. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  70. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  71. val l1: DoubleParam
    Definition Classes
    VowpalWabbitBase
  72. val l2: DoubleParam
    Definition Classes
    VowpalWabbitBase
  73. val learningRate: DoubleParam
    Definition Classes
    VowpalWabbitBase
  74. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  75. def logBase(info: Map[String, String], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  76. def logBase(methodName: String, numCols: Option[Int], executionSeconds: Option[Double], featureName: Option[String]): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  77. def logClass(featureName: String): Unit
    Definition Classes
    SynapseMLLogging
  78. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  79. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logErrorBase(methodName: String, e: Exception): Unit
    Attributes
    protected
    Definition Classes
    SynapseMLLogging
  83. def logFit[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  84. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  86. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  87. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def logTransform[T](f: ⇒ T, columns: Int): T
    Definition Classes
    SynapseMLLogging
  90. def logVerb[T](verb: String, f: ⇒ T, columns: Option[Int] = None): T
    Definition Classes
    SynapseMLLogging
  91. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  92. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  93. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  94. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  95. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  96. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  97. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  98. val numBits: IntParam
    Definition Classes
    VowpalWabbitBase
  99. val numPasses: IntParam
    Definition Classes
    VowpalWabbitBase
  100. val numSyncsPerPass: IntParam
    Definition Classes
    VowpalWabbitBase
  101. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  102. val passThroughArgs: Param[String]
    Definition Classes
    VowpalWabbitBase
  103. val powerT: DoubleParam
    Definition Classes
    VowpalWabbitBase
  104. val predictionIdCol: Param[String]
    Definition Classes
    VowpalWabbitBaseLearner
  105. def prepareDataSet(dataset: Dataset[_]): DataFrame
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  106. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  107. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  108. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  109. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  110. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  111. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  112. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  113. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    VowpalWabbitGeneric → VowpalWabbitBase → PythonWrappable
  114. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  115. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  116. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  117. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  118. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  119. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  120. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  121. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  122. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  123. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  124. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  125. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  126. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  127. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  128. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  129. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  130. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  131. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  132. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  133. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  134. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  135. final def set(paramPair: ParamPair[_]): VowpalWabbitGeneric.this.type
    Attributes
    protected
    Definition Classes
    Params
  136. final def set(param: String, value: Any): VowpalWabbitGeneric.this.type
    Attributes
    protected
    Definition Classes
    Params
  137. final def set[T](param: Param[T], value: T): VowpalWabbitGeneric.this.type
    Definition Classes
    Params
  138. final def setDefault(paramPairs: ParamPair[_]*): VowpalWabbitGeneric.this.type
    Attributes
    protected
    Definition Classes
    Params
  139. final def setDefault[T](param: Param[T], value: T): VowpalWabbitGeneric.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  140. def setHashSeed(value: Int): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  141. def setIgnoreNamespaces(value: String): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  142. def setInitialModel(value: Array[Byte]): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  143. def setInputCol(value: String): VowpalWabbitGeneric.this.type

    Definition Classes
    HasInputCol
  144. def setInteractions(value: Array[String]): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  145. def setL1(value: Double): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  146. def setL2(value: Double): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  147. def setLearningRate(value: Double): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  148. def setNumBits(value: Int): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  149. def setNumPasses(value: Int): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  150. def setNumSyncsPerPass(value: Int): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  151. def setPassThroughArgs(value: String): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  152. def setPowerT(value: Double): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  153. def setPredictionIdCol(value: String): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBaseLearner
  154. def setSplitCol(value: String): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBaseLearner
  155. def setSplitColValues(value: Array[String]): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBaseLearner
  156. def setUseBarrierExecutionMode(value: Boolean): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
  157. val splitCol: Param[String]
    Definition Classes
    VowpalWabbitBaseLearner
  158. val splitColValues: StringArrayParam
    Definition Classes
    VowpalWabbitBaseLearner
  159. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  160. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  161. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  162. def train(dataset: Dataset[_]): VowpalWabbitGenericModel
    Attributes
    protected
  163. def trainDistributedExternal[T <: VowpalWabbitBaseModel](df: DataFrame, model: T): T
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseLearner
  164. def trainFromRows(schema: StructType, inputRows: Iterator[Row], ctx: TrainContext): Unit
    Attributes
    protected
    Definition Classes
    VowpalWabbitGeneric → VowpalWabbitBaseLearner
  165. 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
  166. 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
  167. def transformSchema(schema: StructType): StructType
    Definition Classes
    VowpalWabbitGeneric → PipelineStage
  168. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  169. val uid: String
    Definition Classes
    VowpalWabbitGeneric → SynapseMLLogging → Identifiable
  170. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    VowpalWabbitBase
  171. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  172. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  173. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  174. def write: MLWriter
    Definition Classes
    ComplexParamsWritable → MLWritable

Deprecated Value Members

  1. def getArgs: String
    Definition Classes
    VowpalWabbitBase
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.6) Please use 'getPassThroughArgs'.

  2. def setArgs(value: String): VowpalWabbitGeneric.this.type
    Definition Classes
    VowpalWabbitBase
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.6) Please use 'setPassThroughArgs'.

Inherited from SynapseMLLogging

Inherited from HasInputCol

Inherited from VowpalWabbitBaseLearner

Inherited from VowpalWabbitBase

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from Estimator[VowpalWabbitGenericModel]

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped