From 5aae754018a7b607ed047de0f3d77dd71640e919 Mon Sep 17 00:00:00 2001 From: tgerdes Date: Thu, 22 Apr 2021 14:29:31 -0500 Subject: [PATCH] Update README and docs for 21.04 release --- README.rst | 89 +++++++++++++++++++++++++++++++++++++++++++-- docs/install.rst | 4 +- docs/quickstart.rst | 4 +- 3 files changed, 90 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index b5d4876..24d93ed 100644 --- a/README.rst +++ b/README.rst @@ -18,11 +18,42 @@ PyProf - PyTorch Profiling tool =============================== - **NOTE: You are currently on the 21.04 branch which tracks stabilization - towards the release. This branch is not usable during stabilization** - .. overview-begin-marker-do-not-remove +PyProf is a tool that profiles and analyzes the GPU performance of PyTorch +models. PyProf aggregates kernel performance from `Nsight Systems +`_ or `NvProf +`_ and provides the +following additional features: + +What's New in 3.10.0 +------------------- + +* Compatibility with NGC 21.04 release + +Features +-------- + +* Identifies the layer that launched a kernel: e.g. the association of + `ComputeOffsetsKernel` with a concrete PyTorch layer or API is not obvious. + +* Identifies the tensor dimensions and precision: without knowing the tensor + dimensions and precision, it's impossible to reason about whether the actual + (silicon) kernel time is close to maximum performance of such a kernel on + the GPU. Knowing the tensor dimensions and precision, we can figure out the + FLOPs and bandwidth required by a layer, and then determine how close to + maximum performance the kernel is for that operation. + +* Forward-backward correlation: PyProf determines what the forward pass step + is that resulted in the particular weight and data gradients (wgrad, dgrad), + which makes it possible to determine the tensor dimensions required by these + backprop steps to assess their performance. + +* Determines Tensor Core usage: PyProf can highlight the kernels that use + `Tensor Cores `_. + +* Correlate the line in the user's code that launched a particular kernel (program trace). + .. overview-end-marker-do-not-remove Quick Installation Instructions @@ -75,5 +106,57 @@ Quick Start Instructions .. quick-start-end-marker-do-not-remove +Documentation +------------- + +The User Guide can be found in the +`documentation for current release +`_, and +provides instructions on how to install and profile with PyProf. + +A complete `Quick Start Guide `_ +provides step-by-step instructions to get you quickly started using PyProf. + +An `FAQ `_ provides +answers for frequently asked questions. + +The `Release Notes +`_ +indicate the required versions of the NVIDIA Driver and CUDA, and also describe +which GPUs are supported by PyProf + +Presentation and Papers +^^^^^^^^^^^^^^^^^^^^^^^ + +* `Automating End-toEnd PyTorch Profiling `_. + * `Presentation slides `_. + +Contributing +------------ + +Contributions to PyProf are more than welcome. To +contribute make a pull request and follow the guidelines outlined in +the `Contributing `_ document. + +Reporting problems, asking questions +------------------------------------ + +We appreciate any feedback, questions or bug reporting regarding this +project. When help with code is needed, follow the process outlined in +the Stack Overflow (https://stackoverflow.com/help/mcve) +document. Ensure posted examples are: + +* minimal – use as little code as possible that still produces the + same problem + +* complete – provide all parts needed to reproduce the problem. Check + if you can strip external dependency and still show the problem. The + less time we spend on reproducing problems the more time we have to + fix it + +* verifiable – test the code you're about to provide to make sure it + reproduces the problem. Remove all other problems that are not + related to your request/question. + .. |License| image:: https://img.shields.io/badge/License-Apache2-green.svg :target: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/docs/install.rst b/docs/install.rst index 97e0e5a..3826b0d 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -48,6 +48,6 @@ the most recent version of CUDA, Docker, and nvidia-docker. After performing the above setup, you can pull the PyProf container using the following command:: - docker pull nvcr.io/nvidia/pytorch:20.12-py3 + docker pull nvcr.io/nvidia/pytorch:21.04-py3 -Replace *20.12* with the version of PyTorch container that you want to pull. +Replace *21.04* with the version of PyTorch container that you want to pull. diff --git a/docs/quickstart.rst b/docs/quickstart.rst index a369522..a5d0ce7 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -39,7 +39,7 @@ Prerequisites drop down button. After cloning the repo be sure to select the r release branch that corresponds to the version of PyProf want to use:: - $ git checkout r20.12 + $ git checkout r21.04 * If you are starting with a pre-built NGC container, you will need to install Docker and nvidia-docker. For DGX users, see `Preparing to use NVIDIA Containers @@ -75,7 +75,7 @@ the GitHub repo and checkout the release version of the branch that you want to build (or the `main` branch if you want to build the under-development version):: - $ git checkout r20.12 + $ git checkout r21.04 Then use docker to build::