Update docs for Profiling and Qualification tool to change wording (#…

…4399) * Update docs for Profiling and Qualification tool to change wording * signoff Signed-off-by: Thomas Graves <tgraves@nvidia.com>
NVIDIA · Dec 21, 2021 · eb7a562 · eb7a562
1 parent a6eb2c8
commit eb7a562
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/docs/download.md b/docs/download.md
@@ -75,9 +75,9 @@ New functionality and performance improvements for this release include:
 * regexp_replace supports more patterns such as replacing null
 * ParquetCachedBatchSerializer supports map
 * Add function explainPotentialGpuPlan to print GPU query plan in a CPU Spark cluster
-* Spark Qualification Tool
+* Qualification Tool
   * Detect RDD APIs and JDBC Scan
-* Spark Profiling Tool
+* Profiling Tool
   * Catch OOM errors and log a hint to increase java heap size
   * Print potential problems
 
@@ -129,13 +129,13 @@ New functionality and performance improvements for this release include:
 * Parquet writing of map
 * ORC reader supports reading map/struct columns
 * ORC reader support decimal64 
-* Spark Qualification Tool
+* Qualification Tool
   * Add conjunction and disjunction filters
   * Filtering specific configuration values
   * Filtering user name
   * Reporting nested data types
   * Reporting write data formats
-* Spark Profiling Tool
+* Profiling Tool
   * Generating structured output format
   * Improved profiling tool performance
 

diff --git a/docs/spark-profiling-tool.md b/docs/spark-profiling-tool.md
@@ -1,9 +1,9 @@
 ---
 layout: page
-title: Spark Profiling tool
+title: Profiling tool
 nav_order: 9
 ---
-# Spark Profiling tool
+# Profiling tool
 
 The Profiling tool analyzes both CPU or GPU generated event logs and generates information 
 which can be used for debugging and profiling Apache Spark applications.
@@ -464,7 +464,7 @@ Failed jobs:
 ## Profiling tool options
   
 ```bash
-RAPIDS Accelerator for Apache Spark Profiling tool
+Profiling tool for the RAPIDS Accelerator and Apache Spark
 
 Usage: java -cp rapids-4-spark-tools_2.12-<version>.jar:$SPARK_HOME/jars/*
        com.nvidia.spark.rapids.tool.profiling.ProfileMain [options]

diff --git a/tools/src/main/scala/com/nvidia/spark/rapids/tool/profiling/GenerateTimeline.scala b/tools/src/main/scala/com/nvidia/spark/rapids/tool/profiling/GenerateTimeline.scala
@@ -358,7 +358,7 @@ object GenerateTimeline {
         s"""<?xml version="1.0" encoding="UTF-8" standalone="no"?>
            |<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
            | "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-           |<!-- Generated by Rapids Accelerator For Apache Spark Profiling Tool -->
+           |<!-- Generated by Profiling Tool for the Rapids Accelerator and Apache Spark -->
            |<svg width="$imageWidth" height="$imageHeight"
            | xmlns="http://www.w3.org/2000/svg">
            | <title>${app.appId} Timeline</title>

diff --git a/tools/src/main/scala/com/nvidia/spark/rapids/tool/profiling/ProfileArgs.scala b/tools/src/main/scala/com/nvidia/spark/rapids/tool/profiling/ProfileArgs.scala
@@ -20,7 +20,7 @@ import org.rogach.scallop.{ScallopConf, ScallopOption}
 class ProfileArgs(arguments: Seq[String]) extends ScallopConf(arguments) {
 
   banner("""
-RAPIDS Accelerator for Apache Spark profiling tool
+Profiling Tool for the RAPIDS Accelerator and Apache Spark
 
 Usage: java -cp rapids-4-spark-tools_2.12-<version>.jar:$SPARK_HOME/jars/*
        com.nvidia.spark.rapids.tool.profiling.ProfileMain [options]