Trait

com.microsoft.ml.spark.vw

VowpalWabbitBase

Related Doc: package vw

Permalink

trait VowpalWabbitBase extends Wrappable with HasWeightCol with HasAdditionalFeatures with Logging

Base implementation of VowpalWabbit learners.

Annotations
@InternalWrapper()
Note

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

Linear Supertypes
Logging, HasAdditionalFeatures, HasWeightCol, Wrappable, HasAdditionalPythonMethods, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VowpalWabbitBase
  2. Logging
  3. HasAdditionalFeatures
  4. HasWeightCol
  5. Wrappable
  6. HasAdditionalPythonMethods
  7. Params
  8. Serializable
  9. Serializable
  10. Identifiable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class ParamStringBuilder extends AnyRef

    Permalink
  2. class TrainContext extends AnyRef

    Permalink

Abstract Value Members

  1. abstract def copy(extra: ParamMap): Params

    Permalink
    Definition Classes
    Params
  2. abstract def featuresCol: Param[String]

    Permalink
  3. abstract def getFeaturesCol: String

    Permalink
  4. abstract def getLabelCol: String

    Permalink
  5. abstract def labelCol: Param[String]

    Permalink
  6. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def addExtraArgs(args: StringBuilder): Unit

    Permalink

    * Allow subclasses to add further arguments

    * Allow subclasses to add further arguments

    args

    argument builder to append to

    Attributes
    protected
  6. val additionalFeatures: StringArrayParam

    Permalink
    Definition Classes
    HasAdditionalFeatures
  7. def additionalPythonMethods(): String

    Permalink
    Definition Classes
    HasAdditionalPythonMethods
  8. val args: Param[String]

    Permalink
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. final def clear(param: Param[_]): VowpalWabbitBase.this.type

    Permalink
    Definition Classes
    Params
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  13. def createLabelSetter(schema: StructType): (Row, VowpalWabbitExample) ⇒ Unit

    Permalink
    Attributes
    protected
  14. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  18. def explainParams(): String

    Permalink
    Definition Classes
    Params
  19. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  20. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  21. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  23. def getAdditionalColumns(): Seq[String]

    Permalink
    Attributes
    protected
  24. def getAdditionalFeatures: Array[String]

    Permalink
    Definition Classes
    HasAdditionalFeatures
  25. def getArgs: String

    Permalink
  26. def getAsFloat(schema: StructType, idx: Int): (Row) ⇒ Float

    Permalink
    Attributes
    protected
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  29. def getHashSeed: Int

    Permalink
  30. def getIgnoreNamespaces: String

    Permalink
  31. def getInitialModel: Array[Byte]

    Permalink
  32. def getInteractions: Array[String]

    Permalink
  33. def getL1: Double

    Permalink
  34. def getL2: Double

    Permalink
  35. def getLearningRate: Double

    Permalink
  36. def getNumBits: Int

    Permalink
  37. def getNumPasses: Int

    Permalink
  38. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  39. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  40. def getPowerT: Double

    Permalink
  41. def getUseBarrierExecutionMode: Boolean

    Permalink
  42. def getWeightCol: String

    Permalink

    Definition Classes
    HasWeightCol
  43. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  44. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  45. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  46. val hashSeed: IntParam

    Permalink
  47. val ignoreNamespaces: Param[String]

    Permalink
  48. val initialModel: ByteArrayParam

    Permalink
  49. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. val interactions: StringArrayParam

    Permalink
  52. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  53. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  54. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  55. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. val l1: DoubleParam

    Permalink
  57. val l2: DoubleParam

    Permalink
  58. val learningRate: DoubleParam

    Permalink
  59. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  67. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  69. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  70. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  71. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  72. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  73. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  74. val numBits: IntParam

    Permalink
  75. val numPasses: IntParam

    Permalink
  76. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  77. val powerT: DoubleParam

    Permalink
  78. final def set(paramPair: ParamPair[_]): VowpalWabbitBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  79. final def set(param: String, value: Any): VowpalWabbitBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  80. final def set[T](param: Param[T], value: T): VowpalWabbitBase.this.type

    Permalink
    Definition Classes
    Params
  81. def setAdditionalFeatures(value: Array[String]): VowpalWabbitBase.this.type

    Permalink
    Definition Classes
    HasAdditionalFeatures
  82. def setArgs(value: String): VowpalWabbitBase.this.type

    Permalink
  83. final def setDefault(paramPairs: ParamPair[_]*): VowpalWabbitBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  84. final def setDefault[T](param: Param[T], value: T): VowpalWabbitBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  85. def setHashSeed(value: Int): VowpalWabbitBase.this.type

    Permalink
  86. def setIgnoreNamespaces(value: String): VowpalWabbitBase.this.type

    Permalink
  87. def setInitialModel(value: Array[Byte]): VowpalWabbitBase.this.type

    Permalink
  88. def setInteractions(value: Array[String]): VowpalWabbitBase.this.type

    Permalink
  89. def setL1(value: Double): VowpalWabbitBase.this.type

    Permalink
  90. def setL2(value: Double): VowpalWabbitBase.this.type

    Permalink
  91. def setLearningRate(value: Double): VowpalWabbitBase.this.type

    Permalink
  92. def setNumBits(value: Int): VowpalWabbitBase.this.type

    Permalink
  93. def setNumPasses(value: Int): VowpalWabbitBase.this.type

    Permalink
  94. def setPowerT(value: Double): VowpalWabbitBase.this.type

    Permalink
  95. def setUseBarrierExecutionMode(value: Boolean): VowpalWabbitBase.this.type

    Permalink
  96. def setWeightCol(value: String): VowpalWabbitBase.this.type

    Permalink

    Definition Classes
    HasWeightCol
  97. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  98. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  99. def trainInternal[T <: VowpalWabbitBaseModel](dataset: Dataset[_], model: T): T

    Permalink

    Main training loop

    Main training loop

    dataset

    input data.

    returns

    binary VW model.

    Attributes
    protected
  100. def trainInternalDistributed(df: DataFrame, vwArgs: StringBuilder, numTasks: Int): Array[TrainingResult]

    Permalink

    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
  101. def trainRow(schema: StructType, inputRows: Iterator[Row], ctx: TrainContext): Unit

    Permalink
    Attributes
    protected
  102. val useBarrierExecutionMode: BooleanParam

    Permalink
  103. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  104. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  105. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  106. val weightCol: Param[String]

    Permalink

    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 Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped