Skip to content
Snippets Groups Projects
Commit 00b655cc authored by Feynman Liang's avatar Feynman Liang Committed by Joseph K. Bradley
Browse files

[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
parent 0f3366a4
No related branches found
No related tags found
No related merge requests found
......@@ -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 = {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment