You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by me...@apache.org on 2016/05/20 00:54:22 UTC
spark git commit: [SPARK-15341][DOC][ML] Add documentation for
"model.write" to clarify "summary" was not saved
Repository: spark
Updated Branches:
refs/heads/master dcf407de6 -> f8107c784
[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 <yb...@gmail.com>
Closes #13131 from yanboliang/spark-15341.
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/f8107c78
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/f8107c78
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/f8107c78
Branch: refs/heads/master
Commit: f8107c7846c9fcabbe2579867574305c7f2028e7
Parents: dcf407d
Author: Yanbo Liang <yb...@gmail.com>
Authored: Thu May 19 17:54:18 2016 -0700
Committer: Xiangrui Meng <me...@databricks.com>
Committed: Thu May 19 17:54:18 2016 -0700
----------------------------------------------------------------------
.../apache/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(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/spark/blob/f8107c78/mllib/src/main/scala/org/apache/spark/ml/classification/LogisticRegression.scala
----------------------------------------------------------------------
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 ac2cd87..0ab4459 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.
http://git-wip-us.apache.org/repos/asf/spark/blob/f8107c78/mllib/src/main/scala/org/apache/spark/ml/clustering/GaussianMixture.scala
----------------------------------------------------------------------
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 d81b337..88b6b27 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)
http://git-wip-us.apache.org/repos/asf/spark/blob/f8107c78/mllib/src/main/scala/org/apache/spark/ml/clustering/KMeans.scala
----------------------------------------------------------------------
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 0ab370e..790ef1f 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)
http://git-wip-us.apache.org/repos/asf/spark/blob/f8107c78/mllib/src/main/scala/org/apache/spark/ml/regression/GeneralizedLinearRegression.scala
----------------------------------------------------------------------
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 4aa7c2c..e8474d0 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)
http://git-wip-us.apache.org/repos/asf/spark/blob/f8107c78/mllib/src/main/scala/org/apache/spark/ml/regression/LinearRegression.scala
----------------------------------------------------------------------
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 3e9a3f9..a702f02 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.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org