1818PyProf - PyTorch Profiling tool
1919===============================
2020
21- **LATEST RELEASE: You are currently working on the master branch which
22- tracks under-development progress towards the next release. **
21+ **PRE- RELEASE: You are currently on the r20.06 branch which tracks
22+ stabilization towards the new release. **
2323
2424.. overview-begin-marker-do-not-remove
2525
2626 PyProf is a tool that profiles and analyzes the GPU performance of PyTorch
2727models. PyProf aggregates kernel performance from `Nsight Systems
2828<https://developer.nvidia.com/nsight-systems> `_ or `NvProf
29- <https://developer.nvidia.com/nvidia-visual-profiler> `_ and provides the
30- following additional features:
29+ <https://developer.nvidia.com/nvidia-visual-profiler> `_.
30+
31+ What's New in 3.1.0
32+ -------------------
33+
34+ * Improved NVTX functionality and coverage.
35+
36+ * Add support required by `NVIDIA Deep Learning Profiler <https://docs.nvidia.com/deeplearning/frameworks/dlprof-user-guide/ >`_.
37+
38+ Features
39+ --------
3140
3241* Identifies the layer that launched a kernel: e.g. the association of
3342 `ComputeOffsetsKernel ` with a concrete PyTorch layer or API is not obvious.
@@ -51,13 +60,20 @@ following additional features:
5160
5261.. overview-end-marker-do-not-remove
5362
54- TODO: add release information here
63+ The current release of PyProf is 3.1.0 and is available in the 20.06 release of
64+ the PyTorch container on `NVIDIA GPU Cloud (NGC) <https://ngc.nvidia.com >`_. The
65+ branch for this release is `r20.06
66+ <https://github.com/NVIDIA/PyProf/tree/r20.06> `_.
5567
5668Documentation
5769-------------
5870
59- TODO: add links to Documentation
60- * `Installation <https://github.com/NVIDIA/PyProf/blob/master/docs/install.rst> ` _.
71+ The User Guide can be found in the
72+ `PyProf docs folder <https://github.com/NVIDIA/PyProf/blob/master/docs >`_, and
73+ provides instructions on how to install and profile with PyProf.
74+
75+ An `FAQ <https://github.com/NVIDIA/PyProf/blob/master/docs/faqs.rst >`_ provides
76+ answers for frequently asked questions.
6177
6278Contributing
6379------------
0 commit comments