Skip to content

Commit 45e767a

Browse files
committed
adding developer api annotation for overriden methods
1 parent c8428c4 commit 45e767a

File tree

3 files changed

+26
-1
lines changed

3 files changed

+26
-1
lines changed

mllib/src/main/scala/org/apache/spark/mllib/tree/impurity/Entropy.scala

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,14 @@ object Entropy extends Impurity {
5252
impurity
5353
}
5454

55+
/**
56+
* :: DeveloperApi ::
57+
* variance calculation
58+
* @param count number of instances
59+
* @param sum sum of labels
60+
* @param sumSquares summation of squares of the labels
61+
*/
62+
@DeveloperApi
5563
override def calculate(count: Double, sum: Double, sumSquares: Double): Double =
5664
throw new UnsupportedOperationException("Entropy.calculate")
5765
}

mllib/src/main/scala/org/apache/spark/mllib/tree/impurity/Gini.scala

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ object Gini extends Impurity {
4848
impurity
4949
}
5050

51+
/**
52+
* :: DeveloperApi ::
53+
* variance calculation
54+
* @param count number of instances
55+
* @param sum sum of labels
56+
* @param sumSquares summation of squares of the labels
57+
*/
58+
@DeveloperApi
5159
override def calculate(count: Double, sum: Double, sumSquares: Double): Double =
5260
throw new UnsupportedOperationException("Gini.calculate")
5361
}

mllib/src/main/scala/org/apache/spark/mllib/tree/impurity/Variance.scala

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,16 @@ import org.apache.spark.annotation.{DeveloperApi, Experimental}
2525
*/
2626
@Experimental
2727
object Variance extends Impurity {
28-
override def calculate(counts: Array[Double], totalCounts: Double): Double =
28+
29+
/**
30+
* :: DeveloperApi ::
31+
* information calculation for multiclass classification
32+
* @param counts Array[Double] with counts for each label
33+
* @param totalCount sum of counts for all labels
34+
* @return information value
35+
*/
36+
@DeveloperApi
37+
override def calculate(counts: Array[Double], totalCount: Double): Double =
2938
throw new UnsupportedOperationException("Variance.calculate")
3039

3140
/**

0 commit comments

Comments
 (0)