Class/Object

com.microsoft.ml.spark

RankingTrainValidationSplit

Related Docs: object RankingTrainValidationSplit | package spark

Permalink

class RankingTrainValidationSplit extends Estimator[RankingTrainValidationSplitModel] with ComplexParamsWritable with RankingFunctions with TrainValidRecommendSplitParams with HasCollectSubModels

Validation for hyper-parameter tuning. Randomly splits the input dataset into train and validation sets, and uses evaluation metric on the validation set to select the best model.

Annotations
@InternalWrapper()
Linear Supertypes
HasCollectSubModels, TrainValidRecommendSplitParams, HasParallelism, HasSeed, Wrappable, RankingFunctions, HasRecommenderCols, RankingParams, ComplexParamsWritable, MLWritable, Estimator[RankingTrainValidationSplitModel], PipelineStage, org.apache.spark.internal.Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RankingTrainValidationSplit
  2. HasCollectSubModels
  3. TrainValidRecommendSplitParams
  4. HasParallelism
  5. HasSeed
  6. Wrappable
  7. RankingFunctions
  8. HasRecommenderCols
  9. RankingParams
  10. ComplexParamsWritable
  11. MLWritable
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RankingTrainValidationSplit()

    Permalink
  2. new RankingTrainValidationSplit(uid: String)

    Permalink

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. final def asInstanceOf[T0]: T0

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val collectSubMetrics: BooleanParam

    Permalink
  9. final val collectSubModels: BooleanParam

    Permalink
    Definition Classes
    HasCollectSubModels
  10. def copy(extra: ParamMap): RankingTrainValidationSplit

    Permalink
    Definition Classes
    RankingTrainValidationSplit → Estimator → PipelineStage → Params
  11. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. val estimator: EstimatorParam

    Permalink
  16. val estimatorParamMaps: ArrayParamMapParam

    Permalink
  17. val evaluator: EvaluatorParam

    Permalink
  18. def explainParam(param: Param[_]): String

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

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

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

    Permalink
    Definition Classes
    Params
  22. def filterRatings(dataset: Dataset[_], itemCol: String, userCol: String): DataFrame

    Permalink
    Definition Classes
    RankingFunctions
  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def fit(dataset: Dataset[_]): RankingTrainValidationSplitModel

    Permalink
    Definition Classes
    RankingTrainValidationSplit → Estimator
  25. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[RankingTrainValidationSplitModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  26. def fit(dataset: Dataset[_], paramMap: ParamMap): RankingTrainValidationSplitModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  27. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): RankingTrainValidationSplitModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  28. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  29. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  30. def getCollectSubMetrics: Boolean

    Permalink
  31. final def getCollectSubModels: Boolean

    Permalink
    Definition Classes
    HasCollectSubModels
  32. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  33. def getEstimator: Estimator[_ <: Model[_]]

    Permalink

  34. def getEstimatorParamMaps: Array[ParamMap]

    Permalink

  35. def getEvaluator: Evaluator

    Permalink

  36. def getExecutionContext: ExecutionContext

    Permalink
    Definition Classes
    RankingTrainValidationSplit → HasParallelism
  37. def getItemCol: String

    Permalink
    Definition Classes
    HasRecommenderCols
  38. def getMinRatingsI: Int

    Permalink

  39. def getMinRatingsPerItem: Int

    Permalink

    Definition Classes
    RankingParams
  40. def getMinRatingsPerUser: Int

    Permalink

    Definition Classes
    RankingParams
  41. def getMinRatingsU: Int

    Permalink

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

    Permalink
    Definition Classes
    Params
  43. def getParallelism: Int

    Permalink
    Definition Classes
    HasParallelism
  44. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  45. def getRatingCol: String

    Permalink
    Definition Classes
    HasRecommenderCols
  46. final def getSeed: Long

    Permalink
    Definition Classes
    HasSeed
  47. def getTrainRatio: Double

    Permalink

  48. def getUserCol: String

    Permalink
    Definition Classes
    HasRecommenderCols
  49. final def hasDefault[T](param: Param[T]): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  52. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. val itemCol: Param[String]

    Permalink
    Definition Classes
    HasRecommenderCols
  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. val minRatingsI: IntParam

    Permalink
  72. val minRatingsPerItem: IntParam

    Permalink
    Definition Classes
    RankingParams
  73. val minRatingsPerUser: IntParam

    Permalink
    Definition Classes
    RankingParams
  74. val minRatingsU: IntParam

    Permalink

    Param for ratio between train and validation data.

    Param for ratio between train and validation data. Must be between 0 and 1. Default: 0.75

    Definition Classes
    TrainValidRecommendSplitParams
  75. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  78. val parallelism: IntParam

    Permalink
    Definition Classes
    HasParallelism
  79. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  80. def prepareTestData(validationDataset: DataFrame, recs: DataFrame, k: Int): Dataset[_]

    Permalink
    Definition Classes
    RankingFunctions
  81. def prepareTestData(userColumn: String, itemColumn: String, validationDataset: DataFrame, recs: DataFrame, k: Int): Dataset[_]

    Permalink
    Definition Classes
    RankingFunctions
  82. val ratingCol: Param[String]

    Permalink
    Definition Classes
    HasRecommenderCols
  83. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  84. final val seed: LongParam

    Permalink
    Definition Classes
    HasSeed
  85. final def set(paramPair: ParamPair[_]): RankingTrainValidationSplit.this.type

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

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

    Permalink
    Definition Classes
    Params
  88. def setCollectSubMetrics(value: Boolean): RankingTrainValidationSplit.this.type

    Permalink
  89. def setCollectSubModels(value: Boolean): RankingTrainValidationSplit.this.type

    Permalink

    Whether to collect submodels when fitting.

    Whether to collect submodels when fitting. If set, we can get submodels from the returned model.

    Note: If set this param, when you save the returned model, you can set an option "persistSubModels" to be "true" before saving, in order to save these submodels.

  90. final def setDefault(paramPairs: ParamPair[_]*): RankingTrainValidationSplit.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  92. def setEstimator(value: Estimator[_ <: Model[_]]): RankingTrainValidationSplit.this.type

    Permalink

  93. def setEstimatorParamMaps(value: Array[ParamMap]): RankingTrainValidationSplit.this.type

    Permalink

  94. def setEvaluator(value: Evaluator): RankingTrainValidationSplit.this.type

    Permalink

  95. def setItemCol(value: String): RankingTrainValidationSplit.this.type

    Permalink

    Definition Classes
    HasRecommenderCols
  96. def setMinRatingsPerItem(value: Int): RankingTrainValidationSplit.this.type

    Permalink

    Definition Classes
    RankingParams
  97. def setMinRatingsPerUser(value: Int): RankingTrainValidationSplit.this.type

    Permalink

    Definition Classes
    RankingParams
  98. def setParallelism(value: Int): RankingTrainValidationSplit.this.type

    Permalink

    Set the mamixum level of parallelism to evaluate models in parallel.

    Set the mamixum level of parallelism to evaluate models in parallel. Default is 1 for serial evaluation

  99. def setRatingCol(value: String): RankingTrainValidationSplit.this.type

    Permalink

    Definition Classes
    HasRecommenderCols
  100. def setSeed(value: Long): RankingTrainValidationSplit.this.type

    Permalink

  101. def setTrainRatio(value: Double): RankingTrainValidationSplit.this.type

    Permalink

  102. def setUserCol(value: String): RankingTrainValidationSplit.this.type

    Permalink

    Definition Classes
    HasRecommenderCols
  103. def split(dataframe: Dataset[_], trainRatio: Double, itemCol: String, userCol: String, ratingCol: String): (DataFrame, DataFrame)

    Permalink
    Definition Classes
    RankingFunctions
  104. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  106. val trainRatio: DoubleParam

    Permalink
  107. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    RankingTrainValidationSplit → PipelineStage
  108. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  109. def transformSchemaImpl(schema: StructType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    TrainValidRecommendSplitParams
  110. val uid: String

    Permalink
    Definition Classes
    RankingTrainValidationSplit → Identifiable
  111. val userCol: Param[String]

    Permalink
    Definition Classes
    HasRecommenderCols
  112. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  115. def write: MLWriter

    Permalink
    Definition Classes
    ComplexParamsWritable → MLWritable

Inherited from HasCollectSubModels

Inherited from HasParallelism

Inherited from HasSeed

Inherited from Wrappable

Inherited from RankingFunctions

Inherited from HasRecommenderCols

Inherited from RankingParams

Inherited from ComplexParamsWritable

Inherited from MLWritable

Inherited from Estimator[RankingTrainValidationSplitModel]

Inherited from PipelineStage

Inherited from org.apache.spark.internal.Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

expertSetParam

Parameters

A list of parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters

Parameter setters

Parameter getters

Members