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, 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. 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
    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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. 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
  18. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  19. def explainParams(): String
    Definition Classes
    Params
  20. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  21. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  22. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  24. def getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float
    Attributes
    protected
  25. def getAsInt(schema: StructType, idx: Int): (Row) ⇒ Int
    Attributes
    protected
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def getCommandLineArgs: ParamsStringBuilder
    Attributes
    protected
    Definition Classes
    VowpalWabbitBase
  28. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  29. def getHashSeed: Int
    Definition Classes
    VowpalWabbitBase
  30. def getIgnoreNamespaces: String
    Definition Classes
    VowpalWabbitBase
  31. def getInitialModel: Array[Byte]
    Definition Classes
    VowpalWabbitBase
  32. def getInteractions: Array[String]
    Definition Classes
    VowpalWabbitBase
  33. def getL1: Double
    Definition Classes
    VowpalWabbitBase
  34. def getL2: Double
    Definition Classes
    VowpalWabbitBase
  35. def getLearningRate: Double
    Definition Classes
    VowpalWabbitBase
  36. def getNumBits: Int
    Definition Classes
    VowpalWabbitBase
  37. def getNumPasses: Int
    Definition Classes
    VowpalWabbitBase
  38. def getNumSyncsPerPass: Int
    Definition Classes
    VowpalWabbitBase
  39. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  40. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  41. def getParamInfo(p: Param[_]): ParamInfo[_]
    Definition Classes
    BaseWrappable
  42. def getPassThroughArgs: String
    Definition Classes
    VowpalWabbitBase
  43. def getPowerT: Double
    Definition Classes
    VowpalWabbitBase
  44. def getPredictionIdCol: String
  45. def getSplitCol: String
  46. def getSplitColValues: Array[String]
  47. def getUseBarrierExecutionMode: Boolean
    Definition Classes
    VowpalWabbitBase
  48. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  49. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  50. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  51. val hashSeed: IntParam
    Definition Classes
    VowpalWabbitBase
  52. val ignoreNamespaces: Param[String]
    Definition Classes
    VowpalWabbitBase
  53. val initialModel: ByteArrayParam
    Definition Classes
    VowpalWabbitBase
  54. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  55. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. 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

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

    Main training loop

    Main training loop

    dataset

    input data.

    returns

    binary VW model.

    Attributes
    protected
  147. 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
  148. val useBarrierExecutionMode: BooleanParam
    Definition Classes
    VowpalWabbitBase
  149. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  150. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  151. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  152. 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 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