Add commands for experiments: start, stop, list, details

Author: BartoszCki

paperspace/cli.py

@@ -14,7 +14,7 @@ def __init__(self, type_map, case_sensitive=True):
         self.type_map = type_map
 
     def convert(self, value, param, ctx):
-        value = super(ChoiceType, self).convert(value, param, ctx)
+        value = super(ChoiceType, self).convert(value, param, ctx).upper()
         return self.type_map[value]
 
 
@@ -101,6 +101,7 @@ def common_experiments_create_options(f):
         click.option(
             "--projectHandle",
             "projectHandle",
+            required=True,
         ),
     ]
     return functools.reduce(lambda x, opt: opt(x), reversed(options), f)
@@ -156,10 +157,6 @@ def common_experiment_create_multi_node_options(f):
             type=int,
             required=True,
         ),
-        click.option(
-            "--projectHandler",
-            "projectHandler",
-        ),
         click.option(
             "--workerContainerUser",
             "workerContainerUser",
@@ -226,15 +223,15 @@ def common_experiments_create_single_node_options(f):
 @create.command(name="multinode")
 @common_experiments_create_options
 @common_experiment_create_multi_node_options
-def multi_node(**kwargs):
+def create_multi_node(**kwargs):
     del_if_value_is_none(kwargs)
     commands.create_experiments(kwargs)
 
 
 @create.command(name="singlenode")
 @common_experiments_create_options
 @common_experiments_create_single_node_options
-def single_node(**kwargs):
+def create_single_node(**kwargs):
     kwargs["experimentTypeId"] = constants.EXPERIMENT_TYPE_SINGLE_NODE_ID
     del_if_value_is_none(kwargs)
     commands.create_experiments(kwargs)
@@ -243,15 +240,42 @@ def single_node(**kwargs):
 @create_and_start.command(name="multinode")
 @common_experiments_create_options
 @common_experiment_create_multi_node_options
-def multi_node(**kwargs):
+def create_and_start_multi_node(**kwargs):
     del_if_value_is_none(kwargs)
-    commands.create_experiments(kwargs)
+    commands.create_and_start_experiments(kwargs)
 
 
 @create_and_start.command(name="singlenode")
 @common_experiments_create_options
 @common_experiments_create_single_node_options
-def single_node(**kwargs):
+def create_and_start_single_node(**kwargs):
     kwargs["experimentTypeId"] = constants.EXPERIMENT_TYPE_SINGLE_NODE_ID
     del_if_value_is_none(kwargs)
-    commands.create_experiments(kwargs)
+    commands.create_and_start_experiments(kwargs)
+
+
+@experiments.command()
+@click.argument("experiment-handle")
+def start(experiment_handle):
+    commands.start_experiment(experiment_handle)
+
+
+@experiments.command()
+@click.argument("experiment-handle")
+def stop(experiment_handle):
+    commands.stop_experiment(experiment_handle)
+
+
+@experiments.command("list")
+def list_experiments():
+    commands.list_experiments()
+
+
+@experiments.command("details")
+@click.argument("experiment-handle")
+def get_experiment_details(experiment_handle):
+    commands.get_experiment_details(experiment_handle)
+
+# TODO: delete experiment - not implemented in the api
+# TODO: modify experiment - not implemented in the api
+# TODO: create experiment template?? What is the difference between experiment and experiment template?

paperspace/client.py

@@ -1,5 +1,7 @@
 import requests
 
+from paperspace import logger
+
 
 class API(object):
     def __init__(self, api_url, headers=None):
@@ -13,5 +15,21 @@ def get_path(self, url):
 
     def post(self, url, json=None, params=None):
         path = self.get_path(url)
+        logger.debug("Sending POST: {}\nto: {}\nwith headers: {}".format(json, path, self.headers))
         response = requests.post(path, json=json, params=params, headers=self.headers)
+        logger.debug("Response content: {}".format(response.content))
+        return response
+
+    def put(self, url):
+        path = self.get_path(url)
+        logger.debug("Sending PUT to {}".format(path))
+        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))
+        response = requests.get(path, headers=self.headers)
+        logger.debug("Response content: {}".format(response.content))
         return response

paperspace/commands.py

@@ -1,13 +1,14 @@
+from pprint import pformat
+
 from paperspace import version, logger
 from paperspace.client import API
 from paperspace.config import config
 
-default_headers = {"x-api-key": config.PAPERSPACE_API_KEY,
+default_headers = {"X-API-Key": config.PAPERSPACE_API_KEY,
                    "ps_client_name": "paperspace-python",
                    "ps_client_version": version.version}
 
 experiments_api = API(config.CONFIG_EXPERIMENTS_HOST, headers=default_headers)
-jobs_api = API(config.CONFIG_HOST, headers=default_headers)
 
 
 def _log_response(response, success_msg, error_msg):
@@ -23,11 +24,38 @@ def _log_response(response, success_msg, error_msg):
 
 def create_experiments(json, api=experiments_api):
     response = api.post("/experiments/", json=json)
-    logger.debug(response.content)
     _log_response(response, "Experiment created", "Unknown error while creating experiment")
 
 
 def create_and_start_experiments(json, api=experiments_api):
     response = api.post("/experiments/create_and_start/", json=json)
-    logger.debug(response.content)
     _log_response(response, "Experiment created", "Unknown error while creating 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")
+
+
+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")
+
+
+def list_experiments(api=experiments_api):
+    response = api.get("/experiments/")
+    _log_response(response, "Experiment stopped", "Unknown error while stopping experiment")
+
+
+def get_experiment_details(experiment_handle, api=experiments_api):
+    url = "/experiments/{}/".format(experiment_handle)
+    response = api.get(url)
+    details = response.content
+    if response.ok:
+        try:
+            details = pformat(response.json()["data"][0])
+        except (ValueError, KeyError, IndexError):
+            pass
+    _log_response(response, details, "Unknown error while retrieving details of the experiment")

paperspace/logger.py

@@ -21,13 +21,16 @@ def log_error_response(data):
         log(str(error), error=True)
 
     if details:
-        for key, val in details.items():
-            if isinstance(val, string_types):
-                val = [val]
-
-            for v in val:
-                msg = "{}: {}".format(key, str(v))
-                log(msg, error=True)
+        if isinstance(details, dict):
+            for key, val in details.items():
+                if isinstance(val, string_types):
+                    val = [val]
+
+                for v in val:
+                    msg = "{}: {}".format(key, str(v))
+                    log(msg, error=True)
+        else:
+            log(details)
 
 
 def debug(*messages):