feat: plain text model format #4025
Conversation
Propose a plain text model format based on YAML, which can be easily read by humans and might be good to be stored in the git repository (which is good for deepmodeling#2103). Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
WalkthroughWalkthroughThe recent updates enhance the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Backend
participant FileSystem
User->>Backend: save_dp_model("model.yaml")
Backend->>FileSystem: Check file extension (.yaml)
alt Save as YAML
Backend->>Backend: Convert model_dict to YAML
Backend->>FileSystem: Write to model.yaml
end
User->>Backend: load_dp_model("model.yaml")
Backend->>FileSystem: Read model.yaml
Backend->>Backend: Parse YAML content
Backend->>User: Return model_dict
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: 0
Outside diff range, codebase verification and nitpick comments (1)
doc/backend.md (1)
37-40: Minor grammatical improvement.The explanation is clear, but it would be more grammatically correct to say "Only the Python inference interface can load these formats."
- Only Python inference interface can load these formats. + Only the Python inference interface can load these formats.Tools
LanguageTool
[uncategorized] ~40-~40: You might be missing the article “the” here.
Context: ... is easy to read for human beings. Only Python inference interface can load these form...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## devel #4025 +/- ##
=======================================
Coverage 82.92% 82.93%
=======================================
Files 522 522
Lines 51010 51036 +26
Branches 3023 3023
=======================================
+ Hits 42301 42325 +24
- Misses 7767 7770 +3
+ Partials 942 941 -1 ☔ View full report in Codecov by Sentry. |
Propose a plain text model format based on YAML, which humans can easily read and might be easier to track changes in the git repository (which is good for deepmodeling#2103). Example: [deeppot_dpa_sel.yaml](https://github.com/user-attachments/files/16384230/deeppot_dpa_sel.yaml.txt) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Added support for additional file formats (.yaml and .yml) for model saving and loading. - Enhanced the ability to serialize and deserialize model data in multiple formats. - **Bug Fixes** - Improved error handling for unsupported file formats during model loading. - **Documentation** - Updated documentation to reflect new supported file formats and clarify backend capabilities. - **Tests** - Introduced new test cases to ensure functionality for saving and loading models in YAML format. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Propose a plain text model format based on YAML, which humans can easily read and might be easier to track changes in the git repository (which is good for #2103).
Example: deeppot_dpa_sel.yaml
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Tests