From 662ddc04e26fb1883c3a644444d9f5358b26feb9 Mon Sep 17 00:00:00 2001 From: dzier Date: Thu, 13 Aug 2020 09:51:41 -0700 Subject: [PATCH] Update README and versions for 20.09 branch --- Dockerfile | 6 +++--- README.rst | 38 ++++++++++++++++++++++---------------- VERSION | 2 +- docs/install.rst | 4 ++-- docs/quickstart.rst | 4 ++-- 5 files changed, 30 insertions(+), 24 deletions(-) diff --git a/Dockerfile b/Dockerfile index 454be72..9caa612 100644 --- a/Dockerfile +++ b/Dockerfile @@ -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.07-py3 +ARG BASE_IMAGE=nvcr.io/nvidia/pytorch:20.09-py3 ############################################################################ ## Install PyProf ############################################################################ FROM $BASE_IMAGE -ARG PYPROF_VERSION=3.4.0dev -ARG PYPROF_CONTAINER_VERSION=20.09dev +ARG PYPROF_VERSION=3.4.0 +ARG PYPROF_CONTAINER_VERSION=20.09 # 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 diff --git a/README.rst b/README.rst index b116537..540234b 100644 --- a/README.rst +++ b/README.rst @@ -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.2.0 and is available on branch** `r20.07 - `_. - .. 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.4.0 +------------------- + +* README and User Guide documentation has been updated with more installation + options and pointers + +Known Issues +------------ + +* Forward-Backward kernel correlation heuristics do not work correctly with + PyTorch 1.6. Recommended work arounds include: + + * Use with PyTorch 1.5 + * Use DLProf in the `20.09 NGC Pytorch container `_ + +Features +-------- * Identifies the layer that launched a kernel: e.g. the association of `ComputeOffsetsKernel` with a concrete PyTorch layer or API is not obvious. @@ -59,10 +65,10 @@ following additional features: .. overview-end-marker-do-not-remove -The current release of PyProf is 3.1.0 and is available in the 20.07 release of +The current release of PyProf is 3.4.0 and is available in the 20.09 release of the PyTorch container on `NVIDIA GPU Cloud (NGC) `_. The -branch for this release is `r20.07 -`_. +branch for this release is `r20.09 +`_. Quick Installation Instructions ------------------------------- diff --git a/VERSION b/VERSION index aba004a..1809198 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -3.3.0dev +3.4.0 diff --git a/docs/install.rst b/docs/install.rst index 2790cc1..16514a8 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.07-py3 + docker pull nvcr.io/nvidia/pytorch:20.09-py3 -Replace *20.07* with the version of PyTorch container that you want to pull. +Replace *20.09* with the version of PyTorch container that you want to pull. diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 6567248..c6884ca 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.07 + $ git checkout r20.09 * 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 master branch if you want to build the under-development version):: - $ git checkout r20.07 + $ git checkout r20.09 Then use docker to build::