Trait

com.microsoft.ml.spark.vw

VowpalWabbitBase

Related Doc: package vw

Permalink

trait VowpalWabbitBase extends Wrappable with DefaultParamsWritable 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, DefaultParamsWritable, MLWritable, Wrappable, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VowpalWabbitBase
  2. Logging
  3. HasAdditionalFeatures
  4. HasWeightCol
  5. DefaultParamsWritable
  6. MLWritable
  7. Wrappable
  8. Params
  9. Serializable
  10. Serializable
  11. Identifiable
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class ParamStringBuilder 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. val additionalFeatures: StringArrayParam

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

    Permalink
    Definition Classes
    Wrappable
  7. val args: Param[String]

    Permalink
  8. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  22. def getAdditionalFeatures: Array[String]

    Permalink
    Definition Classes
    HasAdditionalFeatures
  23. def getArgs: String

    Permalink
  24. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Params
  26. def getHashSeed: Int

    Permalink
  27. def getIgnoreNamespaces: String

    Permalink
  28. def getInitialModel: Array[Byte]

    Permalink
  29. def getInteractions: Array[String]

    Permalink
  30. def getL1: Double

    Permalink
  31. def getL2: Double

    Permalink
  32. def getLearningRate: Double

    Permalink
  33. def getNumBits: Int

    Permalink
  34. def getNumPasses: Int

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

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

    Permalink
    Definition Classes
    Params
  37. def getPowerT: Double

    Permalink
  38. def getWeightCol: String

    Permalink

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

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

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

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

    Permalink
  43. val ignoreNamespaces: Param[String]

    Permalink
  44. val initialModel: ByteArrayParam

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

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

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

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

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

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

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

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

    Permalink
  53. val l2: DoubleParam

    Permalink
  54. val learningRate: DoubleParam

    Permalink
  55. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  70. val numBits: IntParam

    Permalink
  71. val numPasses: IntParam

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

    Permalink
    Definition Classes
    Params
  73. val powerT: DoubleParam

    Permalink
  74. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  75. final def set(paramPair: ParamPair[_]): VowpalWabbitBase.this.type

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  95. 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
  96. def trainInternalDistributed(df: DataFrame, vwArgs: StringBuilder, numWorkers: Int): Array[TrainingResult]

    Permalink

    Setup spanning tree and invoke training.

    Setup spanning tree and invoke training.

    df

    input data.

    vwArgs

    VW command line arguments.

    numWorkers

    number of target workers.

    Attributes
    protected
  97. final def wait(): Unit

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

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

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

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  101. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from Logging

Inherited from HasAdditionalFeatures

Inherited from HasWeightCol

Inherited from DefaultParamsWritable

Inherited from MLWritable

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