Skip to content

Commit af67fde

Browse files
author
Feynman Liang
committed
Add MultivariateOnlineSummarizer docs
1 parent 9897cc5 commit af67fde

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

mllib/src/main/scala/org/apache/spark/mllib/stat/MultivariateOnlineSummarizer.scala

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
153153
}
154154

155155
/**
156+
* Sample mean of each dimension.
157+
*
156158
* @since 1.1.0
157159
*/
158160
override def mean: Vector = {
@@ -168,6 +170,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
168170
}
169171

170172
/**
173+
* Sample variance of each dimension.
174+
*
171175
* @since 1.1.0
172176
*/
173177
override def variance: Vector = {
@@ -193,11 +197,15 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
193197
}
194198

195199
/**
200+
* Sample size.
201+
*
196202
* @since 1.1.0
197203
*/
198204
override def count: Long = totalCnt
199205

200206
/**
207+
* Number of nonzero elements in each dimension.
208+
*
201209
* @since 1.1.0
202210
*/
203211
override def numNonzeros: Vector = {
@@ -207,6 +215,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
207215
}
208216

209217
/**
218+
* Maximum value of each dimension.
219+
*
210220
* @since 1.1.0
211221
*/
212222
override def max: Vector = {
@@ -221,6 +231,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
221231
}
222232

223233
/**
234+
* Minimum value of each dimension.
235+
*
224236
* @since 1.1.0
225237
*/
226238
override def min: Vector = {
@@ -235,6 +247,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
235247
}
236248

237249
/**
250+
* L2 (Euclidian) norm of each dimension.
251+
*
238252
* @since 1.2.0
239253
*/
240254
override def normL2: Vector = {
@@ -252,6 +266,8 @@ class MultivariateOnlineSummarizer extends MultivariateStatisticalSummary with S
252266
}
253267

254268
/**
269+
* L1 norm of each dimension.
270+
*
255271
* @since 1.2.0
256272
*/
257273
override def normL1: Vector = {

0 commit comments

Comments
 (0)