From 213ed4ab48d951d0734c265ea2f225ef32acc279 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Fri, 10 Mar 2023 15:55:41 -0700 Subject: [PATCH 01/10] Standardize hipBLAS documentation builds to use the rocm-docs-core template (#566) * Changing Documentation Template * Changing Documentation Template * hipBLAS documentation refactored for pitchfork * Remove old rocm logo * Reorganize sections to match swab-documentation for reference libraries https://github.com/RadeonOpenCompute/swab-documentation/blob/main/docs/sphinx/templates/references/reference_library.md * Moving files around * Renaming conf.py to sphix_conf.py * Recompile requirements.txt * Fix typo * Renaming back * Update requirements * Point requirements to rocm-docs-core * updating yml * final move for conf.py * Update toc file entries * Renaming folders * Updating rtd yaml with new folder structure * Rename sphinx and doxygen folders prepend . to indicate config folders * Remove extra header * Build html only pdf etc not used * Add section on how to build documentation locally --------- Co-authored-by: Sergey Kostrov Co-authored-by: Saad Rahim --- .gitignore | 2 - README.md | 4 -- docs/.sphinx/requirements.txt | 91 +++++++++++++++++------------------ docs/deprecation.rst | 52 -------------------- docs/disclaimer.rst | 17 +++++++ 5 files changed, 61 insertions(+), 105 deletions(-) create mode 100644 docs/disclaimer.rst diff --git a/.gitignore b/.gitignore index 1e010d3a4..4c990c627 100644 --- a/.gitignore +++ b/.gitignore @@ -40,10 +40,8 @@ build* *~ # documentation artifacts -build/ _build/ _images/ _static/ _templates/ _toc.yml -docBin/ diff --git a/README.md b/README.md index 019399d94..ae517aa77 100644 --- a/README.md +++ b/README.md @@ -10,15 +10,11 @@ hipBLAS requires either **rocBLAS** + **rocSOLVER** or **cuBLAS** APIs for BLAS ### How to build documentation -Run the steps below to build documentation locally. - -``` cd docs pip3 install -r .sphinx/requirements.txt python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html -``` ## Quickstart build diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index b2ef0f492..9abd19aca 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -2,41 +2,39 @@ # This file is autogenerated by pip-compile with Python 3.8 # by the following command: # -# pip-compile requirements.in +# pip-compile docs/sphinx/requirements.in # accessible-pygments==0.0.3 # via pydata-sphinx-theme -alabaster==0.7.13 +alabaster==0.7.12 # via sphinx -asttokens==2.2.1 +asttokens==2.2.0 # via stack-data -attrs==22.2.0 +attrs==22.1.0 # via # jsonschema # jupyter-cache -babel==2.12.1 +babel==2.10.3 # via # pydata-sphinx-theme # sphinx backcall==0.2.0 # via ipython -beautifulsoup4==4.11.2 +beautifulsoup4==4.11.1 # via pydata-sphinx-theme breathe==4.34.0 # via rocm-docs-core -certifi==2022.12.7 +certifi==2022.6.15 # via requests cffi==1.15.1 # via pynacl -charset-normalizer==3.1.0 +charset-normalizer==2.1.0 # via requests click==8.1.3 # via # jupyter-cache # sphinx-external-toc -comm==0.1.2 - # via ipykernel -debugpy==1.6.6 +debugpy==1.6.4 # via ipykernel decorator==5.1.1 # via ipython @@ -49,32 +47,33 @@ docutils==0.16 # pydata-sphinx-theme # rocm-docs-core # sphinx +entrypoints==0.4 + # via jupyter-client executing==1.2.0 # via stack-data -fastjsonschema==2.16.3 +fastjsonschema==2.16.2 # via nbformat gitdb==4.0.10 # via gitpython gitpython==3.1.31 # via rocm-docs-core -greenlet==2.0.2 +greenlet==2.0.1 # via sqlalchemy -idna==3.4 +idna==3.3 # via requests imagesize==1.4.1 # via sphinx -importlib-metadata==6.0.0 +importlib-metadata==5.1.0 # via # jupyter-cache - # jupyter-client # myst-nb importlib-resources==5.10.4 # via # jsonschema # rocm-docs-core -ipykernel==6.21.3 +ipykernel==6.17.1 # via myst-nb -ipython==8.11.0 +ipython==8.7.0 # via # ipykernel # myst-nb @@ -88,28 +87,27 @@ jsonschema==4.17.3 # via nbformat jupyter-cache==0.5.0 # via myst-nb -jupyter-client==8.0.3 +jupyter-client==7.4.7 # via # ipykernel # nbclient -jupyter-core==5.3.0 +jupyter-core==5.1.0 # via - # ipykernel # jupyter-client # nbformat linkify-it-py==1.0.3 # via myst-parser -markdown-it-py==2.2.0 +markdown-it-py==2.1.0 # via # mdit-py-plugins # myst-parser -markupsafe==2.1.2 +markupsafe==2.1.1 # via jinja2 matplotlib-inline==0.1.6 # via # ipykernel # ipython -mdit-py-plugins==0.3.5 +mdit-py-plugins==0.3.1 # via myst-parser mdurl==0.1.2 # via markdown-it-py @@ -123,7 +121,7 @@ nbclient==0.5.13 # via # jupyter-cache # myst-nb -nbformat==5.7.3 +nbformat==5.7.0 # via # jupyter-cache # myst-nb @@ -131,8 +129,9 @@ nbformat==5.7.3 nest-asyncio==1.5.6 # via # ipykernel + # jupyter-client # nbclient -packaging==23.0 +packaging==21.3 # via # ipykernel # pydata-sphinx-theme @@ -145,9 +144,9 @@ pickleshare==0.7.5 # via ipython pkgutil-resolve-name==1.3.10 # via jsonschema -platformdirs==3.1.1 +platformdirs==2.5.4 # via jupyter-core -prompt-toolkit==3.0.38 +prompt-toolkit==3.0.33 # via ipython psutil==5.9.4 # via ipykernel @@ -161,7 +160,7 @@ pydata-sphinx-theme==0.13.1 # via sphinx-book-theme pygithub==1.57 # via rocm-docs-core -pygments==2.14.0 +pygments==2.12.0 # via # accessible-pygments # ipython @@ -171,11 +170,13 @@ pyjwt==2.6.0 # via pygithub pynacl==1.5.0 # via pygithub -pyrsistent==0.19.3 +pyparsing==3.0.9 + # via packaging +pyrsistent==0.19.2 # via jsonschema python-dateutil==2.8.2 # via jupyter-client -pytz==2022.7.1 +pytz==2022.1 # via babel pyyaml==6.0 # via @@ -183,16 +184,16 @@ pyyaml==6.0 # myst-nb # myst-parser # sphinx-external-toc -pyzmq==25.0.1 +pyzmq==24.0.1 # via # ipykernel # jupyter-client -requests==2.28.2 +requests==2.28.1 # via # pygithub # sphinx rocm-docs-core @ git+https://github.com/RadeonOpenCompute/rocm-docs-core.git - # via -r requirements.in + # via -r docs/sphinx/requirements.in six==1.16.0 # via # asttokens @@ -201,7 +202,7 @@ smmap==5.0.0 # via gitdb snowballstemmer==2.2.0 # via sphinx -soupsieve==2.4 +soupsieve==2.3.2.post1 # via beautifulsoup4 sphinx==4.3.1 # via @@ -214,7 +215,6 @@ sphinx==4.3.1 # sphinx-copybutton # sphinx-design # sphinx-external-toc - # sphinx-notfound-page sphinx-book-theme==1.0.0rc2 # via rocm-docs-core sphinx-copybutton==0.5.1 @@ -223,13 +223,11 @@ sphinx-design==0.3.0 # via rocm-docs-core sphinx-external-toc==0.3.1 # via rocm-docs-core -sphinx-notfound-page==0.8.3 - # via rocm-docs-core -sphinxcontrib-applehelp==1.0.4 +sphinxcontrib-applehelp==1.0.2 # via sphinx sphinxcontrib-devhelp==1.0.2 # via sphinx -sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-htmlhelp==2.0.0 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx @@ -237,7 +235,7 @@ sphinxcontrib-qthelp==1.0.3 # via sphinx sphinxcontrib-serializinghtml==1.1.5 # via sphinx -sqlalchemy==1.4.46 +sqlalchemy==1.4.44 # via jupyter-cache stack-data==0.6.2 # via ipython @@ -247,9 +245,8 @@ tornado==6.2 # via # ipykernel # jupyter-client -traitlets==5.9.0 +traitlets==5.6.0 # via - # comm # ipykernel # ipython # jupyter-client @@ -257,19 +254,19 @@ traitlets==5.9.0 # matplotlib-inline # nbclient # nbformat -typing-extensions==4.5.0 +typing-extensions==4.4.0 # via # myst-nb # myst-parser uc-micro-py==1.0.1 # via linkify-it-py -urllib3==1.26.15 +urllib3==1.26.11 # via requests -wcwidth==0.2.6 +wcwidth==0.2.5 # via prompt-toolkit wrapt==1.15.0 # via deprecated -zipp==3.15.0 +zipp==3.11.0 # via # importlib-metadata # importlib-resources diff --git a/docs/deprecation.rst b/docs/deprecation.rst index 078d6d4f8..1548bbb2a 100644 --- a/docs/deprecation.rst +++ b/docs/deprecation.rst @@ -26,55 +26,3 @@ The packed_int8x4 datatype will be removed in hipBLAS 1.0. There are two int8 da int8_t is the C99 unsigned 8 bit integer. packed_int8x4 has 4 consecutive int8_t numbers in the k dimension packed into 32 bits. packed_int8x4 is only used in hipblasGemmEx. int8_t will continue to be available in hipblasGemmEx. - -Announced in hipBLAS 1.0 -^^^^^^^^^^^^^^^^^^^^^^^^ - -Replace Legacy BLAS in-place trmm functions with trmm functions that support both in-place and out-of-place functionality -========================================================================================================================= -Use of the deprecated Legacy BLAS in-place trmm functions will give deprecation warnings telling -you to compile with -DHIPBLAS_V1 and use the new in-place and out-of-place trmm functions. - -Note that there are no deprecation warnings for the hipBLAS Fortran API. - -The Legacy BLAS in-place trmm calculates B <- alpha * op(A) * B. Matrix B is replaced in-place by -triangular matrix A multiplied by matrix B. The prototype in the include file rocblas-functions.h is: - -:: - - hipblasStatus_t hipblasStrmm(hipblasHandle_t handle, - hipblasSideMode_t side, - hipblasFillMode_t uplo, - hipblasOperation_t transA, - hipblasDiagType_t diag, - int m, - int n, - const float* alpha, - const float* AP, - int lda, - float* BP, - int ldb); - -hipBLAS 1.0 deprecates the legacy BLAS trmm functionality and replaces it with C <- alpha * op(A) * B. The prototype is: - -:: - - hipblasStatus_t hipblasStrmmOutofplace(hipblasHandle_t handle, - hipblasSideMode_t side, - hipblasFillMode_t uplo, - hipblasOperation_t transA, - hipblasDiagType_t diag, - int m, - int n, - const float* alpha, - const float* AP, - int lda, - const float* BP, - int ldb, - float* CP, - int ldc); - -The new API provides the legacy BLAS in-place functionality if you set pointer C equal to pointer B and -ldc equal to ldb. - -There are similar deprecations for the _batched and _strided_batched versions of trmm. diff --git a/docs/disclaimer.rst b/docs/disclaimer.rst new file mode 100644 index 000000000..5bfe0ece4 --- /dev/null +++ b/docs/disclaimer.rst @@ -0,0 +1,17 @@ +************ +Disclaimer +************ + +The information contained herein is for informational purposes only and is subject to change without notice. While every precaution has been taken in the preparation of this document, it may contain technical inaccuracies, omissions and typographical errors, and AMD is under no obligation to update or otherwise correct this information. Advanced Micro Devices, Inc. makes no representations or warranties with respect to the accuracy or completeness of the contents of this document, and assumes no liability of any kind, including the implied warranties of noninfringement, merchantability or fitness for particular purposes, with respect to the operation or use of AMD hardware, software or other products described herein. No license, including implied or arising by estoppel, to any intellectual property rights is granted by this document. Terms and limitations applicable to the purchase or use of AMD's products are as set forth in a signed agreement between the parties or in AMD's Standard Terms and Conditions of Sale. + +- AMD, the AMD Arrow logo, Radeon, Ryzen, Epyc, and combinations thereof are trademarks of Advanced Micro Devices, Inc. + +- Google(R) is a registered trademark of Google LLC. + +- PCIe(R) is a registered trademark of PCI-SIG Corporation. + +- Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. + +- Ubuntu and the Ubuntu logo are registered trademarks of Canonical Ltd. + +- Other product names used in this publication are for identification purposes only and may be trademarks of their respective companies. From b47e0b7287cccc2cd1319f11eea7318193e7029e Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Tue, 21 Mar 2023 09:56:25 -0600 Subject: [PATCH 02/10] Update requirements.txt (#574) * update requirements remove unused .gitignore * fix typo in functions docs page * brain float 16 * remove disclaimer --- .gitignore | 2 + README.md | 4 ++ docs/.sphinx/requirements.txt | 91 ++++++++++++++++++----------------- docs/disclaimer.rst | 17 ------- 4 files changed, 53 insertions(+), 61 deletions(-) delete mode 100644 docs/disclaimer.rst diff --git a/.gitignore b/.gitignore index 4c990c627..1e010d3a4 100644 --- a/.gitignore +++ b/.gitignore @@ -40,8 +40,10 @@ build* *~ # documentation artifacts +build/ _build/ _images/ _static/ _templates/ _toc.yml +docBin/ diff --git a/README.md b/README.md index ae517aa77..019399d94 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,15 @@ hipBLAS requires either **rocBLAS** + **rocSOLVER** or **cuBLAS** APIs for BLAS ### How to build documentation +Run the steps below to build documentation locally. + +``` cd docs pip3 install -r .sphinx/requirements.txt python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html +``` ## Quickstart build diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index 9abd19aca..b2ef0f492 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -2,39 +2,41 @@ # This file is autogenerated by pip-compile with Python 3.8 # by the following command: # -# pip-compile docs/sphinx/requirements.in +# pip-compile requirements.in # accessible-pygments==0.0.3 # via pydata-sphinx-theme -alabaster==0.7.12 +alabaster==0.7.13 # via sphinx -asttokens==2.2.0 +asttokens==2.2.1 # via stack-data -attrs==22.1.0 +attrs==22.2.0 # via # jsonschema # jupyter-cache -babel==2.10.3 +babel==2.12.1 # via # pydata-sphinx-theme # sphinx backcall==0.2.0 # via ipython -beautifulsoup4==4.11.1 +beautifulsoup4==4.11.2 # via pydata-sphinx-theme breathe==4.34.0 # via rocm-docs-core -certifi==2022.6.15 +certifi==2022.12.7 # via requests cffi==1.15.1 # via pynacl -charset-normalizer==2.1.0 +charset-normalizer==3.1.0 # via requests click==8.1.3 # via # jupyter-cache # sphinx-external-toc -debugpy==1.6.4 +comm==0.1.2 + # via ipykernel +debugpy==1.6.6 # via ipykernel decorator==5.1.1 # via ipython @@ -47,33 +49,32 @@ docutils==0.16 # pydata-sphinx-theme # rocm-docs-core # sphinx -entrypoints==0.4 - # via jupyter-client executing==1.2.0 # via stack-data -fastjsonschema==2.16.2 +fastjsonschema==2.16.3 # via nbformat gitdb==4.0.10 # via gitpython gitpython==3.1.31 # via rocm-docs-core -greenlet==2.0.1 +greenlet==2.0.2 # via sqlalchemy -idna==3.3 +idna==3.4 # via requests imagesize==1.4.1 # via sphinx -importlib-metadata==5.1.0 +importlib-metadata==6.0.0 # via # jupyter-cache + # jupyter-client # myst-nb importlib-resources==5.10.4 # via # jsonschema # rocm-docs-core -ipykernel==6.17.1 +ipykernel==6.21.3 # via myst-nb -ipython==8.7.0 +ipython==8.11.0 # via # ipykernel # myst-nb @@ -87,27 +88,28 @@ jsonschema==4.17.3 # via nbformat jupyter-cache==0.5.0 # via myst-nb -jupyter-client==7.4.7 +jupyter-client==8.0.3 # via # ipykernel # nbclient -jupyter-core==5.1.0 +jupyter-core==5.3.0 # via + # ipykernel # jupyter-client # nbformat linkify-it-py==1.0.3 # via myst-parser -markdown-it-py==2.1.0 +markdown-it-py==2.2.0 # via # mdit-py-plugins # myst-parser -markupsafe==2.1.1 +markupsafe==2.1.2 # via jinja2 matplotlib-inline==0.1.6 # via # ipykernel # ipython -mdit-py-plugins==0.3.1 +mdit-py-plugins==0.3.5 # via myst-parser mdurl==0.1.2 # via markdown-it-py @@ -121,7 +123,7 @@ nbclient==0.5.13 # via # jupyter-cache # myst-nb -nbformat==5.7.0 +nbformat==5.7.3 # via # jupyter-cache # myst-nb @@ -129,9 +131,8 @@ nbformat==5.7.0 nest-asyncio==1.5.6 # via # ipykernel - # jupyter-client # nbclient -packaging==21.3 +packaging==23.0 # via # ipykernel # pydata-sphinx-theme @@ -144,9 +145,9 @@ pickleshare==0.7.5 # via ipython pkgutil-resolve-name==1.3.10 # via jsonschema -platformdirs==2.5.4 +platformdirs==3.1.1 # via jupyter-core -prompt-toolkit==3.0.33 +prompt-toolkit==3.0.38 # via ipython psutil==5.9.4 # via ipykernel @@ -160,7 +161,7 @@ pydata-sphinx-theme==0.13.1 # via sphinx-book-theme pygithub==1.57 # via rocm-docs-core -pygments==2.12.0 +pygments==2.14.0 # via # accessible-pygments # ipython @@ -170,13 +171,11 @@ pyjwt==2.6.0 # via pygithub pynacl==1.5.0 # via pygithub -pyparsing==3.0.9 - # via packaging -pyrsistent==0.19.2 +pyrsistent==0.19.3 # via jsonschema python-dateutil==2.8.2 # via jupyter-client -pytz==2022.1 +pytz==2022.7.1 # via babel pyyaml==6.0 # via @@ -184,16 +183,16 @@ pyyaml==6.0 # myst-nb # myst-parser # sphinx-external-toc -pyzmq==24.0.1 +pyzmq==25.0.1 # via # ipykernel # jupyter-client -requests==2.28.1 +requests==2.28.2 # via # pygithub # sphinx rocm-docs-core @ git+https://github.com/RadeonOpenCompute/rocm-docs-core.git - # via -r docs/sphinx/requirements.in + # via -r requirements.in six==1.16.0 # via # asttokens @@ -202,7 +201,7 @@ smmap==5.0.0 # via gitdb snowballstemmer==2.2.0 # via sphinx -soupsieve==2.3.2.post1 +soupsieve==2.4 # via beautifulsoup4 sphinx==4.3.1 # via @@ -215,6 +214,7 @@ sphinx==4.3.1 # sphinx-copybutton # sphinx-design # sphinx-external-toc + # sphinx-notfound-page sphinx-book-theme==1.0.0rc2 # via rocm-docs-core sphinx-copybutton==0.5.1 @@ -223,11 +223,13 @@ sphinx-design==0.3.0 # via rocm-docs-core sphinx-external-toc==0.3.1 # via rocm-docs-core -sphinxcontrib-applehelp==1.0.2 +sphinx-notfound-page==0.8.3 + # via rocm-docs-core +sphinxcontrib-applehelp==1.0.4 # via sphinx sphinxcontrib-devhelp==1.0.2 # via sphinx -sphinxcontrib-htmlhelp==2.0.0 +sphinxcontrib-htmlhelp==2.0.1 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx @@ -235,7 +237,7 @@ sphinxcontrib-qthelp==1.0.3 # via sphinx sphinxcontrib-serializinghtml==1.1.5 # via sphinx -sqlalchemy==1.4.44 +sqlalchemy==1.4.46 # via jupyter-cache stack-data==0.6.2 # via ipython @@ -245,8 +247,9 @@ tornado==6.2 # via # ipykernel # jupyter-client -traitlets==5.6.0 +traitlets==5.9.0 # via + # comm # ipykernel # ipython # jupyter-client @@ -254,19 +257,19 @@ traitlets==5.6.0 # matplotlib-inline # nbclient # nbformat -typing-extensions==4.4.0 +typing-extensions==4.5.0 # via # myst-nb # myst-parser uc-micro-py==1.0.1 # via linkify-it-py -urllib3==1.26.11 +urllib3==1.26.15 # via requests -wcwidth==0.2.5 +wcwidth==0.2.6 # via prompt-toolkit wrapt==1.15.0 # via deprecated -zipp==3.11.0 +zipp==3.15.0 # via # importlib-metadata # importlib-resources diff --git a/docs/disclaimer.rst b/docs/disclaimer.rst deleted file mode 100644 index 5bfe0ece4..000000000 --- a/docs/disclaimer.rst +++ /dev/null @@ -1,17 +0,0 @@ -************ -Disclaimer -************ - -The information contained herein is for informational purposes only and is subject to change without notice. While every precaution has been taken in the preparation of this document, it may contain technical inaccuracies, omissions and typographical errors, and AMD is under no obligation to update or otherwise correct this information. Advanced Micro Devices, Inc. makes no representations or warranties with respect to the accuracy or completeness of the contents of this document, and assumes no liability of any kind, including the implied warranties of noninfringement, merchantability or fitness for particular purposes, with respect to the operation or use of AMD hardware, software or other products described herein. No license, including implied or arising by estoppel, to any intellectual property rights is granted by this document. Terms and limitations applicable to the purchase or use of AMD's products are as set forth in a signed agreement between the parties or in AMD's Standard Terms and Conditions of Sale. - -- AMD, the AMD Arrow logo, Radeon, Ryzen, Epyc, and combinations thereof are trademarks of Advanced Micro Devices, Inc. - -- Google(R) is a registered trademark of Google LLC. - -- PCIe(R) is a registered trademark of PCI-SIG Corporation. - -- Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. - -- Ubuntu and the Ubuntu logo are registered trademarks of Canonical Ltd. - -- Other product names used in this publication are for identification purposes only and may be trademarks of their respective companies. From cded49342dfea995be4ece212eac81ad9ea71a36 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Mon, 10 Apr 2023 09:35:46 -0600 Subject: [PATCH 03/10] Add dependabot config and pin rocm-docs-core (#586) --- .github/dependabot.yml | 12 ++++++++++++ .gitignore | 1 + docs/.sphinx/requirements.in | 2 +- docs/.sphinx/requirements.txt | 21 +++++---------------- 4 files changed, 19 insertions(+), 17 deletions(-) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..ada22f1b5 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "pip" # See documentation for possible values + directory: "/" # Location of package manifests + open-pull-requests-limit: 10 + schedule: + interval: "daily" diff --git a/.gitignore b/.gitignore index 1e010d3a4..c941191ba 100644 --- a/.gitignore +++ b/.gitignore @@ -47,3 +47,4 @@ _static/ _templates/ _toc.yml docBin/ +_doxygen/ diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in index 2dfc7b076..6d6f5bde9 100644 --- a/docs/.sphinx/requirements.in +++ b/docs/.sphinx/requirements.in @@ -1 +1 @@ -git+https://github.com/RadeonOpenCompute/rocm-docs-core.git +rocm-docs-core==0.2.0 diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index b2ef0f492..1a404aacf 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -1,8 +1,8 @@ # -# 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 +# pip-compile .sphinx/requirements.in # accessible-pygments==0.0.3 # via pydata-sphinx-theme @@ -66,12 +66,7 @@ imagesize==1.4.1 importlib-metadata==6.0.0 # via # jupyter-cache - # jupyter-client # myst-nb -importlib-resources==5.10.4 - # via - # jsonschema - # rocm-docs-core ipykernel==6.21.3 # via myst-nb ipython==8.11.0 @@ -143,8 +138,6 @@ pexpect==4.8.0 # via ipython pickleshare==0.7.5 # via ipython -pkgutil-resolve-name==1.3.10 - # via jsonschema platformdirs==3.1.1 # via jupyter-core prompt-toolkit==3.0.38 @@ -175,8 +168,6 @@ pyrsistent==0.19.3 # via jsonschema python-dateutil==2.8.2 # via jupyter-client -pytz==2022.7.1 - # via babel pyyaml==6.0 # via # jupyter-cache @@ -191,8 +182,8 @@ requests==2.28.2 # via # pygithub # sphinx -rocm-docs-core @ git+https://github.com/RadeonOpenCompute/rocm-docs-core.git - # via -r requirements.in +rocm-docs-core==0.2.0 + # via -r .sphinx/requirements.in six==1.16.0 # via # asttokens @@ -270,9 +261,7 @@ wcwidth==0.2.6 wrapt==1.15.0 # via deprecated zipp==3.15.0 - # via - # importlib-metadata - # importlib-resources + # via importlib-metadata # The following packages are considered to be unsafe in a requirements file: # setuptools From 08f9b80491c4daaf49e10c64957cb9e9cb410a26 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Wed, 26 Apr 2023 11:22:35 -0600 Subject: [PATCH 04/10] Update dependabot config (#589) Co-authored-by: samjwu --- .github/dependabot.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index ada22f1b5..9cdf2d670 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,7 +6,7 @@ version: 2 updates: - package-ecosystem: "pip" # See documentation for possible values - directory: "/" # Location of package manifests + directory: "/docs/.sphinx" # Location of package manifests open-pull-requests-limit: 10 schedule: interval: "daily" From 9a533875ce7136f1d2f7162ba9c4d02521dbff16 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Wed, 17 May 2023 16:23:19 -0600 Subject: [PATCH 05/10] Update documentation requirements (#594) --- docs/.sphinx/requirements.in | 2 +- docs/.sphinx/requirements.txt | 147 +++++----------------------------- 2 files changed, 23 insertions(+), 126 deletions(-) diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in index 6d6f5bde9..b8366edf9 100644 --- a/docs/.sphinx/requirements.in +++ b/docs/.sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core==0.2.0 +rocm-docs-core==0.11.0 diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index 1a404aacf..37e97757c 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -1,25 +1,17 @@ # -# This file is autogenerated by pip-compile with Python 3.10 +# This file is autogenerated by pip-compile with Python 3.8 # by the following command: # -# pip-compile .sphinx/requirements.in +# pip-compile requirements.in # accessible-pygments==0.0.3 # via pydata-sphinx-theme alabaster==0.7.13 # via sphinx -asttokens==2.2.1 - # via stack-data -attrs==22.2.0 - # via - # jsonschema - # jupyter-cache babel==2.12.1 # via # pydata-sphinx-theme # sphinx -backcall==0.2.0 - # via ipython beautifulsoup4==4.11.2 # via pydata-sphinx-theme breathe==4.34.0 @@ -31,6 +23,7 @@ cffi==1.15.1 charset-normalizer==3.1.0 # via requests click==8.1.3 +<<<<<<< HEAD # via # jupyter-cache # sphinx-external-toc @@ -40,6 +33,11 @@ debugpy==1.6.6 # via ipykernel decorator==5.1.1 # via ipython +======= + # via sphinx-external-toc +cryptography==40.0.2 + # via pyjwt +>>>>>>> 910d826... Update documentation requirements (#594) deprecated==1.2.13 # via pygithub docutils==0.16 @@ -49,49 +47,24 @@ docutils==0.16 # pydata-sphinx-theme # rocm-docs-core # sphinx -executing==1.2.0 - # via stack-data fastjsonschema==2.16.3 - # via nbformat + # via rocm-docs-core gitdb==4.0.10 # via gitpython gitpython==3.1.31 # via rocm-docs-core -greenlet==2.0.2 - # via sqlalchemy idna==3.4 # via requests imagesize==1.4.1 # via sphinx importlib-metadata==6.0.0 - # via - # jupyter-cache - # myst-nb -ipykernel==6.21.3 - # via myst-nb -ipython==8.11.0 - # via - # ipykernel - # myst-nb -jedi==0.18.2 - # via ipython + # via sphinx +importlib-resources==5.12.0 + # via rocm-docs-core jinja2==3.1.2 # via # myst-parser # sphinx -jsonschema==4.17.3 - # via nbformat -jupyter-cache==0.5.0 - # via myst-nb -jupyter-client==8.0.3 - # via - # ipykernel - # nbclient -jupyter-core==5.3.0 - # via - # ipykernel - # jupyter-client - # nbformat linkify-it-py==1.0.3 # via myst-parser markdown-it-py==2.2.0 @@ -100,54 +73,16 @@ markdown-it-py==2.2.0 # myst-parser markupsafe==2.1.2 # via jinja2 -matplotlib-inline==0.1.6 - # via - # ipykernel - # ipython mdit-py-plugins==0.3.5 # via myst-parser mdurl==0.1.2 # via markdown-it-py -myst-nb==0.17.1 +myst-parser[linkify]==1.0.0 # via rocm-docs-core -myst-parser[linkify]==0.18.1 - # via - # myst-nb - # rocm-docs-core -nbclient==0.5.13 - # via - # jupyter-cache - # myst-nb -nbformat==5.7.3 - # via - # jupyter-cache - # myst-nb - # nbclient -nest-asyncio==1.5.6 - # via - # ipykernel - # nbclient packaging==23.0 # via - # ipykernel # pydata-sphinx-theme # sphinx -parso==0.8.3 - # via jedi -pexpect==4.8.0 - # via ipython -pickleshare==0.7.5 - # via ipython -platformdirs==3.1.1 - # via jupyter-core -prompt-toolkit==3.0.38 - # via ipython -psutil==5.9.4 - # via ipykernel -ptyprocess==0.7.0 - # via pexpect -pure-eval==0.2.2 - # via stack-data pycparser==2.21 # via cffi pydata-sphinx-theme==0.13.1 @@ -157,37 +92,25 @@ pygithub==1.57 pygments==2.14.0 # via # accessible-pygments - # ipython # pydata-sphinx-theme # sphinx pyjwt==2.6.0 # via pygithub pynacl==1.5.0 # via pygithub -pyrsistent==0.19.3 - # via jsonschema -python-dateutil==2.8.2 - # via jupyter-client +pytz==2023.3 + # via babel pyyaml==6.0 # via - # jupyter-cache - # myst-nb # myst-parser + # rocm-docs-core # sphinx-external-toc -pyzmq==25.0.1 - # via - # ipykernel - # jupyter-client requests==2.28.2 # via # pygithub # sphinx -rocm-docs-core==0.2.0 - # via -r .sphinx/requirements.in -six==1.16.0 - # via - # asttokens - # python-dateutil +rocm-docs-core==0.11.0 + # via -r requirements.in smmap==5.0.0 # via gitdb snowballstemmer==2.2.0 @@ -197,7 +120,6 @@ soupsieve==2.4 sphinx==4.3.1 # via # breathe - # myst-nb # myst-parser # pydata-sphinx-theme # rocm-docs-core @@ -228,40 +150,15 @@ sphinxcontrib-qthelp==1.0.3 # via sphinx sphinxcontrib-serializinghtml==1.1.5 # via sphinx -sqlalchemy==1.4.46 - # via jupyter-cache -stack-data==0.6.2 - # via ipython -tabulate==0.9.0 - # via jupyter-cache -tornado==6.2 - # via - # ipykernel - # jupyter-client -traitlets==5.9.0 - # via - # comm - # ipykernel - # ipython - # jupyter-client - # jupyter-core - # matplotlib-inline - # nbclient - # nbformat typing-extensions==4.5.0 - # via - # myst-nb - # myst-parser + # via pydata-sphinx-theme uc-micro-py==1.0.1 # via linkify-it-py urllib3==1.26.15 # via requests -wcwidth==0.2.6 - # via prompt-toolkit wrapt==1.15.0 # via deprecated zipp==3.15.0 - # via importlib-metadata - -# The following packages are considered to be unsafe in a requirements file: -# setuptools + # via + # importlib-metadata + # importlib-resources From 5ce6f9fef3c18138f3b56f93d30edbc727f8bafe Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 May 2023 08:10:32 -0600 Subject: [PATCH 06/10] Bump requests from 2.28.2 to 2.31.0 in /docs/.sphinx (#596) Bumps [requests](https://github.com/psf/requests) from 2.28.2 to 2.31.0. - [Release notes](https://github.com/psf/requests/releases) - [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md) - [Commits](https://github.com/psf/requests/compare/v2.28.2...v2.31.0) --- updated-dependencies: - dependency-name: requests dependency-type: indirect ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- docs/.sphinx/requirements.txt | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index 37e97757c..102f88446 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -57,10 +57,6 @@ idna==3.4 # via requests imagesize==1.4.1 # via sphinx -importlib-metadata==6.0.0 - # via sphinx -importlib-resources==5.12.0 - # via rocm-docs-core jinja2==3.1.2 # via # myst-parser @@ -98,14 +94,12 @@ pyjwt==2.6.0 # via pygithub pynacl==1.5.0 # via pygithub -pytz==2023.3 - # via babel pyyaml==6.0 # via # myst-parser # rocm-docs-core # sphinx-external-toc -requests==2.28.2 +requests==2.31.0 # via # pygithub # sphinx @@ -158,7 +152,3 @@ urllib3==1.26.15 # via requests wrapt==1.15.0 # via deprecated -zipp==3.15.0 - # via - # importlib-metadata - # importlib-resources From fb92b09734f8293432df2cada14e4366b1ff29b7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 May 2023 08:10:57 -0600 Subject: [PATCH 07/10] Bump rocm-docs-core from 0.11.0 to 0.11.1 in /docs/.sphinx (#597) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.11.0 to 0.11.1. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.11.0...v0.11.1) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- docs/.sphinx/requirements.in | 2 +- docs/.sphinx/requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in index b8366edf9..5da3d6d53 100644 --- a/docs/.sphinx/requirements.in +++ b/docs/.sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core==0.11.0 +rocm-docs-core==0.11.1 diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index 102f88446..1dfe0348d 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -103,7 +103,7 @@ requests==2.31.0 # via # pygithub # sphinx -rocm-docs-core==0.11.0 +rocm-docs-core==0.11.1 # via -r requirements.in smmap==5.0.0 # via gitdb From 6318f24d680ecb8ab348d31425ac8df736227a69 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 25 May 2023 08:03:16 -0600 Subject: [PATCH 08/10] Bump rocm-docs-core from 0.11.1 to 0.12.0 in /docs/.sphinx (#599) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.11.1 to 0.12.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/RadeonOpenCompute/rocm-docs-core/compare/v0.11.1...v0.12.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> --- docs/.sphinx/requirements.in | 2 +- docs/.sphinx/requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in index 5da3d6d53..2ca4f80ba 100644 --- a/docs/.sphinx/requirements.in +++ b/docs/.sphinx/requirements.in @@ -1 +1 @@ -rocm-docs-core==0.11.1 +rocm-docs-core==0.12.0 diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index 1dfe0348d..0ca8b4181 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -103,7 +103,7 @@ requests==2.31.0 # via # pygithub # sphinx -rocm-docs-core==0.11.1 +rocm-docs-core==0.12.0 # via -r requirements.in smmap==5.0.0 # via gitdb From ea409cfcc9827c3b3c1d0f33a99322bbfca215de Mon Sep 17 00:00:00 2001 From: daineAMD Date: Mon, 29 May 2023 12:38:48 -0600 Subject: [PATCH 09/10] fix bad merge --- docs/.sphinx/requirements.txt | 12 -------- docs/deprecation.rst | 52 +++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 12 deletions(-) diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index 0ca8b4181..316e92be9 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -23,21 +23,9 @@ cffi==1.15.1 charset-normalizer==3.1.0 # via requests click==8.1.3 -<<<<<<< HEAD - # via - # jupyter-cache - # sphinx-external-toc -comm==0.1.2 - # via ipykernel -debugpy==1.6.6 - # via ipykernel -decorator==5.1.1 - # via ipython -======= # via sphinx-external-toc cryptography==40.0.2 # via pyjwt ->>>>>>> 910d826... Update documentation requirements (#594) deprecated==1.2.13 # via pygithub docutils==0.16 diff --git a/docs/deprecation.rst b/docs/deprecation.rst index 1548bbb2a..078d6d4f8 100644 --- a/docs/deprecation.rst +++ b/docs/deprecation.rst @@ -26,3 +26,55 @@ The packed_int8x4 datatype will be removed in hipBLAS 1.0. There are two int8 da int8_t is the C99 unsigned 8 bit integer. packed_int8x4 has 4 consecutive int8_t numbers in the k dimension packed into 32 bits. packed_int8x4 is only used in hipblasGemmEx. int8_t will continue to be available in hipblasGemmEx. + +Announced in hipBLAS 1.0 +^^^^^^^^^^^^^^^^^^^^^^^^ + +Replace Legacy BLAS in-place trmm functions with trmm functions that support both in-place and out-of-place functionality +========================================================================================================================= +Use of the deprecated Legacy BLAS in-place trmm functions will give deprecation warnings telling +you to compile with -DHIPBLAS_V1 and use the new in-place and out-of-place trmm functions. + +Note that there are no deprecation warnings for the hipBLAS Fortran API. + +The Legacy BLAS in-place trmm calculates B <- alpha * op(A) * B. Matrix B is replaced in-place by +triangular matrix A multiplied by matrix B. The prototype in the include file rocblas-functions.h is: + +:: + + hipblasStatus_t hipblasStrmm(hipblasHandle_t handle, + hipblasSideMode_t side, + hipblasFillMode_t uplo, + hipblasOperation_t transA, + hipblasDiagType_t diag, + int m, + int n, + const float* alpha, + const float* AP, + int lda, + float* BP, + int ldb); + +hipBLAS 1.0 deprecates the legacy BLAS trmm functionality and replaces it with C <- alpha * op(A) * B. The prototype is: + +:: + + hipblasStatus_t hipblasStrmmOutofplace(hipblasHandle_t handle, + hipblasSideMode_t side, + hipblasFillMode_t uplo, + hipblasOperation_t transA, + hipblasDiagType_t diag, + int m, + int n, + const float* alpha, + const float* AP, + int lda, + const float* BP, + int ldb, + float* CP, + int ldc); + +The new API provides the legacy BLAS in-place functionality if you set pointer C equal to pointer B and +ldc equal to ldb. + +There are similar deprecations for the _batched and _strided_batched versions of trmm. From 0c96f5cd759b6270b8cb52650afb077aecf42687 Mon Sep 17 00:00:00 2001 From: daineAMD Date: Mon, 29 May 2023 12:49:07 -0600 Subject: [PATCH 10/10] Taking updated requirements.txt. --- docs/.sphinx/requirements.txt | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt index 316e92be9..28c213e37 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/.sphinx/requirements.txt @@ -19,7 +19,9 @@ breathe==4.34.0 certifi==2022.12.7 # via requests cffi==1.15.1 - # via pynacl + # via + # cryptography + # pynacl charset-normalizer==3.1.0 # via requests click==8.1.3 @@ -28,12 +30,11 @@ cryptography==40.0.2 # via pyjwt deprecated==1.2.13 # via pygithub -docutils==0.16 +docutils==0.19 # via # breathe # myst-parser # pydata-sphinx-theme - # rocm-docs-core # sphinx fastjsonschema==2.16.3 # via rocm-docs-core @@ -69,16 +70,18 @@ packaging==23.0 # sphinx pycparser==2.21 # via cffi -pydata-sphinx-theme==0.13.1 - # via sphinx-book-theme -pygithub==1.57 +pydata-sphinx-theme==0.13.3 + # via + # rocm-docs-core + # sphinx-book-theme +pygithub==1.58.1 # via rocm-docs-core pygments==2.14.0 # via # accessible-pygments # pydata-sphinx-theme # sphinx -pyjwt==2.6.0 +pyjwt[crypto]==2.6.0 # via pygithub pynacl==1.5.0 # via pygithub @@ -99,7 +102,7 @@ snowballstemmer==2.2.0 # via sphinx soupsieve==2.4 # via beautifulsoup4 -sphinx==4.3.1 +sphinx==5.3.0 # via # breathe # myst-parser @@ -110,11 +113,11 @@ sphinx==4.3.1 # sphinx-design # sphinx-external-toc # sphinx-notfound-page -sphinx-book-theme==1.0.0rc2 +sphinx-book-theme==1.0.1 # via rocm-docs-core sphinx-copybutton==0.5.1 # via rocm-docs-core -sphinx-design==0.3.0 +sphinx-design==0.4.1 # via rocm-docs-core sphinx-external-toc==0.3.1 # via rocm-docs-core @@ -139,4 +142,4 @@ uc-micro-py==1.0.1 urllib3==1.26.15 # via requests wrapt==1.15.0 - # via deprecated + # via deprecated \ No newline at end of file