Add 'models list' command with filtering by experimentId

Author: BartoszCki

paperspace/cli/cli.py

@@ -6,6 +6,7 @@
 from paperspace import constants, client, config
 from paperspace.cli.common import api_key_option, del_if_value_is_none
 from paperspace.cli.jobs import jobs_group
+from paperspace.cli.models import models_group
 from paperspace.cli.projects import projects_group
 from paperspace.cli.types import ChoiceType, json_string
 from paperspace.cli.validators import validate_mutually_exclusive, validate_email
@@ -1054,3 +1055,4 @@ def version():
 
 cli.add_command(jobs_group)
 cli.add_command(projects_group)
+cli.add_command(models_group)

paperspace/cli/models.py

@@ -0,0 +1,24 @@
+import click
+
+from paperspace import client, config
+from paperspace.cli import common
+from paperspace.commands import models as models_commands
+
+
+@click.group("models", help="Manage models")
+def models_group():
+    pass
+
+
+@models_group.command("list", help="List models with optional filtering")
+@click.option(
+    "--experimentId",
+    "experimentId",
+    help="Use to filter jobs by experiment ID",
+)
+@common.api_key_option
+def list_jobs(api_key, **filters):
+    common.del_if_value_is_none(filters)
+    jobs_api = client.API(config.CONFIG_HOST, api_key=api_key)
+    command = models_commands.ListModelsCommand(api=jobs_api)
+    command.execute(filters)

paperspace/commands/models.py

@@ -0,0 +1,64 @@
+import pydoc
+
+import terminaltables
+
+from paperspace.utils import get_terminal_lines
+
+from paperspace.commands import CommandBase
+
+
+class ListModelsCommand(CommandBase):
+    def execute(self, filters):
+        json_ = self._get_request_json(filters)
+        params = {"limit": -1}  # so the api returns full list without pagination
+        response = self.api.get("/mlModels/getModelList/", json=json_, params=params)
+
+        try:
+            models = self._get_models_list(response)
+        except (ValueError, KeyError) as e:
+            self.logger.log("Error while parsing response data: {}".format(e))
+        else:
+            self._log_models_list(models)
+
+    @staticmethod
+    def _get_request_json(filters):
+        experiment_id = filters.get("experimentId")
+        if not experiment_id:
+            return None
+
+        json_ = {"filter": {"where": {"and": [{"experimentId": experiment_id}]}}}
+        return json_
+
+    def _get_models_list(self, response):
+        if not response.ok:
+            raise ValueError("Unknown error")
+
+        data = response.json()["modelList"]
+        self.logger.debug(data)
+        return data
+
+    def _log_models_list(self, model):
+        if not model:
+            self.logger.log("No models found")
+        else:
+            table_str = self._make_models_list_table(model)
+            if len(table_str.splitlines()) > get_terminal_lines():
+                pydoc.pager(table_str)
+            else:
+                self.logger.log(table_str)
+
+    @staticmethod
+    def _make_models_list_table(models):
+        data = [("Name", "ID", "Model Type", "Project ID", "Experiment ID")]
+        for model in models:
+            name = model.get("name")
+            id_ = model.get("id")
+            model_type = model.get("modelType")
+            project_id = model.get("projectId")
+            experiment_id = model.get("experimentId")
+            data.append((name, id_, model_type, project_id, experiment_id))
+
+        ascii_table = terminaltables.AsciiTable(data)
+        table_string = ascii_table.table
+        return table_string
+

paperspace/main.py

@@ -9,7 +9,7 @@
 
 def main():
     if len(sys.argv) >= 2 and sys.argv[1] in ('experiments', 'deployments', 'machines', 'login', 'logout', 'version',
-                                              'projects', 'jobs'):
+                                              'projects', 'jobs', 'models'):
         cli(sys.argv[1:])
 
     args = sys.argv[:]