docs: improve docs for environment variables #4070
Conversation
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
WalkthroughWalkthroughThe recent changes enhance the DeePMD-kit package documentation by introducing detailed sections on runtime environment variables. These updates provide comprehensive descriptions, default values, and a structured format, improving user understanding and usability. Additionally, consistent terminology and formatting adjustments throughout various documents clarify the configurations necessary for optimal performance. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (1)
doc/env.md (1)
29-31: Reword repetitive sentence beginnings.The sentences starting with "If" in the list are repetitive. Consider rephrasing for variety and improved readability.
Here's a suggestion:
- If OpenMP is used, [OpenMP environment variables](https://www.openmp.org/spec-html/5.0/openmpch6.html) can be used to control OpenMP threads, such as [`OMP_NUM_THREADS`](https://www.openmp.org/spec-html/5.0/openmpse50.html#x289-20540006.2). - If CUDA is used, [CUDA environment variables](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#cuda-environment-variables) can be used to control CUDA devices, such as `CUDA_VISIBLE_DEVICES`. - If ROCm is used, [ROCm environment variables](https://rocm.docs.amd.com/en/latest/conceptual/gpu-isolation.html#environment-variables) can be used to control ROCm devices. + OpenMP users can control threads using [OpenMP environment variables](https://www.openmp.org/spec-html/5.0/openmpch6.html), such as [`OMP_NUM_THREADS`](https://www.openmp.org/spec-html/5.0/openmpse50.html#x289-20540006.2). + For CUDA, [CUDA environment variables](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#cuda-environment-variables) manage CUDA devices, like `CUDA_VISIBLE_DEVICES`. + ROCm users can utilize [ROCm environment variables](https://rocm.docs.amd.com/en/latest/conceptual/gpu-isolation.html#environment-variables) for device control.Tools
LanguageTool
[style] ~31-~31: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ices, such asCUDA_VISIBLE_DEVICES. - If ROCm is used, [ROCm environment variabl...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## devel #4070 +/- ##
==========================================
- Coverage 82.95% 82.94% -0.01%
==========================================
Files 522 522
Lines 51044 51045 +1
Branches 3031 3028 -3
==========================================
- Hits 42341 42340 -1
Misses 7759 7759
- Partials 944 946 +2 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
doc/env.md (1)
29-31: Improve sentence variety for better readability.The section has repetitive sentence beginnings. Consider rewording for improved readability.
Here's a suggested rewording:
- If OpenMP is used, [OpenMP environment variables](https://www.openmp.org/spec-html/5.0/openmpch6.html) can be used to control OpenMP threads, such as [`OMP_NUM_THREADS`](https://www.openmp.org/spec-html/5.0/openmpse50.html#x289-20540006.2). - If CUDA is used, [CUDA environment variables](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#cuda-environment-variables) can be used to control CUDA devices, such as `CUDA_VISIBLE_DEVICES`. - If ROCm is used, [ROCm environment variables](https://rocm.docs.amd.com/en/latest/conceptual/gpu-isolation.html#environment-variables) can be used to control ROCm devices. + When using OpenMP, [OpenMP environment variables](https://www.openmp.org/spec-html/5.0/openmpch6.html) control threads, such as [`OMP_NUM_THREADS`](https://www.openmp.org/spec-html/5.0/openmpse50.html#x289-20540006.2). + For CUDA, [CUDA environment variables](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#cuda-environment-variables) manage device settings, such as `CUDA_VISIBLE_DEVICES`. + With ROCm, [ROCm environment variables](https://rocm.docs.amd.com/en/latest/conceptual/gpu-isolation.html#environment-variables) handle device configurations.Tools
LanguageTool
[style] ~31-~31: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ices, such asCUDA_VISIBLE_DEVICES. - If ROCm is used, [ROCm environment variabl...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
doc/env.md (1)
29-33: Reword repetitive sentences for clarity.The sentences starting with "If" can be rephrased to improve readability and avoid repetition.
Consider rewording as follows:
- If OpenMP is used, [OpenMP environment variables](https://www.openmp.org/spec-html/5.0/openmpch6.html) can be used to control OpenMP threads, such as [`OMP_NUM_THREADS`](https://www.openmp.org/spec-html/5.0/openmpse50.html#x289-20540006.2). - If CUDA is used, [CUDA environment variables](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#cuda-environment-variables) can be used to control CUDA devices, such as `CUDA_VISIBLE_DEVICES`. - If ROCm is used, [ROCm environment variables](https://rocm.docs.amd.com/en/latest/conceptual/gpu-isolation.html#environment-variables) can be used to control ROCm devices. + Use [OpenMP environment variables](https://www.openmp.org/spec-html/5.0/openmpch6.html) to control OpenMP threads, such as [`OMP_NUM_THREADS`](https://www.openmp.org/spec-html/5.0/openmpse50.html#x289-20540006.2). + Control CUDA devices with [CUDA environment variables](https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#cuda-environment-variables), such as `CUDA_VISIBLE_DEVICES`. + Manage ROCm devices using [ROCm environment variables](https://rocm.docs.amd.com/en/latest/conceptual/gpu-isolation.html#environment-variables).Tools
LanguageTool
[style] ~31-~31: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ices, such asCUDA_VISIBLE_DEVICES. - If ROCm is used, [ROCm environment variabl...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced comprehensive documentation on runtime environment variables for improved user guidance. - Added references to environment-related topics in various interface documentation. - **Documentation** - Enhanced structure and clarity of documentation regarding environment variables across multiple sections. - Improved presentation of environment variables for better readability. - Included detailed descriptions and choices for configuring performance-related variables. - **Bug Fixes** - Corrected terminology from "environmental variables" to "environment variables" for consistency. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Summary by CodeRabbit
New Features
Documentation
Bug Fixes