Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,60 @@
# 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

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

```bash
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"
Expand All @@ -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.
20 changes: 10 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -88,7 +88,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical
<a href=./data-science/hipDF.html class="card-header-link">
<h2 class="card-header">hipDF</h2>
</a>
<p class="paragraph"> GPU Accelerated DataFrames to enhance your data manipulation and analysis tasks with AMD Instinct GPUs.
<p class="paragraph"> GPU Accelerated DataFrames to enhance your data manipulation and analysis tasks with AMD Instinct GPUs.
</p>
:::

Expand All @@ -102,7 +102,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical
<a href=./data-science/hipGRAPH.html class="card-header-link">
<h2 class="card-header">hipGRAPH</h2>
</a>
<p class="paragraph"> Create, manipulate, and analyze complex networks and graphs on AMD Instinct GPUs.
<p class="paragraph"> Create, manipulate, and analyze complex networks and graphs on AMD Instinct GPUs.
</p>
:::

Expand All @@ -116,7 +116,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical
<a href=./data-science/ROCmDS-Blogs.html class="card-header-link">
<h2 class="card-header">Blogs</h2>
</a>
<p class="paragraph"> Browse blogs detailing how to accelerate your data science workloads on AMD Instinct GPUs.
<p class="paragraph"> Browse blogs detailing how to accelerate your data science workloads on AMD Instinct GPUs.
</p>
:::

Expand Down Expand Up @@ -152,7 +152,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical
<a href=./life-science/hipCIM.html class="card-header-link">
<h2 class="card-header">hipCIM</h2>
</a>
<p class="paragraph"> Run image processing and computer vision workloads on N-dimensional images for medical imaging workloads on AMD Instinct GPUs.
<p class="paragraph"> Run image processing and computer vision workloads on N-dimensional images for medical imaging workloads on AMD Instinct GPUs.
</p>
:::

Expand All @@ -166,7 +166,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical
<a href=./life-science/MONAI.html class="card-header-link">
<h2 class="card-header">MONAI</h2>
</a>
<p class="paragraph"> Train and deploy AI and computer vision models for medical imaging use cases on AMD Instinct GPUs.
<p class="paragraph"> Train and deploy AI and computer vision models for medical imaging use cases on AMD Instinct GPUs.
</p>
:::

Expand All @@ -180,7 +180,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical
<a href=./life-science/ROCmLS-Blogs.html class="card-header-link">
<h2 class="card-header">Blogs</h2>
</a>
<p class="paragraph"> Browse blogs detailing how to accelerate your life science workloads on AMD Instinct GPUs.
<p class="paragraph"> Browse blogs detailing how to accelerate your life science workloads on AMD Instinct GPUs.
</p>
:::

Expand Down Expand Up @@ -366,7 +366,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical
<a href="https://instinct.docs.amd.com/projects/system-acceptance/en/latest/" class="card-header-link">
<h2 class="card-header">Instinct Customer Acceptance Guide</h2>
</a>
<p class="paragraph">Comprehensive guide for configuring, validating, benchmarking, and baselining AMD Instinct GPUs.</p>
<p class="paragraph">Comprehensive guide for configuring, validating, benchmarking, and baselining AMD Instinct GPUs.</p>
:::

:::{grid-item-card}
Expand Down Expand Up @@ -580,7 +580,7 @@ The AMD Instinct Documentation site provides comprehensive guides and technical
<a href=./gpu-arch/gpu-arch.html class="card-header-link">
<h2 class="card-header">Instinct Micro-architecture</h2>
</a>
<p class="paragraph">Review hardware aspects of the AMD Instinct MI350, MI300, MI200 and MI100 series of GPU accelerators.</p>
<p class="paragraph">Review hardware aspects of the AMD Instinct MI350, MI300, MI200 and MI100 series of GPU</p>
:::::

:::::{grid-item-card}
Expand Down
2 changes: 1 addition & 1 deletion docs/simulation/gsplat.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx/requirements.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
rocm-docs-core==1.20.0
sphinx-reredirects
rocm-docs-core==1.31.2
sphinx-reredirects
Loading