From c79c81a70754adcd9bb3541b6f85852aa087d9d3 Mon Sep 17 00:00:00 2001 From: mentat <108366729+bghimireamd@users.noreply.github.com> Date: Tue, 30 Jan 2024 00:30:29 -0600 Subject: [PATCH] [DOC] fix broken links in docs (#2696) * lwpmiopen_521_correct_doc_issues: fix broken links in docs * lwpmiopen_521_correct_doc_issues: remove citing --- README.md | 24 +++--------------------- docs/driver.md | 2 +- docs/install.md | 4 ++-- docs/sphinx/_toc.yml.in | 1 - 4 files changed, 6 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 931b07c851..ef4fc8c57e 100755 --- a/README.md +++ b/README.md @@ -43,8 +43,8 @@ python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html * [MIOpenTENSILE](https://github.com/ROCmSoftwarePlatform/MIOpenTensile) - users can enable this library using the cmake configuration flag`-DMIOPEN_USE_MIOPENTENSILE=On`. (deprecated after ROCm 5.1.1) * [rocBLAS](https://github.com/ROCm/rocBLAS) - AMD library for Basic Linear Algebra Subprograms (BLAS) on the ROCm platform. * Minimum version branch for pre-ROCm 3.5 [master-rocm-2.10](https://github.com/ROCm/rocBLAS/tree/master-rocm-2.10) - * Minimum version branch for post-ROCm 3.5 [master-rocm-3.5](https://github.com/ROCm/rocBLAS/releases/tag/rocm-3.5.0) -* [MLIR](https://github.com/ROCm/llvm-project-mlir) - (Multi-Level Intermediate Representation) with its MIOpen dialect to support and complement kernel development. + * Minimum version branch for post-ROCm 3.5 [master-rocm-3.5](https://github.com/ROCm/rocBLAS/tree/master-rocm-3.5) +* [MLIR](https://github.com/ROCm/rocMLIR) - (Multi-Level Intermediate Representation) with its MIOpen dialect to support and complement kernel development. * [Composable Kernel](https://github.com/ROCm/composable_kernel) - C++ templated device library for GEMM-like and reduction-like operators. ## Installing MIOpen with pre-built packages @@ -215,7 +215,7 @@ The driver can be built using the `MIOpenDriver` target: ` cmake --build . --config Release --target MIOpenDriver ` **OR** ` make MIOpenDriver ` -Documentation on how to run the driver is [here](https://rocm.docs.amd.com/projects/MIOpen/en/latest/driver.html). +Documentation on how to run the driver is [here](https://github.com/ROCm/MIOpen/blob/develop/driver/README.md). ## Running the tests @@ -314,24 +314,6 @@ docker run -it -v $HOME:/data --privileged --rm --device=/dev/kfd --device /dev/ Prebuilt docker images can be found on [ROCm's public docker hub here](https://hub.docker.com/r/rocm/miopen/tags). -## Citing MIOpen - -MIOpen's paper is freely available and can be accessed on arXiv: -[MIOpen: An Open Source Library For Deep Learning Primitives](https://arxiv.org/abs/1910.00078) - -### Citation BibTeX - -```bibtex -@misc{jeh2019miopen, - title={MIOpen: An Open Source Library For Deep Learning Primitives}, - author={Jehandad Khan and Paul Fultz and Artem Tamazov and Daniel Lowell and Chao Liu and Michael Melesse and Murali Nandhimandalam and Kamil Nasyrov and Ilya Perminov and Tejash Shah and Vasilii Filippov and Jing Zhang and Jing Zhou and Bragadeesh Natarajan and Mayank Daga}, - year={2019}, - eprint={1910.00078}, - archivePrefix={arXiv}, - primaryClass={cs.LG} -} -``` - ## Porting from cuDNN to MIOpen The [porting diff --git a/docs/driver.md b/docs/driver.md index d17b578813..6785bc8970 100644 --- a/docs/driver.md +++ b/docs/driver.md @@ -6,4 +6,4 @@ The driver can be built using the `MIOpenDriver` target: ` cmake --build . --config Release --target MIOpenDriver ` **OR** ` make MIOpenDriver ` -Documentation on how to run the driver is [here](https://rocm.docs.amd.com/projects/MIOpen/en/latest/driver.html). +Documentation on how to run the driver is [here](https://github.com/ROCm/MIOpen/blob/develop/driver/README.md). diff --git a/docs/install.md b/docs/install.md index fe97ef0e40..740398469c 100644 --- a/docs/install.md +++ b/docs/install.md @@ -14,8 +14,8 @@ * [SQLite3](https://sqlite.org/index.html) - reading and writing performance database, enabling persistent [kernel cache](https://rocm.docs.amd.com/projects/MIOpen/en/latest/cache.html) * [rocBLAS](https://github.com/ROCm/rocBLAS) - AMD library for Basic Linear Algebra Subprograms (BLAS) on the ROCm platform. * Minimum version branch for pre-ROCm 3.5 [master-rocm-2.10](https://github.com/ROCm/rocBLAS/tree/master-rocm-2.10) - * Minimum version branch for post-ROCm 3.5 [master-rocm-3.5](https://github.com/ROCm/rocBLAS/releases/tag/rocm-3.5.0) -* [MLIR](https://github.com/ROCm/llvm-project-mlir) - (Multi-Level Intermediate Representation) with its MIOpen dialect to support and complement kernel development. + * Minimum version branch for post-ROCm 3.5 [master-rocm-3.5](https://github.com/ROCm/rocBLAS/tree/master-rocm-3.5) +* [MLIR](https://github.com/ROCm/rocMLIR) - (Multi-Level Intermediate Representation) with its MIOpen dialect to support and complement kernel development. * [Composable Kernel](https://github.com/ROCm/composable_kernel) - C++ templated device library for GEMM-like and reduction-like operators. ## Installing MIOpen with pre-built packages diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index a4becb31dc..0b1a03908e 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -5,7 +5,6 @@ root: index subtrees: - entries: - file: releasenotes - - file: citation - file: install - file: embed - file: driver