[SPARK-7583] User guide update for RegexTokenizer

• Type: Documentation
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.5.0
• Component/s: Documentation, ML
• Target Version/s: 1.5.0
• Assignee: yuhao yang
• Reporter: Joseph K. Bradley
• Shepherd: Xiangrui Meng
• Created: 12/May/15 21:44
• Updated: 12/Aug/15 16:35
• Resolved: 12/Aug/15 16:35

Description

Copied from SPARK-7443:

Now that we have algorithms in spark.ml which are not in spark.mllib, we should start making subsections for the spark.ml API as needed. We can follow the structure of the spark.mllib user guide.

• The spark.ml user guide can provide: (a) code examples and (b) info on algorithms which do not exist in spark.mllib.
• We should not duplicate info in the spark.ml guides. Since spark.mllib is still the primary API, we should provide links to the corresponding algorithms in the spark.mllib user guide for more info.

Note: I created a new subsection for links to spark.ml-specific guides in this JIRA's PR: SPARK-7557. This transformer can go within the new subsection. I'll try to get that PR merged ASAP.

Issue Links

• is related to: SPARK-5566 Tokenizer for mllib package
• is required by: SPARK-9668 ML 1.5 QA: Docs: Check for new APIs
• is required by: SPARK-7443 MLlib 1.4 QA plan
• links to: [Github] Pull Request #7828 (hhbyyh)