Github user MLnick commented on the pull request:
https://github.com/apache/spark/pull/12914#issuecomment-217134578
@holdenk one potential issue that I've found with including the default
value in the param "help" is that it then gets duplicated if users call
`explainParam`/`explainParams`, e.g.
```
In [44]: als = ALS().setAlpha(10)
In [45]: print als.explainParams()
alpha: alpha for implicit preference (default: 1.0, current: 10.0)
checkpointInterval: set checkpoint interval (>= 1) or disable checkpoint
(-1). E.g. 10 means that the cache will get checkpointed every 10 iterations.
(default: 10)
finalStorageLevel: StorageLevel for ALS model factors. Default:
'MEMORY_AND_DISK'. (default: MEMORY_AND_DISK)
```
I've used ALS as an example here where I put the defaults for storage level
params in the param doc, and you can see it gets duplicated and IMO doesn't
look great. Though without something like this, the defaults don't go into the
HTML doc for the param (well they go into the constructor doc so they are there
somewhere, but I agree it would be better if they lived with the param doc).
Not sure if there is an alternative solution.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
