Add .from_proto() and .from_json() class methods #278
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
codesue
commented
May 21, 2023
| def from_json(self, json_dict: Dict[str, Any]) -> None: | ||
| def merge_from_json(self, json: Union[Dict[str, Any], str]) -> 'ModelCard': |
There was a problem hiding this comment.
I moved the definition of from_json below merge_from_json, so this diff looks strange.
hanneshapke
reviewed
May 21, 2023
| @@ -55,7 +59,7 @@ def to_proto(self) -> message.Message: | |||
| for field_name, field_value in self.__dict__.items(): | |||
| if not hasattr(proto, field_name): | |||
| raise ValueError( | |||
| "%s has no such field named '%s'." % (type(proto), field_name) | |||
| '%s has no such field named "%s".' % (type(proto), field_name) | |||
There was a problem hiding this comment.
Is the swap from " to ' due to an editor config from your side? Should we define one way in yapf to keep it consistent?
There was a problem hiding this comment.
No, it's not from an editor config: mct mostly uses single quotes, and I default to single quotes here like in other tf projects. I switched to single here when yapf complained about the mixing, but I didn't update all other files.
Great idea! Yes, let's define single quotes in yapf.
hanneshapke
approved these changes
May 21, 2023
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.
What does this pull request do?
This pull request adds
BaseModelCardField.from_proto()and makesModelCard().from_json()a class method. It deprecates but doesn't removeBaseModelCardField.copy_from_proto().These are commonly used as alternative constructors, but in a roundabout way:
Additionally, both
.from_json()and.copy_from_proto()call.clear()before copying contents from the JSON/proto into these empty objects.New usage:
Relates to #276
How did you test this change?
Updated tests and ran
pytest model_card_toolkit.How did you document this change?
Updated docstrings.
Before submitting
Before submitting a pull request, please be sure to do the following: