Skip to content

Commit 29234a3

Browse files
committed
Update documentation for version 2.8 release
1 parent e09ffa4 commit 29234a3

13 files changed

+45
-11
lines changed

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
# built documents.
5555
#
5656
# The short X.Y version.
57-
version = u'2.7.0'
57+
version = u'2.8.0'
5858
# The full version, including alpha/beta/rc tags.
59-
release = u'2.7.0'
59+
release = u'2.8.0'
6060

6161
# The language for content autogenerated by Sphinx. Refer to documentation
6262
# for a list of supported languages.

docs/source/index.rst

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ and GCN hardware. The suite is comprised of the following software:
3535
Radeon Developer Panel connects to the Radeon Developer Service in
3636
order to collect a profile, trace or scene.
3737

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

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

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

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

5858
\ **Supported RDNA and GCN hardware**
5959

60+
- AMD Radeon RX 7000 series
61+
6062
- AMD Radeon RX 6000 series
6163

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

8082
- Windows® 11
8183

82-
- Ubuntu 18.04 LTS (Vulkan only)
83-
84-
- Ubuntu 20.04 LTS (Vulkan only)
85-
8684
- Ubuntu 22.04 LTS (Vulkan only)
8785

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

9391
- OpenCL
9492

93+
- HIP
94+
9595
\ **Supported RDNA and GCN hardware**
9696

97+
- AMD Radeon RX 7000 series
98+
9799
- AMD Radeon RX 6000 series
98100

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

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

188+
- :ref:`SystemInformation` - Lists detailed hardware and system information for the active Radeon Developer Panel connection
189+
190+
186191
.. _MyApplications:
187192

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

276281
* Dispatch Range allows for setting the start and stop dispatch indices to use during automatic profile capture
277-
* Dispatch Count specifies the number of dispatches to include in the profile capture
282+
283+
.. image:: media/Workflow_Profiling_Config_OpenCL_AutoCapture_Timer.png
284+
285+
* Dispatch count and capture time specifies the number of dispatches to capture after a specified elapsed time
278286

279287
**NOTE**
280-
To reduce the chance of truncated profile data, OpenCL profiling is limited to 50 dispatches
288+
To reduce the chance of truncated profile data, OpenCL profiling is limited to 10000 dispatches
281289

282290
.. image:: media/Workflow_Profiling_Config_OpenCL.png
283291

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

334+
The blocked applications list supports wildcard matching. The following syntax is supported:
335+
* ? : Matches exactly one of any character
336+
* [...] : Matches one character in a set of characters
337+
* \* : Matches zero or more of any character
338+
339+
These can be escaped by using backslash.
340+
341+
Here are some examples of blocked application items that leverage the wildcard matching:
342+
* [Gg]ears.exe : Blocks any application called gears.exe with either a lowercase or uppercase G
343+
* gpu_info\* : Blocks any applications who's name starts with gpu_info
344+
* test?.exe : Blocks any application called test with a single character suffix -- e.g. test1 or test6
345+
326346
.. image:: media/Blocked_apps_1.png
327347

348+
.. _SystemInformation:
349+
350+
System information
351+
------------------
352+
353+
The system information pane lists detailed hardware and system information for the active Radeon Developer Panel connection.
354+
355+
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
356+
as a JSON file.
357+
358+
.. image:: media/System_Info.png
359+
328360
How to profile your application
329361
===============================
330362

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

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

342-
- **Collect counters** - Enables capturing GPU cache counter data. Systems with an AMD Radeon RX 6000 series GPU will also collect raytracing counter data.
374+
- **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.
343375

344376
- **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.
345377

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

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

485+
- **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.
486+
453487
- **Recently collected scenes** - Displays any recently collected scenes found in the output directory
454488

455489
Capturing a scene can be achieved by the following:
1.57 KB
Loading

docs/source/media/Raytracing_1.png

-12.8 KB
Loading

docs/source/media/System_1.png

796 Bytes
Loading

docs/source/media/System_Info.png

99.8 KB
Loading

docs/source/media/Workflow_1.png

-33 KB
Loading
-1.59 KB
Loading
-6.6 KB
Loading
-6.17 KB
Loading

0 commit comments

Comments
 (0)