diff --git a/README.md b/README.md index 66f2404a..48723269 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ -# AMD Instinct Data Center GPU Documentation +# AMD GPU Systems and Infrastructure documentation Welcome to the documentation site for AMD Instinct Data Center GPUs. Targeted for system administrators and power users, this site provides comprehensive technical documentation, guides, and best practices for deploying and managing AMD Instinct Data Center GPUs. Content for GPU software development and applications including AI are located at [ROCm documentation](https://rocm.docs.amd.com). -[Instinct Docs Site](https://instinct.docs.amd.com/) +[AMD GPU Systems and Infrastructure documentation](https://instinct.docs.amd.com/) -## Documentation Build Guide +## Documentation build guide -This guide provides information for developers who want to contribute to the Instinct Docs site. The docs use [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) as their base and the below guide will show how you can build and serve the docs locally for testing. +This guide provides information for developers who want to contribute to the AMD GPU Systems and Infrastructure documentation site. The documentation uses [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) as the base. The following guide shows how you can build and access the documentation locally for testing. -### Building and Serving the Docs +### Building and accessing the documentation -- Create a Python Virtual Environment (optional, but recommended) +- Create a Python Virtual Environment (optional, but recommended). ```bash python3 -m venv .venv/docs ``` -- Activate the Virtual Environment +- Activate the Virtual Environment. ```bash source .venv/docs/bin/activate # For Linux @@ -24,29 +24,29 @@ This guide provides information for developers who want to contribute to the Ins source .venv/docs/Scripts/activate # For Windows ``` -- Install required packages for docs +- Install the required packages for the documentation. ```bash pip install -r docs/sphinx/requirements.txt ``` -- Build the docs +- Build the documentation. ```bash python3 -m sphinx -b html -d _build/doctrees -D language=en ./docs/ docs/_build/html ``` -- Serve docs locally on port 8000 +- Serve the documentation locally on port 8000. ```bash python3 -m http.server -d ./docs/_build/html/ ``` -- You can now view the docs site by going to http://localhost:8000 +- You can now view the documentation site by going to http://localhost:8000. -### Auto-building the docs +### Auto-building the documentation -The below will allow you to watch the docs directory and rebuild the documenatation each time you make a change to the documentation files: +The following instructions allow you to watch the docs directory and rebuild the documentation each time you make a change to the documentation files: - Install Sphinx Autobuild package @@ -54,7 +54,7 @@ The below will allow you to watch the docs directory and rebuild the documenatat pip install sphinx-autobuild ``` -- Run the autobuild (will also serve the docs on port 8000 automatically) +- Run the autobuild (will also serve the documentation on port 8000 automatically). ```bash sphinx-autobuild -b html -d _build/doctrees -D language=en ./docs docs/_build/html --ignore "docs/_build/*" --ignore "docs/sphinx/_toc.yml" --ignore "docs/sphinx/requirements.txt" @@ -64,4 +64,4 @@ The below will allow you to watch the docs directory and rebuild the documenatat #### Navigation Menu not displaying new links -Note that if you've recently added a new link to the navigation menu previously unchanged pages may not correctly display the new link. To fix this delete the existing `_build/` directory and rebuild the docs so that the navigation menu will be rebuilt for all pages. +Note that if you've recently added a new link to the navigation menu, previously unchanged pages may not correctly display the new link. To fix this, delete the existing `_build/` directory and rebuild the documentation so that the navigation menu will be rebuilt for all pages. diff --git a/docs/index.md b/docs/index.md index f190c2e1..c8e4eb24 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,9 @@ --- html_theme.sidebar_secondary.remove: true --- -# AMD Instinct Data Center GPU Documentation +# AMD GPU Systems and Infrastructure documentation -The AMD Instinct Documentation site provides comprehensive guides and technical documentation for system administrators and technical users deploying AMD Instinct Data Center GPUs in enterprise environments. This site focuses on large-scale deployment, cluster management, monitoring, and operational best practices for both HPC and AI workloads. For API documentation and core software stack details, please visit the [ROCm documentation](https://rocm.docs.amd.com). +The AMD GPU Systems and Infrastructure Documentation site provides comprehensive guides and technical documentation for system administrators and technical users deploying AMD Instinct Data Center GPUs in enterprise environments. This site focuses on large-scale deployment, cluster management, monitoring, and operational best practices for both HPC and AI workloads. For API documentation and core software stack details, please visit the [ROCm documentation](https://rocm.docs.amd.com). ::::::::::{dropdown} Industries/Verticals :open: @@ -88,7 +88,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical

hipDF

 -

GPU Accelerated DataFrames to enhance your data manipulation and analysis tasks with AMD Instinct™ GPUs. +

GPU Accelerated DataFrames to enhance your data manipulation and analysis tasks with AMD Instinct GPUs.

::: @@ -102,7 +102,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical

hipGRAPH

 -

Create, manipulate, and analyze complex networks and graphs on AMD Instinct™ GPUs. +

Create, manipulate, and analyze complex networks and graphs on AMD Instinct GPUs.

::: @@ -116,7 +116,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical

Blogs

 -

Browse blogs detailing how to accelerate your data science workloads on AMD Instinct™ GPUs. +

Browse blogs detailing how to accelerate your data science workloads on AMD Instinct GPUs.

::: @@ -152,7 +152,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical

hipCIM

 -

Run image processing and computer vision workloads on N-dimensional images for medical imaging workloads on AMD Instinct™ GPUs. +

Run image processing and computer vision workloads on N-dimensional images for medical imaging workloads on AMD Instinct GPUs.

::: @@ -166,7 +166,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical

MONAI

 -

Train and deploy AI and computer vision models for medical imaging use cases on AMD Instinct™ GPUs. +

Train and deploy AI and computer vision models for medical imaging use cases on AMD Instinct GPUs.

::: @@ -180,7 +180,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical

Blogs

 -

Browse blogs detailing how to accelerate your life science workloads on AMD Instinct™ GPUs. +

Browse blogs detailing how to accelerate your life science workloads on AMD Instinct GPUs.

::: @@ -366,7 +366,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical

Instinct Customer Acceptance Guide

 -

Comprehensive guide for configuring, validating, benchmarking, and baselining AMD Instinct™ GPUs.

+

Comprehensive guide for configuring, validating, benchmarking, and baselining AMD Instinct GPUs.

::: :::{grid-item-card} @@ -580,7 +580,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical

Instinct Micro-architecture

 -

Review hardware aspects of the AMD Instinct™ MI350, MI300, MI200 and MI100 series of GPU accelerators.

+

Review hardware aspects of the AMD Instinct MI350, MI300, MI200 and MI100 series of GPU

::::: :::::{grid-item-card} diff --git a/docs/simulation/gsplat.md b/docs/simulation/gsplat.md index 982fe6f5..863f72a6 100644 --- a/docs/simulation/gsplat.md +++ b/docs/simulation/gsplat.md @@ -7,7 +7,7 @@ images and render these in real time. ## Documentation -- For full documentation, installation instructions, and API reference guide, please refer to the +- For full documentation, installation instructions, and API reference guide, refer to the [ROCm docs site](https://rocm.docs.amd.com/projects/gsplat/en/latest/). - View the ROCm enabled GSplat code on [Github](https://github.com/ROCm/gsplat). - Learn more about Gaussian splatting and see examples of its use in the diff --git a/docs/sphinx/requirements.in b/docs/sphinx/requirements.in index 989889b3..eca31718 100644 --- a/docs/sphinx/requirements.in +++ b/docs/sphinx/requirements.in @@ -1,2 +1,2 @@ -rocm-docs-core==1.20.0 -sphinx-reredirects \ No newline at end of file +rocm-docs-core==1.31.2 +sphinx-reredirects diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt index 1f4fd541..cf4d656c 100644 --- a/docs/sphinx/requirements.txt +++ b/docs/sphinx/requirements.txt @@ -8,94 +8,91 @@ accessible-pygments==0.0.5 # via pydata-sphinx-theme alabaster==1.0.0 # via sphinx -asttokens==3.0.0 +asttokens==3.0.1 # via stack-data -attrs==25.1.0 +attrs==25.4.0 # via # jsonschema # jupyter-cache # referencing -babel==2.16.0 +babel==2.17.0 # via # pydata-sphinx-theme # sphinx -beautifulsoup4==4.12.3 +beautifulsoup4==4.14.3 # via pydata-sphinx-theme -breathe==4.35.0 +breathe==4.36.0 # via rocm-docs-core -certifi==2024.8.30 +certifi==2026.1.4 # via requests -cffi==1.17.1 +cffi==2.0.0 # via # cryptography # pynacl -charset-normalizer==3.4.0 +charset-normalizer==3.4.4 # via requests -click==8.1.7 +click==8.3.1 # via # jupyter-cache # sphinx-external-toc -comm==0.2.2 +comm==0.2.3 # via ipykernel -cryptography==43.0.3 +cryptography==46.0.3 # via pyjwt -debugpy==1.8.12 +debugpy==1.8.19 # via ipykernel -decorator==5.1.1 +decorator==5.2.1 # via ipython -deprecated==1.2.15 - # via pygithub docutils==0.21.2 # via - # breathe # myst-parser # pydata-sphinx-theme # sphinx -exceptiongroup==1.2.2 +exceptiongroup==1.3.1 # via ipython -executing==2.2.0 +executing==2.2.1 # via stack-data -fastjsonschema==2.20.0 +fastjsonschema==2.21.2 # via # nbformat # rocm-docs-core -gitdb==4.0.11 +gitdb==4.0.12 # via gitpython -gitpython==3.1.43 +gitpython==3.1.46 # via rocm-docs-core -greenlet==3.1.1 +greenlet==3.3.0 # via sqlalchemy -idna==3.10 +idna==3.11 # via requests imagesize==1.4.1 # via sphinx -importlib-metadata==8.6.1 +importlib-metadata==8.7.1 # via # jupyter-cache # myst-nb -ipykernel==6.29.5 +ipykernel==7.1.0 # via myst-nb -ipython==8.31.0 +ipython==8.38.0 # via # ipykernel # myst-nb jedi==0.19.2 # via ipython -jinja2==3.1.4 +jinja2==3.1.6 # via # myst-parser # sphinx -jsonschema==4.23.0 +jsonschema==4.26.0 # via nbformat -jsonschema-specifications==2024.10.1 +jsonschema-specifications==2025.9.1 # via jsonschema jupyter-cache==1.0.1 # via myst-nb -jupyter-client==8.6.3 +jupyter-client==8.8.0 # via # ipykernel # nbclient -jupyter-core==5.7.2 +jupyter-core==5.9.1 # via # ipykernel # jupyter-client @@ -105,21 +102,21 @@ markdown-it-py==3.0.0 # via # mdit-py-plugins # myst-parser -markupsafe==3.0.2 +markupsafe==3.0.3 # via jinja2 -matplotlib-inline==0.1.7 +matplotlib-inline==0.2.1 # via # ipykernel # ipython -mdit-py-plugins==0.4.2 +mdit-py-plugins==0.5.0 # via myst-parser mdurl==0.1.2 # via markdown-it-py -myst-nb==1.1.2 +myst-nb==1.3.0 # via rocm-docs-core -myst-parser==4.0.0 +myst-parser==4.0.1 # via myst-nb -nbclient==0.10.2 +nbclient==0.10.4 # via # jupyter-cache # myst-nb @@ -130,76 +127,77 @@ nbformat==5.10.4 # nbclient nest-asyncio==1.6.0 # via ipykernel -packaging==24.2 +packaging==25.0 # via # ipykernel + # pydata-sphinx-theme # sphinx -parso==0.8.4 +parso==0.8.5 # via jedi pexpect==4.9.0 # via ipython -platformdirs==4.3.6 +platformdirs==4.5.1 # via jupyter-core -prompt-toolkit==3.0.50 +prompt-toolkit==3.0.52 # via ipython -psutil==6.1.1 +psutil==7.2.1 # via ipykernel ptyprocess==0.7.0 # via pexpect pure-eval==0.2.3 # via stack-data -pycparser==2.22 +pycparser==2.23 # via cffi -pydata-sphinx-theme==0.16.0 +pydata-sphinx-theme==0.15.4 # via # rocm-docs-core # sphinx-book-theme -pygithub==2.5.0 +pygithub==2.8.1 # via rocm-docs-core -pygments==2.18.0 +pygments==2.19.2 # via # accessible-pygments # ipython # pydata-sphinx-theme # sphinx -pyjwt[crypto]==2.10.0 +pyjwt[crypto]==2.10.1 # via pygithub -pynacl==1.5.0 +pynacl==1.6.2 # via pygithub python-dateutil==2.9.0.post0 # via jupyter-client -pyyaml==6.0.2 +pyyaml==6.0.3 # via # jupyter-cache # myst-nb # myst-parser # rocm-docs-core # sphinx-external-toc -pyzmq==26.2.1 +pyzmq==27.1.0 # via # ipykernel # jupyter-client -referencing==0.36.2 +referencing==0.37.0 # via # jsonschema # jsonschema-specifications -requests==2.32.3 +requests==2.32.5 # via # pygithub # sphinx -rocm-docs-core==1.20.0 +rocm-docs-core==1.31.2 # via -r requirements.in -rpds-py==0.22.3 +rpds-py==0.30.0 # via # jsonschema # referencing six==1.17.0 # via python-dateutil -smmap==5.0.1 +smmap==5.0.2 # via gitdb -snowballstemmer==2.2.0 +snowballstemmer==3.0.1 # via sphinx -soupsieve==2.6 +soupsieve==2.8.1 # via beautifulsoup4 sphinx==8.1.3 # via @@ -214,7 +212,7 @@ sphinx==8.1.3 # sphinx-external-toc # sphinx-notfound-page # sphinx-reredirects -sphinx-book-theme==1.1.3 +sphinx-book-theme==1.1.4 # via rocm-docs-core sphinx-copybutton==0.5.2 # via rocm-docs-core @@ -222,7 +220,7 @@ sphinx-design==0.6.1 # via rocm-docs-core sphinx-external-toc==1.0.1 # via rocm-docs-core -sphinx-notfound-page==1.0.4 +sphinx-notfound-page==1.1.0 # via rocm-docs-core sphinx-reredirects==0.1.6 # via -r requirements.in @@ -238,21 +236,20 @@ sphinxcontrib-qthelp==2.0.0 # via sphinx sphinxcontrib-serializinghtml==2.0.0 # via sphinx -sqlalchemy==2.0.37 +sqlalchemy==2.0.45 # via jupyter-cache stack-data==0.6.3 # via ipython tabulate==0.9.0 # via jupyter-cache -tomli==2.1.0 +tomli==2.4.0 # via sphinx -tornado==6.4.2 +tornado==6.5.4 # via # ipykernel # jupyter-client traitlets==5.14.3 # via - # comm # ipykernel # ipython # jupyter-client @@ -260,21 +257,22 @@ traitlets==5.14.3 # matplotlib-inline # nbclient # nbformat -typing-extensions==4.12.2 +typing-extensions==4.15.0 # via + # beautifulsoup4 + # cryptography + # exceptiongroup # ipython # myst-nb # pydata-sphinx-theme # pygithub # referencing # sqlalchemy -urllib3==2.2.3 +urllib3==2.6.3 # via # pygithub # requests -wcwidth==0.2.13 +wcwidth==0.2.14 # via prompt-toolkit -wrapt==1.17.0 - # via deprecated -zipp==3.21.0 +zipp==3.23.0 # via importlib-metadata diff --git a/docs/vision/ai.md b/docs/vision/ai.md index 2e6c6690..9926fc72 100644 --- a/docs/vision/ai.md +++ b/docs/vision/ai.md @@ -6,6 +6,6 @@ The MIVisionX toolkit provides you with all the necessary tools you need through ## Documentation -For full documentation, please refer to the ROCm docs site: +For full documentation, refer to the ROCm docs site: - [MIVisionX](https://rocm.docs.amd.com/projects/MIVisionX/en/latest/index.html) diff --git a/docs/vision/decode.md b/docs/vision/decode.md index c9ab8a90..db93eb76 100644 --- a/docs/vision/decode.md +++ b/docs/vision/decode.md @@ -12,7 +12,7 @@ The [rocJPEG](https://github.com/ROCm/rocJPEG) library enables fast and efficien ## Documentation -For full documentation, please refer to the ROCm docs site: +For full documentation, refer to the ROCm docs site: - [rocDecode](https://rocm.docs.amd.com/projects/rocDecode/en/latest/) - [rocPyDecode](https://rocm.docs.amd.com/projects/rocPyDecode/en/latest/index.html) diff --git a/docs/vision/preprocess.md b/docs/vision/preprocess.md index d5797c94..09a41852 100644 --- a/docs/vision/preprocess.md +++ b/docs/vision/preprocess.md @@ -12,7 +12,7 @@ The [ROCm Performance Primitives (RPP)](https://github.com/ROCm/rpp) library con ## Documentation -For full documentation, please refer to the ROCm docs site: +For full documentation, refer to the ROCm docs site: - [rocAL](https://rocm.docs.amd.com/projects/rocAL/en/latest/) - [RPP](https://rocm.docs.amd.com/projects/rpp/en/latest/)