ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[MINOR][MLLIB] DefaultParamsReadable/Writable should be DeveloperApi

Browse source 
## What changes were proposed in this pull request?

`DefaultParamsReadable/Writable` are not user-facing. Only developers who implement `Transformer/Estimator` would use it. So this PR changes the annotation to `DeveloperApi`.

Author: Xiangrui Meng <meng@databricks.com>

Closes #13828 from mengxr/default-readable-should-be-developer-api.
This commit is contained in:
Xiangrui Meng 2016-06-22 10:06:43 -07:00
parent 18faa588ca
commit 6a6010f001
1 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
mllib/src/main/scala/org/apache/spark/ml/util/ReadWrite.scala
View file

@ -26,7 +26,7 @@ import org.json4s.JsonDSL._
import org.json4s.jackson.JsonMethods._
import org.apache.spark.SparkContext
import org.apache.spark.annotation.{Experimental, Since}
import org.apache.spark.annotation.{DeveloperApi, Experimental, Since}
import org.apache.spark.internal.Logging
import org.apache.spark.ml._
import org.apache.spark.ml.classification.{OneVsRest, OneVsRestModel}
@ -161,7 +161,7 @@ trait MLWritable {
}
/**
* :: Experimental ::
* :: DeveloperApi ::
*
* Helper trait for making simple [[Params]] types writable. If a [[Params]] class stores
* all data as [[org.apache.spark.ml.param.Param]] values, then extending this trait will provide
@ -171,8 +171,7 @@ trait MLWritable {
*
* @see [[DefaultParamsReadable]], the counterpart to this trait
*/
@Experimental
@Since("2.0.0")
@DeveloperApi
trait DefaultParamsWritable extends MLWritable { self: Params =>
override def write: MLWriter = new DefaultParamsWriter(this)
@ -230,7 +229,7 @@ trait MLReadable[T] {
/**
* :: Experimental ::
* :: DeveloperApi ::
*
* Helper trait for making simple [[Params]] types readable. If a [[Params]] class stores
* all data as [[org.apache.spark.ml.param.Param]] values, then extending this trait will provide
@ -239,11 +238,9 @@ trait MLReadable[T] {
* [[org.apache.spark.sql.Dataset]].
*
* @tparam T ML instance type
*
* @see [[DefaultParamsWritable]], the counterpart to this trait
*/
@Experimental
@Since("2.0.0")
@DeveloperApi
trait DefaultParamsReadable[T] extends MLReadable[T] {
override def read: MLReader[T] = new DefaultParamsReader[T]