t

com.microsoft.azure.synapse.ml.vw

VowpalWabbitBase

trait VowpalWabbitBase extends Wrappable with HasWeightCol with HasAdditionalFeatures with Logging

Base implementation of VowpalWabbit learners.

Note

parameters that regularly are swept through are exposed as proper parameters.

Linear Supertypes
Logging, HasAdditionalFeatures, HasWeightCol, 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. VowpalWabbitBase
  2. Logging
  3. HasAdditionalFeatures
  4. HasWeightCol
  5. Wrappable
  6. DotnetWrappable
  7. RWrappable
  8. PythonWrappable
  9. BaseWrappable
  10. Params
  11. Serializable
  12. Serializable
  13. Identifiable
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class SpecificParamAppender extends AnyRef
  2. class TrainContext extends AnyRef

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract def featuresCol: Param[String]
  3. abstract def getFeaturesCol: String
  4. abstract def getLabelCol: String
  5. abstract def labelCol: Param[String]
  6. 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
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  9. final def clear(param: Param[_]): VowpalWabbitBase.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 copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  13. lazy val copyrightLines: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  14. def createLabelSetter(schema: StructType): (Row, VowpalWabbitExample) ⇒ Unit
    Attributes
    protected
  15. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  16. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  17. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  18. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  19. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  20. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  21. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  22. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  23. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  24. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  25. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  26. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  27. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  28. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  29. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  30. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  31. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  32. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  33. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  35. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  36. def explainParams(): String
    Definition Classes
    Params
  37. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  38. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  39. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  40. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  41. def getAdditionalColumns: Seq[String]
    Attributes
    protected
  42. def getAdditionalFeatures: Array[String]
    Definition Classes
    HasAdditionalFeatures
  43. def getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float
    Attributes
    protected
  44. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  46. def getHashSeed: Int
  47. def getIgnoreNamespaces: String
  48. def getInitialModel: Array[Byte]
  49. def getInteractions: Array[String]
  50. def getL1: Double
  51. def getL2: Double
  52. def getLearningRate: Double
  53. def getNumBits: Int
  54. def getNumPasses: Int
  55. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  56. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  57. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  58. def getPassThroughArgs: String
  59. def getPowerT: Double
  60. def getUseBarrierExecutionMode: Boolean
  61. def getWeightCol: String

    Definition Classes
    HasWeightCol
  62. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  63. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  64. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  65. val hashSeed: IntParam
  66. val ignoreNamespaces: Param[String]
  67. val initialModel: ByteArrayParam
  68. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  69. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. val interactions: StringArrayParam
  71. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  74. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  75. val l1: DoubleParam
  76. val l2: DoubleParam
  77. val learningRate: DoubleParam
  78. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  79. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  84. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  85. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  86. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  87. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  88. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  89. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  90. def makeDotnetFile(conf: CodegenConfig): Unit
    Definition Classes
    DotnetWrappable
  91. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  92. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  93. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  94. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  95. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  96. val numBits: IntParam
  97. val numPasses: IntParam
  98. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  99. val passThroughArgs: Param[String]
  100. val powerT: DoubleParam
  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. final def set(paramPair: ParamPair[_]): VowpalWabbitBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  130. final def set(param: String, value: Any): VowpalWabbitBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  131. final def set[T](param: Param[T], value: T): VowpalWabbitBase.this.type
    Definition Classes
    Params
  132. def setAdditionalFeatures(value: Array[String]): VowpalWabbitBase.this.type
    Definition Classes
    HasAdditionalFeatures
  133. final def setDefault(paramPairs: ParamPair[_]*): VowpalWabbitBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  134. final def setDefault[T](param: Param[T], value: T): VowpalWabbitBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  135. def setHashSeed(value: Int): VowpalWabbitBase.this.type
  136. def setIgnoreNamespaces(value: String): VowpalWabbitBase.this.type
  137. def setInitialModel(value: Array[Byte]): VowpalWabbitBase.this.type
  138. def setInteractions(value: Array[String]): VowpalWabbitBase.this.type
  139. def setL1(value: Double): VowpalWabbitBase.this.type
  140. def setL2(value: Double): VowpalWabbitBase.this.type
  141. def setLearningRate(value: Double): VowpalWabbitBase.this.type
  142. def setNumBits(value: Int): VowpalWabbitBase.this.type
  143. def setNumPasses(value: Int): VowpalWabbitBase.this.type
  144. def setPassThroughArgs(value: String): VowpalWabbitBase.this.type
  145. def setPowerT(value: Double): VowpalWabbitBase.this.type
  146. def setUseBarrierExecutionMode(value: Boolean): VowpalWabbitBase.this.type
  147. def setWeightCol(value: String): VowpalWabbitBase.this.type

    Definition Classes
    HasWeightCol
  148. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  149. val thisStage: Params
    Attributes
    protected
    Definition Classes
    BaseWrappable
  150. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  151. def trainInternal[T <: VowpalWabbitBaseModel](dataset: Dataset[_], model: T): T

    Main training loop

    Main training loop

    dataset

    input data.

    returns

    binary VW model.

    Attributes
    protected
  152. def trainInternalDistributed(df: DataFrame, vwArgs: ParamsStringBuilder, 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
  153. def trainRow(schema: StructType, inputRows: Iterator[Row], ctx: TrainContext): Unit
    Attributes
    protected
  154. val useBarrierExecutionMode: BooleanParam
  155. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  156. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  157. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  158. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol

Deprecated Value Members

  1. def getArgs: String
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.6) Please use 'getPassThroughArgs'.

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

    (Since version 0.9.6) Please use 'setPassThroughArgs'.

Inherited from Logging

Inherited from HasAdditionalFeatures

Inherited from HasWeightCol

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