From b767a2f935e066c301af73b78cf9dfb672a6e7cb Mon Sep 17 00:00:00 2001 From: srawat <120587655+SwRaw@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:10:20 +0530 Subject: [PATCH] Cherry picking documentation changes from develop to 6.2 (#237) * doc folder organization * removing what-is-hiptensor * Update Read the Docs configuration (#226) * Bump rocm-docs-core from 1.1.3 to 1.2.0 in /docs/sphinx (#228) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.1.3 to 1.2.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.1.3...v1.2.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 1.2.0 to 1.3.0 in /docs/sphinx Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 1.2.0 to 1.3.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v1.2.0...v1.3.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * Fix linting workflow and codeowner syntax (#227) * Fix syntax for codeowners * Fix linting workflow * Bump rocm-docs-core from 1.3.0 to 1.4.0 in /docs/sphinx (#233) Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.3.0 to 1.4.0. - [Release notes](https://github.com/ROCm/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.3.0...v1.4.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/CODEOWNERS | 5 +- .github/workflows/linting.yml | 12 +- docs/{ => api-reference}/api-reference.rst | 0 docs/{ => conceptual}/programmers-guide.rst | 0 .../{ => contribution}/contributors-guide.rst | 6 +- docs/environment.yml | 2 +- docs/index.rst | 12 +- docs/{ => install}/installation.rst | 0 docs/sphinx/_toc.yml.in | 12 +- docs/sphinx/requirements.in | 2 +- docs/sphinx/requirements.txt | 114 +++++++++--------- 11 files changed, 86 insertions(+), 79 deletions(-) rename docs/{ => api-reference}/api-reference.rst (100%) rename docs/{ => conceptual}/programmers-guide.rst (100%) rename docs/{ => contribution}/contributors-guide.rst (98%) rename docs/{ => install}/installation.rst (100%) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index cbb0f685..6f719874 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,7 +1,8 @@ * @cgmillette @bragadeesh @mkarunan @dlangbe @congma13 @afanfa # Documentation files -docs/* @ROCm/rocm-documentation +docs/ @ROCm/rocm-documentation *.md @ROCm/rocm-documentation *.rst @ROCm/rocm-documentation +.readthedocs.yaml @ROCm/rocm-documentation # Header directory -library/include/* @ROCm/rocm-documentation @cgmillette @bragadeesh @mkarunan @dlangbe @congma13 @afanfa +library/include/ @ROCm/rocm-documentation @cgmillette @bragadeesh @mkarunan @dlangbe @congma13 @afanfa diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index 49bb5645..99e90263 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -2,11 +2,17 @@ name: Linting on: push: - branches: [develop] + branches: + - develop + - master + - 'docs/*' pull_request: - branches: [develop] + branches: + - develop + - master + - 'docs/*' jobs: call-workflow-passing-data: name: Documentation - uses: RadeonOpenCompute/rocm-docs-core/.github/workflows/linting.yml@develop + uses: ROCm/rocm-docs-core/.github/workflows/linting.yml@develop diff --git a/docs/api-reference.rst b/docs/api-reference/api-reference.rst similarity index 100% rename from docs/api-reference.rst rename to docs/api-reference/api-reference.rst diff --git a/docs/programmers-guide.rst b/docs/conceptual/programmers-guide.rst similarity index 100% rename from docs/programmers-guide.rst rename to docs/conceptual/programmers-guide.rst diff --git a/docs/contributors-guide.rst b/docs/contribution/contributors-guide.rst similarity index 98% rename from docs/contributors-guide.rst rename to docs/contribution/contributors-guide.rst index efe6853e..4558f37a 100644 --- a/docs/contributors-guide.rst +++ b/docs/contribution/contributors-guide.rst @@ -4,9 +4,9 @@ .. _contributors-guide: -=================== -Contributor's guide -=================== +============================ +Contributing to hipTensor +============================ This document provides the coding guidelines to be followed while contributing to the hipTensor APIs. diff --git a/docs/environment.yml b/docs/environment.yml index fa46ba40..599d9013 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -3,7 +3,7 @@ channels: - conda-forge - defaults dependencies: - - python=3.8 + - python=3.10 - pip - doxygen=1.9.8 - pip: diff --git a/docs/index.rst b/docs/index.rst index 7f4ff1ac..34ce7356 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,14 +8,20 @@ hipTensor documentation =========================== -Welcome to the hipTensor docs home page! To learn more, see :ref:`what-is-hiptensor`. +hipTensor is a work-in-progress (WIP) high-performance HIP library for tensor primitives. It is AMD's C++ library for accelerating tensor primitives which can leverage specialized GPU matrix cores on AMD's latest discrete GPUs. hipTensor is currently powered by the composable kernel library. The API is designed to be portable with the Nvidia cuTensor library, allowing those users to easily migrate to the AMD platform. -Our documentation is structured as follows: +The hipTensor API offers functionality for defining tensor data objects and currently supports contraction and permutation operations on the tensor objects. Users may also control several available logging options. Under the hood, the hipTensor library is bundled with multitude of GPU kernels which are automatically selected and invoked to solve problems as defined by input parameters to the API. As hipTensor is currently a WIP, future tensor operation support may include reductions, element-wise operations and caching of selection instances. + +Supporting host code is required for GPU device and memory management. The hipTensor code samples and tests provided are built and launched via the Heterogeneous-Compute Interface for Portability (HIP) ecosystem within ROCm. + +You can access hipTensor code on our `GitHub repository `_. + +The documentation is structured as follows: .. grid:: 2 :gutter: 3 - .. grid-item-card:: Tutorial + .. grid-item-card:: Install * :ref:`installation` diff --git a/docs/installation.rst b/docs/install/installation.rst similarity index 100% rename from docs/installation.rst rename to docs/install/installation.rst diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 0fab3d18..e49b10a0 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -2,20 +2,18 @@ # These comments will also be removed. root: index subtrees: - - entries: - - file: what-is-hiptensor - - caption: Tutorial + - caption: Install entries: - - file: installation + - file: install/installation - caption: Conceptual entries: - - file: programmers-guide + - file: conceptual/programmers-guide - caption: API reference entries: - - file: api-reference + - file: api-reference/api-reference - caption: Contribution entries: - - file: contributors-guide + - file: contribution/contributors-guide - caption: About entries: - file: license diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in index 0a3deabf..189f0449 100644 --- a/docs/sphinx/requirements.in +++ b/docs/sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core==0.38.1 +rocm-docs-core==1.4.0 diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt index 89f03524..46352f70 100644 --- a/docs/sphinx/requirements.txt +++ b/docs/sphinx/requirements.txt @@ -1,112 +1,106 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.10 # by the following command: # # pip-compile requirements.in # -accessible-pygments==0.0.3 +accessible-pygments==0.0.5 # via pydata-sphinx-theme -alabaster==0.7.13 +alabaster==0.7.16 # via sphinx -babel==2.12.1 +babel==2.15.0 # via # pydata-sphinx-theme # sphinx -beautifulsoup4==4.11.2 +beautifulsoup4==4.12.3 # via pydata-sphinx-theme -breathe==4.34.0 +breathe==4.35.0 # via rocm-docs-core -certifi==2023.7.22 +certifi==2024.2.2 # via requests -cffi==1.15.1 +cffi==1.16.0 # via # cryptography # pynacl -charset-normalizer==3.1.0 +charset-normalizer==3.3.2 # via requests -click==8.1.3 +click==8.1.7 # via sphinx-external-toc -cryptography==42.0.4 +cryptography==42.0.7 # via pyjwt -deprecated==1.2.13 +deprecated==1.2.14 # via pygithub -docutils==0.19 +docutils==0.21.2 # via # breathe # myst-parser # pydata-sphinx-theme # sphinx -fastjsonschema==2.16.3 +fastjsonschema==2.19.1 # via rocm-docs-core -gitdb==4.0.10 +gitdb==4.0.11 # via gitpython -gitpython==3.1.41 +gitpython==3.1.43 # via rocm-docs-core -idna==3.4 +idna==3.7 # via requests imagesize==1.4.1 # via sphinx -importlib-metadata==6.8.0 - # via sphinx -importlib-resources==6.1.0 - # via rocm-docs-core -jinja2==3.1.3 +jinja2==3.1.4 # via # myst-parser # sphinx -markdown-it-py==2.2.0 +markdown-it-py==3.0.0 # via # mdit-py-plugins # myst-parser -markupsafe==2.1.2 +markupsafe==2.1.5 # via jinja2 -mdit-py-plugins==0.3.5 +mdit-py-plugins==0.4.1 # via myst-parser mdurl==0.1.2 # via markdown-it-py -myst-parser==1.0.0 +myst-parser==3.0.1 # via rocm-docs-core -packaging==23.0 +packaging==24.0 # via # pydata-sphinx-theme # sphinx -pycparser==2.21 +pycparser==2.22 # via cffi -pydata-sphinx-theme==0.13.3 +pydata-sphinx-theme==0.15.2 # via # rocm-docs-core # sphinx-book-theme -pygithub==1.58.1 +pygithub==2.3.0 # via rocm-docs-core -pygments==2.15.0 +pygments==2.18.0 # via # accessible-pygments # pydata-sphinx-theme # sphinx -pyjwt[crypto]==2.6.0 +pyjwt[crypto]==2.8.0 # via pygithub pynacl==1.5.0 # via pygithub -pytz==2023.3.post1 - # via babel -pyyaml==6.0 +pyyaml==6.0.1 # via # myst-parser # rocm-docs-core # sphinx-external-toc -requests==2.31.0 +requests==2.32.2 # via # pygithub # sphinx -rocm-docs-core==0.38.1 +rocm-docs-core==1.4.0 # via -r requirements.in -smmap==5.0.0 +smmap==5.0.1 # via gitdb snowballstemmer==2.2.0 # via sphinx -soupsieve==2.4 +soupsieve==2.5 # via beautifulsoup4 -sphinx==5.3.0 +sphinx==7.3.7 # via # breathe # myst-parser @@ -117,35 +111,37 @@ sphinx==5.3.0 # sphinx-design # sphinx-external-toc # sphinx-notfound-page -sphinx-book-theme==1.0.1 +sphinx-book-theme==1.1.2 # via rocm-docs-core -sphinx-copybutton==0.5.1 +sphinx-copybutton==0.5.2 # via rocm-docs-core -sphinx-design==0.4.1 +sphinx-design==0.6.0 # via rocm-docs-core -sphinx-external-toc==0.3.1 +sphinx-external-toc==1.0.1 # via rocm-docs-core -sphinx-notfound-page==0.8.3 +sphinx-notfound-page==1.0.2 # via rocm-docs-core -sphinxcontrib-applehelp==1.0.4 +sphinxcontrib-applehelp==1.0.8 # via sphinx -sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-devhelp==1.0.6 # via sphinx -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.0.5 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-qthelp==1.0.7 # via sphinx -sphinxcontrib-serializinghtml==1.1.5 +sphinxcontrib-serializinghtml==1.1.10 # via sphinx -typing-extensions==4.5.0 - # via pydata-sphinx-theme -urllib3==1.26.18 - # via requests -wrapt==1.15.0 - # via deprecated -zipp==3.17.0 +tomli==2.0.1 + # via sphinx +typing-extensions==4.11.0 # via - # importlib-metadata - # importlib-resources + # pydata-sphinx-theme + # pygithub +urllib3==2.2.1 + # via + # pygithub + # requests +wrapt==1.16.0 + # via deprecated