Standard template implementation (#703)
This commit is contained in:
Saad Rahim
GitHub
@@ -0,0 +1,14 @@
|
||||
# Read the Docs configuration file
|
||||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
||||
|
||||
version: 2
|
||||
|
||||
sphinx:
|
||||
configuration: docs/conf.py
|
||||
|
||||
formats: [htmlzip]
|
||||
|
||||
python:
|
||||
version: "3.8"
|
||||
install:
|
||||
- requirements: docs/.sphinx/requirements.txt
|
||||
@@ -32,7 +32,7 @@ The root of this repository has a helper script 'install.sh' to build and instal
|
||||
* `./install.sh --prefix` -- specify custom path to install RCCL to (default:/opt/rocm)
|
||||
|
||||
## Manual build
|
||||
#### To build the library :
|
||||
### To build the library :
|
||||
|
||||
```shell
|
||||
$ git clone https://github.com/ROCmSoftwarePlatform/rccl.git
|
||||
@@ -48,7 +48,7 @@ $ CXX=/opt/rocm/bin/hipcc cmake -DCMAKE_PREFIX_PATH=/opt/rocm/ -DCMAKE_INSTALL_P
|
||||
```
|
||||
Note: ensure rocm-cmake is installed, `apt install rocm-cmake`.
|
||||
|
||||
#### To build the RCCL package and install package :
|
||||
### To build the RCCL package and install package :
|
||||
|
||||
Assuming you have already cloned this repository and built the library as shown in the previous section:
|
||||
|
||||
@@ -60,6 +60,17 @@ $ sudo dpkg -i *.deb
|
||||
|
||||
RCCL package install requires sudo/root access because it creates a directory called "rccl" under /opt/rocm/. This is an optional step and RCCL can be used directly by including the path containing librccl.so.
|
||||
|
||||
### How to build documentation
|
||||
Please follow the instructions below to build the documentation.
|
||||
```bash
|
||||
cd docs
|
||||
|
||||
pip3 install -r .sphinx/requirements.txt
|
||||
|
||||
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
|
||||
```
|
||||
|
||||
|
||||
## Enabling peer-to-peer transport
|
||||
In order to enable peer-to-peer access on machines with PCIe-connected GPUs, the HSA environment variable HSA_FORCE_FINE_GRAIN_PCIE=1 is required to be set, on top of requiring GPUs that support peer-to-peer access and proper large BAR addressing support.
|
||||
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
booktitle=RCCL API Guide
|
||||
spreadsheet.xml=docs/classification-map.xml
|
||||
document.locale=enus
|
||||
@@ -52,7 +52,7 @@ PROJECT_BRIEF = "prototype interfaces compatible with ROCm platform and
|
||||
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
|
||||
# the logo to the output directory.
|
||||
|
||||
PROJECT_LOGO = ./rocm.jpg
|
||||
PROJECT_LOGO =
|
||||
|
||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
||||
# into which the generated documentation will be written. If a relative path is
|
||||
@@ -778,7 +778,7 @@ WARN_LOGFILE =
|
||||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = nccl.h
|
||||
INPUT = ../../tools/topo_expl/include/nccl.h
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||
@@ -960,7 +960,7 @@ FILTER_SOURCE_PATTERNS =
|
||||
# (index.html). This can be useful if you have a project on for instance GitHub
|
||||
# and want to reuse the introduction page also for the doxygen output.
|
||||
|
||||
USE_MDFILE_AS_MAINPAGE = ../README.md
|
||||
# USE_MDFILE_AS_MAINPAGE = ../README.md
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to source browsing
|
||||
@@ -0,0 +1,8 @@
|
||||
root: index
|
||||
subtrees:
|
||||
- entries:
|
||||
- file: api
|
||||
- file: allapi
|
||||
- file: attributions
|
||||
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
git+https://github.com/RadeonOpenCompute/rocm-docs-core.git
|
||||
@@ -0,0 +1,275 @@
|
||||
#
|
||||
# This file is autogenerated by pip-compile with Python 3.8
|
||||
# by the following command:
|
||||
#
|
||||
# pip-compile docs/sphinx/requirements.in
|
||||
#
|
||||
accessible-pygments==0.0.3
|
||||
# via pydata-sphinx-theme
|
||||
alabaster==0.7.12
|
||||
# via sphinx
|
||||
asttokens==2.2.0
|
||||
# via stack-data
|
||||
attrs==22.1.0
|
||||
# via
|
||||
# jsonschema
|
||||
# jupyter-cache
|
||||
babel==2.10.3
|
||||
# via
|
||||
# pydata-sphinx-theme
|
||||
# sphinx
|
||||
backcall==0.2.0
|
||||
# via ipython
|
||||
beautifulsoup4==4.11.1
|
||||
# via pydata-sphinx-theme
|
||||
breathe==4.34.0
|
||||
# via rocm-docs-core
|
||||
certifi==2022.6.15
|
||||
# via requests
|
||||
cffi==1.15.1
|
||||
# via pynacl
|
||||
charset-normalizer==2.1.0
|
||||
# via requests
|
||||
click==8.1.3
|
||||
# via
|
||||
# jupyter-cache
|
||||
# sphinx-external-toc
|
||||
debugpy==1.6.4
|
||||
# via ipykernel
|
||||
decorator==5.1.1
|
||||
# via ipython
|
||||
deprecated==1.2.13
|
||||
# via pygithub
|
||||
docutils==0.16
|
||||
# via
|
||||
# breathe
|
||||
# myst-parser
|
||||
# pydata-sphinx-theme
|
||||
# rocm-docs-core
|
||||
# sphinx
|
||||
entrypoints==0.4
|
||||
# via jupyter-client
|
||||
executing==1.2.0
|
||||
# via stack-data
|
||||
fastjsonschema==2.16.2
|
||||
# via nbformat
|
||||
gitdb==4.0.10
|
||||
# via gitpython
|
||||
gitpython==3.1.31
|
||||
# via rocm-docs-core
|
||||
greenlet==2.0.1
|
||||
# via sqlalchemy
|
||||
idna==3.3
|
||||
# via requests
|
||||
imagesize==1.4.1
|
||||
# via sphinx
|
||||
importlib-metadata==5.1.0
|
||||
# via
|
||||
# jupyter-cache
|
||||
# myst-nb
|
||||
importlib-resources==5.10.4
|
||||
# via
|
||||
# jsonschema
|
||||
# rocm-docs-core
|
||||
ipykernel==6.17.1
|
||||
# via myst-nb
|
||||
ipython==8.7.0
|
||||
# via
|
||||
# ipykernel
|
||||
# myst-nb
|
||||
jedi==0.18.2
|
||||
# via ipython
|
||||
jinja2==3.1.2
|
||||
# via
|
||||
# myst-parser
|
||||
# sphinx
|
||||
jsonschema==4.17.3
|
||||
# via nbformat
|
||||
jupyter-cache==0.5.0
|
||||
# via myst-nb
|
||||
jupyter-client==7.4.7
|
||||
# via
|
||||
# ipykernel
|
||||
# nbclient
|
||||
jupyter-core==5.1.0
|
||||
# via
|
||||
# jupyter-client
|
||||
# nbformat
|
||||
linkify-it-py==1.0.3
|
||||
# via myst-parser
|
||||
markdown-it-py==2.1.0
|
||||
# via
|
||||
# mdit-py-plugins
|
||||
# myst-parser
|
||||
markupsafe==2.1.1
|
||||
# via jinja2
|
||||
matplotlib-inline==0.1.6
|
||||
# via
|
||||
# ipykernel
|
||||
# ipython
|
||||
mdit-py-plugins==0.3.1
|
||||
# via myst-parser
|
||||
mdurl==0.1.2
|
||||
# via markdown-it-py
|
||||
myst-nb==0.17.1
|
||||
# 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.0
|
||||
# via
|
||||
# jupyter-cache
|
||||
# myst-nb
|
||||
# nbclient
|
||||
nest-asyncio==1.5.6
|
||||
# via
|
||||
# ipykernel
|
||||
# jupyter-client
|
||||
# nbclient
|
||||
packaging==21.3
|
||||
# via
|
||||
# ipykernel
|
||||
# pydata-sphinx-theme
|
||||
# sphinx
|
||||
parso==0.8.3
|
||||
# via jedi
|
||||
pexpect==4.8.0
|
||||
# via ipython
|
||||
pickleshare==0.7.5
|
||||
# via ipython
|
||||
pkgutil-resolve-name==1.3.10
|
||||
# via jsonschema
|
||||
platformdirs==2.5.4
|
||||
# via jupyter-core
|
||||
prompt-toolkit==3.0.33
|
||||
# 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
|
||||
# via sphinx-book-theme
|
||||
pygithub==1.57
|
||||
# via rocm-docs-core
|
||||
pygments==2.12.0
|
||||
# via
|
||||
# accessible-pygments
|
||||
# ipython
|
||||
# pydata-sphinx-theme
|
||||
# sphinx
|
||||
pyjwt==2.6.0
|
||||
# via pygithub
|
||||
pynacl==1.5.0
|
||||
# via pygithub
|
||||
pyparsing==3.0.9
|
||||
# via packaging
|
||||
pyrsistent==0.19.2
|
||||
# via jsonschema
|
||||
python-dateutil==2.8.2
|
||||
# via jupyter-client
|
||||
pytz==2022.1
|
||||
# via babel
|
||||
pyyaml==6.0
|
||||
# via
|
||||
# jupyter-cache
|
||||
# myst-nb
|
||||
# myst-parser
|
||||
# sphinx-external-toc
|
||||
pyzmq==24.0.1
|
||||
# via
|
||||
# ipykernel
|
||||
# jupyter-client
|
||||
requests==2.28.1
|
||||
# via
|
||||
# pygithub
|
||||
# sphinx
|
||||
rocm-docs-core @ git+https://github.com/RadeonOpenCompute/rocm-docs-core.git
|
||||
# via -r docs/sphinx/requirements.in
|
||||
six==1.16.0
|
||||
# via
|
||||
# asttokens
|
||||
# python-dateutil
|
||||
smmap==5.0.0
|
||||
# via gitdb
|
||||
snowballstemmer==2.2.0
|
||||
# via sphinx
|
||||
soupsieve==2.3.2.post1
|
||||
# via beautifulsoup4
|
||||
sphinx==4.3.1
|
||||
# via
|
||||
# breathe
|
||||
# myst-nb
|
||||
# myst-parser
|
||||
# pydata-sphinx-theme
|
||||
# rocm-docs-core
|
||||
# sphinx-book-theme
|
||||
# sphinx-copybutton
|
||||
# sphinx-design
|
||||
# sphinx-external-toc
|
||||
sphinx-book-theme==1.0.0rc2
|
||||
# via rocm-docs-core
|
||||
sphinx-copybutton==0.5.1
|
||||
# via rocm-docs-core
|
||||
sphinx-design==0.3.0
|
||||
# via rocm-docs-core
|
||||
sphinx-external-toc==0.3.1
|
||||
# via rocm-docs-core
|
||||
sphinxcontrib-applehelp==1.0.2
|
||||
# via sphinx
|
||||
sphinxcontrib-devhelp==1.0.2
|
||||
# via sphinx
|
||||
sphinxcontrib-htmlhelp==2.0.0
|
||||
# via sphinx
|
||||
sphinxcontrib-jsmath==1.0.1
|
||||
# via sphinx
|
||||
sphinxcontrib-qthelp==1.0.3
|
||||
# via sphinx
|
||||
sphinxcontrib-serializinghtml==1.1.5
|
||||
# via sphinx
|
||||
sqlalchemy==1.4.44
|
||||
# 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.6.0
|
||||
# via
|
||||
# ipykernel
|
||||
# ipython
|
||||
# jupyter-client
|
||||
# jupyter-core
|
||||
# matplotlib-inline
|
||||
# nbclient
|
||||
# nbformat
|
||||
typing-extensions==4.4.0
|
||||
# via
|
||||
# myst-nb
|
||||
# myst-parser
|
||||
uc-micro-py==1.0.1
|
||||
# via linkify-it-py
|
||||
urllib3==1.26.11
|
||||
# via requests
|
||||
wcwidth==0.2.5
|
||||
# via prompt-toolkit
|
||||
wrapt==1.15.0
|
||||
# via deprecated
|
||||
zipp==3.11.0
|
||||
# via
|
||||
# importlib-metadata
|
||||
# importlib-resources
|
||||
|
||||
# The following packages are considered to be unsafe in a requirements file:
|
||||
# setuptools
|
||||
@@ -0,0 +1,7 @@
|
||||
=======
|
||||
All API
|
||||
=======
|
||||
|
||||
.. doxygenindex::
|
||||
|
||||
|
||||
@@ -1,189 +0,0 @@
|
||||
<?xml version="1.0"?>
|
||||
<?mso-application progid="Excel.Sheet"?>
|
||||
<Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet"
|
||||
xmlns:o="urn:schemas-microsoft-com:office:office"
|
||||
xmlns:x="urn:schemas-microsoft-com:office:excel"
|
||||
xmlns:dt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882"
|
||||
xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet"
|
||||
xmlns:html="http://www.w3.org/TR/REC-html40">
|
||||
<DocumentProperties xmlns="urn:schemas-microsoft-com:office:office">
|
||||
<Author>Kanika Yadav (external)</Author>
|
||||
<LastAuthor>Microsoft Office User</LastAuthor>
|
||||
<Created>2020-09-25T06:54:04Z</Created>
|
||||
<LastSaved>2021-12-22T19:07:50Z</LastSaved>
|
||||
<Version>16.00</Version>
|
||||
</DocumentProperties>
|
||||
<CustomDocumentProperties xmlns="urn:schemas-microsoft-com:office:office">
|
||||
<MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_Enabled dt:dt="string">true</MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_Enabled>
|
||||
<MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_SetDate dt:dt="string">2021-02-23T09:13:03Z</MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_SetDate>
|
||||
<MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_Method dt:dt="string">Standard</MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_Method>
|
||||
<MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_Name dt:dt="string">90c2fedb-0da6-4717-8531-d16a1b9930f4</MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_Name>
|
||||
<MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_SiteId dt:dt="string">45597f60-6e37-4be7-acfb-4c9e23b261ea</MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_SiteId>
|
||||
<MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_ActionId dt:dt="string"></MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_ActionId>
|
||||
<MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_ContentBits dt:dt="string">0</MSIP_Label_90c2fedb-0da6-4717-8531-d16a1b9930f4_ContentBits>
|
||||
<MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_Enabled dt:dt="string">true</MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_Enabled>
|
||||
<MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_SetDate dt:dt="string">2022-01-14T16:33:39Z</MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_SetDate>
|
||||
<MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_Method dt:dt="string">Privileged</MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_Method>
|
||||
<MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_Name dt:dt="string">AMD Official Use Only-AIP 2.0</MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_Name>
|
||||
<MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_SiteId dt:dt="string">3dd8961f-e488-4e60-8e11-a82d994e183d</MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_SiteId>
|
||||
<MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_ActionId dt:dt="string">3ab6c0f7-c658-4f6f-bd9d-6ef921551ff7</MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_ActionId>
|
||||
<MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_ContentBits dt:dt="string">1</MSIP_Label_88914ebd-7e6c-4e12-a031-a9906be2db14_ContentBits>
|
||||
</CustomDocumentProperties>
|
||||
<OfficeDocumentSettings xmlns="urn:schemas-microsoft-com:office:office">
|
||||
<AllowPNG/>
|
||||
</OfficeDocumentSettings>
|
||||
<ExcelWorkbook xmlns="urn:schemas-microsoft-com:office:excel">
|
||||
<WindowHeight>14235</WindowHeight>
|
||||
<WindowWidth>32767</WindowWidth>
|
||||
<WindowTopX>32767</WindowTopX>
|
||||
<WindowTopY>32767</WindowTopY>
|
||||
<ProtectStructure>False</ProtectStructure>
|
||||
<ProtectWindows>False</ProtectWindows>
|
||||
</ExcelWorkbook>
|
||||
<Styles>
|
||||
<Style ss:ID="Default" ss:Name="Normal">
|
||||
<Alignment ss:Vertical="Bottom"/>
|
||||
<Borders/>
|
||||
<Font ss:FontName="SwissReSans" x:Family="Swiss" ss:Size="11" ss:Color="#000000"/>
|
||||
<Interior/>
|
||||
<NumberFormat/>
|
||||
<Protection/>
|
||||
</Style>
|
||||
<Style ss:ID="s16" ss:Name="Comma">
|
||||
<NumberFormat ss:Format="_(* #,##0.00_);_(* \(#,##0.00\);_(* "-"??_);_(@_)"/>
|
||||
</Style>
|
||||
<Style ss:ID="s62">
|
||||
<Font ss:FontName="Arial" x:Family="Swiss" ss:Size="11" ss:Color="#333333"
|
||||
ss:Bold="1"/>
|
||||
</Style>
|
||||
<Style ss:ID="s63">
|
||||
<Font ss:FontName="Arial" x:Family="Swiss" ss:Color="#000000"/>
|
||||
</Style>
|
||||
<Style ss:ID="s65" ss:Parent="s16">
|
||||
<Font ss:FontName="Arial" x:Family="Swiss" ss:Color="#000000"/>
|
||||
<NumberFormat ss:Format="@"/>
|
||||
</Style>
|
||||
<Style ss:ID="s66">
|
||||
<Alignment ss:Vertical="Bottom" ss:WrapText="1"/>
|
||||
</Style>
|
||||
<Style ss:ID="s67">
|
||||
<Font ss:FontName="Arial" x:Family="Swiss" ss:Size="11" ss:Color="#333333"/>
|
||||
</Style>
|
||||
</Styles>
|
||||
<Worksheet ss:Name="Sheet1">
|
||||
<Table ss:ExpandedColumnCount="5" ss:ExpandedRowCount="8" x:FullColumns="1"
|
||||
x:FullRows="1" ss:DefaultColumnWidth="60" ss:DefaultRowHeight="14.25">
|
||||
<Column ss:Width="378"/>
|
||||
<Column ss:Width="348.75"/>
|
||||
<Column ss:AutoFitWidth="0" ss:Width="147.75"/>
|
||||
<Row ss:AutoFitHeight="0">
|
||||
<Cell><Data ss:Type="String">Filename</Data></Cell>
|
||||
<Cell><Data ss:Type="String">Title</Data></Cell>
|
||||
<Cell><Data ss:Type="String">Categories</Data></Cell>
|
||||
<Cell><Data ss:Type="String">Version</Data></Cell>
|
||||
<Cell><Data ss:Type="String">Doc Type</Data></Cell>
|
||||
</Row>
|
||||
<Row ss:AutoFitHeight="0" ss:Height="15">
|
||||
<Cell ss:StyleID="s62"><Data ss:Type="String">MAP</Data></Cell>
|
||||
<Cell ss:Index="3" ss:StyleID="s63"><Data ss:Type="String">rocm;hip-sdk;hip;gpu;amd;rccl;</Data></Cell>
|
||||
<Cell ss:StyleID="s65"><Data ss:Type="String">4-5</Data></Cell>
|
||||
</Row>
|
||||
<Row ss:AutoFitHeight="0" ss:Height="15">
|
||||
<Cell ss:StyleID="s62"><Data ss:Type="String">apply-ALL</Data></Cell>
|
||||
</Row>
|
||||
<Row ss:AutoFitHeight="0" ss:Height="15">
|
||||
<Cell ss:StyleID="s62"><Data ss:Type="String">default</Data></Cell>
|
||||
</Row>
|
||||
<Row ss:AutoFitHeight="0">
|
||||
<Cell><Data ss:Type="String">RCCL API Guide </Data></Cell>
|
||||
<Cell ss:StyleID="s66"/>
|
||||
<Cell ss:Index="5" ss:StyleID="s63"><Data ss:Type="String">reference </Data></Cell>
|
||||
</Row>
|
||||
<Row ss:AutoFitHeight="0">
|
||||
<Cell ss:StyleID="s67"/>
|
||||
<Cell ss:StyleID="s66"/>
|
||||
<Cell ss:StyleID="s63"/>
|
||||
<Cell ss:StyleID="s65"/>
|
||||
<Cell ss:StyleID="s63"/>
|
||||
</Row>
|
||||
<Row ss:AutoFitHeight="0">
|
||||
<Cell ss:Index="2" ss:StyleID="s66"/>
|
||||
<Cell ss:StyleID="s63"/>
|
||||
<Cell ss:StyleID="s65"/>
|
||||
<Cell ss:StyleID="s63"/>
|
||||
</Row>
|
||||
<Row ss:AutoFitHeight="0">
|
||||
<Cell ss:Index="3" ss:StyleID="s63"/>
|
||||
<Cell ss:StyleID="s65"/>
|
||||
<Cell ss:StyleID="s63"/>
|
||||
</Row>
|
||||
</Table>
|
||||
<WorksheetOptions xmlns="urn:schemas-microsoft-com:office:excel">
|
||||
<PageSetup>
|
||||
<Header x:Margin="0.3"
|
||||
x:Data="&L&"Arial"&10&K0000FF[AMD Official Use Only]&1#"/>
|
||||
<Footer x:Margin="0.3"/>
|
||||
<PageMargins x:Bottom="0.75" x:Left="0.7" x:Right="0.7" x:Top="0.75"/>
|
||||
</PageSetup>
|
||||
<Unsynced/>
|
||||
<Print>
|
||||
<ValidPrinterInfo/>
|
||||
<HorizontalResolution>200</HorizontalResolution>
|
||||
<VerticalResolution>200</VerticalResolution>
|
||||
</Print>
|
||||
<Selected/>
|
||||
<Panes>
|
||||
<Pane>
|
||||
<Number>3</Number>
|
||||
<ActiveRow>4</ActiveRow>
|
||||
</Pane>
|
||||
</Panes>
|
||||
<ProtectObjects>False</ProtectObjects>
|
||||
<ProtectScenarios>False</ProtectScenarios>
|
||||
</WorksheetOptions>
|
||||
</Worksheet>
|
||||
<Worksheet ss:Name="Sheet2">
|
||||
<Table ss:ExpandedColumnCount="1" ss:ExpandedRowCount="1" x:FullColumns="1"
|
||||
x:FullRows="1" ss:DefaultColumnWidth="60" ss:DefaultRowHeight="14.25">
|
||||
<Row ss:AutoFitHeight="0"/>
|
||||
</Table>
|
||||
<WorksheetOptions xmlns="urn:schemas-microsoft-com:office:excel">
|
||||
<PageSetup>
|
||||
<Header x:Margin="0.3"
|
||||
x:Data="&L&"Arial"&10&K0000FF[AMD Official Use Only]&1#"/>
|
||||
<Footer x:Margin="0.3"/>
|
||||
<PageMargins x:Bottom="0.75" x:Left="0.7" x:Right="0.7" x:Top="0.75"/>
|
||||
</PageSetup>
|
||||
<Unsynced/>
|
||||
<Print>
|
||||
<ValidPrinterInfo/>
|
||||
<HorizontalResolution>200</HorizontalResolution>
|
||||
<VerticalResolution>200</VerticalResolution>
|
||||
</Print>
|
||||
<ProtectObjects>False</ProtectObjects>
|
||||
<ProtectScenarios>False</ProtectScenarios>
|
||||
</WorksheetOptions>
|
||||
</Worksheet>
|
||||
<Worksheet ss:Name="Sheet3">
|
||||
<Table ss:ExpandedColumnCount="1" ss:ExpandedRowCount="1" x:FullColumns="1"
|
||||
x:FullRows="1" ss:DefaultColumnWidth="60" ss:DefaultRowHeight="14.25">
|
||||
<Row ss:AutoFitHeight="0"/>
|
||||
</Table>
|
||||
<WorksheetOptions xmlns="urn:schemas-microsoft-com:office:excel">
|
||||
<PageSetup>
|
||||
<Header x:Margin="0.3"
|
||||
x:Data="&L&"Arial"&10&K0000FF[AMD Official Use Only]&1#"/>
|
||||
<Footer x:Margin="0.3"/>
|
||||
<PageMargins x:Bottom="0.75" x:Left="0.7" x:Right="0.7" x:Top="0.75"/>
|
||||
</PageSetup>
|
||||
<Unsynced/>
|
||||
<Print>
|
||||
<ValidPrinterInfo/>
|
||||
<HorizontalResolution>200</HorizontalResolution>
|
||||
<VerticalResolution>200</VerticalResolution>
|
||||
</Print>
|
||||
<ProtectObjects>False</ProtectObjects>
|
||||
<ProtectScenarios>False</ProtectScenarios>
|
||||
</WorksheetOptions>
|
||||
</Worksheet>
|
||||
</Workbook>
|
||||
@@ -0,0 +1,14 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
from rocm_docs import ROCmDocs
|
||||
|
||||
docs_core = ROCmDocs("RCCL Documentation")
|
||||
docs_core.run_doxygen()
|
||||
docs_core.setup()
|
||||
|
||||
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
||||
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|
||||
@@ -1,15 +1,9 @@
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:caption: Contents:
|
||||
|
||||
======
|
||||
RCCL
|
||||
======
|
||||
|
||||
Introduction
|
||||
------------
|
||||
********************************
|
||||
Welcome to RCCL's documentation!
|
||||
********************************
|
||||
|
||||
The ROCm Collective Communication Library (RCCL) is a stand-alone library which provides multi-GPU and multi-node collective communication primitives optimized for AMD GPUs. RCCL (pronounced “Rickel”) implements routines such as all-reduce, all-gather, reduce, broadcast, reduce-scatter, gather, scatter, all-to-allv, and all-to-all as well as direct point-to-point (GPU-to-GPU) send and receive operations. The provided collective communication routines are implemented using Ring and Tree algorithms. They are optimized to achieve high bandwidth and low latency by leveraging topology awareness, high-speed interconnects, RDMA based collectives. RCCL utilizes PCIe and xGMI high-speed interconnects for intra-node communication as well as InfiniBand, RoCE, and TCP/IP for inter-node communication.
|
||||
RCCL supports an arbitrary number of GPUs installed in a single-node or multi-node platform. It can be easily integrated into either single- or multi-process (e.g., MPI) applications.
|
||||
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 6.6 KiB |
@@ -1,15 +0,0 @@
|
||||
#!/bin/bash
|
||||
# Copyright (c) 2019-2021 Advanced Micro Devices, Inc. All rights reserved.
|
||||
|
||||
set -eu
|
||||
|
||||
# Make this directory the PWD
|
||||
cd "$(dirname "${BASH_SOURCE[0]}")"
|
||||
|
||||
# Build doxygen info
|
||||
./run_doxygen.sh
|
||||
|
||||
# Build sphinx docs
|
||||
cd source
|
||||
make clean
|
||||
make html
|
||||
@@ -1,17 +0,0 @@
|
||||
#!/bin/bash
|
||||
# # Copyright (c) 2019-2021 Advanced Micro Devices, Inc. All rights reserved.
|
||||
|
||||
set -eu
|
||||
|
||||
# Make this directory the PWD
|
||||
cd "$(dirname "${BASH_SOURCE[0]}")"
|
||||
|
||||
# Rename our input file
|
||||
cp ../src/nccl.h.in nccl.h
|
||||
|
||||
# Build the doxygen info
|
||||
rm -rf docBin
|
||||
doxygen Doxyfile
|
||||
|
||||
# Cleanup
|
||||
rm nccl.h
|
||||
@@ -1,20 +0,0 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SPHINXPROJ = RCCL
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
@@ -1,11 +0,0 @@
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:caption: Contents:
|
||||
|
||||
=======
|
||||
All API
|
||||
=======
|
||||
|
||||
.. doxygenindex::
|
||||
|
||||
|
||||
@@ -1,182 +0,0 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# RCCL documentation build configuration file, created by
|
||||
# sphinx-quickstart on Mon Jan 8 16:34:42 2018.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
import os
|
||||
import sys
|
||||
import subprocess
|
||||
|
||||
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
|
||||
|
||||
if read_the_docs_build:
|
||||
subprocess.call('cd ..; ./run_doxygen.sh; cd source', shell=True)
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ['sphinx.ext.mathjax', 'breathe']
|
||||
breathe_projects = { "RCCL": "../docBin/xml" }
|
||||
breathe_default_project = "RCCL"
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'RCCL'
|
||||
copyright = u'Copyright 2019-2021 Advanced Micro Devices'
|
||||
author = u'Advanced Micro Devices'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = u'0.8'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = u'0.8'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This patterns also effect to html_static_path and html_extra_path
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
# html_theme = 'alabaster'
|
||||
|
||||
if read_the_docs_build:
|
||||
html_theme = 'default'
|
||||
else:
|
||||
import sphinx_rtd_theme
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
# html_static_path = ['_static']
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
#
|
||||
# This is required for the alabaster theme
|
||||
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
||||
# html_sidebars = {
|
||||
# '**': [
|
||||
# 'relations.html', # needs 'show_related': True theme option to display
|
||||
# 'searchbox.html',
|
||||
# ]
|
||||
# }
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'RCCLdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'RCCL.tex', u'RCCL Documentation',
|
||||
u'Advanced Micro Devices', 'manual'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'RCCL', u'RCCL Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'RCCL', u'RCCL Documentation',
|
||||
author, 'RCCL', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
@@ -1,22 +0,0 @@
|
||||
.. rocFFT documentation master file, created by
|
||||
sphinx-quickstart on Mon Jan 8 09:51:41 2018.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to RCCL's documentation!
|
||||
==================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:caption: Contents:
|
||||
|
||||
library
|
||||
api
|
||||
allapi
|
||||
attributions
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`search`
|
||||
@@ -1,3 +0,0 @@
|
||||
|
||||
breathe
|
||||
|
||||
Reference in New Issue
Block a user