Skip to content

Commit

Permalink
Update README and versions for 20.08 branch
Browse files Browse the repository at this point in the history
  • Loading branch information
dzier committed Jul 23, 2020
1 parent 11a572c commit a0009e8
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 21 deletions.
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@
# See the License for the specific language governing permissions and
# limitations under the License.

ARG BASE_IMAGE=nvcr.io/nvidia/pytorch:20.06-py3
ARG BASE_IMAGE=nvcr.io/nvidia/pytorch:20.08-py3

############################################################################
## Install PyProf
############################################################################
FROM $BASE_IMAGE

ARG PYPROF_VERSION=3.2.0dev
ARG PYPROF_CONTAINER_VERSION=20.07dev
ARG PYPROF_VERSION=3.3.0
ARG PYPROF_CONTAINER_VERSION=20.08

# Copy entire repo into container even though some is not needed for the
# build itself... because we want to be able to copyright check on
Expand Down
46 changes: 29 additions & 17 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,24 +18,30 @@
PyProf - PyTorch Profiling tool
===============================

**NOTE: Our forward-backward kernel correlation heuristics are not working correctly
with PyTorch v1.6. We are working to resolve it. In the mean time, please use Pytorch
1.5 or the 20.03 NGC container, which you can retrieve via:** ::

docker pull http://nvcr.io/nvidia/pytorch:20.03-py3

**LATEST RELEASE: You are currently working on the master branch which
tracks under-development progress towards the next release. The
latest release of the PyProf is 3.1.0 and is available on branch** `r20.06
<https://github.com/NVIDIA/PyProf/blob/r20.06>`_.
**PRE-RELEASE: You are currently on the r20.08 branch which tracks
stabilization towards the new release.**

.. 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
<https://developer.nvidia.com/nsight-systems>`_ or `NvProf
<https://developer.nvidia.com/nvidia-visual-profiler>`_ and provides the
following additional features:
<https://developer.nvidia.com/nvidia-visual-profiler>`_.

What's New in 3.3.0
-------------------

* Capture PyTorch API information and data loading configuration

* Added CUTLASS to the list of GEMM kernels

* Added optional function stack tracing to NVTX markers. Enable with ::

pyprof.init(enable_function_stack=True)


Features
--------

* Identifies the layer that launched a kernel: e.g. the association of
`ComputeOffsetsKernel` with a concrete PyTorch layer or API is not obvious.
Expand All @@ -59,21 +65,27 @@ following additional features:

.. overview-end-marker-do-not-remove
The current release of PyProf is 3.1.0 and is available in the 20.06 release of
The current release of PyProf is 3.3.0 and is available in the 20.08 release of
the PyTorch container on `NVIDIA GPU Cloud (NGC) <https://ngc.nvidia.com>`_. The
branch for this release is `r20.06
<https://github.com/NVIDIA/PyProf/tree/r20.06>`_.
branch for this release is `r20.08
<https://github.com/NVIDIA/PyProf/tree/r20.08>`_.

Documentation
-------------

The User Guide can be found in the
`PyProf docs folder <https://github.com/NVIDIA/PyProf/blob/master/docs>`_, and
`documentation for current release
<https://docs.nvidia.com/deeplearning/frameworks/pyprof-user-guide/index.html>`_, and
provides instructions on how to install and profile with PyProf.

An `FAQ <https://github.com/NVIDIA/PyProf/blob/master/docs/faqs.rst>`_ provides
An `FAQ <https://docs.nvidia.com/deeplearning/frameworks/pyprof-user-guide/index.html/faqs.rst>`_ provides
answers for frequently asked questions.

The `Release Notes
<https://docs.nvidia.com/deeplearning/frameworks/pyprof-release-notes/index.html>`_
indicate the required versions of the NVIDIA Driver and CUDA, and also describe
which GPUs are supported by PyProf.

Contributing
------------

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.2.0dev
3.3.0

0 comments on commit a0009e8

Please sign in to comment.