Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
gaoqiong
MIGraphX
Commits
cd4ab535
Commit
cd4ab535
authored
Jun 20, 2023
by
Khalique Ahmed
Browse files
manual merge
parents
3891ee58
a0fa3742
Changes
279
Show whitespace changes
Inline
Side-by-side
Showing
20 changed files
with
234 additions
and
9 deletions
+234
-9
docs/.sphinx/requirements.in
docs/.sphinx/requirements.in
+1
-0
docs/.sphinx/requirements.txt
docs/.sphinx/requirements.txt
+175
-0
docs/CMakeLists.txt
docs/CMakeLists.txt
+9
-5
docs/conf.py
docs/conf.py
+37
-0
docs/contributor_guide.rst
docs/contributor_guide.rst
+0
-0
docs/cpp_user_guide.rst
docs/cpp_user_guide.rst
+0
-0
docs/data/roctx1.jpg
docs/data/roctx1.jpg
+0
-0
docs/data/roctx2.jpg
docs/data/roctx2.jpg
+0
-0
docs/dev/data.rst
docs/dev/data.rst
+0
-0
docs/dev/matchers.rst
docs/dev/matchers.rst
+0
-0
docs/dev/operators.rst
docs/dev/operators.rst
+0
-0
docs/dev/pass.rst
docs/dev/pass.rst
+0
-0
docs/dev/program.rst
docs/dev/program.rst
+0
-0
docs/dev/quantization.rst
docs/dev/quantization.rst
+0
-0
docs/dev/targets.rst
docs/dev/targets.rst
+0
-0
docs/dev/tools.rst
docs/dev/tools.rst
+3
-3
docs/dev_intro.rst
docs/dev_intro.rst
+0
-0
docs/driver.rst
docs/driver.rst
+0
-0
docs/driver/compile.rst
docs/driver/compile.rst
+0
-0
docs/driver/read.rst
docs/driver/read.rst
+9
-1
No files found.
docs/.sphinx/requirements.in
0 → 100644
View file @
cd4ab535
rocm-docs-core==0.11.0
docs/.sphinx/requirements.txt
0 → 100644
View file @
cd4ab535
# Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# This file is autogenerated by pip-compile with Python 3.8
# by the following command:
#
# pip-compile requirements.in
#
accessible-pygments==0.0.4
# via pydata-sphinx-theme
alabaster==0.7.13
# via sphinx
babel==2.12.1
# via
# pydata-sphinx-theme
# sphinx
beautifulsoup4==4.12.2
# via pydata-sphinx-theme
breathe==4.34.0
# via rocm-docs-core
certifi==2022.12.7
# via requests
cffi==1.15.1
# via
# cryptography
# pynacl
charset-normalizer==3.1.0
# via requests
click==8.1.3
# via sphinx-external-toc
cryptography==40.0.2
# via pyjwt
deprecated==1.2.13
# via pygithub
docutils==0.16
# via
# breathe
# myst-parser
# pydata-sphinx-theme
# sphinx
fastjsonschema==2.16.3
# via rocm-docs-core
gitdb==4.0.10
# via gitpython
gitpython==3.1.31
# via rocm-docs-core
idna==3.4
# via requests
imagesize==1.4.1
# via sphinx
importlib-metadata==6.4.1
# via sphinx
importlib-resources==5.12.0
# via rocm-docs-core
jinja2==3.1.2
# via
# myst-parser
# sphinx
linkify-it-py==1.0.3
# via myst-parser
markdown-it-py==2.2.0
# via
# mdit-py-plugins
# myst-parser
markupsafe==2.1.2
# via jinja2
mdit-py-plugins==0.3.5
# via myst-parser
mdurl==0.1.2
# via markdown-it-py
myst-parser[linkify]==1.0.0
# via rocm-docs-core
packaging==23.1
# via
# pydata-sphinx-theme
# sphinx
pycparser==2.21
# via cffi
pydata-sphinx-theme==0.13.3
# via
# rocm-docs-core
# sphinx-book-theme
pygithub==1.58.1
# via rocm-docs-core
pygments==2.15.0
# via
# accessible-pygments
# pydata-sphinx-theme
# sphinx
pyjwt[crypto]==2.6.0
# via pygithub
pynacl==1.5.0
# via pygithub
pytz==2023.3
# via babel
pyyaml==6.0
# via
# myst-parser
# rocm-docs-core
# sphinx-external-toc
requests==2.28.2
# via
# pygithub
# sphinx
rocm-docs-core==0.11.0
# via -r requirements.in
smmap==5.0.0
# via gitdb
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.4.1
# via beautifulsoup4
sphinx==5.3.0
# via
# breathe
# myst-parser
# pydata-sphinx-theme
# rocm-docs-core
# sphinx-book-theme
# sphinx-copybutton
# sphinx-design
# sphinx-external-toc
# sphinx-notfound-page
sphinx-book-theme==1.0.1
# 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
sphinx-notfound-page==0.8.3
# via rocm-docs-core
sphinxcontrib-applehelp==1.0.4
# via sphinx
sphinxcontrib-devhelp==1.0.2
# via sphinx
sphinxcontrib-htmlhelp==2.0.1
# via sphinx
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.3
# via sphinx
sphinxcontrib-serializinghtml==1.1.5
# via sphinx
typing-extensions==4.5.0
# via pydata-sphinx-theme
uc-micro-py==1.0.1
# via linkify-it-py
urllib3==1.26.15
# via requests
wrapt==1.15.0
# via deprecated
zipp==3.15.0
# via
# importlib-metadata
# importlib-resources
doc
/requiremen
ts.txt
→
doc
s/CMakeLis
ts.txt
100644 → 100755
View file @
cd4ab535
...
@@ -21,8 +21,12 @@
...
@@ -21,8 +21,12 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# THE SOFTWARE.
#####################################################################################
#####################################################################################
docutils==0.17.1
project
(
migraphx-doc
)
sphinx==4.2.0
find_package
(
ROCM REQUIRED
)
breathe==4.31.0
sphinx_rtd_theme==1.0.0
include
(
ROCMSphinxDoc
)
# git+https://github.com/arximboldi/breathe@fix-node-parent
rocm_add_sphinx_doc
(
.
BUILDER html
OUTPUT_DIR html
)
docs/conf.py
0 → 100755
View file @
cd4ab535
# Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# 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
setting_all_article_info
=
True
all_article_info_os
=
[
"linux"
]
docs_core
=
ROCmDocs
(
"AMD MIGraphX Documentation"
)
docs_core
.
run_doxygen
()
docs_core
.
setup
()
for
sphinx_var
in
ROCmDocs
.
SPHINX_VARS
:
globals
()[
sphinx_var
]
=
getattr
(
docs_core
,
sphinx_var
)
doc
/src
/contributor_guide.rst
→
doc
s
/contributor_guide.rst
View file @
cd4ab535
File moved
doc
/src
/cpp_user_guide.rst
→
doc
s
/cpp_user_guide.rst
View file @
cd4ab535
File moved
doc
/src/dev
/roctx1.jpg
→
doc
s/data
/roctx1.jpg
View file @
cd4ab535
File moved
doc
/src/dev
/roctx2.jpg
→
doc
s/data
/roctx2.jpg
View file @
cd4ab535
File moved
doc
/src
/dev/data.rst
→
doc
s
/dev/data.rst
View file @
cd4ab535
File moved
doc
/src
/dev/matchers.rst
→
doc
s
/dev/matchers.rst
View file @
cd4ab535
File moved
doc
/src
/dev/operators.rst
→
doc
s
/dev/operators.rst
View file @
cd4ab535
File moved
doc
/src
/dev/pass.rst
→
doc
s
/dev/pass.rst
View file @
cd4ab535
File moved
doc
/src
/dev/program.rst
→
doc
s
/dev/program.rst
View file @
cd4ab535
File moved
doc
/src
/dev/quantization.rst
→
doc
s
/dev/quantization.rst
View file @
cd4ab535
File moved
doc
/src
/dev/targets.rst
→
doc
s
/dev/targets.rst
View file @
cd4ab535
File moved
doc
/src
/dev/tools.rst
→
doc
s
/dev/tools.rst
View file @
cd4ab535
...
@@ -53,11 +53,11 @@ Average total time is also provided. There are three files provided for referenc
...
@@ -53,11 +53,11 @@ Average total time is also provided. There are three files provided for referenc
An example output:
An example output:
.. image:: ./roctx1.jpg
.. image:: .
./data
/roctx1.jpg
Hotspot kerel timing information:
Hotspot kerel timing information:
.. image:: ./roctx2.jpg
.. image:: .
./data
/roctx2.jpg
**Parsing an already existing JSON file:**
**Parsing an already existing JSON file:**
::
::
...
...
doc
/src
/dev_intro.rst
→
doc
s
/dev_intro.rst
View file @
cd4ab535
File moved
doc
/src
/driver.rst
→
doc
s
/driver.rst
View file @
cd4ab535
File moved
doc
/src
/driver/compile.rst
→
doc
s
/driver/compile.rst
View file @
cd4ab535
File moved
doc
/src
/driver/read.rst
→
doc
s
/driver/read.rst
View file @
cd4ab535
...
@@ -24,7 +24,7 @@ Load as MIGraphX JSON
...
@@ -24,7 +24,7 @@ Load as MIGraphX JSON
.. option:: --batch [unsigned int] (Default: 1)
.. option:: --batch [unsigned int] (Default: 1)
Set batch size for model
For a static model, set batch size. For a dynamic batch model, sets the batch size at runtime.
.. option:: --nhwc
.. option:: --nhwc
...
@@ -46,6 +46,14 @@ Trim instructions from the end (Default: 0)
...
@@ -46,6 +46,14 @@ Trim instructions from the end (Default: 0)
Dim of a parameter (format: "@name d1 d2 dn")
Dim of a parameter (format: "@name d1 d2 dn")
.. options:: --dyn-input-dim [std::vector<std::string>]
Set dynamic dimensions of a parameter using JSON formatting (format "@name" "dynamic_dimension_json")
.. options:: --default-dyn-dim
Set the default dynamic dimension (format {min:x, max:y, optimals:[o1,o2,...]})
.. option:: --optimize, -O
.. option:: --optimize, -O
Optimize when reading
Optimize when reading
...
...
Prev
1
2
3
4
5
6
…
14
Next
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment