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, 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. RWrappable
  13. PythonWrappable
  14. BaseWrappable
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. 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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  19. 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
  20. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  21. def explainParams(): String
    Definition Classes
    Params
  22. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  23. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  24. final val featuresCol: Param[String]
    Definition Classes
    HasFeaturesCol
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  27. def getAdditionalColumns: Seq[String]
    Attributes
    protected
  28. def getAdditionalFeatures: Array[String]
    Definition Classes
    HasAdditionalFeatures
  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. final def getFeaturesCol: String
    Definition Classes
    HasFeaturesCol
  35. def getHashSeed: Int
    Definition Classes
    VowpalWabbitBase
  36. def getIgnoreNamespaces: String
    Definition Classes
    VowpalWabbitBase
  37. def getInitialModel: Array[Byte]
    Definition Classes
    VowpalWabbitBase
  38. def getInputColumns: Seq[String]
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseSpark → VowpalWabbitBase
  39. def getInteractions: Array[String]
    Definition Classes
    VowpalWabbitBase
  40. def getL1: Double
    Definition Classes
    VowpalWabbitBase
  41. def getL2: Double
    Definition Classes
    VowpalWabbitBase
  42. final def getLabelCol: String
    Definition Classes
    HasLabelCol
  43. def getLearningRate: Double
    Definition Classes
    VowpalWabbitBase
  44. def getNumBits: Int
    Definition Classes
    VowpalWabbitBase
  45. def getNumPasses: Int
    Definition Classes
    VowpalWabbitBase
  46. def getNumSyncsPerPass: Int
    Definition Classes
    VowpalWabbitBase
  47. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  48. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  49. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  50. def getPassThroughArgs: String
    Definition Classes
    VowpalWabbitBase
  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. def getWeightCol: String

    Definition Classes
    HasWeightCol
  57. 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
  58. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  59. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  60. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  61. val hashSeed: IntParam
    Definition Classes
    VowpalWabbitBase
  62. val ignoreNamespaces: Param[String]
    Definition Classes
    VowpalWabbitBase
  63. val initialModel: ByteArrayParam
    Definition Classes
    VowpalWabbitBase
  64. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  65. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. 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

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

    Definition Classes
    HasWeightCol
  153. val splitCol: Param[String]
    Definition Classes
    VowpalWabbitBaseLearner
  154. val splitColValues: StringArrayParam
    Definition Classes
    VowpalWabbitBaseLearner
  155. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  156. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  157. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  158. def trainDistributedExternal[T <: VowpalWabbitBaseModel](df: DataFrame, model: T): T
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseLearner
  159. def trainFromRows(schema: StructType, inputRows: Iterator[Row], ctx: TrainContext): Unit
    Attributes
    protected
    Definition Classes
    VowpalWabbitBaseSpark → VowpalWabbitBaseLearner
  160. 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
  161. 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
  162. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    VowpalWabbitBase
  163. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  164. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  165. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  166. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  167. 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 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