[SPARK-16151] Make generated params non-final

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Incomplete
• Affects Version/s: 2.0.0
• Component/s: MLlib
• Labels: bulk-closed
• Assignee: Unassigned
• Reporter: Xiangrui Meng
• Created: 22/Jun/16 17:36
• Updated: 21/May/19 04:17
• Resolved: 21/May/19 04:17

Description

Currently, all generated param instances are final. There are several scenarios where we need them to be non-final:

1. We don't have a guideline about where we should document the param doc. Some were inherited from the generated param traits directly, while some were documented in the setters if we want to make changes. I think it is better to have all documented in the param instances, which appear at the top the generated API doc. However, this requires inherit the param instance.

/**
 * new doc
 */
val param: Param = super.param

We can use `@inherit_doc` if we just want to add a few words, e.g., the default value, to the inherited doc.

2. We might want to update the embedded doc in the param instance.

Opened this JIRA for discussion.

Issue Links

• is depended upon by: SPARK-18619 Make QuantileDiscretizer/Bucketizer/StringIndexer inherit from HasHandleInvalid
• relates to: SPARK-18518 HasSolver should support allowed values