Addressing review comments

apache · Jul 13, 2018 · 7533114 · 7533114
1 parent 07a4ac0
commit 7533114
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 2 deletions.
diff --git a/R/pkg/NAMESPACE b/R/pkg/NAMESPACE
@@ -435,6 +435,8 @@ export("as.DataFrame",
        "spark.addFile",
        "spark.getSparkFilesRootDirectory",
        "spark.getSparkFiles",
+       "spark.numCores",
+       "spark.numExecutors",
        "sql",
        "str",
        "tableToDF",

diff --git a/R/pkg/R/context.R b/R/pkg/R/context.R
@@ -447,7 +447,7 @@ setCheckpointDir <- function(directory) {
 #' @note spark.numCores since 2.4.0
 spark.numCores <- function() {
   sc <- getSparkContext()
-  invisible(callJMethod(sc, "numCores"))
+  callJMethod(sc, "numCores")
 }
 
 #' Total number of executors registered in the cluster at the moment.
@@ -461,5 +461,5 @@ spark.numCores <- function() {
 #' @note spark.numExecutors since 2.4.0
 spark.numExecutors <- function() {
   sc <- getSparkContext()
-  invisible(callJMethod(sc, "numExecutors"))
+  callJMethod(sc, "numExecutors")
 }
diff --git a/core/src/main/scala/org/apache/spark/SparkContext.scala b/core/src/main/scala/org/apache/spark/SparkContext.scala
@@ -2340,12 +2340,18 @@ class SparkContext(config: SparkConf) extends Logging {
   /**
    * Total number of CPU cores of all executors registered in the cluster at the moment.
    * The number reflects current status of the cluster and can change in the future.
+   *
+   * @note This method is experimental, and its behavior can be changed in the next releases.
+   * @since 2.4.0
    */
   def numCores: Int = taskScheduler.numCores
 
   /**
    * Total number of executors registered in the cluster at the moment.
    * The number reflects current status of the cluster and can change in the future.
+   *
+   * @note This method is experimental, and its behavior can be changed in the next releases.
+   * @since 2.4.0
    */
   def numExecutors: Int = taskScheduler.numExecutors
 

diff --git a/core/src/main/scala/org/apache/spark/api/java/JavaSparkContext.scala b/core/src/main/scala/org/apache/spark/api/java/JavaSparkContext.scala
@@ -131,12 +131,18 @@ class JavaSparkContext(val sc: SparkContext)
   /**
    * Total number of CPU cores of all executors registered in the cluster at the moment.
    * The number reflects current status of the cluster and can change in the future.
+   *
+   * @note This method is experimental, and its behavior can be changed in the next releases.
+   * @since 2.4.0
    */
   def numCores: java.lang.Integer = sc.numCores
 
   /**
    * Total number of executors registered in the cluster at the moment.
    * The number reflects current status of the cluster and can change in the future.
+   *
+   * @note This method is experimental, and its behavior can be changed in the next releases.
+   * @since 2.4.0
    */
   def numExecutors: java.lang.Integer = sc.numExecutors
 

diff --git a/python/pyspark/context.py b/python/pyspark/context.py
@@ -409,16 +409,24 @@ def defaultMinPartitions(self):
     @property
     def numCores(self):
         """
+        .. note:: Experimental
+
         Total number of CPU cores of all executors registered in the cluster at the moment.
         The number reflects current status of the cluster and can change in the future.
+
+        .. versionadded:: 2.4.0
         """
         return self._jsc.sc().numCores()
 
     @property
     def numExecutors(self):
         """
+        .. note:: Experimental
+
         Total number of executors registered in the cluster at the moment.
         The number reflects current status of the cluster and can change in the future.
+
+        .. versionadded:: 2.4.0
         """
         return self._jsc.sc().numExecutors()