ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[SPARK-9755] [MLLIB] Add docs to MultivariateOnlineSummarizer methods

Browse source 
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
This commit is contained in:
Feynman Liang 2015-08-10 11:01:45 -07:00 committed by Joseph K. Bradley
parent 0f3366a4c7
commit 00b655cced
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
mllib/src/main/scala/org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.scala
View file

@ -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 = {