ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-02-12 07:35:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add docstrings for model properties (#1213)

Browse Source
This commit is contained in:
pollfly 2024-02-25 18:00:57 +02:00 committed by GitHub
parent beb0f5e607
commit 592ab881f7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
clearml/model.py
View File

@ -342,11 +342,22 @@ class BaseModel(object):
@property @property
def published(self): def published(self):
# type: () -> bool # type: () -> bool
"""
Get the published state of this model.
:return:
"""
return self._get_base_model().locked return self._get_base_model().locked
@property @property
def framework(self): def framework(self):
# type: () -> str # type: () -> str
"""
The ML framework of the model (for example: PyTorch, TensorFlow, XGBoost, etc.).
:return: The model's framework
"""
return self._get_model_data().framework return self._get_model_data().framework
def __init__(self, task=None): def __init__(self, task=None):
@ -2136,6 +2147,11 @@ class OutputModel(BaseModel):
@property @property
def upload_storage_uri(self): def upload_storage_uri(self):
# type: () -> str # type: () -> str
"""
The URI of the storage destination for uploaded model weight files.
:return: The URI string
"""
return self._get_base_model().upload_storage_uri return self._get_base_model().upload_storage_uri
def __init__( def __init__(