Move tools README to docs/additional-functionality/qualification-profiling-tools.md with some modification #2985
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Move tools README under docs folder.
Correct some typos of the link
Fix some typo
Add more example options for tools doc
Add a new README for tools.
tgravescs
reviewed
Jul 21, 2021
jlowe
reviewed
Jul 21, 2021
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
Co-authored-by: Jason Lowe <jlowe@nvidia.com>
jlowe
approved these changes
Jul 21, 2021
tgravescs
approved these changes
Jul 21, 2021
|
build |
sameerz
reviewed
Jul 22, 2021
Comment on lines
+10
to
+11
| Please refer to [this documentation](../docs/additional-functionality/qualification-profiling-tools.md) | ||
| for more details on how to use the tools. |
There was a problem hiding this comment.
If a user lands in this folder from within the github repository, I think it is still useful to give the pre-amble of what these tools are.
Suggested change
| Please refer to [this documentation](../docs/additional-functionality/qualification-profiling-tools.md) | |
| for more details on how to use the tools. | |
| The qualification tool analyzes applications to determine if the RAPIDS Accelerator for Apache Spark | |
| might be a good fit for those applications. | |
| The profiling tool generates information which can be used for debugging and profiling applications. | |
| The information contains the Spark version, executor details, properties, etc. This runs on either CPU or | |
| GPU generated event logs. | |
| Please refer to [this documentation](../docs/additional-functionality/qualification-profiling-tools.md) | |
| for more details on how to use the tools. |
There was a problem hiding this comment.
@sameerz I think in this tools README, we do have some pre-amble on the top right?
There was a problem hiding this comment.
Oh yes, I missed that at the top of the file. I am good with the change.
sameerz
approved these changes
Jul 22, 2021
Comment on lines
+10
to
+11
| Please refer to [this documentation](../docs/additional-functionality/qualification-profiling-tools.md) | ||
| for more details on how to use the tools. |
There was a problem hiding this comment.
Oh yes, I missed that at the top of the file. I am good with the change.
nartal1
approved these changes
Jul 22, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Move tools README to docs/additional-functionality/qualification-profiling-tools.md with some modification.
Basically added the new options in 21.08 and also created an index in the beginning since the doc is pretty long already.