[SPARK-10264][Documentation, ML] Added Since annotation for ml.recomendation #8532
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -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
|
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added Since annotation for ALS.scala