Change output messages for experiment commands

Author: BartoszCki

Pipfile

@@ -12,8 +12,10 @@ botocore = "*"
 six = "*"
 gradient-statsd = "*"
 click = "*"
+terminaltables = "*"
 
 [dev-packages]
 twine = "*"
 pypandoc = "*"
 pytest = "*"
+mock = "*"

paperspace/cli.py

@@ -19,8 +19,8 @@ def convert(self, value, param, ctx):
 
 
 MULTI_NODE_EXPERIMENT_TYPES_MAP = {
-    "GRPC": constants.EXPERIMENT_TYPE_GRPC_MULTI_NODE_ID,
-    "MPI": constants.EXPERIMENT_TYPE_MPI_MULTI_NODE_ID,
+    "GRPC": constants.ExperimentType.GRPC_MULTI_NODE,
+    "MPI": constants.ExperimentType.MPI_MULTI_NODE,
 }
 
 
@@ -225,33 +225,33 @@ def common_experiments_create_single_node_options(f):
 @common_experiment_create_multi_node_options
 def create_multi_node(**kwargs):
     del_if_value_is_none(kwargs)
-    commands.create_experiments(kwargs)
+    commands.create_experiment(kwargs)
 
 
 @create.command(name="singlenode")
 @common_experiments_create_options
 @common_experiments_create_single_node_options
 def create_single_node(**kwargs):
-    kwargs["experimentTypeId"] = constants.EXPERIMENT_TYPE_SINGLE_NODE_ID
+    kwargs["experimentTypeId"] = constants.ExperimentType.SINGLE_NODE
     del_if_value_is_none(kwargs)
-    commands.create_experiments(kwargs)
+    commands.create_experiment(kwargs)
 
 
 @create_and_start.command(name="multinode")
 @common_experiments_create_options
 @common_experiment_create_multi_node_options
 def create_and_start_multi_node(**kwargs):
     del_if_value_is_none(kwargs)
-    commands.create_and_start_experiments(kwargs)
+    commands.create_and_start_experiment(kwargs)
 
 
 @create_and_start.command(name="singlenode")
 @common_experiments_create_options
 @common_experiments_create_single_node_options
 def create_and_start_single_node(**kwargs):
-    kwargs["experimentTypeId"] = constants.EXPERIMENT_TYPE_SINGLE_NODE_ID
+    kwargs["experimentTypeId"] = constants.ExperimentType.SINGLE_NODE
     del_if_value_is_none(kwargs)
-    commands.create_and_start_experiments(kwargs)
+    commands.create_and_start_experiment(kwargs)
 
 
 @experiments.command()

paperspace/client.py

@@ -22,14 +22,14 @@ def post(self, url, json=None, params=None):
 
     def put(self, url):
         path = self.get_path(url)
-        logger.debug("Sending PUT to {}".format(path))
+        logger.debug("Sending PUT to {}\nwith headers: {}".format(path, self.headers))
         response = requests.put(path, headers=self.headers)
         logger.debug("Response content: {}".format(response.content))
         return response
 
     def get(self, url):
         path = self.get_path(url)
-        logger.debug("Sending GET to {}".format(path))
+        logger.debug("Sending GET to {}\nwith headers: {}".format(path, self.headers))
         response = requests.get(path, headers=self.headers)
         logger.debug("Response content: {}".format(response.content))
         return response

paperspace/commands.py

@@ -1,6 +1,6 @@
-from pprint import pformat
+import terminaltables
 
-from paperspace import version, logger
+from paperspace import version, logger, constants
 from paperspace.client import API
 from paperspace.config import config
 
@@ -11,42 +11,130 @@
 experiments_api = API(config.CONFIG_EXPERIMENTS_HOST, headers=default_headers)
 
 
-def _log_response(response, success_msg, error_msg):
+def _log_response(response, success_msg, error_msg, logger_=logger):
     if response.ok:
-        logger.log(success_msg)
+        logger_.log(success_msg)
     else:
         try:
             data = response.json()
-            logger.log_error_response(data)
+            logger_.log_error_response(data)
         except ValueError:
-            logger.log(error_msg)
+            logger_.log(error_msg)
 
 
-def create_experiments(json, api=experiments_api):
-    response = api.post("/experiments/", json=json)
-    _log_response(response, "Experiment created", "Unknown error while creating experiment")
+def _log_create_experiment(response, success_msg_template, error_msg, logger_=logger):
+    if response.ok:
+        j = response.json()
+        handle = j["handle"]
+        msg = success_msg_template.format(handle)
+        logger_.log(msg)
+    else:
+        try:
+            data = response.json()
+            logger_.log_error_response(data)
+        except ValueError:
+            logger_.log(error_msg)
 
 
-def create_and_start_experiments(json, api=experiments_api):
-    response = api.post("/experiments/create_and_start/", json=json)
-    _log_response(response, "Experiment created", "Unknown error while creating experiment")
+def create_experiment(json_, api=experiments_api):
+    response = api.post("/experiments/", json=json_)
+
+    _log_create_experiment(response,
+                           "New experiment created with handle: {}",
+                           "Unknown error while creating the experiment")
+
+
+def create_and_start_experiment(json_, api=experiments_api):
+    response = api.post("/experiments/create_and_start/", json=json_)
+    _log_create_experiment(response,
+                           "New experiment created and started with handle: {}",
+                           "Unknown error while creating/starting the experiment")
 
 
 def start_experiment(experiment_handle, api=experiments_api):
     url = "/experiments/{}/start/".format(experiment_handle)
     response = api.put(url)
-    _log_response(response, "Experiment started", "Unknown error while starting experiment")
+    _log_response(response, "Experiment started", "Unknown error while starting the experiment")
 
 
 def stop_experiment(experiment_handle, api=experiments_api):
     url = "/experiments/{}/stop/".format(experiment_handle)
     response = api.put(url)
-    _log_response(response, "Experiment stopped", "Unknown error while stopping experiment")
+    _log_response(response, "Experiment stopped", "Unknown error while stopping the experiment")
+
+
+def _make_experiments_list_table(experiments):
+    data = [("Name", "Handle", "Status")]
+    for experiment in experiments:
+        name = experiment["templateHistory"]["params"]["name"]
+        handle = experiment["handle"]
+        status = constants.ExperimentState.get_state_str(experiment["state"])
+        data.append((name, handle, status))
+
+    ascii_table = terminaltables.AsciiTable(data)
+    table_string = ascii_table.table
+    return table_string
 
 
 def list_experiments(api=experiments_api):
     response = api.get("/experiments/")
-    _log_response(response, "Experiment stopped", "Unknown error while stopping experiment")
+    details = response.content
+    if response.ok:
+        try:
+            experiments = response.json()["data"]
+            details = _make_experiments_list_table(experiments)
+        except (ValueError, KeyError) as e:
+            logger.log("Error parsing response data")
+            logger.debug(e)
+
+    _log_response(response, details, "Unknown error while retrieving list of experiments")
+
+
+def _make_details_table(experiment):
+    if experiment["experimentTypeId"] == constants.ExperimentType.SINGLE_NODE:
+        data = (
+            ("Name", experiment["templateHistory"]["params"].get("name")),
+            ("Handle", experiment.get("handle")),
+            ("State", constants.ExperimentState.get_state_str(experiment.get("state"))),
+            ("Ports", experiment["templateHistory"]["params"].get("ports")),
+            ("Project Handle", experiment["templateHistory"]["params"].get("project_handle")),
+            ("Worker Command", experiment["templateHistory"]["params"].get("worker_command")),
+            ("Worker Container", experiment["templateHistory"]["params"].get("worker_container")),
+            ("Worker Machine Type", experiment["templateHistory"]["params"].get("worker_machine_type")),
+            ("Working Directory", experiment["templateHistory"]["params"].get("workingDirectory")),
+            ("Workspace URL", experiment["templateHistory"]["params"].get("workspaceUrl")),
+        )
+    elif experiment["experimentTypeId"] in (constants.ExperimentType.GRPC_MULTI_NODE,
+                                            constants.ExperimentType.MPI_MULTI_NODE):
+        data = (
+            ("Name", experiment["templateHistory"]["params"].get("name")),
+            ("Handle", experiment.get("handle")),
+            ("State", constants.ExperimentState.get_state_str(experiment.get("state"))),
+            ("Artifact directory", experiment["templateHistory"]["params"].get("artifactDirectory")),
+            ("Cluster ID", experiment["templateHistory"]["params"].get("clusterId")),
+            ("Experiment Env", experiment["templateHistory"]["params"].get("experimentEnv")),
+            ("Experiment Type",
+             constants.ExperimentType.get_type_str(experiment["templateHistory"]["params"].get("experimentTypeId"))),
+            ("Parameter Server Command", experiment["templateHistory"]["params"].get("parameter_server_command")),
+            ("Parameter Server Container", experiment["templateHistory"]["params"].get("parameter_server_container")),
+            ("Parameter Server Count", experiment["templateHistory"]["params"].get("parameter_server_count")),
+            ("Parameter Server Machine Type",
+             experiment["templateHistory"]["params"].get("parameter_server_machine_type")),
+            ("Ports", experiment["templateHistory"]["params"].get("ports")),
+            ("Project Handle", experiment["templateHistory"]["params"].get("project_handle")),
+            ("Worker Command", experiment["templateHistory"]["params"].get("worker_command")),
+            ("Worker Container", experiment["templateHistory"]["params"].get("worker_container")),
+            ("Worker Count", experiment["templateHistory"]["params"].get("worker_count")),
+            ("Worker Machine Type", experiment["templateHistory"]["params"].get("worker_machine_type")),
+            ("Working Directory", experiment["templateHistory"]["params"].get("workingDirectory")),
+            ("Workspace URL", experiment["templateHistory"]["params"].get("workspaceUrl")),
+        )
+    else:
+        raise ValueError("Wrong experiment type: {}".format(experiment["experimentTypeId"]))
+
+    ascii_table = terminaltables.AsciiTable(data)
+    table_string = ascii_table.table
+    return table_string
 
 
 def get_experiment_details(experiment_handle, api=experiments_api):
@@ -55,7 +143,10 @@ def get_experiment_details(experiment_handle, api=experiments_api):
     details = response.content
     if response.ok:
         try:
-            details = pformat(response.json()["data"][0])
-        except (ValueError, KeyError, IndexError):
-            pass
+            experiment = response.json()["data"]
+            details = _make_details_table(experiment)
+        except (ValueError, KeyError) as e:
+            logger.log("Error parsing response data")
+            logger.debug(e)
+
     _log_response(response, details, "Unknown error while retrieving details of the experiment")

paperspace/constants.py

@@ -1,3 +1,48 @@
-EXPERIMENT_TYPE_SINGLE_NODE_ID = 1
-EXPERIMENT_TYPE_GRPC_MULTI_NODE_ID = 2
-EXPERIMENT_TYPE_MPI_MULTI_NODE_ID = 3
+class ExperimentType:
+    SINGLE_NODE = 1
+    GRPC_MULTI_NODE = 2
+    MPI_MULTI_NODE = 3
+
+    @classmethod
+    def get_type_str(cls, state_int):
+        type_strings = {
+            1: "single node",
+            2: "GRPC multi node",
+            3: "MPI multi node",
+        }
+        return type_strings.get(state_int, "undefined")
+
+
+class ExperimentState:
+    CREATED = 1
+    PROVISIONED = 2
+    NETWORK_SETUP = 3
+    RUNNING = 4
+    STOPPED = 5
+    ERROR = 6
+    FAILED = 7
+    CANCELLED = 8
+    NETWORK_TEARDOWN = 9
+    PENDING = 10
+    PROVISIONING = 11
+    NETWORK_SETTING_UP = 12
+    NETWORK_TEARING_DOWN = 13
+
+    @classmethod
+    def get_state_str(cls, state_int):
+        state_strings = {
+            1: "created",
+            2: "provisioned",
+            3: "network setup",
+            4: "running",
+            5: "stopped",
+            6: "error",
+            7: "failed",
+            8: "canceled",
+            9: "network teardown",
+            10: "pending",
+            11: "provisioning",
+            12: "network setting up",
+            13: "network tearing down",
+        }
+        return state_strings.get(state_int, "undefined")

paperspace/logger.py

@@ -4,10 +4,9 @@
 from .config import config
 
 
-def log(*messages, **kwargs):
+def log(message, **kwargs):
     error = kwargs.get("error", False)
-    for message in messages:
-        click.echo(message, err=error)
+    click.echo(message, err=error)
 
 
 def log_error_response(data):
@@ -33,6 +32,6 @@ def log_error_response(data):
             log(details)
 
 
-def debug(*messages):
+def debug(messages):
     if config.DEBUG:
-        log(*messages)
+        log("DEBUG: {}".format(messages))

setup.py

@@ -39,7 +39,7 @@
     ],
     keywords='paperspace api development library',
     packages=find_packages(exclude=['contrib', 'docs', 'tests']),
-    install_requires=['requests[security]', 'boto3', 'botocore', 'six', 'gradient-statsd', 'click'],
+    install_requires=['requests[security]', 'boto3', 'botocore', 'six', 'gradient-statsd', 'click', 'terminaltables'],
     entry_points={'console_scripts': [
         'paperspace-python = paperspace.main:main',
     ]},