diff --git a/.Doxyfile b/.Doxyfile index 3b6c75135..f5cf9bddd 100644 --- a/.Doxyfile +++ b/.Doxyfile @@ -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 \ @@ -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 diff --git a/CMakeLists.txt b/CMakeLists.txt index 2405847b2..c80f6fa34 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -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) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index d8f9f5570..c51779d3e 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -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 \ @@ -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 diff --git a/docs/README.md b/docs/index.md similarity index 97% rename from docs/README.md rename to docs/index.md index 4a00c6c93..c085ab435 100644 --- a/docs/README.md +++ b/docs/index.md @@ -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 ``` diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index cbfa51912..de68e8b0b 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -6,7 +6,7 @@ root: doxygen/html/index subtrees: - caption: User Guide entries: - - file: README + - file: index subtrees: - entries: - file: user_guide/ch1