From 4c0d827cfc30243893b0f6c0b496e2e0c866cb54 Mon Sep 17 00:00:00 2001 From: Holden Karau Date: Thu, 5 May 2016 10:52:25 +0100 Subject: [SPARK-15106][PYSPARK][ML] Add PySpark package doc for ML component & remove "BETA" ## What changes were proposed in this pull request? Copy the package documentation from Scala/Java to Python for ML package and remove beta tags. Not super sure if we want to keep the BETA tag but since we are making it the default it seems like probably the time to remove it (happy to put it back in if we want to keep it BETA). ## How was this patch tested? Python documentation built locally as HTML and text and verified output. Author: Holden Karau Closes #12883 from holdenk/SPARK-15106-add-pyspark-package-doc-for-ml. --- mllib/src/main/scala/org/apache/spark/ml/package-info.java | 2 +- mllib/src/main/scala/org/apache/spark/ml/package.scala | 2 +- python/pyspark/ml/__init__.py | 4 ++++ 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/mllib/src/main/scala/org/apache/spark/ml/package-info.java b/mllib/src/main/scala/org/apache/spark/ml/package-info.java index 87f4223964..9a40f5dd69 100644 --- a/mllib/src/main/scala/org/apache/spark/ml/package-info.java +++ b/mllib/src/main/scala/org/apache/spark/ml/package-info.java @@ -16,7 +16,7 @@ */ /** - * Spark ML is a BETA component that adds a new set of machine learning APIs to let users quickly + * Spark ML is a component that adds a new set of machine learning APIs to let users quickly * assemble and configure practical machine learning pipelines. */ @Experimental diff --git a/mllib/src/main/scala/org/apache/spark/ml/package.scala b/mllib/src/main/scala/org/apache/spark/ml/package.scala index c589d06d9f..5cc328b4a9 100644 --- a/mllib/src/main/scala/org/apache/spark/ml/package.scala +++ b/mllib/src/main/scala/org/apache/spark/ml/package.scala @@ -18,7 +18,7 @@ package org.apache.spark /** - * Spark ML is a BETA component that adds a new set of machine learning APIs to let users quickly + * Spark ML is a component that adds a new set of machine learning APIs to let users quickly * assemble and configure practical machine learning pipelines. * * @groupname param Parameters diff --git a/python/pyspark/ml/__init__.py b/python/pyspark/ml/__init__.py index 25cfac02f3..05f3be5f0d 100644 --- a/python/pyspark/ml/__init__.py +++ b/python/pyspark/ml/__init__.py @@ -15,6 +15,10 @@ # limitations under the License. # +""" +Spark ML is a component that adds a new set of machine learning APIs to let users quickly +assemble and configure practical machine learning pipelines. +""" from pyspark.ml.base import Estimator, Model, Transformer from pyspark.ml.pipeline import Pipeline, PipelineModel -- cgit v1.2.3