NVIDIA / spark-rapids-tools

User tools for Spark RAPIDS
Apache License 2.0
49 stars 36 forks source link

[DOC] Documentation and user tools --help should clarify what type of cluster is used with --cluster option #1144

Closed tgravescs closed 2 months ago

tgravescs commented 3 months ago

Report incorrect documentation

Our user docs and the spark_rapids profiling/qualification --help should explicitly state what type of cluster (--cluster option) is expected - cpu or gpu. Some of our docs to mention it but not in all places and the main one for me is the --help option.

it was confusing to me when I was running qualification which type it was expected as far as this is the type of gpu cluster I want to to target, vs this is what cpu cluster I ran this app on.

### Tasks
- [x] Update in spark_rapids qualification --help for cluster argument
- [x] Update in documentation.
nartal1 commented 2 months ago

MR to update this in documentation is merged. Closing this issue.