Docs: refactor and integrate into ROCm docs portal (#362)

* pip-compile docs/requirements.txt Signed-off-by: Peter Jun Park <peter.park@amd.com> Add Sphinx docs config Signed-off-by: Peter Jun Park <peter.park@amd.com> Add Sphinx config Signed-off-by: Peter Jun Park <peter.park@amd.com> Update docs build config Signed-off-by: Peter Jun Park <peter.park@amd.com> * style(conf.py): Apply black formatting to docs/conf.py Signed-off-by: Sam Wu <22262939+samjwu@users.noreply.github.com> * Update docs requirements Signed-off-by: Peter Jun Park <peter.park@amd.com> Update to rocm-docs-core 1.3.0 Signed-off-by: Peter Jun Park <peter.park@amd.com> Update docs requirements Signed-off-by: Peter Jun Park <peter.park@amd.com> pip-compile requirements Signed-off-by: Peter Jun Park <peter.park@amd.com> bump rocm-docs-core to 1.5.0 bump rocm-docs-core to 1.4.1 Signed-off-by: Peter Jun Park <peter.park@amd.com> * Add dependabot.yml and update CODEOWNERS Signed-off-by: Peter Jun Park <peter.park@amd.com> Update toc and conf Signed-off-by: Peter Jun Park <peter.park@amd.com> update dependabot * Port docs to rocm-docs standard Signed-off-by: Peter Jun Park <peter.park@amd.com> Add toc and Diataxis cards Signed-off-by: Peter Jun Park <peter.park@amd.com> Add basic file structure Signed-off-by: Peter Jun Park <peter.park@amd.com> add glossary Signed-off-by: Peter Jun Park <peter.park@amd.com> add includes Signed-off-by: Peter Jun Park <peter.park@amd.com> Add license.rst Signed-off-by: Peter Jun Park <peter.park@amd.com> add compatible hw Signed-off-by: Peter Jun Park <peter.park@amd.com> fix spelling and license Signed-off-by: Peter Jun Park <peter.park@amd.com> clean up index Signed-off-by: Peter Jun Park <peter.park@amd.com> clean up installation guides Signed-off-by: Peter Jun Park <peter.park@amd.com> add basic usage (quickstart) Signed-off-by: Peter Jun Park <peter.park@amd.com> add ref to global options update toc Signed-off-by: Peter Jun Park <peter.park@amd.com> modularize modes and global options Signed-off-by: Peter Jun Park <peter.park@amd.com> add profile mode Signed-off-by: Peter Jun Park <peter.park@amd.com> fixes Signed-off-by: Peter Jun Park <peter.park@amd.com> reorg and clean up Signed-off-by: Peter Jun Park <peter.park@amd.com> add dynamic omniperf version number in installation guide Signed-off-by: Peter Jun Park <peter.park@amd.com> add datatemplate more reorg Signed-off-by: Peter Jun Park <peter.park@amd.com> clean up Signed-off-by: Peter Jun Park <peter.park@amd.com> reorg images move profile mode reorg reorg reorg more fix formatting fix headings ref anchor mi2xx note add extlinks add extlinks Signed-off-by: Peter Jun Park <peter.park@amd.com> black format fix formatting, anchors Signed-off-by: Peter Jun Park <peter.park@amd.com> reorg fix words and formatting Signed-off-by: Peter Jun Park <peter.park@amd.com> formatting Signed-off-by: Peter Jun Park <peter.park@amd.com> same reorg format fix formatting fix toc Signed-off-by: Peter Jun Park <peter.park@amd.com> format * impr internal linking and fix sphinx warnings Signed-off-by: Peter Jun Park <peter.park@amd.com> * add spellcheck/linting from rocm-docs-core Signed-off-by: Peter Jun Park <peter.park@amd.com> fix rst directives satisfy spellcheck fix more spelling rm unused files fix spelling and update wordlist * bump rocm-docs-core to 1.6.0 Signed-off-by: Peter Jun Park <peter.park@amd.com> * add fixes from @skyreflectedinmirrors and @lpaoletti Signed-off-by: Peter Jun Park <peter.park@amd.com> add references to toc Signed-off-by: Peter Jun Park <peter.park@amd.com> add more fixes Signed-off-by: Peter Jun Park <peter.park@amd.com> * add package manager install section Signed-off-by: Peter Jun Park <peter.park@amd.com> * add fixes Signed-off-by: Peter Jun Park <peter.park@amd.com> add metadata and fixes Signed-off-by: Peter Jun Park <peter.park@amd.com> add fixes bump to 1.6.1 more fixes fix fmt in profiling examples Signed-off-by: Peter Jun Park <peter.park@amd.com> add missing mem type table Signed-off-by: Peter Jun Park <peter.park@amd.com> fix formatting fmt * add custom css Signed-off-by: Peter Jun Park <peter.park@amd.com> fix css fs * make images/figs click-to-expand Signed-off-by: Peter Jun Park <peter.park@amd.com> add missed image update fix link * update documentation link in README Signed-off-by: Peter Jun Park <peter.park@amd.com> * formatting fixes Signed-off-by: Peter Jun Park <peter.park@amd.com> more formatting * fix heading Signed-off-by: Peter Jun Park <peter.park@amd.com> * move archived docs Signed-off-by: Peter Jun Park <peter.park@amd.com> * exclude archived docs from docs build Signed-off-by: Peter Jun Park <peter.park@amd.com> * update archived docs workflow Signed-off-by: Peter Jun Park <peter.park@amd.com> move files update archived docs workflow Signed-off-by: Peter Jun Park <peter.park@amd.com> fix version number clean up workflow workflow test workflow test another workflow test * rm docs linting Signed-off-by: Peter Jun Park <peter.park@amd.com> * Apply cmake-format suggested changes Signed-off-by: Sam Wu <22262939+samjwu@users.noreply.github.com> * Apply cmake-format Signed-off-by: Sam Wu <22262939+samjwu@users.noreply.github.com> --------- Signed-off-by: Peter Jun Park <peter.park@amd.com> Signed-off-by: Sam Wu <22262939+samjwu@users.noreply.github.com> Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>
2024-07-31 10:42:27 -04:00
parent 96803e327c
commit a0dc485ceb
307 changed files with 16783 additions and 34 deletions
@@ -0,0 +1,36 @@
+.. meta::
+   :description: Omniperf support: compatible accelerators and GPUs
+   :keywords: Omniperf, ROCm, profiler, tool, Instinct, accelerator, AMD, GPU
+
+***********************
+Compatible accelerators
+***********************
+
+The following table lists SoCs (System on Chip) tested for compatibility with
+Omniperf. See :doc:`rocm:reference/gpu-arch-specs` for full AMD accelerator and
+GPU specifications.
+
+.. _def-soc:
+
+.. note::
+
+   In Omniperf documentation, the term System on Chip (SoC) refers to a
+   particular family of AMD accelerators.
+
+.. list-table::
+    :header-rows: 1
+
+    * - Platform
+      - Status
+
+    * - AMD Instinct™ MI300
+      - Supported ✅
+
+    * - AMD Instinct MI200
+      - Supported ✅
+
+    * - AMD Instinct MI100
+      - Supported ✅
+
+    * - AMD Instinct MI50, MI60 (Vega 20)
+      - No support ❌
@@ -0,0 +1,85 @@
+.. meta::
+    :description: Omniperf FAQ and troubleshooting
+    :keywords: Omniperf, FAQ, troubleshooting, ROCm, profiler, tool, Instinct,
+               accelerator, AMD, SSH, error, version, workaround, help
+
+***
+FAQ
+***
+
+Frequently asked questions and troubleshooting tips.
+
+How do I export profiling data I have already generated using Omniperf?
+=======================================================================
+
+To interact with the Grafana GUI, you must sync data with the MongoDB
+backend. You can do this using :ref:`database <modes-database>` mode.
+
+Pass in the directory of your desired workload as follows.
+
+.. code-block:: shell
+
+    $ omniperf database --import -w <path-to-results> -H <hostname> -u <username> -t <team-name>
+
+python ast error: 'Constant' object has no attribute 'kind'
+===========================================================
+
+This error arises from a bug in the default ``astunparse 1.6.3`` with
+``python 3.8``. The error doesn't seem to occur with Python 3.7 or 3.9.
+
+Workaround:
+
+.. code-block:: shell
+
+   $ pip3 uninstall astunparse
+   $ pip3 astunparse
+
+tabulate doesn't print properly
+===============================
+
+To get around this issue, set the following environment variables to update your
+locale settings.
+
+.. code-block:: shell
+
+   $ export LC_ALL=C.UTF-8
+   $ export LANG=C.UTF-8
+
+How can I SSH tunnel in MobaXterm?
+==================================
+
+1. Open MobaXterm.
+2. In the top ribbon, select **Tunneling** to access tunneling options.
+
+   .. image:: ../data/faq/tunnel_demo1.png
+      :align: center
+      :alt: MobaXterm Tunnel button
+      :width: 800
+
+   This pop-up should appear.
+
+   .. image:: ../data/faq/tunnel_demo2.png
+      :align: center
+      :alt: MobaXterm pop-up
+      :width: 800
+
+3. Select **New SSH tunnel**.
+
+   .. image:: ../data/faq/tunnel_demo3.png
+      :align: center
+      :alt: MobaXterm pop-up
+      :width: 800
+
+4. Configure the SSH tunnel.
+
+   Local clients
+     * ``<Forwarded port>``: ``[PORT]``
+
+   Remote server
+     * ``<Remote server>``: ``localhost``
+     * ``<Remote port>``: ``[PORT]``
+
+   SSH server
+     * ``<SSH server>``: *name of the server to connect to*
+     * ``<SSH login>``: *username to login to the server*
+     * ``<SSH port>``: ``22``