t

com.microsoft.azure.synapse.ml.vw

VowpalWabbitBaseSpark

trait VowpalWabbitBaseSpark extends VowpalWabbitBaseLearner with HasLabelCol with HasWeightCol with HasFeaturesCol with HasAdditionalFeatures

* Base implementation for estimators that use Spark-based features (e.g. SparkML vectors)

Linear Supertypes
HasAdditionalFeatures, HasFeaturesCol, HasWeightCol, HasLabelCol, VowpalWabbitBaseLearner, VowpalWabbitBase, Logging, ComplexParamsWritable, MLWritable, Wrappable, DotnetWrappable, RWrappable, PythonWrappable, BaseWrappable, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
VowpalWabbitClassifier, VowpalWabbitContextualBandit, VowpalWabbitContextualBanditBase, VowpalWabbitContextualBanditModel, VowpalWabbitRegressor
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VowpalWabbitBaseSpark
  2. HasAdditionalFeatures
  3. HasFeaturesCol
  4. HasWeightCol
  5. HasLabelCol
  6. VowpalWabbitBaseLearner
  7. VowpalWabbitBase
  8. Logging
  9. ComplexParamsWritable
  10. MLWritable
  11. Wrappable
  12. DotnetWrappable
  13. RWrappable
  14. PythonWrappable
  15. BaseWrappable
  16. Params
  17. Serializable
  18. Serializable
  19. Identifiable
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class SpecificParamAppender extends AnyRef
    Definition Classes
    VowpalWabbitBase
  2. type VowpalWabbitLabelSetFunc = (Row, VowpalWabbitExample) ⇒ Unit

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract val uid: String
    Definition Classes
    Identifiable

Concrete 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. val additionalFeatures: StringArrayParam
    Definition Classes
    HasAdditionalFeatures
  6. def appendExtraParams(sb: ParamsStringBuilder): ParamsStringBuilder

    Override to add parameters specific to subclass.

    Override to add parameters specific to subclass.

    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def buildCommandLineArguments(vwArgs: String, contextArgs: ⇒ String = ""): String
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  9. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  10. final def clear(param: Param[_]): VowpalWabbitBaseSpark.this.type
    Definition Classes
    Params
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def companionModelClassName: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  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. def createLabelSetter(schema: StructType): VowpalWabbitLabelSetFunc
    Attributes
    protected
  16. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  17. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  18. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  19. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  20. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  21. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  22. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  23. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  24. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  25. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  26. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  27. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  28. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  29. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  30. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  31. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  32. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  33. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  34. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  36. 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
  37. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  38. def explainParams(): String
    Definition Classes
    Params
  39. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  40. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  41. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  42. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  43. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getAdditionalColumns: Seq[String]
    Attributes
    protected
  45. def getAdditionalFeatures: Array[String]
    Definition Classes
    HasAdditionalFeatures
  46. def getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseLearner
  47. def getAsInt(schema: StructType, idx: Int): (Row) ⇒ Int
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseLearner
  48. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  49. def getCommandLineArgs: ParamsStringBuilder
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  50. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  51. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  52. def getHashSeed: Int
    Definition Classes
    VowpalWabbitBase
  53. def getIgnoreNamespaces: String
    Definition Classes
    VowpalWabbitBase
  54. def getInitialModel: Array[Byte]
    Definition Classes
    VowpalWabbitBase
  55. def getInputColumns: Seq[String]
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseSpark → VowpalWabbitBase
  56. def getInteractions: Array[String]
    Definition Classes
    VowpalWabbitBase
  57. def getL1: Double
    Definition Classes
    VowpalWabbitBase
  58. def getL2: Double
    Definition Classes
    VowpalWabbitBase
  59. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  60. def getLearningRate: Double
    Definition Classes
    VowpalWabbitBase
  61. def getNumBits: Int
    Definition Classes
    VowpalWabbitBase
  62. def getNumPasses: Int
    Definition Classes
    VowpalWabbitBase
  63. def getNumSyncsPerPass: Int
    Definition Classes
    VowpalWabbitBase
  64. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  65. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  66. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  67. def getPassThroughArgs: String
    Definition Classes
    VowpalWabbitBase
  68. def getPowerT: Double
    Definition Classes
    VowpalWabbitBase
  69. def getPredictionIdCol: String
    Definition Classes
    VowpalWabbitBaseLearner
  70. def getSplitCol: String
    Definition Classes
    VowpalWabbitBaseLearner
  71. def getSplitColValues: Array[String]
    Definition Classes
    VowpalWabbitBaseLearner
  72. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    VowpalWabbitBase
  73. def getWeightCol: String

    Definition Classes
    HasWeightCol
  74. def getWeightGetter(schema: StructType): (Row) ⇒ Float

    default weight to 1 if not provided

    default weight to 1 if not provided

    schema

    the schema to fetch weight from

    returns

    an accessor method used to fetch the weight

    Attributes
    protected
  75. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  76. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  77. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  78. val hashSeed: IntParam
    Definition Classes
    VowpalWabbitBase
  79. val ignoreNamespaces: Param[String]
    Definition Classes
    VowpalWabbitBase
  80. val initialModel: ByteArrayParam
    Definition Classes
    VowpalWabbitBase
  81. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  82. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. 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

  84. val interactions: StringArrayParam
    Definition Classes
    VowpalWabbitBase
  85. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  86. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  87. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  88. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  89. val l1: DoubleParam
    Definition Classes
    VowpalWabbitBase
  90. val l2: DoubleParam
    Definition Classes
    VowpalWabbitBase
  91. final val labelCol: Param[String]
    Definition Classes
    HasLabelCol
  92. val learningRate: DoubleParam
    Definition Classes
    VowpalWabbitBase
  93. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  94. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  95. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  96. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  97. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  98. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  99. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  100. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  101. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  102. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  103. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  104. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  105. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  106. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  107. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  108. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  109. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  110. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  111. val numBits: IntParam
    Definition Classes
    VowpalWabbitBase
  112. val numPasses: IntParam
    Definition Classes
    VowpalWabbitBase
  113. val numSyncsPerPass: IntParam
    Definition Classes
    VowpalWabbitBase
  114. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  115. val passThroughArgs: Param[String]
    Definition Classes
    VowpalWabbitBase
  116. val powerT: DoubleParam
    Definition Classes
    VowpalWabbitBase
  117. val predictionIdCol: Param[String]
    Definition Classes
    VowpalWabbitBaseLearner
  118. def prepareDataSet(dataset: Dataset[_]): DataFrame
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  119. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  120. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  121. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  122. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  123. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  124. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  125. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  126. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase → PythonWrappable
  127. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  128. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  129. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  130. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  131. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  132. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  133. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  134. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  135. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  136. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  137. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  138. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  139. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  140. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  141. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  142. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  143. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  144. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  145. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  146. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  147. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  148. final def set(paramPair: ParamPair[_]): VowpalWabbitBaseSpark.this.type
    Attributes
    protected
    Definition Classes
    Params
  149. final def set(param: String, value: Any): VowpalWabbitBaseSpark.this.type
    Attributes
    protected
    Definition Classes
    Params
  150. final def set[T](param: Param[T], value: T): VowpalWabbitBaseSpark.this.type
    Definition Classes
    Params
  151. def setAdditionalFeatures(value: Array[String]): VowpalWabbitBaseSpark.this.type
    Definition Classes
    HasAdditionalFeatures
  152. final def setDefault(paramPairs: ParamPair[_]*): VowpalWabbitBaseSpark.this.type
    Attributes
    protected
    Definition Classes
    Params
  153. final def setDefault[T](param: Param[T], value: T): VowpalWabbitBaseSpark.this.type
    Attributes
    protected
    Definition Classes
    Params
  154. def setHashSeed(value: Int): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  155. def setIgnoreNamespaces(value: String): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  156. def setInitialModel(value: Array[Byte]): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  157. def setInteractions(value: Array[String]): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  158. def setL1(value: Double): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  159. def setL2(value: Double): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  160. def setLearningRate(value: Double): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  161. def setNumBits(value: Int): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  162. def setNumPasses(value: Int): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  163. def setNumSyncsPerPass(value: Int): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  164. def setPassThroughArgs(value: String): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  165. def setPowerT(value: Double): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  166. def setPredictionIdCol(value: String): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBaseLearner
  167. def setSplitCol(value: String): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBaseLearner
  168. def setSplitColValues(value: Array[String]): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBaseLearner
  169. def setUseBarrierExecutionMode(value: Boolean): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
  170. def setWeightCol(value: String): VowpalWabbitBaseSpark.this.type

    Definition Classes
    HasWeightCol
  171. val splitCol: Param[String]
    Definition Classes
    VowpalWabbitBaseLearner
  172. val splitColValues: StringArrayParam
    Definition Classes
    VowpalWabbitBaseLearner
  173. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  174. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  175. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  176. def trainDistributedExternal[T <: VowpalWabbitBaseModel](df: DataFrame, model: T): T
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseLearner
  177. def trainFromRows(schema: StructType, inputRows: Iterator[Row], ctx: TrainContext): Unit
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseSpark → VowpalWabbitBaseLearner
  178. 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
  179. 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
  180. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    VowpalWabbitBase
  181. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  182. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  183. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  184. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  185. 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): VowpalWabbitBaseSpark.this.type
    Definition Classes
    VowpalWabbitBase
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.6) Please use 'setPassThroughArgs'.

Inherited from HasAdditionalFeatures

Inherited from HasFeaturesCol

Inherited from HasWeightCol

Inherited from HasLabelCol

Inherited from VowpalWabbitBaseLearner

Inherited from VowpalWabbitBase

Inherited from Logging

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from Wrappable

Inherited from DotnetWrappable

Inherited from RWrappable

Inherited from PythonWrappable

Inherited from BaseWrappable

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped