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, 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. RWrappable
  7. PythonWrappable
  8. BaseWrappable
  9. Params
  10. Serializable
  11. Serializable
  12. Identifiable
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class ParamStringBuilder 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. def addExtraArgs(args: StringBuilder): Unit

    * Allow subclasses to add further arguments

    * Allow subclasses to add further arguments

    args

    argument builder to append to

    Attributes
    protected
  6. val additionalFeatures: StringArrayParam
    Definition Classes
    HasAdditionalFeatures
  7. val args: Param[String]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. lazy val classNameHelper: String
    Attributes
    protected
    Definition Classes
    BaseWrappable
  10. final def clear(param: Param[_]): VowpalWabbitBase.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): (Row, VowpalWabbitExample) ⇒ Unit
    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 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. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  25. def getAdditionalColumns: Seq[String]
    Attributes
    protected
  26. def getAdditionalFeatures: Array[String]
    Definition Classes
    HasAdditionalFeatures
  27. def getArgs: String
  28. def getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float
    Attributes
    protected
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  31. def getHashSeed: Int
  32. def getIgnoreNamespaces: String
  33. def getInitialModel: Array[Byte]
  34. def getInteractions: Array[String]
  35. def getL1: Double
  36. def getL2: Double
  37. def getLearningRate: Double
  38. def getNumBits: Int
  39. def getNumPasses: Int
  40. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  41. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  42. def getPowerT: Double
  43. def getUseBarrierExecutionMode: Boolean
  44. def getWeightCol: String

    Definition Classes
    HasWeightCol
  45. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  46. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  47. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  48. val hashSeed: IntParam
  49. val ignoreNamespaces: Param[String]
  50. val initialModel: ByteArrayParam
  51. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  52. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. val interactions: StringArrayParam
  54. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  57. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  58. val l1: DoubleParam
  59. val l2: DoubleParam
  60. val learningRate: DoubleParam
  61. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  62. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  68. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  69. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  70. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  71. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  72. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def makePyFile(conf: CodegenConfig): Unit
    Definition Classes
    PythonWrappable
  74. def makeRFile(conf: CodegenConfig): Unit
    Definition Classes
    RWrappable
  75. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  76. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  77. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  78. val numBits: IntParam
  79. val numPasses: IntParam
  80. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  81. val powerT: DoubleParam
  82. def pyAdditionalMethods: String
    Definition Classes
    PythonWrappable
  83. lazy val pyClassDoc: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  84. lazy val pyClassName: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  85. def pyExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  86. def pyExtraEstimatorMethods: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  87. lazy val pyInheritedClasses: Seq[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  88. def pyInitFunc(): String
    Definition Classes
    PythonWrappable
  89. lazy val pyInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase → PythonWrappable
  90. lazy val pyObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  91. def pyParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  92. def pyParamDefault[T](p: Param[T]): Option[String]
    Attributes
    protected
    Definition Classes
    PythonWrappable
  93. def pyParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  94. def pyParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  95. def pyParamsArgs: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  96. def pyParamsDefaults: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  97. lazy val pyParamsDefinitions: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  98. def pyParamsGetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  99. def pyParamsSetters: String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  100. def pythonClass(): String
    Attributes
    protected
    Definition Classes
    PythonWrappable
  101. def rClass(): String
    Attributes
    protected
    Definition Classes
    RWrappable
  102. def rDocString: String
    Attributes
    protected
    Definition Classes
    RWrappable
  103. def rExtraBodyLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  104. def rExtraInitLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  105. lazy val rFuncName: String
    Attributes
    protected
    Definition Classes
    RWrappable
  106. lazy val rInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    RWrappable
  107. def rParamArg[T](p: Param[T]): String
    Attributes
    protected
    Definition Classes
    RWrappable
  108. def rParamsArgs: String
    Attributes
    protected
    Definition Classes
    RWrappable
  109. def rSetterLines: String
    Attributes
    protected
    Definition Classes
    RWrappable
  110. final def set(paramPair: ParamPair[_]): VowpalWabbitBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  111. final def set(param: String, value: Any): VowpalWabbitBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  112. final def set[T](param: Param[T], value: T): VowpalWabbitBase.this.type
    Definition Classes
    Params
  113. def setAdditionalFeatures(value: Array[String]): VowpalWabbitBase.this.type
    Definition Classes
    HasAdditionalFeatures
  114. def setArgs(value: String): VowpalWabbitBase.this.type
  115. final def setDefault(paramPairs: ParamPair[_]*): VowpalWabbitBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  116. final def setDefault[T](param: Param[T], value: T): VowpalWabbitBase.this.type
    Attributes
    protected
    Definition Classes
    Params
  117. def setHashSeed(value: Int): VowpalWabbitBase.this.type
  118. def setIgnoreNamespaces(value: String): VowpalWabbitBase.this.type
  119. def setInitialModel(value: Array[Byte]): VowpalWabbitBase.this.type
  120. def setInteractions(value: Array[String]): VowpalWabbitBase.this.type
  121. def setL1(value: Double): VowpalWabbitBase.this.type
  122. def setL2(value: Double): VowpalWabbitBase.this.type
  123. def setLearningRate(value: Double): VowpalWabbitBase.this.type
  124. def setNumBits(value: Int): VowpalWabbitBase.this.type
  125. def setNumPasses(value: Int): VowpalWabbitBase.this.type
  126. def setPowerT(value: Double): VowpalWabbitBase.this.type
  127. def setUseBarrierExecutionMode(value: Boolean): VowpalWabbitBase.this.type
  128. def setWeightCol(value: String): VowpalWabbitBase.this.type

    Definition Classes
    HasWeightCol
  129. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  130. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  131. def trainInternal[T <: VowpalWabbitBaseModel](dataset: Dataset[_], model: T): T

    Main training loop

    Main training loop

    dataset

    input data.

    returns

    binary VW model.

    Attributes
    protected
  132. def trainInternalDistributed(df: DataFrame, vwArgs: StringBuilder, 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
  133. def trainRow(schema: StructType, inputRows: Iterator[Row], ctx: TrainContext): Unit
    Attributes
    protected
  134. val useBarrierExecutionMode: BooleanParam
  135. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  136. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  137. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  138. val weightCol: Param[String]

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol

Inherited from Logging

Inherited from HasAdditionalFeatures

Inherited from HasWeightCol

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