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

Fix broken links #98

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions .Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -943,7 +943,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = README.md \
INPUT = index.md \
rocAL/include/api/rocal_api_augmentation.h \
rocAL/include/api/rocal_api_data_loaders.h \
rocAL/include/api/rocal_api_data_transfer.h \
Expand All @@ -952,7 +952,7 @@ INPUT = README.md \
rocAL/include/api/rocal_api_parameters.h \
rocAL/include/api/rocal_api_types.h \
rocAL/include/api/rocal_api.h


# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ add_subdirectory(rocAL)
add_subdirectory(rocAL_pybind)

# install rocAL docs -- {ROCM_PATH}/${CMAKE_INSTALL_DATADIR}/doc/rocal/
install(FILES docs/README.md DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/rocal)
install(FILES docs/index.md DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/rocal)

enable_testing()
include(CTest)
Expand Down
4 changes: 2 additions & 2 deletions docs/doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -943,7 +943,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ../../README.md \
INPUT = ../../index.md \
../../rocAL/include/api/rocal_api_augmentation.h \
../../rocAL/include/api/rocal_api_data_loaders.h \
../../rocAL/include/api/rocal_api_data_transfer.h \
Expand All @@ -961,7 +961,7 @@ INPUT = ../../README.md \
../../rocAL_pybind/amd/rocal/plugin/generic.py \
../../rocAL_pybind/amd/rocal/plugin/pytorch.py \
../../rocAL_pybind/amd/rocal/plugin/tf.py


# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md → docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,13 @@ 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 [rocal_pybind](https://github.com/ROCm/rocAL/tree/master/rocAL_pybind) folder
* sudo ./run.sh

### Steps to run MLPerf Resnet50 classification training with rocAL on a system with MI50+ and ROCm

* Step 1: Ensure you have downloaded ILSVRC2012_img_val.tar (6.3GB) and ILSVRC2012_img_train.tar (138 GB) files and unzip into train and val folders
* Step 2: Build [MIVisionX Pytorch docker](../docker/README.md)
* Step 2: Build [MIVisionX Pytorch docker](https://github.com/ROCm/rocAL/blob/master/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
```
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/_toc.yml.in
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ root: doxygen/html/index
subtrees:
- caption: User Guide
entries:
- file: README
- file: index
subtrees:
- entries:
- file: user_guide/ch1
Expand Down
Loading