[SPARK-10264][Documentation, ML] Added Since annotation for ml.recomendation #8532
Conversation
| @@ -255,64 +262,81 @@ class ALSModel private[ml] ( | |||
| * preferences rather than explicit ratings given to items. | |||
| */ | |||
| @Experimental | |||
| class ALS(override val uid: String) extends Estimator[ALSModel] with ALSParams { | |||
| @Since("1.3.0") | |||
| class ALS(@Since("1.4.0") override val uid: String) extends Estimator[ALSModel] with ALSParams { | |||
|
|
|||
| import org.apache.spark.ml.recommendation.ALS.Rating | |||
|
|
|||
| def this() = this(Identifiable.randomUID("als")) | |||
There was a problem hiding this comment.
Please annotate auxillary constructor
There was a problem hiding this comment.
Added Auxiliary constructor
|
Made a pass |
|
LGTM |
| @@ -178,6 +178,7 @@ private[recommendation] trait ALSParams extends ALSModelParams with HasMaxIter w | |||
| * @param itemFactors a DataFrame that stores item factors in two columns: `id` and `features` | |||
| */ | |||
| @Experimental | |||
| @Since("1.3.0") | |||
| class ALSModel private[ml] ( | |||
| override val uid: String, | |||
There was a problem hiding this comment.
Document public params in the constructor. Though the constructor is private, those variables are public.
@Since("1.4.0") override val uid: String,
@Since("1.4.0") override val rank: Int
|
Any of you can review this and merge. I may loose track if it is delayed more. |
|
ok to test |
| @@ -355,7 +383,11 @@ object ALS extends Logging { | |||
| * Rating class for better code readability. | |||
| */ | |||
| @DeveloperApi | |||
| case class Rating[@specialized(Int, Long) ID](user: ID, item: ID, rating: Float) | |||
| @Since("1.3.0") | |||
There was a problem hiding this comment.
We don't need @Since annotation for developer APIs.
|
Test build #44015 has finished for PR 8532 at commit
|
|
@tijoparacka Ping! Could you please update this based on @mengxr 's comments and also fix the merge conflicts? Thank you! |
|
Close this PR please @tijoparacka if you're not updating it |
|
I closed this PR. The feature is implemented in #10756. |
Added Since annotation for ALS.scala