Add support for creating experiments - WIP

Author: BartoszCki

Pipfile

@@ -11,9 +11,8 @@ cryptography = {extras = ["security"]}
 botocore = "*"
 six = "*"
 gradient-statsd = "*"
+click = "*"
 
 [dev-packages]
 twine = "*"
 pypandoc = "*"
-pylint = "*"
-hacking = "*"

paperspace/cli.py

@@ -0,0 +1,60 @@
+import click
+
+from paperspace import commands
+
+
+class OptionRequiredIfMultinode(click.Option):
+    def full_process_value(self, ctx, value):
+        value = super(OptionRequiredIfMultinode, self).full_process_value(ctx, value)
+
+        if value is None and ctx.params["workercount"] > 1:
+            msg = "Required if --workerCount > 1"
+            raise click.MissingParameter(ctx=ctx, param=self, message=msg)
+
+        return value
+
+
+def del_if_value_is_none(d):
+    """Remove all elements with value == None"""
+    for key, val in list(d.items()):
+        if val is None:
+            del d[key]
+
+
+@click.group()
+def cli():
+    pass
+
+
+@cli.group()
+def experiments():
+    pass
+
+
+@experiments.command()
+@click.option("--name", required=True)
+@click.option("--workerCount", "workerCount", required=True, type=int)
+@click.option("--workerContainer", "workerContainer", cls=OptionRequiredIfMultinode)
+@click.option("--workerMachineType", "workerMachineType", cls=OptionRequiredIfMultinode)
+@click.option("--workerCommand", "workerCommand", cls=OptionRequiredIfMultinode)
+@click.option("--parameterServerContainer", "parameterServerContainer", cls=OptionRequiredIfMultinode)
+@click.option("--parameterServerMachineType", "parameterServerMachineType", cls=OptionRequiredIfMultinode)
+@click.option("--parameterServerCommand", "parameterServerCommand", cls=OptionRequiredIfMultinode)
+@click.option("--parameterServerCount", "parameterServerCount", type=int, cls=OptionRequiredIfMultinode)
+@click.option("--ports", type=int)
+@click.option("--workspaceUrl", "workspaceUrl")
+@click.option("--projectHandler", "projectHandler")
+@click.option("--workingDirectory", "workingDirectory")
+@click.option("--artifactDirectory", "artifactDirectory")
+@click.option("--clusterId", "clusterId", type=int)
+# @click.option("--experimentEnv", type=dict)
+@click.option("--experimentTypeId", "experimentTypeId", type=int)
+@click.option("--workerContainerUser", "workerContainerUser")
+@click.option("--workerRegistryUsername", "workerRegistryUsername")
+@click.option("--workerRegistryPassword", "workerRegistryPassword")
+@click.option("--parameterServerContainerUser", "parameterServerContainerUser")
+@click.option("--parameterServerRegistryContainerUser", "parameterServerRegistryContainerUser")
+@click.option("--parameterServerRegistryPassword", "parameterServerRegistryPassword")
+def create(**kwargs):
+    del_if_value_is_none(kwargs)
+    commands.create_experiments(kwargs)

paperspace/client.py

@@ -0,0 +1,16 @@
+import requests
+
+
+class API(object):
+    def __init__(self, api_url, headers=None):
+        self.api_url = api_url
+        self.headers = headers or {}
+
+    def get_path(self, url):
+        template = "{}{}" if url.startswith("/") else "{}/{}"
+        return template.format(self.api_url, url)
+
+    def post(self, url, json=None):
+        path = self.get_path(url)
+        response = requests.post(path, json=json, headers=self.headers)
+        return response

paperspace/commands.py

@@ -0,0 +1,27 @@
+from paperspace import config, version, logger
+
+from paperspace.client import API
+
+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):
+    if response.ok:
+        logger.log(success_msg)
+    else:
+        try:
+            data = response.json()
+            logger.log_error_response(data)
+        except ValueError:
+            logger.log(error_msg)
+
+
+def create_experiments(data=None, api=experiments_api):
+    data = data or {}
+    response = api.post("/experiments", data)
+    _log_response(response, "Experiment created", "Unknown error while creating experiment")

paperspace/config.py

@@ -1,14 +1,13 @@
 import os
 
-class config: pass
+_DEFAULT_PAPERSPACE_API_KEY = ""
+_DEFAULT_CONFIG_HOST = "https://api.paperspace.io"
+_DEFAULT_CONFIG_LOG_HOST = "https://logs.paperspace.io"
+_DEFAULT_CONFIG_EXPERIMENTS_HOST = "https://"  # TODO: fill this
 
-config.PAPERSPACE_API_KEY = ''
-config.CONFIG_HOST = 'https://api.paperspace.io'
-config.CONFIG_LOG_HOST = 'https://logs.paperspace.io'
 
-if 'PAPERSPACE_API_KEY' in os.environ:
-    config.PAPERSPACE_API_KEY = os.environ['PAPERSPACE_API_KEY']
-if 'PAPERSPACE_CONFIG_HOST' in os.environ:
-    config.CONFIG_HOST = os.environ['PAPERSPACE_CONFIG_HOST']
-if 'PAPERSPACE_CONFIG_LOG_HOST' in os.environ:
-    config.CONFIG_LOG_HOST = os.environ['PAPERSPACE_CONFIG_LOG_HOST']
+class config(object):
+    PAPERSPACE_API_KEY = os.environ.get("PAPERSPACE_API_KEY", _DEFAULT_PAPERSPACE_API_KEY)
+    CONFIG_HOST = os.environ.get("PAPERSPACE_CONFIG_HOST", _DEFAULT_CONFIG_HOST)
+    CONFIG_LOG_HOST = os.environ.get("PAPERSPACE_CONFIG_LOG_HOST", _DEFAULT_CONFIG_LOG_HOST)
+    CONFIG_EXPERIMENTS_HOST = os.environ.get("PAPERSPACE_CONFIG_EXPERIMENTS_HOST", _DEFAULT_CONFIG_EXPERIMENTS_HOST)

paperspace/jobs.py

@@ -1,6 +1,7 @@
 import base64
 import inspect
 import re
+import time
 
 import boto3
 import botocore

paperspace/logger.py

@@ -0,0 +1,27 @@
+import click
+from six import string_types
+
+
+def log(*messages, error=False):
+    for message in messages:
+        click.echo(message, err=error)
+
+
+def log_error_response(data):
+    error = data.get("error")
+    details = data.get("details")
+
+    if not any((error, details)):
+        raise ValueError("No error messages found")
+
+    if error:
+        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)

paperspace/main.py

@@ -1,12 +1,16 @@
-import sys
 import os
+import sys
 
-from .version import version
-from .login import login, logout, set_apikey
+from .cli import cli
 from .jobs import run, print_json_pretty
+from .login import login, logout, set_apikey
+from .version import version
 
 
 def main():
+    if len(sys.argv) >= 2 and sys.argv[1] == 'experiments':
+        cli(sys.argv[1:])
+
     args = sys.argv[:]
     prog = os.path.basename(args.pop(0))
 

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'],
+    install_requires=['requests[security]', 'boto3', 'botocore', 'six', 'gradient-statsd', 'click'],
     entry_points={'console_scripts': [
         'paperspace-python = paperspace.main:main',
     ]},