docs: developer docs for the universal unit tests #3921
Conversation
Fix deepmodeling#3736. Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
WalkthroughWalkthroughThe documentation changes enhance the instructions for creating models across various backends, notably PyTorch and DP, and introduce unit tests for these models. Additionally, regression tests ensure consistency across different backends. The updates clarify supported backends with icons and provide detailed sections on universal and consistent tests. Changes
Assessment against linked issues
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional context usedLanguageTool
Additional comments not posted (6)
Tip Early access features: disabledWe are currently testing the following features in early access:
Note:
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 (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## devel #3921 +/- ##
==========================================
+ Coverage 82.72% 82.87% +0.14%
==========================================
Files 519 520 +1
Lines 50539 50679 +140
Branches 3017 3015 -2
==========================================
+ Hits 41810 42001 +191
+ Misses 7793 7740 -53
- Partials 936 938 +2 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Co-authored-by: Han Wang <92130845+wanghan-iapcm@users.noreply.github.com> Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
![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 and nitpick comments (1)
doc/development/create-a-model-pt.md (1)
Line range hint
11-11: Comma needed for clarity.Adding a comma before "you'll need to" improves the readability and grammatical correctness of the sentence.
- To incorporate your custom model you'll need to: + To incorporate your custom model, you'll need to:Tools
LanguageTool
[style] ~9-~9: In American English, abbreviations like “etc.” require a period.
Context: ...ules such as data processing, trainner, etc, you may want to read this section. To...(ETC_PERIOD)
Fix deepmodeling#3736. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated documentation to include information on creating models in various backends (PyTorch, DP). - Added sections on unit tests and regression tests for ensuring consistency across different backends. - Incorporated icons and notes to denote supported backends in the documentation. - Added a TensorFlow icon in the "Create a model in TensorFlow" section. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> Co-authored-by: Han Wang <92130845+wanghan-iapcm@users.noreply.github.com>
Fix #3736.
Summary by CodeRabbit