1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.spark.ml.regression
import org.apache.hadoop.fs.Path
import org.apache.spark.Logging
import org.apache.spark.annotation.{Experimental, Since}
import org.apache.spark.ml.param._
import org.apache.spark.ml.param.shared._
import org.apache.spark.ml.regression.IsotonicRegressionModel.IsotonicRegressionModelWriter
import org.apache.spark.ml.util._
import org.apache.spark.ml.{Estimator, Model}
import org.apache.spark.mllib.linalg.{Vector, VectorUDT, Vectors}
import org.apache.spark.mllib.regression.{IsotonicRegression => MLlibIsotonicRegression}
import org.apache.spark.mllib.regression.{IsotonicRegressionModel => MLlibIsotonicRegressionModel}
import org.apache.spark.rdd.RDD
import org.apache.spark.sql.functions.{col, lit, udf}
import org.apache.spark.sql.types.{DoubleType, StructType}
import org.apache.spark.sql.{DataFrame, Row}
import org.apache.spark.storage.StorageLevel
/**
* Params for isotonic regression.
*/
private[regression] trait IsotonicRegressionBase extends Params with HasFeaturesCol
with HasLabelCol with HasPredictionCol with HasWeightCol with Logging {
/**
* Param for whether the output sequence should be isotonic/increasing (true) or
* antitonic/decreasing (false).
* Default: true
* @group param
*/
final val isotonic: BooleanParam =
new BooleanParam(this, "isotonic",
"whether the output sequence should be isotonic/increasing (true) or" +
"antitonic/decreasing (false)")
/** @group getParam */
final def getIsotonic: Boolean = $(isotonic)
/**
* Param for the index of the feature if [[featuresCol]] is a vector column (default: `0`), no
* effect otherwise.
* @group param
*/
final val featureIndex: IntParam = new IntParam(this, "featureIndex",
"The index of the feature if featuresCol is a vector column, no effect otherwise.")
/** @group getParam */
final def getFeatureIndex: Int = $(featureIndex)
setDefault(isotonic -> true, featureIndex -> 0)
/** Checks whether the input has weight column. */
protected[ml] def hasWeightCol: Boolean = {
isDefined(weightCol) && $(weightCol) != ""
}
/**
* Extracts (label, feature, weight) from input dataset.
*/
protected[ml] def extractWeightedLabeledPoints(
dataset: DataFrame): RDD[(Double, Double, Double)] = {
val f = if (dataset.schema($(featuresCol)).dataType.isInstanceOf[VectorUDT]) {
val idx = $(featureIndex)
val extract = udf { v: Vector => v(idx) }
extract(col($(featuresCol)))
} else {
col($(featuresCol))
}
val w = if (hasWeightCol) {
col($(weightCol))
} else {
lit(1.0)
}
dataset.select(col($(labelCol)), f, w)
.map { case Row(label: Double, feature: Double, weight: Double) =>
(label, feature, weight)
}
}
/**
* Validates and transforms input schema.
* @param schema input schema
* @param fitting whether this is in fitting or prediction
* @return output schema
*/
protected[ml] def validateAndTransformSchema(
schema: StructType,
fitting: Boolean): StructType = {
if (fitting) {
SchemaUtils.checkColumnType(schema, $(labelCol), DoubleType)
if (hasWeightCol) {
SchemaUtils.checkColumnType(schema, $(weightCol), DoubleType)
} else {
logInfo("The weight column is not defined. Treat all instance weights as 1.0.")
}
}
val featuresType = schema($(featuresCol)).dataType
require(featuresType == DoubleType || featuresType.isInstanceOf[VectorUDT])
SchemaUtils.appendColumn(schema, $(predictionCol), DoubleType)
}
}
/**
* :: Experimental ::
* Isotonic regression.
*
* Currently implemented using parallelized pool adjacent violators algorithm.
* Only univariate (single feature) algorithm supported.
*
* Uses [[org.apache.spark.mllib.regression.IsotonicRegression]].
*/
@Since("1.5.0")
@Experimental
class IsotonicRegression @Since("1.5.0") (@Since("1.5.0") override val uid: String)
extends Estimator[IsotonicRegressionModel]
with IsotonicRegressionBase with DefaultParamsWritable {
@Since("1.5.0")
def this() = this(Identifiable.randomUID("isoReg"))
/** @group setParam */
@Since("1.5.0")
def setLabelCol(value: String): this.type = set(labelCol, value)
/** @group setParam */
@Since("1.5.0")
def setFeaturesCol(value: String): this.type = set(featuresCol, value)
/** @group setParam */
@Since("1.5.0")
def setPredictionCol(value: String): this.type = set(predictionCol, value)
/** @group setParam */
@Since("1.5.0")
def setIsotonic(value: Boolean): this.type = set(isotonic, value)
/** @group setParam */
@Since("1.5.0")
def setWeightCol(value: String): this.type = set(weightCol, value)
/** @group setParam */
@Since("1.5.0")
def setFeatureIndex(value: Int): this.type = set(featureIndex, value)
@Since("1.5.0")
override def copy(extra: ParamMap): IsotonicRegression = defaultCopy(extra)
@Since("1.5.0")
override def fit(dataset: DataFrame): IsotonicRegressionModel = {
validateAndTransformSchema(dataset.schema, fitting = true)
// Extract columns from data. If dataset is persisted, do not persist oldDataset.
val instances = extractWeightedLabeledPoints(dataset)
val handlePersistence = dataset.rdd.getStorageLevel == StorageLevel.NONE
if (handlePersistence) instances.persist(StorageLevel.MEMORY_AND_DISK)
val isotonicRegression = new MLlibIsotonicRegression().setIsotonic($(isotonic))
val oldModel = isotonicRegression.run(instances)
copyValues(new IsotonicRegressionModel(uid, oldModel).setParent(this))
}
@Since("1.5.0")
override def transformSchema(schema: StructType): StructType = {
validateAndTransformSchema(schema, fitting = true)
}
}
@Since("1.6.0")
object IsotonicRegression extends DefaultParamsReadable[IsotonicRegression] {
@Since("1.6.0")
override def load(path: String): IsotonicRegression = super.load(path)
}
/**
* :: Experimental ::
* Model fitted by IsotonicRegression.
* Predicts using a piecewise linear function.
*
* For detailed rules see [[org.apache.spark.mllib.regression.IsotonicRegressionModel.predict()]].
*
* @param oldModel A [[org.apache.spark.mllib.regression.IsotonicRegressionModel]]
* model trained by [[org.apache.spark.mllib.regression.IsotonicRegression]].
*/
@Since("1.5.0")
@Experimental
class IsotonicRegressionModel private[ml] (
override val uid: String,
private val oldModel: MLlibIsotonicRegressionModel)
extends Model[IsotonicRegressionModel] with IsotonicRegressionBase with MLWritable {
/** @group setParam */
@Since("1.5.0")
def setFeaturesCol(value: String): this.type = set(featuresCol, value)
/** @group setParam */
@Since("1.5.0")
def setPredictionCol(value: String): this.type = set(predictionCol, value)
/** @group setParam */
@Since("1.5.0")
def setFeatureIndex(value: Int): this.type = set(featureIndex, value)
/** Boundaries in increasing order for which predictions are known. */
@Since("1.5.0")
def boundaries: Vector = Vectors.dense(oldModel.boundaries)
/**
* Predictions associated with the boundaries at the same index, monotone because of isotonic
* regression.
*/
@Since("1.5.0")
def predictions: Vector = Vectors.dense(oldModel.predictions)
@Since("1.5.0")
override def copy(extra: ParamMap): IsotonicRegressionModel = {
copyValues(new IsotonicRegressionModel(uid, oldModel), extra).setParent(parent)
}
@Since("1.5.0")
override def transform(dataset: DataFrame): DataFrame = {
val predict = dataset.schema($(featuresCol)).dataType match {
case DoubleType =>
udf { feature: Double => oldModel.predict(feature) }
case _: VectorUDT =>
val idx = $(featureIndex)
udf { features: Vector => oldModel.predict(features(idx)) }
}
dataset.withColumn($(predictionCol), predict(col($(featuresCol))))
}
@Since("1.5.0")
override def transformSchema(schema: StructType): StructType = {
validateAndTransformSchema(schema, fitting = false)
}
@Since("1.6.0")
override def write: MLWriter =
new IsotonicRegressionModelWriter(this)
}
@Since("1.6.0")
object IsotonicRegressionModel extends MLReadable[IsotonicRegressionModel] {
@Since("1.6.0")
override def read: MLReader[IsotonicRegressionModel] = new IsotonicRegressionModelReader
@Since("1.6.0")
override def load(path: String): IsotonicRegressionModel = super.load(path)
/** [[MLWriter]] instance for [[IsotonicRegressionModel]] */
private[IsotonicRegressionModel] class IsotonicRegressionModelWriter (
instance: IsotonicRegressionModel
) extends MLWriter with Logging {
private case class Data(
boundaries: Array[Double],
predictions: Array[Double],
isotonic: Boolean)
override protected def saveImpl(path: String): Unit = {
// Save metadata and Params
DefaultParamsWriter.saveMetadata(instance, path, sc)
// Save model data: boundaries, predictions, isotonic
val data = Data(
instance.oldModel.boundaries, instance.oldModel.predictions, instance.oldModel.isotonic)
val dataPath = new Path(path, "data").toString
sqlContext.createDataFrame(Seq(data)).repartition(1).write.parquet(dataPath)
}
}
private class IsotonicRegressionModelReader extends MLReader[IsotonicRegressionModel] {
/** Checked against metadata when loading model */
private val className = classOf[IsotonicRegressionModel].getName
override def load(path: String): IsotonicRegressionModel = {
val metadata = DefaultParamsReader.loadMetadata(path, sc, className)
val dataPath = new Path(path, "data").toString
val data = sqlContext.read.parquet(dataPath)
.select("boundaries", "predictions", "isotonic").head()
val boundaries = data.getAs[Seq[Double]](0).toArray
val predictions = data.getAs[Seq[Double]](1).toArray
val isotonic = data.getBoolean(2)
val model = new IsotonicRegressionModel(
metadata.uid, new MLlibIsotonicRegressionModel(boundaries, predictions, isotonic))
DefaultParamsReader.getAndSetParams(model, metadata)
model
}
}
}
|