Update docs.

yanboliang · yanboliang · commit 0c85fd4143c6 · 2016-11-23T21:52:52.000-08:00
diff --git a/mllib/src/main/scala/org/apache/spark/ml/classification/GBTClassifier.scala b/mllib/src/main/scala/org/apache/spark/ml/classification/GBTClassifier.scala
@@ -204,6 +204,7 @@ class GBTClassificationModel private[ml](
   /**
    * Number of trees in ensemble
    */
+  @Since("2.0.0")
   val getNumTrees: Int = trees.length
 
   @Since("1.4.0")
diff --git a/mllib/src/main/scala/org/apache/spark/ml/regression/GBTRegressor.scala b/mllib/src/main/scala/org/apache/spark/ml/regression/GBTRegressor.scala
@@ -186,6 +186,7 @@ class GBTRegressionModel private[ml](
   /**
    * Number of trees in ensemble
    */
+  @Since("2.0.0")
   val getNumTrees: Int = trees.length
 
   @Since("1.4.0")
diff --git a/mllib/src/main/scala/org/apache/spark/ml/tree/treeParams.scala b/mllib/src/main/scala/org/apache/spark/ml/tree/treeParams.scala
@@ -327,6 +327,10 @@ private[ml] trait RandomForestParams extends TreeEnsembleParams {
    * If 1, then no bootstrapping is used.  If > 1, then bootstrapping is done.
    * TODO: Change to always do bootstrapping (simpler).  SPARK-7130
    * (default = 20)
+   *
+   * Note: The reason that we cannot add this to both GBT and RF (i.e. in TreeEnsembleParams)
+   * is the param `maxIter` controls how many trees a GBT has. The semantics in the algorithms
+   * are a bit different.
    * @group param
    */
   final val numTrees: IntParam = new IntParam(this, "numTrees", "Number of trees to train (>= 1)",
diff --git a/python/pyspark/ml/util.py b/python/pyspark/ml/util.py
@@ -80,7 +80,7 @@ def overwrite(self):
     def context(self, sqlContext):
         """
         Sets the SQL context to use for saving.
-        .. note:: Deprecated in 2.1, use session instead.
+        .. note:: Deprecated in 2.1 and will be removed in 2.2, use session instead.
         """
         raise NotImplementedError("MLWriter is not yet implemented for type: %s" % type(self))
 
@@ -114,9 +114,9 @@ def overwrite(self):
     def context(self, sqlContext):
         """
         Sets the SQL context to use for saving.
-        .. note:: Deprecated in 2.1, use session instead.
+        .. note:: Deprecated in 2.1 and will be removed in 2.2, use session instead.
         """
-        warnings.warn("Deprecated in 2.1, use session instead.")
+        warnings.warn("Deprecated in 2.1 and will be removed in 2.2, use session instead.")
         self._jwrite.context(sqlContext._ssql_ctx)
         return self
 
@@ -173,7 +173,7 @@ def load(self, path):
     def context(self, sqlContext):
         """
         Sets the SQL context to use for loading.
-        .. note:: Deprecated in 2.1, use session instead.
+        .. note:: Deprecated in 2.1 and will be removed in 2.2, use session instead.
         """
         raise NotImplementedError("MLReader is not yet implemented for type: %s" % type(self))
 
@@ -205,9 +205,9 @@ def load(self, path):
     def context(self, sqlContext):
         """
         Sets the SQL context to use for loading.
-        .. note:: Deprecated in 2.1, use session instead.
+        .. note:: Deprecated in 2.1 and will be removed in 2.2, use session instead.
         """
-        warnings.warn("Deprecated in 2.1, use session instead.")
+        warnings.warn("Deprecated in 2.1 and will be removed in 2.2, use session instead.")
         self._jread.context(sqlContext._ssql_ctx)
         return self
 
