Skip to content

Commit

Permalink
Merge pull request NVIDIA#18 from lcskrishna/cl/readme-updates
Browse files Browse the repository at this point in the history
[Documentation] Update the readme for ROCm.
  • Loading branch information
sunway513 authored May 29, 2020
2 parents 38ade0a + 8fff447 commit aea81c0
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,27 @@ It's often convenient to use Apex in Docker containers. Compatible options incl

See the [Docker example folder](https://github.com/NVIDIA/apex/tree/master/examples/docker) for details.

## On ROCm:
* Python 3.6
* Pytorch 1.5 or newer, The HIPExtensions require 1.5 or newer.
* We recommend follow the instructions from [ROCm-Pytorch](https://github.com/ROCmSoftwarePlatform/pytorch) to install pytorch on ROCm.

# Quick Start

### Rocm
Apex on ROCm supports both python only build and extension build.
Note: Pytorch version recommended is >=1.5 for extension build.

### To install using python only build use the following command in apex folder:
```
python3.6 setup.py install
```

### To install using extensions enabled use the following command in apex folder:
```
python3.6 setup.py install --cpp_ext --cuda_ext
```

### Linux

For performance and full functionality, we recommend installing Apex with
Expand Down

0 comments on commit aea81c0

Please sign in to comment.