Skip to content

Commit 39cbf42

Browse files
yanboliangyanboliang
committed
Deprecate DT/RF/GBT setter methods in the Model classes
1 parent 7e52a08 commit 39cbf42

File tree

1 file changed

+67
-19
lines changed

1 file changed

+67
-19
lines changed

‎mllib/src/main/scala/org/apache/spark/ml/tree/treeParams.scala‎

Lines changed: 67 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -107,25 +107,41 @@ private[ml] trait DecisionTreeParams extends PredictorParams
107107
setDefault(maxDepth -> 5, maxBins -> 32, minInstancesPerNode -> 1, minInfoGain -> 0.0,
108108
maxMemoryInMB -> 256, cacheNodeIds -> false, checkpointInterval -> 10)
109109

110-
/** @group setParam */
110+
/**
111+
* @deprecated This method is deprecated and will be removed in 2.2.0.
112+
* @group setParam
113+
*/
114+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
111115
def setMaxDepth(value: Int): this.type = set(maxDepth, value)
112116

113117
/** @group getParam */
114118
final def getMaxDepth: Int = $(maxDepth)
115119

116-
/** @group setParam */
120+
/**
121+
* @deprecated This method is deprecated and will be removed in 2.2.0.
122+
* @group setParam
123+
*/
124+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
117125
def setMaxBins(value: Int): this.type = set(maxBins, value)
118126

119127
/** @group getParam */
120128
final def getMaxBins: Int = $(maxBins)
121129

122-
/** @group setParam */
130+
/**
131+
* @deprecated This method is deprecated and will be removed in 2.2.0.
132+
* @group setParam
133+
*/
134+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
123135
def setMinInstancesPerNode(value: Int): this.type = set(minInstancesPerNode, value)
124136

125137
/** @group getParam */
126138
final def getMinInstancesPerNode: Int = $(minInstancesPerNode)
127139

128-
/** @group setParam */
140+
/**
141+
* @deprecated This method is deprecated and will be removed in 2.2.0.
142+
* @group setParam
143+
*/
144+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
129145
def setMinInfoGain(value: Double): this.type = set(minInfoGain, value)
130146

131147
/** @group getParam */
@@ -134,27 +150,31 @@ private[ml] trait DecisionTreeParams extends PredictorParams
134150
/** @group setParam */
135151
def setSeed(value: Long): this.type = set(seed, value)
136152

137-
/** @group expertSetParam */
153+
/**
154+
* @deprecated This method is deprecated and will be removed in 2.2.0.
155+
* @group expertSetParam
156+
*/
157+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
138158
def setMaxMemoryInMB(value: Int): this.type = set(maxMemoryInMB, value)
139159

140160
/** @group expertGetParam */
141161
final def getMaxMemoryInMB: Int = $(maxMemoryInMB)
142162

143-
/** @group expertSetParam */
163+
/**
164+
* @deprecated This method is deprecated and will be removed in 2.2.0.
165+
* @group expertSetParam
166+
*/
167+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
144168
def setCacheNodeIds(value: Boolean): this.type = set(cacheNodeIds, value)
145169

146170
/** @group expertGetParam */
147171
final def getCacheNodeIds: Boolean = $(cacheNodeIds)
148172

149173
/**
150-
* Specifies how often to checkpoint the cached node IDs.
151-
* E.g. 10 means that the cache will get checkpointed every 10 iterations.
152-
* This is only used if cacheNodeIds is true and if the checkpoint directory is set in
153-
* [[org.apache.spark.SparkContext]].
154-
* Must be >= 1.
155-
* (default = 10)
174+
* @deprecated This method is deprecated and will be removed in 2.2.0.
156175
* @group setParam
157176
*/
177+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
158178
def setCheckpointInterval(value: Int): this.type = set(checkpointInterval, value)
159179

160180
/** (private[ml]) Create a Strategy instance to use with the old API. */
@@ -198,7 +218,11 @@ private[ml] trait TreeClassifierParams extends Params {
198218

199219
setDefault(impurity -> "gini")
200220

201-
/** @group setParam */
221+
/**
222+
* @deprecated This method is deprecated and will be removed in 2.2.0.
223+
* @group setParam
224+
*/
225+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
202226
def setImpurity(value: String): this.type = set(impurity, value)
203227

204228
/** @group getParam */
@@ -243,7 +267,11 @@ private[ml] trait TreeRegressorParams extends Params {
243267

244268
setDefault(impurity -> "variance")
245269

246-
/** @group setParam */
270+
/**
271+
* @deprecated This method is deprecated and will be removed in 2.2.0.
272+
* @group setParam
273+
*/
274+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
247275
def setImpurity(value: String): this.type = set(impurity, value)
248276

249277
/** @group getParam */
@@ -300,7 +328,11 @@ private[ml] trait TreeEnsembleParams extends DecisionTreeParams {
300328

301329
setDefault(subsamplingRate -> 1.0)
302330

303-
/** @group setParam */
331+
/**
332+
* @deprecated This method is deprecated and will be removed in 2.2.0.
333+
* @group setParam
334+
*/
335+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
304336
def setSubsamplingRate(value: Double): this.type = set(subsamplingRate, value)
305337

306338
/** @group getParam */
@@ -340,7 +372,11 @@ private[ml] trait RandomForestParams extends TreeEnsembleParams {
340372

341373
setDefault(numTrees -> 20)
342374

343-
/** @group setParam */
375+
/**
376+
* @deprecated This method is deprecated and will be removed in 2.2.0.
377+
* @group setParam
378+
*/
379+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
344380
def setNumTrees(value: Int): this.type = set(numTrees, value)
345381

346382
/** @group getParam */
@@ -383,7 +419,11 @@ private[ml] trait RandomForestParams extends TreeEnsembleParams {
383419

384420
setDefault(featureSubsetStrategy -> "auto")
385421

386-
/** @group setParam */
422+
/**
423+
* @deprecated This method is deprecated and will be removed in 2.2.0.
424+
* @group setParam
425+
*/
426+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
387427
def setFeatureSubsetStrategy(value: String): this.type = set(featureSubsetStrategy, value)
388428

389429
/** @group getParam */
@@ -420,7 +460,11 @@ private[ml] trait GBTParams extends TreeEnsembleParams with HasMaxIter {
420460
// final val validationTol: DoubleParam = new DoubleParam(this, "validationTol", "")
421461
// validationTol -> 1e-5
422462

423-
/** @group setParam */
463+
/**
464+
* @deprecated This method is deprecated and will be removed in 2.2.0.
465+
* @group setParam
466+
*/
467+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
424468
def setMaxIter(value: Int): this.type = set(maxIter, value)
425469

426470
/**
@@ -436,7 +480,11 @@ private[ml] trait GBTParams extends TreeEnsembleParams with HasMaxIter {
436480
/** @group getParam */
437481
final def getStepSize: Double = $(stepSize)
438482

439-
/** @group setParam */
483+
/**
484+
* @deprecated This method is deprecated and will be removed in 2.2.0.
485+
* @group setParam
486+
*/
487+
@deprecated("This method is deprecated and will be removed in 2.2.0.", "2.1.0")
440488
def setStepSize(value: Double): this.type = set(stepSize, value)
441489

442490
setDefault(maxIter -> 20, stepSize -> 0.1)

0 commit comments

Comments
 (0)