t

com.microsoft.azure.synapse.ml.vw

VowpalWabbitBaseLearner

trait VowpalWabbitBaseLearner extends VowpalWabbitBase

Base implementation of VowpalWabbit learners.

Note

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

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

Type Members

  1. implicit class SpecificParamAppender extends AnyRef
    Definition Classes
    VowpalWabbitBase

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params
    Definition Classes
    Params
  2. abstract def getInputColumns: Seq[String]
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  3. abstract def trainFromRows(schema: StructType, inputRows: Iterator[Row], ctx: TrainContext): Unit
    Attributes
    protected
  4. 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 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[_]): VowpalWabbitBaseLearner.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. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  15. def dotnetAdditionalMethods: String
    Definition Classes
    DotnetWrappable
  16. def dotnetClass(): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  17. lazy val dotnetClassName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  18. lazy val dotnetClassNameString: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  19. lazy val dotnetClassWrapperName: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  20. lazy val dotnetCopyrightLines: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  21. def dotnetExtraEstimatorImports: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  22. def dotnetExtraMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  23. lazy val dotnetInternalWrapper: Boolean
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  24. def dotnetMLReadWriteMethods: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  25. lazy val dotnetNamespace: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  26. lazy val dotnetObjectBaseClass: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  27. def dotnetParamGetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  28. def dotnetParamGetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  29. def dotnetParamSetter(p: Param[_]): String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  30. def dotnetParamSetters: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  31. def dotnetWrapAsTypeMethod: String
    Attributes
    protected
    Definition Classes
    DotnetWrappable
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  34. 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
  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 getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float
    Attributes
    protected
  42. def getAsInt(schema: StructType, idx: Int): (Row) ⇒ Int
    Attributes
    protected
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def getCommandLineArgs: ParamsStringBuilder
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  45. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  46. def getHashSeed: Int
    Definition Classes
    VowpalWabbitBase
  47. def getIgnoreNamespaces: String
    Definition Classes
    VowpalWabbitBase
  48. def getInitialModel: Array[Byte]
    Definition Classes
    VowpalWabbitBase
  49. def getInteractions: Array[String]
    Definition Classes
    VowpalWabbitBase
  50. def getL1: Double
    Definition Classes
    VowpalWabbitBase
  51. def getL2: Double
    Definition Classes
    VowpalWabbitBase
  52. def getLearningRate: Double
    Definition Classes
    VowpalWabbitBase
  53. def getNumBits: Int
    Definition Classes
    VowpalWabbitBase
  54. def getNumPasses: Int
    Definition Classes
    VowpalWabbitBase
  55. def getNumSyncsPerPass: Int
    Definition Classes
    VowpalWabbitBase
  56. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  57. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  58. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  59. def getPassThroughArgs: String
    Definition Classes
    VowpalWabbitBase
  60. def getPowerT: Double
    Definition Classes
    VowpalWabbitBase
  61. def getPredictionIdCol: String
  62. def getSplitCol: String
  63. def getSplitColValues: Array[String]
  64. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    VowpalWabbitBase
  65. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  66. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  67. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  68. val hashSeed: IntParam
    Definition Classes
    VowpalWabbitBase
  69. val ignoreNamespaces: Param[String]
    Definition Classes
    VowpalWabbitBase
  70. val initialModel: ByteArrayParam
    Definition Classes
    VowpalWabbitBase
  71. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  72. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. 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

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

    Main training loop

    Main training loop

    dataset

    input data.

    returns

    binary VW model.

    Attributes
    protected
  165. 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
  166. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    VowpalWabbitBase
  167. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  168. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  169. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  170. 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): VowpalWabbitBaseLearner.this.type
    Definition Classes
    VowpalWabbitBase
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.6) Please use 'setPassThroughArgs'.

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

Ungrouped