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.

Sign up for GitHub

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

Jump to bottom

Update documentation link #175

Merged
merged 2 commits into from
Jul 10, 2024
Merged

Update documentation link #175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70098c4
Update documentation link
samjwu Jul 3, 2024
9b834bf
Merge branch 'develop' into doc-link
kiritigowda Jul 10, 2024
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
8 changes: 4 additions & 4 deletions docs/user_guide/ch3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This chapter provides information about the installation of rocAL and related packages.

## 3.1 Prerequisites
## 3.1 Prerequisites

* Linux distribution
* [AMD RPP](https://github.com/ROCm/rpp)
Expand All @@ -16,15 +16,15 @@ This chapter provides information about the installation of rocAL and related pa

## 3.2 Platform Support

To see the list of supported platforms for rocAL, see the ROCm Installation Guide at https://docs.amd.com.
To see the list of supported platforms for rocAL, see the [ROCm Installation Guide](https://rocm.docs.amd.com).

## 3.3 Installing rocAL
## 3.3 Installing rocAL

To build and install the rocAL library, follow the instructions given [here](https://github.com/ROCm/rocAL#build-instructions)

## 3.4 Installing rocAL Python Package

The rocAL Python package (rocal_pybind) is a separate redistributable wheel. rocal_pybind, which is created using Pybind11, enables data transfer between rocAL C++ API and Python API. With the help of rocal_pybind.so wrapper library, the rocAL functionality, which is primarily in C/C++, can be effectively used in Python.
The rocAL Python package (rocal_pybind) is a separate redistributable wheel. rocal_pybind, which is created using Pybind11, enables data transfer between rocAL C++ API and Python API. With the help of rocal_pybind.so wrapper library, the rocAL functionality, which is primarily in C/C++, can be effectively used in Python.
The Python package supports PyTorch, TensorFlow, Caffe2, and data readers available for various formats such as FileReader, COCO Reader, TFRecord Reader, and CaffeReader.

To build and install the Python package, install the PyPackageInstall instruction [here](https://github.com/ROCm/rocAL#build-instructions)
Expand Down
Loading