Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: reference documentation for the model registry #907

Merged
merged 3 commits into from
Jul 20, 2020
Merged

docs: reference documentation for the model registry #907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ae4904
docs: reference documentation for the model registry
Jul 20, 2020
7b3a625
fix typo
Jul 20, 2020
24b949c
fix line break
Jul 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions common/determined_common/experimental/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,16 @@ class ModelOrderBy(enum.Enum):

class Model:
"""
Class representing a model. Contains methods for managing metadata.
Class representing a model. Contains methods for managing metadata and
model versions.

Arguments:
name (string): The name of the model.
description (string, optional): The description of the model.
creation_time (datetime): The time the model was created.
last_updated_time (datetime): The time the model was most recently updated.
metadata (dict, optional): User defined metadata associated with the checkpoint.
master (string, optional): The address of the Determined master instance.
"""

def __init__(
Expand All @@ -48,7 +57,7 @@ def get_version(self, version: int = 0) -> Checkpoint:
model. If no version is specified the latest model version is returned.

Arguments:
version (int, optional): the model version number requested.
version (int, optional): The model version number requested.
"""
if version == 0:
resp = api.get(
Expand Down Expand Up @@ -79,7 +88,7 @@ def get_versions(self, order_by: ModelOrderBy = ModelOrderBy.DESC) -> List[Check
order by default.

Arguments:
order_by (enum): a member of the ModelOrderBy enum.
order_by (enum): A member of the ModelOrderBy enum.
"""
resp = api.get(
self._master,
Expand Down Expand Up @@ -107,7 +116,7 @@ def register_version(self, checkpoint_uuid: str) -> Checkpoint:
version.

Arguments:
checkpoint_uuid: the uuid to associate with the new model version.
checkpoint_uuid: The uuid to associated with the new model version.
"""
resp = api.post(
self._master,
Expand Down
7 changes: 7 additions & 0 deletions docs/reference/api/experimental.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ determined.experimental
:inherited-members:
:member-order: bysource

``Model``
-----------------------

.. autoclass:: determined.experimental.Model
:members:
:inherited-members:
:member-order: bysource

``ExperimentReference``
-----------------------
Expand Down