From 00b655cced637e1c3b750c19266086b9dcd7c158 Mon Sep 17 00:00:00 2001
From: Feynman Liang <fliang@databricks.com>
Date: Mon, 10 Aug 2015 11:01:45 -0700
Subject: [PATCH] [SPARK-9755] [MLLIB] Add docs to MultivariateOnlineSummarizer
methods
Adds method documentations back to `MultivariateOnlineSummarizer`, which were present in 1.4 but disappeared somewhere along the way to 1.5.
jkbradley
Author: Feynman Liang <fliang@databricks.com>
Closes #8045 from feynmanliang/SPARK-9755 and squashes the following commits:
af67fde [Feynman Liang] Add MultivariateOnlineSummarizer docs
---
.../stat/MultivariateOnlineSummarizer.scala | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/mllib/src/main/scala/org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.scala b/mllib/src/main/scala/org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.scala
index 62da9f2ef2..64e4be0ebb 100644
--- a/mllib/src/main/scala/org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.scala
+++ b/mllib/src/main/scala/org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.scala
@@ -153,6 +153,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
}
/**
+ * Sample mean of each dimension.
+ *
* @since 1.1.0
*/
override def mean: Vector = {
@@ -168,6 +170,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
}
/**
+ * Sample variance of each dimension.
+ *
* @since 1.1.0
*/
override def variance: Vector = {
@@ -193,11 +197,15 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
}
/**
+ * Sample size.
+ *
* @since 1.1.0
*/
override def count: Long = totalCnt
/**
+ * Number of nonzero elements in each dimension.
+ *
* @since 1.1.0
*/
override def numNonzeros: Vector = {
@@ -207,6 +215,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
}
/**
+ * Maximum value of each dimension.
+ *
* @since 1.1.0
*/
override def max: Vector = {
@@ -221,6 +231,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
}
/**
+ * Minimum value of each dimension.
+ *
* @since 1.1.0
*/
override def min: Vector = {
@@ -235,6 +247,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
}
/**
+ * L2 (Euclidian) norm of each dimension.
+ *
* @since 1.2.0
*/
override def normL2: Vector = {
@@ -252,6 +266,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
}
/**
+ * L1 norm of each dimension.
+ *
* @since 1.2.0
*/
override def normL1: Vector = {
--
GitLab