From f8107c7846c9fcabbe2579867574305c7f2028e7 Mon Sep 17 00:00:00 2001
From: Yanbo Liang <ybliang8@gmail.com>
Date: Thu, 19 May 2016 17:54:18 -0700
Subject: [PATCH] [SPARK-15341][DOC][ML] Add documentation for "model.write" to
clarify "summary" was not saved
## What changes were proposed in this pull request?
Currently in ```model.write```, we don't save ```summary```(if applicable). We should add documentation to clarify it.
We fixed the incorrect link ```[[MLWriter]]``` to ```[[org.apache.spark.ml.util.MLWriter]]``` BTW.
## How was this patch tested?
Documentation update, no unit test.
Author: Yanbo Liang <ybliang8@gmail.com>
Closes #13131 from yanboliang/spark-15341.
---
.../spark/ml/classification/LogisticRegression.scala | 2 +-
.../org/apache/spark/ml/clustering/GaussianMixture.scala | 7 +++++++
.../main/scala/org/apache/spark/ml/clustering/KMeans.scala | 7 +++++++
.../spark/ml/regression/GeneralizedLinearRegression.scala | 7 +++++++
.../org/apache/spark/ml/regression/LinearRegression.scala | 2 +-
5 files changed, 23 insertions(+), 2 deletions(-)
diff --git a/mllib/src/main/scala/org/apache/spark/ml/classification/LogisticRegression.scala b/mllib/src/main/scala/org/apache/spark/ml/classification/LogisticRegression.scala
index ac2cd8726b..0ab4459bdb 100644
--- a/mllib/src/main/scala/org/apache/spark/ml/classification/LogisticRegression.scala
+++ b/mllib/src/main/scala/org/apache/spark/ml/classification/LogisticRegression.scala
@@ -614,7 +614,7 @@ class LogisticRegressionModel private[spark] (
}
/**
- * Returns a [[MLWriter]] instance for this ML instance.
+ * Returns a [[org.apache.spark.ml.util.MLWriter]] instance for this ML instance.
*
* For [[LogisticRegressionModel]], this does NOT currently save the training [[summary]].
* An option to save [[summary]] may be added in the future.
diff --git a/mllib/src/main/scala/org/apache/spark/ml/clustering/GaussianMixture.scala b/mllib/src/main/scala/org/apache/spark/ml/clustering/GaussianMixture.scala
index d81b337607..88b6b27e62 100644
--- a/mllib/src/main/scala/org/apache/spark/ml/clustering/GaussianMixture.scala
+++ b/mllib/src/main/scala/org/apache/spark/ml/clustering/GaussianMixture.scala
@@ -139,6 +139,13 @@ class GaussianMixtureModel private[ml] (
sqlContext.createDataFrame(modelGaussians).toDF("mean", "cov")
}
+ /**
+ * Returns a [[org.apache.spark.ml.util.MLWriter]] instance for this ML instance.
+ *
+ * For [[GaussianMixtureModel]], this does NOT currently save the training [[summary]].
+ * An option to save [[summary]] may be added in the future.
+ *
+ */
@Since("2.0.0")
override def write: MLWriter = new GaussianMixtureModel.GaussianMixtureModelWriter(this)
diff --git a/mllib/src/main/scala/org/apache/spark/ml/clustering/KMeans.scala b/mllib/src/main/scala/org/apache/spark/ml/clustering/KMeans.scala
index 0ab370e3b4..790ef1fe8d 100644
--- a/mllib/src/main/scala/org/apache/spark/ml/clustering/KMeans.scala
+++ b/mllib/src/main/scala/org/apache/spark/ml/clustering/KMeans.scala
@@ -148,6 +148,13 @@ class KMeansModel private[ml] (
parentModel.computeCost(data)
}
+ /**
+ * Returns a [[org.apache.spark.ml.util.MLWriter]] instance for this ML instance.
+ *
+ * For [[KMeansModel]], this does NOT currently save the training [[summary]].
+ * An option to save [[summary]] may be added in the future.
+ *
+ */
@Since("1.6.0")
override def write: MLWriter = new KMeansModel.KMeansModelWriter(this)
diff --git a/mllib/src/main/scala/org/apache/spark/ml/regression/GeneralizedLinearRegression.scala b/mllib/src/main/scala/org/apache/spark/ml/regression/GeneralizedLinearRegression.scala
index 4aa7c2cc0b..e8474d035e 100644
--- a/mllib/src/main/scala/org/apache/spark/ml/regression/GeneralizedLinearRegression.scala
+++ b/mllib/src/main/scala/org/apache/spark/ml/regression/GeneralizedLinearRegression.scala
@@ -776,6 +776,13 @@ class GeneralizedLinearRegressionModel private[ml] (
.setParent(parent)
}
+ /**
+ * Returns a [[org.apache.spark.ml.util.MLWriter]] instance for this ML instance.
+ *
+ * For [[GeneralizedLinearRegressionModel]], this does NOT currently save the
+ * training [[summary]]. An option to save [[summary]] may be added in the future.
+ *
+ */
@Since("2.0.0")
override def write: MLWriter =
new GeneralizedLinearRegressionModel.GeneralizedLinearRegressionModelWriter(this)
diff --git a/mllib/src/main/scala/org/apache/spark/ml/regression/LinearRegression.scala b/mllib/src/main/scala/org/apache/spark/ml/regression/LinearRegression.scala
index 3e9a3f9db5..a702f02c91 100644
--- a/mllib/src/main/scala/org/apache/spark/ml/regression/LinearRegression.scala
+++ b/mllib/src/main/scala/org/apache/spark/ml/regression/LinearRegression.scala
@@ -449,7 +449,7 @@ class LinearRegressionModel private[ml] (
}
/**
- * Returns a [[MLWriter]] instance for this ML instance.
+ * Returns a [[org.apache.spark.ml.util.MLWriter]] instance for this ML instance.
*
* For [[LinearRegressionModel]], this does NOT currently save the training [[summary]].
* An option to save [[summary]] may be added in the future.
--
GitLab