Docs: Add environment variable reference page #596
Conversation
docs/reference/env-variables.rst
Outdated
| * - **Environment variable** | ||
| - **Value** | ||
|
|
||
| * - | ``DUMP_TUNING`` |
There was a problem hiding this comment.
Aside from ROCFFT_DEVICE_BW, all of the variables in this section are used by tuning helpers that are intended mainly for internal use and are not distributed to users. I think it only makes sense to document them when the rest of the tuning framework is documented, which should be its own dedicated effort.
They're also not namespaced correctly (i.e. not prefixed with ROCFFT_), and I wouldn't want to imply that regular users of rocFFT need to know about them.
| - | Integer value specifying maximum workgroup size | ||
| | Default varies by tuning phase (512 for phase 0, 768 for phase 1) | ||
|
|
||
| * - | ``ROCFFT_DEVICE_BW`` |
There was a problem hiding this comment.
We can be more specific here - the value here is used when computing numbers for profile logging (ROCFFT_LAYER=4). If this is the only variable in this section it might make sense to move it to the logging section.
docs/reference/env-variables.rst
Outdated
| | ``32``: RTC logging | ||
| | ``64``: Tuning logging | ||
| | ``128``: Graph logging | ||
| | Values can be combined with bitwise OR |
There was a problem hiding this comment.
Since the values here are being described as base-10 integers, it's more straightforward to say that they can be combined by adding multiple values together. For example, plan and profile logging can be enabled with ROCFFT_LAYER=12, since 8 + 4 = 12.
There was a problem hiding this comment.
Also, the ROCFFT_LOG_TRACE_PATH variable should to next to the Trace Logging entry above. Same with the other path/ROCFFT_LAYER variable combinations.
| * - | ``ROCFFT_LOG_GRAPH_PATH`` | ||
| | Specifies file path for graph logging output. | ||
| - | String path to graph log file | ||
| | Used when graph logging is enabled via ``ROCFFT_LAYER`` |
There was a problem hiding this comment.
The context here is that the output can be used with graphviz. The 128: Graph logging comment should be combined with ROCFFT_LOG_GRAPH_PATH and then we should mention graphviz.
| - | ``0`` or unset: Enable cache reading | ||
| | ``1``: Disable cache reading | ||
|
|
||
| * - | ``ROCFFT_RTC_CACHE_WRITE_DISABLE`` |
There was a problem hiding this comment.
These RTC variables need to be linked/combined with the RTC documentation.
There was a problem hiding this comment.
| @@ -6,22 +6,22 @@ subtrees: | |||
| - file: what-is-rocfft | |||
| title: What is rocFFT? | |||
There was a problem hiding this comment.
Can this formatting change be moved to a separate PR?
| - | ``0`` or unset: Don't print rejection reasons | ||
| | ``1``: Print rejection reasons | ||
|
|
||
| Development and debugging (advanced) |
There was a problem hiding this comment.
I discussed this section with the team and we're likely not going to document this advanced debugging functionality. It's very complicated to configure and is mainly designed for use by the FFT development team.
So, given that we don't want to encourage its use, maybe we want to convert this into a short note that just mentions the name of the two variables and states that are for advanced users or internal use. Or just leave them out altogether.
This is part of the environment variable initiative, where we aim to create a ROCm environment variable index page that contains the links to every component's environment variable page. Do let me know if there are any other environment variables besides the one that is listed, and whether the description/default values are correct.
Summary of proposed changes: