github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-04-27 03:01:52 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update links to new docs and rename .sphinx dir to sphinx (#2141)

Browse Source 
* update links to new docs and rename .sphinx dir to sphinx

* fix spelling and formatting
add new words to wordlist
remove empty headers
remove version number for ROCm in conf.py

fix typos

* add more formats to rtd config
This commit is contained in:
Sam Wu
2023-05-17 11:40:18 -06:00
committed by GitHub
parent 4096b867d8
commit f953a99298
16 changed files with 27 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/conf.py
View File

@@ -24,16 +24,14 @@ linkcheck_anchors_ignore = [
linkcheck_ignore = [
# site to be built
"https://rocmdocs.amd.com/projects/ROCmCC/en/latest/",
"https://rocmdocs.amd.com/projects/RVS/en/latest/",
"https://rocmdocs.amd.com/projects/amdsmi/en/latest/",
"https://rocmdocs.amd.com/projects/rdc/en/latest/",
"https://rocmdocs.amd.com/projects/rocmsmi/en/latest/",
"https://rocmdocs.amd.com/projects/roctracer/en/latest/",
"https://rocmdocs.amd.com/projects/MIGraphX/en/latest/",
"https://rocmdocs.amd.com/projects/rocprofiler/en/latest/",
"https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md",
"https://rocmdocs.amd.com/projects/HIPIFY/en/develop/",
# correct links that linkcheck times out on
"https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md",
r"https://www.amd.com/system/files/.*.pdf",
"https://www.amd.com/en/developer/aocc.html",
"https://www.amd.com/en/support/linux-drivers",
@@ -42,12 +40,9 @@ linkcheck_ignore = [
"http://cs231n.stanford.edu/"
]
html_output_directory = "../_readthedocs/html"
setting_all_article_info = True
all_article_info_os = ["linux", "windows"]
all_article_info_author = ""
all_article_info_date = "2023-05-05"
all_article_info_read_time = "5-10 min read"
# pages with specific settings
article_pages = [
@@ -86,9 +81,10 @@ article_pages = [
{"file":"understand/isv_deployment_win", "os":["windows"]},
]
docs_core = ROCmDocs("ROCm Docs 5.5.1")
external_toc_path = "./sphinx/_toc.yml"
docs_core = ROCmDocs("ROCm Documentation")
docs_core.setup()
docs_core.disable_main_doc_link()
for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)

19
docs/how_to/tuning_guides/mi100.md
View File

@@ -83,97 +83,78 @@ available as listed in {numref}`mi100-bios`.
- AMD CBS / NBIO Common Options
- IOMMU
- Disable
- -
*
- AMD CBS / NBIO Common Options
- PCIe Ten Bit Tag Support
- Enable
- -
*
- AMD CBS / NBIO Common Options
- Preferred IO
- Manual
- -
*
- AMD CBS / NBIO Common Options
- Preferred IO Bus
- "Use lspci to find pci device id"
- -
*
- AMD CBS / NBIO Common Options
- Enhanced Preferred IO Mode
- Enable
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- Determinism Control
- Manual
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- Determinism Slider
- Power
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- cTDP Control
- Manual
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- cTDP
- 240
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- Package Power Limit Control
- Manual
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- Package Power Limit
- 240
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Link Width Control
- Manual
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Force Link Width
- 2
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Force Link Width Control
- Force
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- APBDIS
- 1
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- DF C-states
- Auto
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- Fixed SOC P-state
- P0
- -
*
- AMD CBS / UMC Common Options / DDR4 Common Options
- Enforce POR
- Accept
- -
*
- AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR
- Overclock
- Enabled
- -
*
- AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR
- Memory Clock Speed

16
docs/how_to/tuning_guides/mi200.md
View File

@@ -82,37 +82,30 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform.
- AMD CBS / NBIO Common Options
- IOMMU
- Disable
- -
*
- AMD CBS / NBIO Common Options
- PCIe Ten Bit Tag Support
- Auto
- -
*
- AMD CBS / NBIO Common Options
- Preferred IO
- Bus
- -
*
- AMD CBS / NBIO Common Options
- Preferred IO Bus
- "Use lspci to find pci device id"
- -
*
- AMD CBS / NBIO Common Options
- Enhanced Preferred IO Mode
- Enable
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- Determinism Control
- Manual
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- Determinism Slider
- Power
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- cTDP Control
@@ -122,7 +115,6 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform.
- AMD CBS / NBIO Common Options / SMU Common Options
- cTDP
- 280
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- Package Power Limit Control
@@ -132,7 +124,6 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform.
- AMD CBS / NBIO Common Options / SMU Common Options
- Package Power Limit
- 280
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Link Width Control
@@ -142,37 +133,30 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform.
- AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Force Link Width
- 2
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- xGMI Force Link Width Control
- Force
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- APBDIS
- 1
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- DF C-states
- Enabled
- -
*
- AMD CBS / NBIO Common Options / SMU Common Options
- Fixed SOC P-state
- P0
- -
*
- AMD CBS / UMC Common Options / DDR4 Common Options
- Enforce POR
- Accept
- -
*
- AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR
- Overclock
- Enabled
- -
*
- AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR
- Memory Clock Speed

1
docs/index.md
View File

@@ -17,7 +17,6 @@ agile, flexible, rapid and secure manner. [more...](rocm)
:::{dropdown} [Deploy ROCm](deploy)
- {doc}`/deploy/linux/index`
- {doc}`/deploy/quick_start_windows`
- {doc}`/deploy/docker`
:::

2
docs/reference/all.md
View File

@@ -80,7 +80,7 @@ Computer vision related projects.
:::{grid-item-card} [Validation Tools](validation_tools)
- [ROCm Validation Suite](https://rocmdocs.amd.com/projects/RVS/en/latest/)
- [ROCm Validation Suite](https://rocm.docs.amd.com/projects/ROCmValidationSuite/en/latest/)
- [TransferBench](https://rocmdocs.amd.com/projects/TransferBench/en/latest/)
:::

4
docs/reference/hip.md
View File

@@ -22,11 +22,11 @@ The HIP Runtime is used to enable GPU acceleration for all HIP language based pr
:::::{grid} 1 1 1 1
:gutter: 1
:::{grid-item-card} [HIPify](https://rocmdocs.amd.com/projects/HIPIFY/en/develop/)
:::{grid-item-card} [HIPify](https://rocm.docs.amd.com/projects/HIPIFY/en/latest/)
HIPify assists with porting applications from based on CUDA to the HIP Runtime. Supported
CUDA APIs are documented here as well.
- [Reference Manual](https://rocmdocs.amd.com/projects/HIPIFY/en/develop/)
- [Reference Manual](https://rocm.docs.amd.com/projects/HIPIFY/en/latest/)
:::

4
docs/reference/validation_tools.md
View File

@@ -3,10 +3,10 @@
:::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} [RVS](https://rocmdocs.amd.com/projects/RVS/en/latest/)
:::{grid-item-card} [RVS](https://rocm.docs.amd.com/projects/ROCmValidationSuite/en/latest/)
The ROCm Validation Suite is a system administrator’s and cluster manager's tool for detecting and troubleshooting common problems affecting AMD GPU(s) running in a high-performance computing environment, enabled using the ROCm software stack on a compatible platform.
- [Documentation](https://rocmdocs.amd.com/projects/RVS/en/latest/)
- [Documentation](https://rocm.docs.amd.com/projects/ROCmValidationSuite/en/latest/)
:::

0
docs/.sphinx/_toc.yml.in → docs/sphinx/_toc.yml.in
View File

0
docs/.sphinx/requirements.in → docs/sphinx/requirements.in
View File

2
docs/.sphinx/requirements.txt → docs/sphinx/requirements.txt
View File

@@ -2,7 +2,7 @@
# This file is autogenerated by pip-compile with Python 3.8
# by the following command:
#
# pip-compile .sphinx/requirements.in
# pip-compile sphinx/requirements.in
#
accessible-pygments==0.0.3
# via pydata-sphinx-theme