Remove 'model_' from ML doc field names #924
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tected 'model_' namespace
tsmathis
requested review from
janosh and
munrojm
and removed request for
janosh
|
@munrojm, per our discussion |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #924 +/- ##
==========================================
- Coverage 90.54% 88.87% -1.68%
==========================================
Files 139 109 -30
Lines 13203 10048 -3155
==========================================
- Hits 11955 8930 -3025
+ Misses 1248 1118 -130 ☔ View full report in Codecov by Sentry. |
janosh
reviewed
Jan 17, 2024
| @@ -55,8 +55,8 @@ def __init__( | |||
| model_name = {"chgnetcalculator": "chgnet"}.get(model_name, model_name) | |||
| pkg_name = {"m3gnet": "matgl"}.get(model_name, model_name) | |||
| self.provenance = dict( | |||
| model_name=model_name, | |||
| model_version=version(pkg_name), | |||
| name=model_name, | |||
There was a problem hiding this comment.
is just model ok? clearer what it refers to than name imo
There was a problem hiding this comment.
Makes sense to me! Changing to model also doesn't result in any runtime warnings, so should be all good.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The fields
model_nameandmodel_versionin the MLDoc clash with the protected namespacemodel_that exists in Pydantic 2. See here, where the warning arises to prevent collisions withBaseModels methods.Proposed fix is to change
model_nameandmodel_versionto justnameandmodel