Skip to content

Commit

Permalink
Update README.md format
Browse files Browse the repository at this point in the history
  • Loading branch information
agostini01 committed Apr 16, 2024
1 parent d7b47d0 commit f13610e
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Dev Container NVIDIA Torch

This is an example of how to set up an NVIDIA VSCode DevContainer with GPU support for PyTorch and profiling.
This is an example of how to set up an NVIDIA VSCode DevContainer with GPU
support for PyTorch and profiling.

The `examples` folder contains several examples of how to compile CUDA kernels within PyTorch, showcasing profiling when possible.
The `examples` folder contains several examples of how to compile CUDA kernels
within PyTorch, showcasing profiling when possible.


## Prerequisites
Expand Down Expand Up @@ -38,16 +40,23 @@ make nsys # to profile the whole application

## Visualize the profiling results

Install nsight-sys and nsight-compute on your local machine and open the files generated in `examples/<app>/prof` folder
Install nsight-sys and nsight-compute on your **local machine**, then use the
tools to open the files located in the `examples/<app>/prof` folder.


## Setup details

We leverage the NVIDIA CUDA image, which contains CUDA and PyTorch dependencies installed. See the [Dockerfile](.devcontainer/Dockerfile) for more details.
We leverage the NVIDIA CUDA image, which contains CUDA and PyTorch dependencies
installed. See the [Dockerfile](.devcontainer/Dockerfile) for more details.


### Additional Python packages
The file `.devcontainer/requirements.txt` contains all third party Python packages you wish to install. Modify the list as you like and uncoment the "updateContentCommand" line in [`.devcontainer/devcontainer.json`](.devcontainer/devcontainer.json) to install the packages.

The file `.devcontainer/requirements.txt` contains all third party Python
packages you wish to install. Modify the list as you like and uncoment the
"updateContentCommand" line in
[`.devcontainer/devcontainer.json`](.devcontainer/devcontainer.json) to install
the packages.

```
# Example: Minimal deps for tensorflow
Expand Down

0 comments on commit f13610e

Please sign in to comment.