Update documentation requirements

Merge pull request #3566 from amd-jnovotny/peak-tflops-typo-docs612
Fix typo for TFLOPs metric in MI250 architecture page: cherry pick to docs/6.1.2
2026-01-10 15:18:11 -05:00 · 2024-09-16 10:13:17 -08:00 · 2024-08-12 13:18:12 -04:00 · 2024-08-12 10:18:38 -04:00 · 2024-08-07 12:42:18 -04:00 · 2024-08-06 16:43:09 -06:00
7 changed files with 43 additions and 49 deletions
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -3,20 +3,19 @@

 version: 2

-sphinx:
-   configuration: docs/conf.py
-
-formats: [htmlzip]
-
-python:
-   install:
-   - requirements: docs/sphinx/requirements.txt
-
 build:
   os: ubuntu-22.04
   tools:
      python: "3.10"
   apt_packages:
     - "doxygen"
-     - "gfortran" # For pre-processing fortran sources
     - "graphviz" # For dot graphs in doxygen
+
+python:
+   install:
+   - requirements: docs/sphinx/requirements.txt
+
+sphinx:
+   configuration: docs/conf.py
+
+formats: []
--- a/docs/conceptual/gpu-arch/mi250.md
+++ b/docs/conceptual/gpu-arch/mi250.md
@@ -33,8 +33,8 @@ Units (CU). The MI250 GCD has 104 active CUs. Each compute unit is further
 subdivided into four SIMD units that process SIMD instructions of 16 data
 elements per instruction (for the FP64 data type). This enables the CU to
 process 64 work items (a so-called “wavefront”) at a peak clock frequency of 1.7
-GHz. Therefore, the theoretical maximum FP64 peak performance per GCD is 45.3
-TFLOPS for vector instructions. The MI250 compute units also provide specialized
+GHz. Therefore, the theoretical maximum FP64 peak performance per GCD is 22.6
+TFLOPS for vector instructions. This equates to 45.3 TFLOPS for vector instructions for both GCDs together. The MI250 compute units also provide specialized
 execution units (also called matrix cores), which are geared toward executing
 matrix operations like matrix-matrix multiplications. For FP64, the peak
 performance of these units amounts to 90.5 TFLOPS.
--- a/docs/contribute/feedback.md
+++ b/docs/contribute/feedback.md
@@ -12,8 +12,7 @@ There are four standard ways to provide feedback on this repository.

 All contributions to ROCm documentation should arrive via the
 [GitHub Flow](https://docs.github.com/en/get-started/quickstart/github-flow)
-targeting the develop branch of the repository. If you are unable to contribute
-via the GitHub Flow, feel free to email us at [rocm-feedback@amd.com](mailto:rocm-feedback@amd.com?subject=Documentation%20Feedback).
+targeting the develop branch of the repository.

 For more in-depth information on creating a pull request (PR), see
 [Contributing](./contributing.md).
@@ -30,7 +29,3 @@ and follow along on via public announcements.

 Issues on existing or absent documentation can be filed in
 [GitHub Issues](https://github.com/ROCm/ROCm/issues).
-
-## Email
-
-Send other feedback or questions to [rocm-feedback@amd.com](mailto:rocm-feedback@amd.com?subject=Documentation%20Feedback).
--- a/docs/how-to/rocm-for-ai/train-a-model.rst
+++ b/docs/how-to/rocm-for-ai/train-a-model.rst
@@ -137,4 +137,4 @@ The following developer blogs showcase examples of how to fine-tune a model on a
 * Recipes for fine-tuning Llama2 and 3 with ``llama-recipes``

  * `meta-llama/llama-recipes: Scripts for fine-tuning Meta Llama3 with composable FSDP & PEFT methods to cover
-    single/multi-node GPUs <https://github.com/meta-llama/llama-recipes/tree/main/recipes/finetuning>`_
+    single/multi-node GPUs <https://github.com/meta-llama/llama-recipes/tree/main/recipes/quickstart/finetuning>`_
--- a/docs/how-to/tuning-guides/mi300x/workload.rst
+++ b/docs/how-to/tuning-guides/mi300x/workload.rst
@@ -1626,7 +1626,7 @@ Identifying a faulting kernel is often enough to triage a memory access
 fault. The ROCr Debug Agent can trap a memory access fault and provide a
 dump of all active wavefronts that caused the error, as well as the name
 of the kernel. For more information, see
-`ROCr Debug Agent documentation <rocr_debug_agent:index>`__.
+:doc:`ROCr Debug Agent documentation <rocr_debug_agent:index>`.

 To summarize, the key points include:

--- a/docs/sphinx/requirements.in
+++ b/docs/sphinx/requirements.in
@@ -1,2 +1,2 @@
-rocm-docs-core==1.5.0
-sphinx-reredirects
+rocm-docs-core==1.8.0
+sphinx-reredirects
--- a/docs/sphinx/requirements.txt
+++ b/docs/sphinx/requirements.txt
@@ -6,9 +6,9 @@
 #
 accessible-pygments==0.0.5
    # via pydata-sphinx-theme
-alabaster==0.7.16
+alabaster==1.0.0
    # via sphinx
-babel==2.15.0
+babel==2.16.0
    # via
    #   pydata-sphinx-theme
    #   sphinx
@@ -16,9 +16,9 @@ beautifulsoup4==4.12.3
    # via pydata-sphinx-theme
 breathe==4.35.0
    # via rocm-docs-core
-certifi==2024.7.4
+certifi==2024.8.30
    # via requests
-cffi==1.16.0
+cffi==1.17.1
    # via
    #   cryptography
    #   pynacl
@@ -26,7 +26,7 @@ charset-normalizer==3.3.2
    # via requests
 click==8.1.7
    # via sphinx-external-toc
-cryptography==42.0.8
+cryptography==43.0.1
    # via pyjwt
 deprecated==1.2.14
    # via pygithub
@@ -36,13 +36,13 @@ docutils==0.21.2
    #   myst-parser
    #   pydata-sphinx-theme
    #   sphinx
-fastjsonschema==2.19.1
+fastjsonschema==2.20.0
    # via rocm-docs-core
 gitdb==4.0.11
    # via gitpython
 gitpython==3.1.43
    # via rocm-docs-core
-idna==3.7
+idna==3.10
    # via requests
 imagesize==1.4.1
    # via sphinx
@@ -56,34 +56,34 @@ markdown-it-py==3.0.0
    #   myst-parser
 markupsafe==2.1.5
    # via jinja2
-mdit-py-plugins==0.4.1
+mdit-py-plugins==0.4.2
    # via myst-parser
 mdurl==0.1.2
    # via markdown-it-py
-myst-parser==3.0.1
+myst-parser==4.0.0
    # via rocm-docs-core
-packaging==24.0
+packaging==24.1
    # via
    #   pydata-sphinx-theme
    #   sphinx
 pycparser==2.22
    # via cffi
-pydata-sphinx-theme==0.15.3
+pydata-sphinx-theme==0.15.4
    # via
    #   rocm-docs-core
    #   sphinx-book-theme
-pygithub==2.3.0
+pygithub==2.4.0
    # via rocm-docs-core
 pygments==2.18.0
    # via
    #   accessible-pygments
    #   pydata-sphinx-theme
    #   sphinx
-pyjwt[crypto]==2.8.0
+pyjwt[crypto]==2.9.0
    # via pygithub
 pynacl==1.5.0
    # via pygithub
-pyyaml==6.0.1
+pyyaml==6.0.2
    # via
    #   myst-parser
    #   rocm-docs-core
@@ -92,15 +92,15 @@ requests==2.32.3
    # via
    #   pygithub
    #   sphinx
-rocm-docs-core==1.5.0
+rocm-docs-core==1.8.0
    # via -r requirements.in
 smmap==5.0.1
    # via gitdb
 snowballstemmer==2.2.0
    # via sphinx
-soupsieve==2.5
+soupsieve==2.6
    # via beautifulsoup4
-sphinx==7.3.7
+sphinx==8.0.2
    # via
    #   breathe
    #   myst-parser
@@ -112,37 +112,37 @@ sphinx==7.3.7
    #   sphinx-external-toc
    #   sphinx-notfound-page
    #   sphinx-reredirects
-sphinx-book-theme==1.1.2
+sphinx-book-theme==1.1.3
    # via rocm-docs-core
 sphinx-copybutton==0.5.2
    # via rocm-docs-core
-sphinx-design==0.6.0
+sphinx-design==0.6.1
    # via rocm-docs-core
 sphinx-external-toc==1.0.1
    # via rocm-docs-core
-sphinx-notfound-page==1.0.2
+sphinx-notfound-page==1.0.4
    # via rocm-docs-core
 sphinx-reredirects==0.1.5
    # via -r requirements.in
-sphinxcontrib-applehelp==1.0.8
+sphinxcontrib-applehelp==2.0.0
    # via sphinx
-sphinxcontrib-devhelp==1.0.6
+sphinxcontrib-devhelp==2.0.0
    # via sphinx
-sphinxcontrib-htmlhelp==2.0.5
+sphinxcontrib-htmlhelp==2.1.0
    # via sphinx
 sphinxcontrib-jsmath==1.0.1
    # via sphinx
-sphinxcontrib-qthelp==1.0.7
+sphinxcontrib-qthelp==2.0.0
    # via sphinx
-sphinxcontrib-serializinghtml==1.1.10
+sphinxcontrib-serializinghtml==2.0.0
    # via sphinx
 tomli==2.0.1
    # via sphinx
-typing-extensions==4.12.1
+typing-extensions==4.12.2
    # via
    #   pydata-sphinx-theme
    #   pygithub
-urllib3==2.2.2
+urllib3==2.2.3
    # via
    #   pygithub
    #   requests
Author	SHA1	Message	Date
Sam Wu	bee91034ef	Update documentation requirements	2024-09-16 10:13:17 -08:00
Jeffrey Novotny	f97066f7af	Merge pull request #3566 from amd-jnovotny/peak-tflops-typo-docs612 Fix typo for TFLOPs metric in MI250 architecture page: cherry pick to docs/6.1.2	2024-08-12 13:18:12 -04:00
Jeffrey Novotny	60ed13b1b0	Fix typo for TFLOPs metric in MI250 architecture page	2024-08-12 10:18:38 -04:00
Jeffrey Novotny	0af66d73e8	Merge pull request #3530 from amd-jnovotny/update-llama-link-612 Fix link to meta-llama finetuning recipes	2024-08-07 12:42:18 -04:00
Jeffrey Novotny	8c0b2dede9	Fix link to rocr debug agent (#3535 )	2024-08-06 16:43:09 -06:00
Jeffrey Novotny	fd4366cdd3	Fix link to meta-llama finetuning recipes	2024-08-06 15:39:57 -04:00
spolifroni-amd	02b8dc3eb3	Cherry picking removal of email feedback into 6.1.2 (#3491 ) * removed all references to the feedback email * making the linter happy	2024-08-02 11:58:48 -06:00
Peter Park	0dcf8be892	Merge pull request #3450 from peterjunpark/docs/6.1.2 Remove unused pages in /how-to	2024-07-23 02:51:48 -04:00
Peter Jun Park	8cf3ff1936	remove unused pages	2024-07-22 18:07:32 -04:00
Peter Park	d1b9a04ee9	Merge pull request #3449 from peterjunpark/docs/6.1.2 Merge remote-tracking branch 'upstream/roc-6.1.x' into docs/6.1.2	2024-07-22 18:00:41 -04:00
Peter Jun Park	2bd30f8b91	Merge remote-tracking branch 'upstream/roc-6.1.x' into HEAD	2024-07-22 17:48:50 -04:00
randyh62	f45fdd5d83	Update using-gpu-sanitizer.md with new known issues (#3423 ) (#3437 ) Co-authored-by: b-sumner <brian.sumner@amd.com>	2024-07-18 20:42:36 -07:00
spolifroni-amd	7fb9c6de51	Merge pull request #3424 from spolifroni-amd/sp-cherry-pick-612 Cherry pick into 6.1.2	2024-07-16 16:46:09 -04:00
Peter Park	c77c3fec23	Update system optimization guides headings (#3422 ) * update headings to system optimization * update index * conv tuning-guides.md to rst * shorten system optimization landing page * update conf.py update toc order add space * Update docs/how-to/tuning-guides.rst Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com> * update keywords * update intro --------- Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>	2024-07-16 16:15:17 -04:00
spolifroni-amd	dc1a141468	Removed TransferBench from the tools list (#3421 )	2024-07-16 16:15:16 -04:00
Sam Wu	747b672b04	Merge pull request #3394 from ROCm/roc-6.1.x Merge roc-6.1.x into docs/6.1.2	2024-07-03 15:54:52 -06:00
Sam Wu	31ffa6428f	Merge pull request #3374 from ROCm/roc-6.1.x Merg roc-6.1.x into docs/6.1.2	2024-07-02 10:44:43 -06:00
randyh62	086104bb9f	remove Magma (#3361 ) (#3381 ) * remove Magma * missed one	2024-07-02 07:08:33 -07:00
Peter Park	e19b8ee2eb	Merge pull request #3369 from peterjunpark/docs/6.1.2 Add fixes to vLLM install and triton kernel optimization (#3366)	2024-06-27 11:45:47 -07:00
Peter Park	ca33838d0c	Add fixes to vLLM install and triton kernel optimization (#3366 ) * Add fixes to vLLM install and triton kernel optimization * Update TGI how-to remove extra step in TGI	2024-06-27 14:32:45 -04:00
randyh62	c66ddc55b9	added ROCm Core and AMD SMI (#3348 ) (#3349 ) * added ROCm Core and AMD SMI * fix URLs	2024-06-21 17:11:16 -07:00
Peter Park	1281e5b145	Merge pull request #3347 from peterjunpark/docs/6.1.2 reorder toc (#3346)	2024-06-21 16:10:23 -07:00
Peter Park	c706f689a0	reorder toc (#3346 )	2024-06-21 18:54:44 -04:00
Peter Park	feaacde707	Merge pull request #3344 from ROCm/roc-6.1.x Merge roc-6.1.x into docs/6.1.2	2024-06-21 15:38:22 -07:00
randyh62	35f6429d1a	license information updated (#3339 ) (#3340 ) * license information updated * Young's comments * Sam's comment	2024-06-21 09:45:00 -07:00
Peter Park	01bcf5e82b	Merge pull request #3336 from ROCm/roc-6.1.x Merge roc-6.1.x into docs/6.1.2	2024-06-19 12:52:35 -07:00
Peter Park	8c0ecf7dfd	Merge pull request #3330 from ROCm/roc-6.1.x Merge roc-6.1.x into docs/6.1.2	2024-06-18 19:22:15 -07:00
randyh62	500c455094	remove nvcc (#3313 ) (#3320 ) * remove nvcc * Update CHANGELOG to match 6.0.0 template --------- Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>	2024-06-18 17:25:51 -07:00
Peter Park	e34d49bea5	Merge pull request #3319 from peterjunpark/docs/6.1.2 Add Radeon PRO dual slot to hw specs (#3318)	2024-06-18 12:34:34 -07:00
Peter Park	40674aac9c	Add Radeon PRO dual slot to hw specs (#3318 )	2024-06-18 15:28:30 -04:00
Peter Park	3c6b9df117	Merge pull request #3310 from peterjunpark/docs/6.1.2 Update link to ROCr Debug Agent to docs portal (#3303)	2024-06-17 10:34:30 -07:00
Peter Park	e6b9ed6dca	Update link to ROCr Debug Agent to docs portal (#3303 ) * Fix link to debug agent in what-is-rocm * ROCm --> ROCR add index * ROCR --> ROCr * Change ROCm Debug Agent to ROCr Debug Agent in docs	2024-06-17 11:53:47 -04:00
srawat	f3d6e6b561	Merge pull request #3294 from SwRaw/SR_6.1.2 Update link to command-line argument reference (#3270)	2024-06-13 22:28:04 +05:30
Sam Wu	8e701689d2	Merge pull request #3267 from ROCm/roc-6.1.x Merge roc-6.1.x into docs/6.1.2	2024-06-13 10:05:13 -06:00
Jeffrey Novotny	cb3dee5d07	Merge pull request #3296 from amd-jnovotny/port-aomp-fix Port aomp fix	2024-06-13 11:37:35 -04:00
Jeffrey Novotny	c61662dadc	Remove AOMP from compatibility matrix (#3289 )	2024-06-13 11:30:42 -04:00
srawat	bbe495867e	Update link to command-line argument reference (#3270 ) * Added deleted sections to openmp.md and other improvements * Update openmp.md	2024-06-13 15:31:30 +05:30
randyh62	c08af3190f	update quarantine (#3284 )	2024-06-12 09:34:49 -07:00
Istvan Kiss	b69a9c7b97	Update docs/conceptual/setting-cus.rst Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>	2024-06-12 17:42:18 +02:00
Peter Park	bcae17a4b5	Merge pull request #3283 from peterjunpark/docs/6.1.2 Remove aomp from What is ROCm? page (#3282)	2024-06-11 11:05:41 -07:00
Peter Park	9140ae5bee	Remove aomp from What is ROCm? page (#3282 )	2024-06-11 11:48:08 -04:00