BAI-1253 Client Datacard Class #1272
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
Member
bw27492
commented
May 14, 2024
bw27492
commented
- Added new parent 'Entry' class for both models and datacards.
- Moved non-unique methods from existing model class to new parent class.
- Created new datacard class
GB27247
suggested changes
May 16, 2024
| name=res["name"], | ||
| description=res["description"], | ||
| ) | ||
| datacard._Entry__unpack(res) |
There was a problem hiding this comment.
Python lacks real access modifiers, although through name mangling will add _Class to any method with a double underscore these are considered private and shouldn't be accessed by any child classes. Instead it is convention to use a single underscore for protected methods(methods to be accessed by child classes).
|
|
||
| @property | ||
| def data_card(self): | ||
| return self.card |
There was a problem hiding this comment.
I would make self.card a protected attribute since you're effectively aliasing it here.
|
|
||
| @property | ||
| def data_card_version(self): | ||
| return self.card_version |
|
|
||
| @property | ||
| def data_card_schema(self): | ||
| return self.card_schema |
GB27247
suggested changes
May 16, 2024
Comment on lines
39
to
97
| @classmethod | ||
| def create( | ||
| cls, | ||
| client: Client, | ||
| name: str, | ||
| description: str, | ||
| team_id: str, | ||
| visibility: ModelVisibility | None = None, | ||
| ) -> Datacard: | ||
| """Build a datacard from Bailo and upload it. | ||
|
|
||
| :param client: A client object used to interact with Bailo | ||
| :param name: Name of datacard | ||
| :param description: Description of datacard | ||
| :param team_id: A unique team ID | ||
| :param visibility: Visibility of datacard, using ModelVisibility enum (e.g Public or Private), defaults to None | ||
| :return: Datacard object | ||
| """ | ||
| res = client.post_model( | ||
| name=name, kind=EntryKind.DATACARD, description=description, team_id=team_id, visibility=visibility | ||
| ) | ||
| datacard = cls( | ||
| client=client, | ||
| datacard_id=res["model"]["id"], | ||
| name=name, | ||
| description=description, | ||
| visibility=visibility, | ||
| ) | ||
|
|
||
| datacard._Entry__unpack(res["model"]) | ||
|
|
||
| return datacard | ||
|
|
||
| @classmethod | ||
| def from_id(cls, client: Client, datacard_id: str) -> Datacard: | ||
| """Return an existing datacard from Bailo. | ||
|
|
||
| :param client: A client object used to interact with Bailo | ||
| :param datacard_id: A unique datacard ID | ||
| :return: A datacard object | ||
| """ | ||
| res = client.get_model(model_id=datacard_id)["model"] | ||
| datacard = cls( | ||
| client=client, | ||
| datacard_id=datacard_id, | ||
| name=res["name"], | ||
| description=res["description"], | ||
| ) | ||
| datacard._Entry__unpack(res) | ||
|
|
||
| datacard.get_card_latest() | ||
|
|
||
| return datacard |
There was a problem hiding this comment.
Can use these as protected class methods in the parent class.
Comment on lines
72
to
97
| @classmethod | ||
| def from_id(cls, client: Client, datacard_id: str) -> Datacard: | ||
| """Return an existing datacard from Bailo. | ||
|
|
||
| :param client: A client object used to interact with Bailo | ||
| :param datacard_id: A unique datacard ID | ||
| :return: A datacard object | ||
| """ | ||
| res = client.get_model(model_id=datacard_id)["model"] | ||
| datacard = cls( | ||
| client=client, | ||
| datacard_id=datacard_id, | ||
| name=res["name"], | ||
| description=res["description"], | ||
| ) | ||
| datacard._Entry__unpack(res) | ||
|
|
||
| datacard.get_card_latest() | ||
|
|
||
| return datacard |
There was a problem hiding this comment.
What's stopping me from pulling down a Model as a Datacard here. There isn't anything differentiating them apart from their kind.
GB27247
approved these changes
May 20, 2024
a3957273
force-pushed
the
BAI-1253-client-dataset-class
branch
from
10c3020 to
eb0e7c3
Compare
bw27492
force-pushed
the
BAI-1253-client-dataset-class
branch
from
eb0e7c3 to
10c3020
Compare
a3957273
approved these changes
May 21, 2024
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.