From 592ab881f7e9c7599a84c00333fdea7a8c203747 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 25 Feb 2024 18:00:57 +0200 Subject: [PATCH] Add docstrings for model properties (#1213) --- clearml/model.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/clearml/model.py b/clearml/model.py index 6288795a..81335e1d 100644 --- a/clearml/model.py +++ b/clearml/model.py @@ -342,11 +342,22 @@ class BaseModel(object): @property def published(self): # type: () -> bool + """ + Get the published state of this model. + + :return: + + """ return self._get_base_model().locked @property def framework(self): # 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 def __init__(self, task=None): @@ -2136,6 +2147,11 @@ class OutputModel(BaseModel): @property def upload_storage_uri(self): # 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 def __init__(