[SPARK-9798] [ML] CrossValidatorModel Documentation Improvements #8882
Conversation
|
Can one of the admins verify this patch? |
There was a problem hiding this comment.
These should be documented in the class Scala doc (line 138+), using the @param tag.
There was a problem hiding this comment.
See other classes for examples.
There was a problem hiding this comment.
@jkbradley I don't fully understand. As far as I understand, @param is for documenting arguments of methods. However, both bestModel and avgMetrics (that Spark-9798 is about) are not arguments in any methods (including constructors). Why should there be @params for the two members for the class? Could you please help elaborate?
There was a problem hiding this comment.
Those are params for the class constructor. I'd recommend you try generating the Scala docs as you have the code now, and with the docs moved to param docs, to see the difference.
There was a problem hiding this comment.
@jkbradley Thank you for your clarification. I modified the PR according to your comment. Please have a look. Note that I also rebase to the master branch, since it has been moved.
rerngvit
force-pushed
the
Spark-9798
branch
from
8d16408 to
9b95c61
Compare
|
Thanks, this should work, pending that 1 doc update. |
…datorModel according to comment.
…datorModel according to comment.
|
@jkbradley Thank you for your review. I updated the doc for avgMetrics according to your comment. Please have a look. |
|
LGTM, thanks! Merging with master |
|
Seems this one breaks our build. |
|
For doc-only change, it will be good to run the style check. |
|
fyi, the hot fix has been merged. |
#8882 broke our build. Author: Yin Huai <[email protected]> Closes #8964 from yhuai/fixStyle.
|
Rats, I'm really sorry. I didn't realize tests hadn't run. |
|
@yhuai Sorry for that. |
|
@rerngvit no worry |
apache/spark#8882 broke our build. Author: Yin Huai <[email protected]> Closes #8964 from yhuai/fixStyle.
4 participants
Document CrossValidatorModel members: bestModel and avgMetrics