[Minor] [Doc] [ML] ml.clustering scala & python api doc sync #13291
Conversation
|
Test build #59264 has finished for PR 13291 at commit
|
| typeConverter=TypeConverters.toString) | ||
| initSteps = Param(Params._dummy(), "initSteps", "steps for k-means initialization mode", | ||
| typeConverter=TypeConverters.toInt) | ||
| initSteps = Param(Params._dummy(), "initSteps", "The number of steps for k-means|| " + |
There was a problem hiding this comment.
Since were copying this over might as well also include "This is an advanced setting -- the default of 5 is almost always enough." from the scala side?
There was a problem hiding this comment.
We just sync the param docs rather than API docs. Actually the Python API docs for params are missing for all classes. I think we should add them in the next release.
There was a problem hiding this comment.
interesting, I hadn't noticed the doc params were different than the scaladoc for these params (normally they are more in sync yes?).
|
LGTM |
|
jenkins retest this please |
|
Test build #59671 has finished for PR 13291 at commit
|
## What changes were proposed in this pull request? Since we done Scala API audit for ml.clustering at #13148, we should also fix and update the corresponding Python API docs to keep them in sync. ## How was this patch tested? Docs change, no tests. Author: Yanbo Liang <[email protected]> Closes #13291 from yanboliang/spark-15361-followup. (cherry picked from commit 594484c) Signed-off-by: Nick Pentreath <[email protected]>
|
Merged to master/branch-2.0. |
4 participants
What changes were proposed in this pull request?
Since we done Scala API audit for ml.clustering at #13148, we should also fix and update the corresponding Python API docs to keep them in sync.
How was this patch tested?
Docs change, no tests.