Skip to content

Commit 82e560d

Browse files
committed
Update README and versions for 20.06 release
1 parent 770904d commit 82e560d

3 files changed

Lines changed: 27 additions & 11 deletions

File tree

Dockerfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
ARG BASE_IMAGE=nvcr.io/nvidia/pytorch:20.03-py3
15+
ARG BASE_IMAGE=nvcr.io/nvidia/pytorch:20.06-py3
1616

1717
############################################################################
1818
## Install PyProf
1919
############################################################################
2020
FROM $BASE_IMAGE
2121

22-
ARG PYPROF_VERSION=3.1.0dev
23-
ARG PYPROF_CONTAINER_VERSION=20.06dev
22+
ARG PYPROF_VERSION=3.1.0
23+
ARG PYPROF_CONTAINER_VERSION=20.06
2424

2525
# Copy entire repo into container even though some is not needed for the
2626
# build itself... because we want to be able to copyright check on

README.rst

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,25 @@
1818
PyProf - 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
2727
models. 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

5668
Documentation
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

6278
Contributing
6379
------------

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.1.0dev
1+
3.1.0

0 commit comments

Comments
 (0)