Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove logo #111

Merged
merged 5 commits into from
Mar 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
<p align="center"><img width="70%" src="data/rocAL_logo.png" /></p>

# rocAL User Guide

Today’s deep learning applications require loading and pre-processing data efficiently to achieve high processing throughput. This requires creating efficient processing pipelines fully utilizing the underlying hardware capabilities. Some examples are load and decode data, do a variety of augmentations, color-format conversions, etc.
Expand All @@ -9,12 +7,12 @@ AMD ROCm Augmentation Library (rocAL) is designed to efficiently do such process
These pipelines are programmable by the user using both C++ and Python APIs.

## User Guide Chapters
- [Chapter 1 - Overview](user_guide/ch1.md)
- [Chapter 2 - Architecture Components](user_guide/ch2.md)
- [Chapter 3 - Installation](user_guide/ch3.md)
- [Chapter 4 - Using with Python API](user_guide/ch4.md)
- [Chapter 5 - Framework Integration](user_guide/ch5.md)
- [Chapter 6 - Using with C++ API](user_guide/ch6.md)
* [Chapter 1 - Overview](user_guide/ch1.md)
* [Chapter 2 - Architecture Components](user_guide/ch2.md)
* [Chapter 3 - Installation](user_guide/ch3.md)
* [Chapter 4 - Using with Python API](user_guide/ch4.md)
* [Chapter 5 - Framework Integration](user_guide/ch5.md)
* [Chapter 6 - Using with C++ API](user_guide/ch6.md)

## Key Components of rocAL

Expand Down Expand Up @@ -88,7 +86,7 @@ amd.rocal.types are enums exported from C++ API to python. Some examples include

* Build and install RPP
* Build and install MIVisionX which installs rocAL c++ lib
* Go to [rocal_pybind](https://github.com/ROCmSoftwarePlatform/rocAL/rocAL_pybind) folder
* Go to the [rocal_pybind](https://github.com/ROCm/rocAL/tree/develop/rocAL_pybind) folder
* sudo ./run.sh

### Steps to run MLPerf Resnet50 classification training with rocAL on a system with MI50+ and ROCm
Expand All @@ -97,12 +95,15 @@ amd.rocal.types are enums exported from C++ API to python. Some examples include
* Step 2: Build [MIVisionX Pytorch docker](../docker/README.md)
* Step 3: Install rocAL python_pybind plugin as described above
* Step 4: Clone [MLPerf](https://github.com/rrawther/MLPerf-mGPU) branch and checkout mlperf-v1.1-rocal branch
```

``` bash
git clone -b mlperf-v1.1-rocal https://github.com/rrawther/MLPerf-mGPU
```

* Step 5: Modify RN50_AMP_LARS_8GPUS_NCHW.sh or RN50_AMP_LARS_8GPUS_NHWC.sh to reflect correct path for imagenet directory
* Step 8: Run RN50_AMP_LARS_8GPUS_NCHC.sh or RN50_AMP_LARS_8GPUS_NHWC.sh
```

``` bash
./RN50_AMP_LARS_8GPUS_NCHW.sh
(or)
./RN50_AMP_LARS_8GPUS_NHWC.sh
Expand All @@ -112,9 +113,11 @@ git clone -b mlperf-v1.1-rocal https://github.com/rrawther/MLPerf-mGPU

* Refer to the [docker](https://github.com/GPUOpen-ProfessionalCompute-Libraries/MIVisionX#docker) page for prerequisites and information on building the docker
* Step 1: Run the docker image*
````

``` bash
sudo docker run -it -v <Path-To-Data-HostSystem>:/data -v /<Path-to-GitRepo>:/dockerx -w /dockerx --privileged --device=/dev/kfd --device=/dev/dri --group-add video --shm-size=4g --ipc="host" --network=host <docker-name>
````
```

* Optional: Map localhost directory on the docker image
* option to map the localhost directory with imagenet dataset folder to be accessed on the docker image.
* usage: -v {LOCAL_HOST_DIRECTORY_PATH}:{DOCKER_DIRECTORY_PATH}
Loading