Added profiling docs for Polaris and Aurora #576
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
added 3 commits
December 11, 2024 14:15
felker
requested changes
Jan 9, 2025
| multiple nodes. A simple example, where we use a wrapper script to trace the | ||
| rank 0 on each node of a 4 node job running a PyTorch application is below: | ||
|
|
||
| ### A `unitrace` wrapper |
There was a problem hiding this comment.
Can you add a title for the script using: https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-a-title
And remove the ### subsection header
|
|
||
| ### Deployment | ||
|
|
||
| The wrapper above can be deployed using a PBS job script the following way |
There was a problem hiding this comment.
Suggested change
| The wrapper above can be deployed using a PBS job script the following way | |
| The wrapper above can be deployed using the following PBS job script: |
| @@ -0,0 +1,250 @@ | |||
| # Profiling Deep Learning Applications | |||
|
|
|||
| We can use both framework (for example, PyTorch) native profiler and vendor specific | |||
There was a problem hiding this comment.
Suggested change
| We can use both framework (for example, PyTorch) native profiler and vendor specific | |
| We can use both a framework-specific (for example, PyTorch-specific) native profiler and the vendor-specific NVIDIA |
| [Nsight compute profiler](https://developer.nvidia.com/tools-overview/nsight-compute/get-started). | ||
| Refer to the respective documentation for more details: | ||
|
|
||
| [Nsight System User Guide](https://docs.nvidia.com/nsight-systems/UserGuide/index.html) |
| multiple nodes. A simple example, where we use a wrapper script to trace the | ||
| rank 0 on each node of a 2 node job running a PyTorch application is below: | ||
|
|
||
| ### An `nsys` wrapper |
There was a problem hiding this comment.
same comment as before re: code block title
|
|
||
| This wrapper can be deployed as the `nsys` example above. In the `ncu` wrapper | ||
| we explicitly set the name of the kernel that we want to analyze | ||
| (a gemm kernel in this case). |
There was a problem hiding this comment.
Suggested change
| (a gemm kernel in this case). | |
| (a GEMM kernel in this case). |
or
Suggested change
| (a gemm kernel in this case). | |
| (a `gemm` kernel in this case). |
| The next step is to load the `nsys-rep` files in the Nsight Systems GUI, and | ||
| the `ncu-rep` files to the Nsight Compute GUI. | ||
|
|
||
| ### For a single rank run |
There was a problem hiding this comment.
Suggested change
| ### For a single rank run | |
| ### Single rank run |
| of the documentation. Here we only show standard options, either of the three | ||
| could be chosen. Note that, invoking each option will lead to varying amounts | ||
| of time the profiler need to run. This will be important in setting the | ||
| requested wall-time for your batch job. |
There was a problem hiding this comment.
Suggested change
| requested wall-time for your batch job. | |
| requested walltime for your batch job. |
| generate the profiles. The exhaustive list could be found in the respective | ||
| documentation pages: | ||
|
|
||
| [Nsight System User Guide](https://docs.nvidia.com/nsight-systems/UserGuide/index.html) |
There was a problem hiding this comment.
Use unordered list to clean up the formatting
| fi | ||
|
|
||
| ``` | ||
| There are a few important things to notice in the wrapper. |
There was a problem hiding this comment.
Suggested change
| There are a few important things to notice in the wrapper. | |
| There are several important shell variables in the wrapper, which may require modification: |
also change the phrasing on the Polaris profiling doc
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.
For Poalris:
For Aurora
TODO: