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 getFeaturesCol: String

    Permalink
  3. abstract def getLabelCol: String

    Permalink
  4. 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. val args: Param[String]

    Permalink
  7. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    HasAdditionalFeatures
  21. def getArgs: String

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

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

    Permalink
    Definition Classes
    Params
  24. def getHashSeed: Int

    Permalink
  25. def getIgnoreNamespaces: String

    Permalink
  26. def getInitialModel: Array[Byte]

    Permalink
  27. def getInteractions: Array[String]

    Permalink
  28. def getL1: Double

    Permalink
  29. def getL2: Double

    Permalink
  30. def getLearningRate: Double

    Permalink
  31. def getNumBits: Int

    Permalink
  32. def getNumPasses: Int

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

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

    Permalink
    Definition Classes
    Params
  35. def getPowerT: Double

    Permalink
  36. def getWeightCol: String

    Permalink

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

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

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

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

    Permalink
  41. val ignoreNamespaces: Param[String]

    Permalink
  42. val initialModel: ByteArrayParam

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

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

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

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

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

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

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

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

    Permalink
  51. val l2: DoubleParam

    Permalink
  52. val learningRate: DoubleParam

    Permalink
  53. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  68. val numBits: IntParam

    Permalink
  69. val numPasses: IntParam

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

    Permalink
    Definition Classes
    Params
  71. val powerT: DoubleParam

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  93. def trainInternal(dataset: Dataset[_]): Array[Byte]

    Permalink

    Main training loop

    Main training loop

    dataset

    input data.

    returns

    binary VW model.

    Attributes
    protected
  94. def trainInternalDistributed(df: DataFrame, vwArgs: StringBuilder, numWorkers: Int): Option[Array[Byte]]

    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
  95. final def wait(): Unit

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

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

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

    Permalink

    The name of the weight column

    The name of the weight column

    Definition Classes
    HasWeightCol
  99. 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