Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the doc for -g option of the profiling tool. #2603

Merged
merged 2 commits into from
Jun 5, 2021
Merged

Add the doc for -g option of the profiling tool. #2603

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7c5e56
Signed-off-by: Hao Zhu <hazhu@nvidia.com>
viadea Jun 5, 2021
e17249f
Update README.md
viadea Jun 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions rapids-4-spark-tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ Below is an example input:

If any input is a S3 file path or directory path, here 2 extra steps to access S3 in Spark:
1. Download the matched jars based on the Hadoop version:
- hadoop-aws-<version>.jar
- aws-java-sdk-<version>.jar
- `hadoop-aws-<version>.jar`
- `aws-java-sdk-<version>.jar`

Take Hadoop 2.7.4 for example, we can download and include below jars in the '--jars' option to spark-shell or spark-submit:
[hadoop-aws-2.7.4.jar](https://repo.maven.apache.org/maven2/org/apache/hadoop/hadoop-aws/2.7.4/hadoop-aws-2.7.4.jar) and
Expand All @@ -75,7 +75,7 @@ Take Hadoop 2.7.4 for example, we can download and include below jars in the '--
## Qualification Tool

### Use from spark-shell
1. Include rapids-4-spark-tools_2.12-<version>.jar in the '--jars' option to spark-shell or spark-submit
1. Include `rapids-4-spark-tools_2.12-<version>.jar` in the '--jars' option to spark-shell or spark-submit
2. After starting spark-shell:

For multiple event logs comparison and analysis:
Expand Down Expand Up @@ -231,6 +231,7 @@ Run `--help` for more information.
- Print Rapids related parameters
- Print Rapids Accelerator Jar and cuDF Jar
- Print SQL Plan Metrics
- Generate DOT graph for each SQL

For example, GPU run vs CPU run performance comparison or different runs with different parameters.

Expand Down Expand Up @@ -304,6 +305,19 @@ SQL Plan Metrics for Application:
|0 |1 |GpuColumnarExchange |116 |shuffle write time |666666666666 |nsTiming |
```


- Generate DOT graph for each SQL (-g option)
```
Generated DOT graphs for app app-20210507103057-0000 to /path/. in 17 second(s)
```
Once the DOT file is generated, you can install [graphviz](http://www.graphviz.org) to convert the DOT file
as a graph in pdf format using below command:
```bash
dot -Tpdf ./app-20210507103057-0000-query-0/0.dot > app-20210507103057-0000.pdf
```
The pdf file has the SQL plan graph with metrics.


#### B. Analysis
- Job + Stage level aggregated task metrics
- SQL level aggregated task metrics
Expand Down