Skip to content

Commit

Permalink
Update documentation for version 2.8 release
Browse files Browse the repository at this point in the history
  • Loading branch information
mguerret-amd committed Dec 14, 2022
1 parent e09ffa4 commit 29234a3
Show file tree
Hide file tree
Showing 13 changed files with 45 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@
# built documents.
#
# The short X.Y version.
version = u'2.7.0'
version = u'2.8.0'
# The full version, including alpha/beta/rc tags.
release = u'2.7.0'
release = u'2.8.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
52 changes: 43 additions & 9 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ and GCN hardware. The suite is comprised of the following software:
Radeon Developer Panel connects to the Radeon Developer Service in
order to collect a profile, trace or scene.

**RGP documentation:** http://radeon-gpuprofiler.readthedocs.io/en/latest/
**RGP documentation:** https://radeon-gpuprofiler.readthedocs.io/en/latest/

**RMV documentation:** https://radeon-memory-visualizer.readthedocs.io/en/latest/

**RRA documentation:** http://radeon-raytracing-analyzer.readthedocs.io/en/latest/
**RRA documentation:** https://radeon-raytracing-analyzer.readthedocs.io/en/latest/

**Note:** By default, the driver allocates a maximum of 75 MB video
memory per Shader Engine to capture RGP profiles. The driver allocates
Expand All @@ -57,6 +57,8 @@ Graphics APIs, RDNA and GCN hardware, and operating systems

\ **Supported RDNA and GCN hardware**

- AMD Radeon RX 7000 series

- AMD Radeon RX 6000 series

- AMD Radeon RX 5000 series
Expand All @@ -79,10 +81,6 @@ Graphics APIs, RDNA and GCN hardware, and operating systems

- Windows® 11

- Ubuntu 18.04 LTS (Vulkan only)

- Ubuntu 20.04 LTS (Vulkan only)

- Ubuntu 22.04 LTS (Vulkan only)

Compute APIs, RDNA and GCN hardware, and operating systems
Expand All @@ -92,8 +90,12 @@ Compute APIs, RDNA and GCN hardware, and operating systems

- OpenCL

- HIP

\ **Supported RDNA and GCN hardware**

- AMD Radeon RX 7000 series

- AMD Radeon RX 6000 series

- AMD Radeon RX 5000 series
Expand Down Expand Up @@ -183,6 +185,9 @@ The system tab contains various panels for configuration:

- Modules - List of modules and their version numbers for the current connection

- :ref:`SystemInformation` - Lists detailed hardware and system information for the active Radeon Developer Panel connection


.. _MyApplications:

My applications
Expand Down Expand Up @@ -274,10 +279,13 @@ The following are the configurable options for profiling
.. image:: media/Workflow_Profiling_Config_OpenCL_AutoCapture.png

* Dispatch Range allows for setting the start and stop dispatch indices to use during automatic profile capture
* Dispatch Count specifies the number of dispatches to include in the profile capture

.. image:: media/Workflow_Profiling_Config_OpenCL_AutoCapture_Timer.png

* Dispatch count and capture time specifies the number of dispatches to capture after a specified elapsed time

**NOTE**
To reduce the chance of truncated profile data, OpenCL profiling is limited to 50 dispatches
To reduce the chance of truncated profile data, OpenCL profiling is limited to 10000 dispatches

.. image:: media/Workflow_Profiling_Config_OpenCL.png

Expand Down Expand Up @@ -323,8 +331,32 @@ from the list then click the edit or remove button. The list can also be restore
to the default set of blocked applications. Right clicking on a process name in the
list will display context menu options to add, remove, or edit.

The blocked applications list supports wildcard matching. The following syntax is supported:
* ? : Matches exactly one of any character
* [...] : Matches one character in a set of characters
* \* : Matches zero or more of any character

These can be escaped by using backslash.

Here are some examples of blocked application items that leverage the wildcard matching:
* [Gg]ears.exe : Blocks any application called gears.exe with either a lowercase or uppercase G
* gpu_info\* : Blocks any applications who's name starts with gpu_info
* test?.exe : Blocks any application called test with a single character suffix -- e.g. test1 or test6

.. image:: media/Blocked_apps_1.png

.. _SystemInformation:

System information
------------------

The system information pane lists detailed hardware and system information for the active Radeon Developer Panel connection.

Pressing the Export button will open a dialog to choose a folder. Upon selecting a folder, the system information will be exported to that folder
as a JSON file.

.. image:: media/System_Info.png

How to profile your application
===============================

Expand All @@ -339,7 +371,7 @@ The profiling UI has the following elements:

- **Enable instruction tracing** - Enables capturing detailed instruction data

- **Collect counters** - Enables capturing GPU cache counter data. Systems with an AMD Radeon RX 6000 series GPU will also collect raytracing counter data.
- **Collect counters** - Enables capturing GPU cache counter data. Systems with an AMD Radeon RX 6000 or AMD Radeon RX 7000 series GPU will also collect raytracing counter data.

- **Delay capture** - If this is enabled, pressing the capture profile button or triggering the hotkey will first wait the entered number of milliseconds before capturing a profile.

Expand Down Expand Up @@ -450,6 +482,8 @@ The raytracing UI has the following elements:

- **Capture scene** - Captures a scene and writes to disk

- **Delay capture** - If this is enabled, pressing the capture scene button or triggering the hotkey will first wait the entered number of milliseconds before capturing.

- **Recently collected scenes** - Displays any recently collected scenes found in the output directory

Capturing a scene can be achieved by the following:
Expand Down
Binary file modified docs/source/media/Blocked_apps_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/media/Raytracing_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/media/System_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/media/System_Info.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/media/Workflow_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/media/Workflow_MemoryTrace_Config.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/media/Workflow_Profiling_Config.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/media/Workflow_Profiling_Config_OpenCL.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/media/Workflow_Raytracing_Config.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 29234a3

Please sign in to comment.