Update explainCatalystSQLPlan to adapt to the change of the default v…

…alue of rapids.sql.explain Signed-off-by: sinkinben <sinkinben@outlook.com>
NVIDIA · Jun 20, 2022 · faf02c4 · faf02c4
1 parent bb50fd8
commit faf02c4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/get-started/getting-started.md b/docs/get-started/getting-started.md
@@ -39,6 +39,11 @@ will vary depending on your cluster manager. Here are some example configs:
   - `--conf spark.task.resource.gpu.amount=1`
 - Specify a GPU discovery script (required on YARN and K8S):
   - `--conf spark.executor.resource.gpu.discoveryScript=./getGpusResources.sh`
+- Explain why some operations of a query were not placed on a GPU or not:
+  - `--conf spark.rapids.sql.explain=ALL` will display whether each operation is placed on GPU.
+  - `--conf spark.rapids.sql.explain=NONE` will disable the log of `rapids.sql.explain`.
+  - `--conf spark.rapids.sql.explain=NOT_ON_GPU` will display only parts that did not go on the GPU,
+  and it's the default setting.
 
 See the deployment specific sections for more details and restrictions. Note that
 `spark.task.resource.gpu.amount` can be a decimal amount, so if you want multiple tasks to be run

diff --git a/sql-plugin/src/main/scala/com/nvidia/spark/rapids/GpuOverrides.scala b/sql-plugin/src/main/scala/com/nvidia/spark/rapids/GpuOverrides.scala
@@ -4142,7 +4142,11 @@ object GpuOverrides extends Logging {
    * GPUs.
    */
   private def explainCatalystSQLPlan(updatedPlan: SparkPlan, conf: RapidsConf): Unit = {
-    val explainSetting = if (conf.shouldExplain) {
+    // Since we set "NOT_ON_GPU" as the default value of spark.rapids.sql.explain, here we keep
+    // "ALL" as default value of "explainSetting", unless spark.rapids.sql.explain is changed
+    // by the user.
+    val explainSetting = if (conf.shouldExplain &&
+      conf.rapidsConfMap.containsKey(RapidsConf.EXPLAIN.key)) {
       conf.explain
     } else {
       "ALL"