docs: Disallow improper capitalization #3982
Conversation
WalkthroughWalkthroughThe updates address numerous minor typographical and consistency issues across various files, focusing on standardizing the capitalization of terms like "LAMMPS," "NumPy," "TensorFlow," and "DeePMD-kit." These changes enhance readability and maintain uniformity in documentation and code comments. Additionally, a new pre-commit hook was introduced to enforce proper capitalization of specific terms. Changes
Sequence DiagramsNo sequence diagrams are generated as the changes are too simple and varied, encompassing typographical corrections and standardizations rather than modifications to control flow or new features. Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Files skipped from review as they are similar to previous changes (1)
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 Configration File (
|
disallow DeepMD (excluding PairDeepMD), DeepMd, Pytorch, Tensorflow, Numpy, Github, Lammps, I-Pi, I-PI, i-Pi Signed-off-by: Jinzhe Zeng <[email protected]>
![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 (4)
.pre-commit-config.yaml (1)
145-145: Clarification needed for the PairDeepMD exclusion.The comment regarding the exclusion of PairDeepMD is unclear. It would be beneficial to provide more context or rationale for this decision.
doc/third-party/gromacs.md (2)
122-122: Grammar correction suggested.Consider changing "default true" to "default is true" for better readability and grammatical correctness.
- - `pbc`: Optional, default true. If true, the GROMACS periodic condition is passed to DeePMD-kit. + - `pbc`: Optional, default is true. If true, the GROMACS periodic condition is passed to DeePMD-kit.Tools
LanguageTool
[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...Used in alchemical calculations. -pbc: Optional, default true. If true, the GR...(UNLIKELY_OPENING_PUNCTUATION)
139-139: Grammar correction suggested.The phrase "provides an evidence" should be corrected to "provides evidence".
- ...which further provides an evidence on the validity of our simulation. + ...which further provides evidence on the validity of our simulation.Tools
LanguageTool
[grammar] ~139-~139: ‘an’ may be redundant when used with the uncountable noun ‘evidence’.
Context: ... with LAMMPS+DP, which further provides an evidence on the validity of our simulation. ![rd...(A_UNCOUNTABLE_NOUN)
doc/train/multi-task-training-pt.md (1)
19-19: Spelling correction suggested.The compound word "multi-task" should be hyphenated consistently throughout the document.
- In the PyTorch implementation, during the multi-task training process, all tasks can share any portion of the model parameters. + In the PyTorch implementation, during the multi-task training process, all tasks can share any portion of the model parameters.Tools
LanguageTool
[misspelling] ~19-~19: This word is normally spelled as one.
Context: ... the PyTorch implementation, during the multi-task training process, all tasks can share a...(EN_COMPOUNDS_MULTI_TASK)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## devel #3982 +/- ##
==========================================
- Coverage 82.83% 82.83% -0.01%
==========================================
Files 522 522
Lines 50872 50872
Branches 3015 3015
==========================================
- Hits 42142 42139 -3
Misses 7795 7795
- Partials 935 938 +3 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Jinzhe Zeng <[email protected]>
fc089c1
disallow DeepMD (excluding PairDeepMD), DeepMd, Pytorch, Tensorflow, Numpy, Github, Lammps, I-Pi, I-PI, i-Pi <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Standardized spelling of "LAMMPS," "NumPy," "PyTorch," and "GitHub" across all documents for consistency. - Updated references from "DeepMD" to "DeePMD-kit" in various installation and usage documentation. - Corrected capitalization of "i-PI" for clarity and uniformity in documentation. - **Chores** - Added a pre-commit hook to enforce proper capitalization of specified terms. - Typo corrections and minor updates in documentation and comments for improved clarity. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Jinzhe Zeng <[email protected]>
disallow DeepMD (excluding PairDeepMD), DeepMd, Pytorch, Tensorflow, Numpy, Github, Lammps, I-Pi, I-PI, i-Pi
Summary by CodeRabbit
Documentation
Chores